CollectiveAPIWebService Web Service

CollectiveAPIWebService

Click here for a complete list of operations.

Features_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/Features_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>
    <Features_Get xmlns="http://bartec-systems.com/">
      <token>string</token>
      <Name>string</Name>
      <Description>string</Description>
      <SerialNumber>string</SerialNumber>
      <AssetTag>string</AssetTag>
      <RFIDTag>string</RFIDTag>
      <UPRN>decimal</UPRN>
      <IncludeRelated>boolean</IncludeRelated>
      <Types>
        <int>int</int>
        <int>int</int>
      </Types>
      <Statuses>
        <int>int</int>
        <int>int</int>
      </Statuses>
      <Manufacturers>
        <int>int</int>
        <int>int</int>
      </Manufacturers>
      <Colours>
        <int>int</int>
        <int>int</int>
      </Colours>
      <Conditions>
        <int>int</int>
        <int>int</int>
      </Conditions>
      <WasteTypes>
        <int>int</int>
        <int>int</int>
      </WasteTypes>
    </Features_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>
    <Features_GetResponse xmlns="http://bartec-systems.com/">
      <Features_GetResult RecordCount="int" xmlns="http://www.bartec-systems.com/Features_Get.xsd">
        <Feature>
          <ID xmlns="http://www.bartec-systems.com">int</ID>
          <FeatureCode xmlns="http://www.bartec-systems.com">string</FeatureCode>
          <Name xmlns="http://www.bartec-systems.com">string</Name>
          <Description xmlns="http://www.bartec-systems.com">string</Description>
          <UPRN xmlns="http://www.bartec-systems.com">decimal</UPRN>
          <Status xmlns="http://www.bartec-systems.com">
            <ID>int</ID>
            <Name>string</Name>
            <RecordStamp xsi:nil="true" />
          </Status>
          <FeatureType xmlns="http://www.bartec-systems.com">
            <ID>int</ID>
            <Name>string</Name>
            <Description>string</Description>
            <FeatureClass xsi:nil="true" />
            <DefaultVolume>decimal</DefaultVolume>
            <DefaultArea>decimal</DefaultArea>
            <DefaultLinear>decimal</DefaultLinear>
            <DefaultEach>decimal</DefaultEach>
            <DefaultWeight>decimal</DefaultWeight>
            <RecordStamp xsi:nil="true" />
          </FeatureType>
          <Manufacturer xmlns="http://www.bartec-systems.com">
            <ID>int</ID>
            <Name>string</Name>
            <Description>string</Description>
            <RecordStamp xsi:nil="true" />
          </Manufacturer>
          <Condition xmlns="http://www.bartec-systems.com">
            <ID>int</ID>
            <Name>string</Name>
            <Description>string</Description>
            <RecordStamp xsi:nil="true" />
          </Condition>
          <Colour xmlns="http://www.bartec-systems.com">
            <ID>int</ID>
            <Name>string</Name>
            <Description>string</Description>
            <Red>int</Red>
            <Green>int</Green>
            <Blue>int</Blue>
            <RecordStamp xsi:nil="true" />
          </Colour>
          <QuantityVolume xmlns="http://www.bartec-systems.com">decimal</QuantityVolume>
          <QuantityArea xmlns="http://www.bartec-systems.com">decimal</QuantityArea>
          <QuantityLinear xmlns="http://www.bartec-systems.com">decimal</QuantityLinear>
          <QuantityEach xmlns="http://www.bartec-systems.com">decimal</QuantityEach>
          <QuantityWeight xmlns="http://www.bartec-systems.com">decimal</QuantityWeight>
          <Longitude xmlns="http://www.bartec-systems.com">decimal</Longitude>
          <Latitude xmlns="http://www.bartec-systems.com">decimal</Latitude>
          <AssetTag xmlns="http://www.bartec-systems.com">string</AssetTag>
          <RFIDTag xmlns="http://www.bartec-systems.com">string</RFIDTag>
          <SerialNumber xmlns="http://www.bartec-systems.com">string</SerialNumber>
          <RecordStamp xmlns="http://www.bartec-systems.com">
            <AddedBy>string</AddedBy>
            <DateAdded>dateTime</DateAdded>
            <Comments>string</Comments>
          </RecordStamp>
        </Feature>
        <Feature>
          <ID xmlns="http://www.bartec-systems.com">int</ID>
          <FeatureCode xmlns="http://www.bartec-systems.com">string</FeatureCode>
          <Name xmlns="http://www.bartec-systems.com">string</Name>
          <Description xmlns="http://www.bartec-systems.com">string</Description>
          <UPRN xmlns="http://www.bartec-systems.com">decimal</UPRN>
          <Status xmlns="http://www.bartec-systems.com">
            <ID>int</ID>
            <Name>string</Name>
            <RecordStamp xsi:nil="true" />
          </Status>
          <FeatureType xmlns="http://www.bartec-systems.com">
            <ID>int</ID>
            <Name>string</Name>
            <Description>string</Description>
            <FeatureClass xsi:nil="true" />
            <DefaultVolume>decimal</DefaultVolume>
            <DefaultArea>decimal</DefaultArea>
            <DefaultLinear>decimal</DefaultLinear>
            <DefaultEach>decimal</DefaultEach>
            <DefaultWeight>decimal</DefaultWeight>
            <RecordStamp xsi:nil="true" />
          </FeatureType>
          <Manufacturer xmlns="http://www.bartec-systems.com">
            <ID>int</ID>
            <Name>string</Name>
            <Description>string</Description>
            <RecordStamp xsi:nil="true" />
          </Manufacturer>
          <Condition xmlns="http://www.bartec-systems.com">
            <ID>int</ID>
            <Name>string</Name>
            <Description>string</Description>
            <RecordStamp xsi:nil="true" />
          </Condition>
          <Colour xmlns="http://www.bartec-systems.com">
            <ID>int</ID>
            <Name>string</Name>
            <Description>string</Description>
            <Red>int</Red>
            <Green>int</Green>
            <Blue>int</Blue>
            <RecordStamp xsi:nil="true" />
          </Colour>
          <QuantityVolume xmlns="http://www.bartec-systems.com">decimal</QuantityVolume>
          <QuantityArea xmlns="http://www.bartec-systems.com">decimal</QuantityArea>
          <QuantityLinear xmlns="http://www.bartec-systems.com">decimal</QuantityLinear>
          <QuantityEach xmlns="http://www.bartec-systems.com">decimal</QuantityEach>
          <QuantityWeight xmlns="http://www.bartec-systems.com">decimal</QuantityWeight>
          <Longitude xmlns="http://www.bartec-systems.com">decimal</Longitude>
          <Latitude xmlns="http://www.bartec-systems.com">decimal</Latitude>
          <AssetTag xmlns="http://www.bartec-systems.com">string</AssetTag>
          <RFIDTag xmlns="http://www.bartec-systems.com">string</RFIDTag>
          <SerialNumber xmlns="http://www.bartec-systems.com">string</SerialNumber>
          <RecordStamp xmlns="http://www.bartec-systems.com">
            <AddedBy>string</AddedBy>
            <DateAdded>dateTime</DateAdded>
            <Comments>string</Comments>
          </RecordStamp>
        </Feature>
        <Errors>
          <Result xmlns="http://www.bartec-systems.com">int</Result>
          <Message xmlns="http://www.bartec-systems.com">string</Message>
        </Errors>
      </Features_GetResult>
    </Features_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>
    <Features_Get xmlns="http://bartec-systems.com/">
      <token>string</token>
      <Name>string</Name>
      <Description>string</Description>
      <SerialNumber>string</SerialNumber>
      <AssetTag>string</AssetTag>
      <RFIDTag>string</RFIDTag>
      <UPRN>decimal</UPRN>
      <IncludeRelated>boolean</IncludeRelated>
      <Types>
        <int>int</int>
        <int>int</int>
      </Types>
      <Statuses>
        <int>int</int>
        <int>int</int>
      </Statuses>
      <Manufacturers>
        <int>int</int>
        <int>int</int>
      </Manufacturers>
      <Colours>
        <int>int</int>
        <int>int</int>
      </Colours>
      <Conditions>
        <int>int</int>
        <int>int</int>
      </Conditions>
      <WasteTypes>
        <int>int</int>
        <int>int</int>
      </WasteTypes>
    </Features_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>
    <Features_GetResponse xmlns="http://bartec-systems.com/">
      <Features_GetResult RecordCount="int" xmlns="http://www.bartec-systems.com/Features_Get.xsd">
        <Feature>
          <ID xmlns="http://www.bartec-systems.com">int</ID>
          <FeatureCode xmlns="http://www.bartec-systems.com">string</FeatureCode>
          <Name xmlns="http://www.bartec-systems.com">string</Name>
          <Description xmlns="http://www.bartec-systems.com">string</Description>
          <UPRN xmlns="http://www.bartec-systems.com">decimal</UPRN>
          <Status xmlns="http://www.bartec-systems.com">
            <ID>int</ID>
            <Name>string</Name>
            <RecordStamp xsi:nil="true" />
          </Status>
          <FeatureType xmlns="http://www.bartec-systems.com">
            <ID>int</ID>
            <Name>string</Name>
            <Description>string</Description>
            <FeatureClass xsi:nil="true" />
            <DefaultVolume>decimal</DefaultVolume>
            <DefaultArea>decimal</DefaultArea>
            <DefaultLinear>decimal</DefaultLinear>
            <DefaultEach>decimal</DefaultEach>
            <DefaultWeight>decimal</DefaultWeight>
            <RecordStamp xsi:nil="true" />
          </FeatureType>
          <Manufacturer xmlns="http://www.bartec-systems.com">
            <ID>int</ID>
            <Name>string</Name>
            <Description>string</Description>
            <RecordStamp xsi:nil="true" />
          </Manufacturer>
          <Condition xmlns="http://www.bartec-systems.com">
            <ID>int</ID>
            <Name>string</Name>
            <Description>string</Description>
            <RecordStamp xsi:nil="true" />
          </Condition>
          <Colour xmlns="http://www.bartec-systems.com">
            <ID>int</ID>
            <Name>string</Name>
            <Description>string</Description>
            <Red>int</Red>
            <Green>int</Green>
            <Blue>int</Blue>
            <RecordStamp xsi:nil="true" />
          </Colour>
          <QuantityVolume xmlns="http://www.bartec-systems.com">decimal</QuantityVolume>
          <QuantityArea xmlns="http://www.bartec-systems.com">decimal</QuantityArea>
          <QuantityLinear xmlns="http://www.bartec-systems.com">decimal</QuantityLinear>
          <QuantityEach xmlns="http://www.bartec-systems.com">decimal</QuantityEach>
          <QuantityWeight xmlns="http://www.bartec-systems.com">decimal</QuantityWeight>
          <Longitude xmlns="http://www.bartec-systems.com">decimal</Longitude>
          <Latitude xmlns="http://www.bartec-systems.com">decimal</Latitude>
          <AssetTag xmlns="http://www.bartec-systems.com">string</AssetTag>
          <RFIDTag xmlns="http://www.bartec-systems.com">string</RFIDTag>
          <SerialNumber xmlns="http://www.bartec-systems.com">string</SerialNumber>
          <RecordStamp xmlns="http://www.bartec-systems.com">
            <AddedBy>string</AddedBy>
            <DateAdded>dateTime</DateAdded>
            <Comments>string</Comments>
          </RecordStamp>
        </Feature>
        <Feature>
          <ID xmlns="http://www.bartec-systems.com">int</ID>
          <FeatureCode xmlns="http://www.bartec-systems.com">string</FeatureCode>
          <Name xmlns="http://www.bartec-systems.com">string</Name>
          <Description xmlns="http://www.bartec-systems.com">string</Description>
          <UPRN xmlns="http://www.bartec-systems.com">decimal</UPRN>
          <Status xmlns="http://www.bartec-systems.com">
            <ID>int</ID>
            <Name>string</Name>
            <RecordStamp xsi:nil="true" />
          </Status>
          <FeatureType xmlns="http://www.bartec-systems.com">
            <ID>int</ID>
            <Name>string</Name>
            <Description>string</Description>
            <FeatureClass xsi:nil="true" />
            <DefaultVolume>decimal</DefaultVolume>
            <DefaultArea>decimal</DefaultArea>
            <DefaultLinear>decimal</DefaultLinear>
            <DefaultEach>decimal</DefaultEach>
            <DefaultWeight>decimal</DefaultWeight>
            <RecordStamp xsi:nil="true" />
          </FeatureType>
          <Manufacturer xmlns="http://www.bartec-systems.com">
            <ID>int</ID>
            <Name>string</Name>
            <Description>string</Description>
            <RecordStamp xsi:nil="true" />
          </Manufacturer>
          <Condition xmlns="http://www.bartec-systems.com">
            <ID>int</ID>
            <Name>string</Name>
            <Description>string</Description>
            <RecordStamp xsi:nil="true" />
          </Condition>
          <Colour xmlns="http://www.bartec-systems.com">
            <ID>int</ID>
            <Name>string</Name>
            <Description>string</Description>
            <Red>int</Red>
            <Green>int</Green>
            <Blue>int</Blue>
            <RecordStamp xsi:nil="true" />
          </Colour>
          <QuantityVolume xmlns="http://www.bartec-systems.com">decimal</QuantityVolume>
          <QuantityArea xmlns="http://www.bartec-systems.com">decimal</QuantityArea>
          <QuantityLinear xmlns="http://www.bartec-systems.com">decimal</QuantityLinear>
          <QuantityEach xmlns="http://www.bartec-systems.com">decimal</QuantityEach>
          <QuantityWeight xmlns="http://www.bartec-systems.com">decimal</QuantityWeight>
          <Longitude xmlns="http://www.bartec-systems.com">decimal</Longitude>
          <Latitude xmlns="http://www.bartec-systems.com">decimal</Latitude>
          <AssetTag xmlns="http://www.bartec-systems.com">string</AssetTag>
          <RFIDTag xmlns="http://www.bartec-systems.com">string</RFIDTag>
          <SerialNumber xmlns="http://www.bartec-systems.com">string</SerialNumber>
          <RecordStamp xmlns="http://www.bartec-systems.com">
            <AddedBy>string</AddedBy>
            <DateAdded>dateTime</DateAdded>
            <Comments>string</Comments>
          </RecordStamp>
        </Feature>
        <Errors>
          <Result xmlns="http://www.bartec-systems.com">int</Result>
          <Message xmlns="http://www.bartec-systems.com">string</Message>
        </Errors>
      </Features_GetResult>
    </Features_GetResponse>
  </soap12:Body>
</soap12:Envelope>