CollectiveAPIWebService Web Service

CollectiveAPIWebService

Click here for a complete list of operations.

Jobs_Detail_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_Detail_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_Detail_Get xmlns="http://bartec-systems.com/">
      <token>string</token>
      <JobID>int</JobID>
    </Jobs_Detail_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_Detail_GetResponse xmlns="http://bartec-systems.com/">
      <Jobs_Detail_GetResult RecordCount="int" xmlns="http://www.bartec-systems.com/Jobs_Detail_Get.xsd">
        <Job>
          <Premises>
            <UPRN xmlns="http://www.bartec-systems.com">decimal</UPRN>
            <USRN xmlns="http://www.bartec-systems.com">decimal</USRN>
            <Address xsi:nil="true" xmlns="http://www.bartec-systems.com" />
            <BLPUClassification xsi:nil="true" xmlns="http://www.bartec-systems.com" />
            <BLPULogicalStatus xsi:nil="true" xmlns="http://www.bartec-systems.com" />
            <UserLabel xmlns="http://www.bartec-systems.com">string</UserLabel>
            <Ward xsi:nil="true" xmlns="http://www.bartec-systems.com" />
            <Parish xsi:nil="true" xmlns="http://www.bartec-systems.com" />
            <Location xsi:nil="true" xmlns="http://www.bartec-systems.com" />
            <RecordStamp xsi:nil="true" xmlns="http://www.bartec-systems.com" />
          </Premises>
          <JobReference>string</JobReference>
          <SequenceNumber>int</SequenceNumber>
          <ScheduledStart>dateTime</ScheduledStart>
          <ScheduledFinish>dateTime</ScheduledFinish>
          <ScheduledMinutes>int</ScheduledMinutes>
          <ScheduledCost>decimal</ScheduledCost>
          <ExpectedStart>dateTime</ExpectedStart>
          <ExpectedFinish>dateTime</ExpectedFinish>
          <ActualStart>dateTime</ActualStart>
          <ActualFinish>dateTime</ActualFinish>
          <ActualMinutes>int</ActualMinutes>
          <ActualCost>decimal</ActualCost>
          <NoFurtherAction>boolean</NoFurtherAction>
          <OnHold>boolean</OnHold>
          <QAPass>boolean</QAPass>
          <Tasks>
            <Task xsi:nil="true" />
            <Task xsi:nil="true" />
          </Tasks>
          <AttachedDocuments>
            <AttachedDocument xsi:nil="true" />
            <AttachedDocument xsi:nil="true" />
          </AttachedDocuments>
          <ExtendedData>
            <ID xmlns="http://www.bartec-systems.com">int</ID>
            <RecordDefinition xsi:nil="true" xmlns="http://www.bartec-systems.com" />
            <Field xsi:nil="true" xmlns="http://www.bartec-systems.com" />
            <Field xsi:nil="true" xmlns="http://www.bartec-systems.com" />
            <RecordStamp xsi:nil="true" xmlns="http://www.bartec-systems.com" />
          </ExtendedData>
          <ExtendedData>
            <ID xmlns="http://www.bartec-systems.com">int</ID>
            <RecordDefinition xsi:nil="true" xmlns="http://www.bartec-systems.com" />
            <Field xsi:nil="true" xmlns="http://www.bartec-systems.com" />
            <Field xsi:nil="true" xmlns="http://www.bartec-systems.com" />
            <RecordStamp xsi:nil="true" xmlns="http://www.bartec-systems.com" />
          </ExtendedData>
        </Job>
        <Errors>
          <Result xmlns="http://www.bartec-systems.com">int</Result>
          <Message xmlns="http://www.bartec-systems.com">string</Message>
        </Errors>
      </Jobs_Detail_GetResult>
    </Jobs_Detail_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_Detail_Get xmlns="http://bartec-systems.com/">
      <token>string</token>
      <JobID>int</JobID>
    </Jobs_Detail_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_Detail_GetResponse xmlns="http://bartec-systems.com/">
      <Jobs_Detail_GetResult RecordCount="int" xmlns="http://www.bartec-systems.com/Jobs_Detail_Get.xsd">
        <Job>
          <Premises>
            <UPRN xmlns="http://www.bartec-systems.com">decimal</UPRN>
            <USRN xmlns="http://www.bartec-systems.com">decimal</USRN>
            <Address xsi:nil="true" xmlns="http://www.bartec-systems.com" />
            <BLPUClassification xsi:nil="true" xmlns="http://www.bartec-systems.com" />
            <BLPULogicalStatus xsi:nil="true" xmlns="http://www.bartec-systems.com" />
            <UserLabel xmlns="http://www.bartec-systems.com">string</UserLabel>
            <Ward xsi:nil="true" xmlns="http://www.bartec-systems.com" />
            <Parish xsi:nil="true" xmlns="http://www.bartec-systems.com" />
            <Location xsi:nil="true" xmlns="http://www.bartec-systems.com" />
            <RecordStamp xsi:nil="true" xmlns="http://www.bartec-systems.com" />
          </Premises>
          <JobReference>string</JobReference>
          <SequenceNumber>int</SequenceNumber>
          <ScheduledStart>dateTime</ScheduledStart>
          <ScheduledFinish>dateTime</ScheduledFinish>
          <ScheduledMinutes>int</ScheduledMinutes>
          <ScheduledCost>decimal</ScheduledCost>
          <ExpectedStart>dateTime</ExpectedStart>
          <ExpectedFinish>dateTime</ExpectedFinish>
          <ActualStart>dateTime</ActualStart>
          <ActualFinish>dateTime</ActualFinish>
          <ActualMinutes>int</ActualMinutes>
          <ActualCost>decimal</ActualCost>
          <NoFurtherAction>boolean</NoFurtherAction>
          <OnHold>boolean</OnHold>
          <QAPass>boolean</QAPass>
          <Tasks>
            <Task xsi:nil="true" />
            <Task xsi:nil="true" />
          </Tasks>
          <AttachedDocuments>
            <AttachedDocument xsi:nil="true" />
            <AttachedDocument xsi:nil="true" />
          </AttachedDocuments>
          <ExtendedData>
            <ID xmlns="http://www.bartec-systems.com">int</ID>
            <RecordDefinition xsi:nil="true" xmlns="http://www.bartec-systems.com" />
            <Field xsi:nil="true" xmlns="http://www.bartec-systems.com" />
            <Field xsi:nil="true" xmlns="http://www.bartec-systems.com" />
            <RecordStamp xsi:nil="true" xmlns="http://www.bartec-systems.com" />
          </ExtendedData>
          <ExtendedData>
            <ID xmlns="http://www.bartec-systems.com">int</ID>
            <RecordDefinition xsi:nil="true" xmlns="http://www.bartec-systems.com" />
            <Field xsi:nil="true" xmlns="http://www.bartec-systems.com" />
            <Field xsi:nil="true" xmlns="http://www.bartec-systems.com" />
            <RecordStamp xsi:nil="true" xmlns="http://www.bartec-systems.com" />
          </ExtendedData>
        </Job>
        <Errors>
          <Result xmlns="http://www.bartec-systems.com">int</Result>
          <Message xmlns="http://www.bartec-systems.com">string</Message>
        </Errors>
      </Jobs_Detail_GetResult>
    </Jobs_Detail_GetResponse>
  </soap12:Body>
</soap12:Envelope>