CollectiveAPIWebService

Click here for a complete list of operations.

Premises_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_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_Get xmlns="http://bartec-systems.com/">
      <token>string</token>
      <UPRN>decimal</UPRN>
      <USRN>decimal</USRN>
      <Address1>string</Address1>
      <Address2>string</Address2>
      <Street>string</Street>
      <Locality>string</Locality>
      <Town>string</Town>
      <Postcode>string</Postcode>
      <WardName>string</WardName>
      <ParishName>string</ParishName>
      <UserLabel>string</UserLabel>
      <ParentUPRN>decimal</ParentUPRN>
      <Bounds>
        <Point1 xmlns="http://www.bartec-systems.com" />
        <Point2 xmlns="http://www.bartec-systems.com" />
      </Bounds>
      <BLPUClass>string</BLPUClass>
      <BLPULStat>
        <string>string</string>
        <string>string</string>
      </BLPULStat>
    </Premises_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_GetResponse xmlns="http://bartec-systems.com/">
      <Premises_GetResult RecordCount="int" xmlns="http://www.bartec-systems.com/Premises_Get.xsd">
        <Premises>
          <UPRN xmlns="http://www.bartec-systems.com">decimal</UPRN>
          <USRN xmlns="http://www.bartec-systems.com">decimal</USRN>
          <Address xmlns="http://www.bartec-systems.com">
            <Address1>string</Address1>
            <Address2>string</Address2>
            <Street>string</Street>
            <Locality>string</Locality>
            <Town>string</Town>
            <PostCode>string</PostCode>
          </Address>
          <BLPUClassification xmlns="http://www.bartec-systems.com">
            <ClassificationCode>string</ClassificationCode>
            <PrimaryDescription>string</PrimaryDescription>
            <SecondaryDescription>string</SecondaryDescription>
            <TertiaryDescription>string</TertiaryDescription>
          </BLPUClassification>
          <BLPULogicalStatus xmlns="http://www.bartec-systems.com">
            <Description>string</Description>
          </BLPULogicalStatus>
          <UserLabel xmlns="http://www.bartec-systems.com">string</UserLabel>
          <Ward xmlns="http://www.bartec-systems.com">
            <ID>int</ID>
            <WardCode>string</WardCode>
            <Name>string</Name>
            <RecordStamp xsi:nil="true" />
          </Ward>
          <Parish xmlns="http://www.bartec-systems.com">
            <ID>int</ID>
            <ParishCode>string</ParishCode>
            <Name>string</Name>
            <RecordStamp xsi:nil="true" />
          </Parish>
          <Location xmlns="http://www.bartec-systems.com">
            <BNG xsi:nil="true" />
            <Metric xsi:nil="true" />
          </Location>
          <RecordStamp xmlns="http://www.bartec-systems.com">
            <AddedBy>string</AddedBy>
            <DateAdded>dateTime</DateAdded>
            <Comments>string</Comments>
          </RecordStamp>
        </Premises>
        <Premises>
          <UPRN xmlns="http://www.bartec-systems.com">decimal</UPRN>
          <USRN xmlns="http://www.bartec-systems.com">decimal</USRN>
          <Address xmlns="http://www.bartec-systems.com">
            <Address1>string</Address1>
            <Address2>string</Address2>
            <Street>string</Street>
            <Locality>string</Locality>
            <Town>string</Town>
            <PostCode>string</PostCode>
          </Address>
          <BLPUClassification xmlns="http://www.bartec-systems.com">
            <ClassificationCode>string</ClassificationCode>
            <PrimaryDescription>string</PrimaryDescription>
            <SecondaryDescription>string</SecondaryDescription>
            <TertiaryDescription>string</TertiaryDescription>
          </BLPUClassification>
          <BLPULogicalStatus xmlns="http://www.bartec-systems.com">
            <Description>string</Description>
          </BLPULogicalStatus>
          <UserLabel xmlns="http://www.bartec-systems.com">string</UserLabel>
          <Ward xmlns="http://www.bartec-systems.com">
            <ID>int</ID>
            <WardCode>string</WardCode>
            <Name>string</Name>
            <RecordStamp xsi:nil="true" />
          </Ward>
          <Parish xmlns="http://www.bartec-systems.com">
            <ID>int</ID>
            <ParishCode>string</ParishCode>
            <Name>string</Name>
            <RecordStamp xsi:nil="true" />
          </Parish>
          <Location xmlns="http://www.bartec-systems.com">
            <BNG xsi:nil="true" />
            <Metric xsi:nil="true" />
          </Location>
          <RecordStamp xmlns="http://www.bartec-systems.com">
            <AddedBy>string</AddedBy>
            <DateAdded>dateTime</DateAdded>
            <Comments>string</Comments>
          </RecordStamp>
        </Premises>
        <Errors>
          <Result xmlns="http://www.bartec-systems.com">int</Result>
          <Message xmlns="http://www.bartec-systems.com">string</Message>
        </Errors>
      </Premises_GetResult>
    </Premises_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_Get xmlns="http://bartec-systems.com/">
      <token>string</token>
      <UPRN>decimal</UPRN>
      <USRN>decimal</USRN>
      <Address1>string</Address1>
      <Address2>string</Address2>
      <Street>string</Street>
      <Locality>string</Locality>
      <Town>string</Town>
      <Postcode>string</Postcode>
      <WardName>string</WardName>
      <ParishName>string</ParishName>
      <UserLabel>string</UserLabel>
      <ParentUPRN>decimal</ParentUPRN>
      <Bounds>
        <Point1 xmlns="http://www.bartec-systems.com" />
        <Point2 xmlns="http://www.bartec-systems.com" />
      </Bounds>
      <BLPUClass>string</BLPUClass>
      <BLPULStat>
        <string>string</string>
        <string>string</string>
      </BLPULStat>
    </Premises_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_GetResponse xmlns="http://bartec-systems.com/">
      <Premises_GetResult RecordCount="int" xmlns="http://www.bartec-systems.com/Premises_Get.xsd">
        <Premises>
          <UPRN xmlns="http://www.bartec-systems.com">decimal</UPRN>
          <USRN xmlns="http://www.bartec-systems.com">decimal</USRN>
          <Address xmlns="http://www.bartec-systems.com">
            <Address1>string</Address1>
            <Address2>string</Address2>
            <Street>string</Street>
            <Locality>string</Locality>
            <Town>string</Town>
            <PostCode>string</PostCode>
          </Address>
          <BLPUClassification xmlns="http://www.bartec-systems.com">
            <ClassificationCode>string</ClassificationCode>
            <PrimaryDescription>string</PrimaryDescription>
            <SecondaryDescription>string</SecondaryDescription>
            <TertiaryDescription>string</TertiaryDescription>
          </BLPUClassification>
          <BLPULogicalStatus xmlns="http://www.bartec-systems.com">
            <Description>string</Description>
          </BLPULogicalStatus>
          <UserLabel xmlns="http://www.bartec-systems.com">string</UserLabel>
          <Ward xmlns="http://www.bartec-systems.com">
            <ID>int</ID>
            <WardCode>string</WardCode>
            <Name>string</Name>
            <RecordStamp xsi:nil="true" />
          </Ward>
          <Parish xmlns="http://www.bartec-systems.com">
            <ID>int</ID>
            <ParishCode>string</ParishCode>
            <Name>string</Name>
            <RecordStamp xsi:nil="true" />
          </Parish>
          <Location xmlns="http://www.bartec-systems.com">
            <BNG xsi:nil="true" />
            <Metric xsi:nil="true" />
          </Location>
          <RecordStamp xmlns="http://www.bartec-systems.com">
            <AddedBy>string</AddedBy>
            <DateAdded>dateTime</DateAdded>
            <Comments>string</Comments>
          </RecordStamp>
        </Premises>
        <Premises>
          <UPRN xmlns="http://www.bartec-systems.com">decimal</UPRN>
          <USRN xmlns="http://www.bartec-systems.com">decimal</USRN>
          <Address xmlns="http://www.bartec-systems.com">
            <Address1>string</Address1>
            <Address2>string</Address2>
            <Street>string</Street>
            <Locality>string</Locality>
            <Town>string</Town>
            <PostCode>string</PostCode>
          </Address>
          <BLPUClassification xmlns="http://www.bartec-systems.com">
            <ClassificationCode>string</ClassificationCode>
            <PrimaryDescription>string</PrimaryDescription>
            <SecondaryDescription>string</SecondaryDescription>
            <TertiaryDescription>string</TertiaryDescription>
          </BLPUClassification>
          <BLPULogicalStatus xmlns="http://www.bartec-systems.com">
            <Description>string</Description>
          </BLPULogicalStatus>
          <UserLabel xmlns="http://www.bartec-systems.com">string</UserLabel>
          <Ward xmlns="http://www.bartec-systems.com">
            <ID>int</ID>
            <WardCode>string</WardCode>
            <Name>string</Name>
            <RecordStamp xsi:nil="true" />
          </Ward>
          <Parish xmlns="http://www.bartec-systems.com">
            <ID>int</ID>
            <ParishCode>string</ParishCode>
            <Name>string</Name>
            <RecordStamp xsi:nil="true" />
          </Parish>
          <Location xmlns="http://www.bartec-systems.com">
            <BNG xsi:nil="true" />
            <Metric xsi:nil="true" />
          </Location>
          <RecordStamp xmlns="http://www.bartec-systems.com">
            <AddedBy>string</AddedBy>
            <DateAdded>dateTime</DateAdded>
            <Comments>string</Comments>
          </RecordStamp>
        </Premises>
        <Errors>
          <Result xmlns="http://www.bartec-systems.com">int</Result>
          <Message xmlns="http://www.bartec-systems.com">string</Message>
        </Errors>
      </Premises_GetResult>
    </Premises_GetResponse>
  </soap12:Body>
</soap12:Envelope>