CollectiveAPIWebService Web Service

CollectiveAPIWebService

Click here for a complete list of operations.

Premises_Attributes_Get

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /API-R1604/CollectiveAPI.asmx HTTP/1.1
Host: collectiveapi.bartec-systems.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://bartec-systems.com/Premises_Attributes_Get"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <Premises_Attributes_Get xmlns="http://bartec-systems.com/">
      <token>string</token>
      <UPRN>decimal</UPRN>
    </Premises_Attributes_Get>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <Premises_Attributes_GetResponse xmlns="http://bartec-systems.com/">
      <Premises_Attributes_GetResult RecordCount="int" xmlns="http://www.bartec-systems.com/Premises_Attributes_Get.xsd">
        <Attribute>
          <AttributeDefinition>
            <ID xmlns="http://www.bartec-systems.com">int</ID>
            <Name xmlns="http://www.bartec-systems.com">string</Name>
            <Description xmlns="http://www.bartec-systems.com">string</Description>
            <SystemAttribute xmlns="http://www.bartec-systems.com">boolean</SystemAttribute>
            <Priority xmlns="http://www.bartec-systems.com">int</Priority>
            <APIVisibility xmlns="http://www.bartec-systems.com">string</APIVisibility>
            <Expiry xmlns="http://www.bartec-systems.com">string</Expiry>
            <ExpiryPeriod xmlns="http://www.bartec-systems.com">string</ExpiryPeriod>
            <MinimumExpiryPeriod xmlns="http://www.bartec-systems.com">string</MinimumExpiryPeriod>
            <MaximumExpiryPeriod xmlns="http://www.bartec-systems.com">string</MaximumExpiryPeriod>
            <Review xmlns="http://www.bartec-systems.com">string</Review>
            <ReviewPeriod xmlns="http://www.bartec-systems.com">string</ReviewPeriod>
            <MinimumReviewPeriod xmlns="http://www.bartec-systems.com">string</MinimumReviewPeriod>
            <MaximumReviewPeriod xmlns="http://www.bartec-systems.com">string</MaximumReviewPeriod>
            <RecordStamp xsi:nil="true" xmlns="http://www.bartec-systems.com" />
          </AttributeDefinition>
          <ID>int</ID>
          <Confirmation>int</Confirmation>
          <ConfirmationDate>dateTime</ConfirmationDate>
          <AttributeValue>string</AttributeValue>
          <ExpiryDate>dateTime</ExpiryDate>
          <ReviewDate>dateTime</ReviewDate>
          <RecordStamp>
            <AddedBy xmlns="http://www.bartec-systems.com">string</AddedBy>
            <DateAdded xmlns="http://www.bartec-systems.com">dateTime</DateAdded>
            <Comments xmlns="http://www.bartec-systems.com">string</Comments>
          </RecordStamp>
        </Attribute>
        <Attribute>
          <AttributeDefinition>
            <ID xmlns="http://www.bartec-systems.com">int</ID>
            <Name xmlns="http://www.bartec-systems.com">string</Name>
            <Description xmlns="http://www.bartec-systems.com">string</Description>
            <SystemAttribute xmlns="http://www.bartec-systems.com">boolean</SystemAttribute>
            <Priority xmlns="http://www.bartec-systems.com">int</Priority>
            <APIVisibility xmlns="http://www.bartec-systems.com">string</APIVisibility>
            <Expiry xmlns="http://www.bartec-systems.com">string</Expiry>
            <ExpiryPeriod xmlns="http://www.bartec-systems.com">string</ExpiryPeriod>
            <MinimumExpiryPeriod xmlns="http://www.bartec-systems.com">string</MinimumExpiryPeriod>
            <MaximumExpiryPeriod xmlns="http://www.bartec-systems.com">string</MaximumExpiryPeriod>
            <Review xmlns="http://www.bartec-systems.com">string</Review>
            <ReviewPeriod xmlns="http://www.bartec-systems.com">string</ReviewPeriod>
            <MinimumReviewPeriod xmlns="http://www.bartec-systems.com">string</MinimumReviewPeriod>
            <MaximumReviewPeriod xmlns="http://www.bartec-systems.com">string</MaximumReviewPeriod>
            <RecordStamp xsi:nil="true" xmlns="http://www.bartec-systems.com" />
          </AttributeDefinition>
          <ID>int</ID>
          <Confirmation>int</Confirmation>
          <ConfirmationDate>dateTime</ConfirmationDate>
          <AttributeValue>string</AttributeValue>
          <ExpiryDate>dateTime</ExpiryDate>
          <ReviewDate>dateTime</ReviewDate>
          <RecordStamp>
            <AddedBy xmlns="http://www.bartec-systems.com">string</AddedBy>
            <DateAdded xmlns="http://www.bartec-systems.com">dateTime</DateAdded>
            <Comments xmlns="http://www.bartec-systems.com">string</Comments>
          </RecordStamp>
        </Attribute>
        <Errors>
          <Result xmlns="http://www.bartec-systems.com">int</Result>
          <Message xmlns="http://www.bartec-systems.com">string</Message>
        </Errors>
      </Premises_Attributes_GetResult>
    </Premises_Attributes_GetResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /API-R1604/CollectiveAPI.asmx HTTP/1.1
Host: collectiveapi.bartec-systems.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <Premises_Attributes_Get xmlns="http://bartec-systems.com/">
      <token>string</token>
      <UPRN>decimal</UPRN>
    </Premises_Attributes_Get>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <Premises_Attributes_GetResponse xmlns="http://bartec-systems.com/">
      <Premises_Attributes_GetResult RecordCount="int" xmlns="http://www.bartec-systems.com/Premises_Attributes_Get.xsd">
        <Attribute>
          <AttributeDefinition>
            <ID xmlns="http://www.bartec-systems.com">int</ID>
            <Name xmlns="http://www.bartec-systems.com">string</Name>
            <Description xmlns="http://www.bartec-systems.com">string</Description>
            <SystemAttribute xmlns="http://www.bartec-systems.com">boolean</SystemAttribute>
            <Priority xmlns="http://www.bartec-systems.com">int</Priority>
            <APIVisibility xmlns="http://www.bartec-systems.com">string</APIVisibility>
            <Expiry xmlns="http://www.bartec-systems.com">string</Expiry>
            <ExpiryPeriod xmlns="http://www.bartec-systems.com">string</ExpiryPeriod>
            <MinimumExpiryPeriod xmlns="http://www.bartec-systems.com">string</MinimumExpiryPeriod>
            <MaximumExpiryPeriod xmlns="http://www.bartec-systems.com">string</MaximumExpiryPeriod>
            <Review xmlns="http://www.bartec-systems.com">string</Review>
            <ReviewPeriod xmlns="http://www.bartec-systems.com">string</ReviewPeriod>
            <MinimumReviewPeriod xmlns="http://www.bartec-systems.com">string</MinimumReviewPeriod>
            <MaximumReviewPeriod xmlns="http://www.bartec-systems.com">string</MaximumReviewPeriod>
            <RecordStamp xsi:nil="true" xmlns="http://www.bartec-systems.com" />
          </AttributeDefinition>
          <ID>int</ID>
          <Confirmation>int</Confirmation>
          <ConfirmationDate>dateTime</ConfirmationDate>
          <AttributeValue>string</AttributeValue>
          <ExpiryDate>dateTime</ExpiryDate>
          <ReviewDate>dateTime</ReviewDate>
          <RecordStamp>
            <AddedBy xmlns="http://www.bartec-systems.com">string</AddedBy>
            <DateAdded xmlns="http://www.bartec-systems.com">dateTime</DateAdded>
            <Comments xmlns="http://www.bartec-systems.com">string</Comments>
          </RecordStamp>
        </Attribute>
        <Attribute>
          <AttributeDefinition>
            <ID xmlns="http://www.bartec-systems.com">int</ID>
            <Name xmlns="http://www.bartec-systems.com">string</Name>
            <Description xmlns="http://www.bartec-systems.com">string</Description>
            <SystemAttribute xmlns="http://www.bartec-systems.com">boolean</SystemAttribute>
            <Priority xmlns="http://www.bartec-systems.com">int</Priority>
            <APIVisibility xmlns="http://www.bartec-systems.com">string</APIVisibility>
            <Expiry xmlns="http://www.bartec-systems.com">string</Expiry>
            <ExpiryPeriod xmlns="http://www.bartec-systems.com">string</ExpiryPeriod>
            <MinimumExpiryPeriod xmlns="http://www.bartec-systems.com">string</MinimumExpiryPeriod>
            <MaximumExpiryPeriod xmlns="http://www.bartec-systems.com">string</MaximumExpiryPeriod>
            <Review xmlns="http://www.bartec-systems.com">string</Review>
            <ReviewPeriod xmlns="http://www.bartec-systems.com">string</ReviewPeriod>
            <MinimumReviewPeriod xmlns="http://www.bartec-systems.com">string</MinimumReviewPeriod>
            <MaximumReviewPeriod xmlns="http://www.bartec-systems.com">string</MaximumReviewPeriod>
            <RecordStamp xsi:nil="true" xmlns="http://www.bartec-systems.com" />
          </AttributeDefinition>
          <ID>int</ID>
          <Confirmation>int</Confirmation>
          <ConfirmationDate>dateTime</ConfirmationDate>
          <AttributeValue>string</AttributeValue>
          <ExpiryDate>dateTime</ExpiryDate>
          <ReviewDate>dateTime</ReviewDate>
          <RecordStamp>
            <AddedBy xmlns="http://www.bartec-systems.com">string</AddedBy>
            <DateAdded xmlns="http://www.bartec-systems.com">dateTime</DateAdded>
            <Comments xmlns="http://www.bartec-systems.com">string</Comments>
          </RecordStamp>
        </Attribute>
        <Errors>
          <Result xmlns="http://www.bartec-systems.com">int</Result>
          <Message xmlns="http://www.bartec-systems.com">string</Message>
        </Errors>
      </Premises_Attributes_GetResult>
    </Premises_Attributes_GetResponse>
  </soap12:Body>
</soap12:Envelope>