CollectiveAPIWebService

Click here for a complete list of operations.

Jobs_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/Jobs_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>
    <Jobs_Get xmlns="http://bartec-systems.com/">
      <token>string</token>
      <UPRN>decimal</UPRN>
      <USRN>decimal</USRN>
      <WorkPackID>int</WorkPackID>
      <ScheduleStart>
        <MinimumDate xmlns="http://www.bartec-systems.com">dateTime</MinimumDate>
        <MaximumDate xmlns="http://www.bartec-systems.com">dateTime</MaximumDate>
      </ScheduleStart>
      <ServiceRequestID>int</ServiceRequestID>
      <WardID>int</WardID>
      <ParishID>int</ParishID>
      <IncludeRelated>boolean</IncludeRelated>
      <Jobs_Bounds>
        <Point1 xmlns="http://www.bartec-systems.com" />
        <Point2 xmlns="http://www.bartec-systems.com" />
      </Jobs_Bounds>
    </Jobs_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>
    <Jobs_GetResponse xmlns="http://bartec-systems.com/">
      <Jobs_GetResult RecordCount="int" xmlns="http://www.bartec-systems.com/Jobs_Get.xsd">
        <Jobs>
          <Job>
            <ServiceRequestID>int</ServiceRequestID>
            <Premises xsi:nil="true" />
            <ScheduledStart>dateTime</ScheduledStart>
          </Job>
        </Jobs>
        <Jobs>
          <Job>
            <ServiceRequestID>int</ServiceRequestID>
            <Premises xsi:nil="true" />
            <ScheduledStart>dateTime</ScheduledStart>
          </Job>
        </Jobs>
        <Errors>
          <Result xmlns="http://www.bartec-systems.com">int</Result>
          <Message xmlns="http://www.bartec-systems.com">string</Message>
        </Errors>
      </Jobs_GetResult>
    </Jobs_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>
    <Jobs_Get xmlns="http://bartec-systems.com/">
      <token>string</token>
      <UPRN>decimal</UPRN>
      <USRN>decimal</USRN>
      <WorkPackID>int</WorkPackID>
      <ScheduleStart>
        <MinimumDate xmlns="http://www.bartec-systems.com">dateTime</MinimumDate>
        <MaximumDate xmlns="http://www.bartec-systems.com">dateTime</MaximumDate>
      </ScheduleStart>
      <ServiceRequestID>int</ServiceRequestID>
      <WardID>int</WardID>
      <ParishID>int</ParishID>
      <IncludeRelated>boolean</IncludeRelated>
      <Jobs_Bounds>
        <Point1 xmlns="http://www.bartec-systems.com" />
        <Point2 xmlns="http://www.bartec-systems.com" />
      </Jobs_Bounds>
    </Jobs_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>
    <Jobs_GetResponse xmlns="http://bartec-systems.com/">
      <Jobs_GetResult RecordCount="int" xmlns="http://www.bartec-systems.com/Jobs_Get.xsd">
        <Jobs>
          <Job>
            <ServiceRequestID>int</ServiceRequestID>
            <Premises xsi:nil="true" />
            <ScheduledStart>dateTime</ScheduledStart>
          </Job>
        </Jobs>
        <Jobs>
          <Job>
            <ServiceRequestID>int</ServiceRequestID>
            <Premises xsi:nil="true" />
            <ScheduledStart>dateTime</ScheduledStart>
          </Job>
        </Jobs>
        <Errors>
          <Result xmlns="http://www.bartec-systems.com">int</Result>
          <Message xmlns="http://www.bartec-systems.com">string</Message>
        </Errors>
      </Jobs_GetResult>
    </Jobs_GetResponse>
  </soap12:Body>
</soap12:Envelope>