CollectiveAPIWebService Web Service

CollectiveAPIWebService

Click here for a complete list of operations.

ServiceRequests_History_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/ServiceRequests_History_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>
    <ServiceRequests_History_Get xmlns="http://bartec-systems.com/">
      <token>string</token>
      <ServiceRequestID>int</ServiceRequestID>
      <ID>int</ID>
      <Date>dateTime</Date>
    </ServiceRequests_History_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>
    <ServiceRequests_History_GetResponse xmlns="http://bartec-systems.com/">
      <ServiceRequests_History_GetResult RecordCount="int" xmlns="http://www.bartec-systems.com/ServiceRequests_History_Get.xsd">
        <ServiceRequest_History>
          <id>int</id>
          <ServiceCode>string</ServiceCode>
          <UPRN>decimal</UPRN>
          <ServiceLocation>
            <BNG xsi:nil="true" xmlns="http://www.bartec-systems.com" />
            <Metric xsi:nil="true" xmlns="http://www.bartec-systems.com" />
          </ServiceLocation>
          <LandType>string</LandType>
          <DateRequested>dateTime</DateRequested>
          <DateChanged>dateTime</DateChanged>
          <DateClosed>dateTime</DateClosed>
          <ClosingCode>string</ClosingCode>
          <ClosingComments>string</ClosingComments>
          <ServiceClassName>string</ServiceClassName>
          <ServiceTypeName>string</ServiceTypeName>
          <ServiceStatusName>string</ServiceStatusName>
          <ExternalReference>string</ExternalReference>
          <ContactName>string</ContactName>
          <ContactTelephone>string</ContactTelephone>
          <ContactEmail>string</ContactEmail>
          <SLAID>int</SLAID>
          <WorkGroupName>string</WorkGroupName>
          <CrewNumber>int</CrewNumber>
          <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>
        </ServiceRequest_History>
        <ServiceRequest_History>
          <id>int</id>
          <ServiceCode>string</ServiceCode>
          <UPRN>decimal</UPRN>
          <ServiceLocation>
            <BNG xsi:nil="true" xmlns="http://www.bartec-systems.com" />
            <Metric xsi:nil="true" xmlns="http://www.bartec-systems.com" />
          </ServiceLocation>
          <LandType>string</LandType>
          <DateRequested>dateTime</DateRequested>
          <DateChanged>dateTime</DateChanged>
          <DateClosed>dateTime</DateClosed>
          <ClosingCode>string</ClosingCode>
          <ClosingComments>string</ClosingComments>
          <ServiceClassName>string</ServiceClassName>
          <ServiceTypeName>string</ServiceTypeName>
          <ServiceStatusName>string</ServiceStatusName>
          <ExternalReference>string</ExternalReference>
          <ContactName>string</ContactName>
          <ContactTelephone>string</ContactTelephone>
          <ContactEmail>string</ContactEmail>
          <SLAID>int</SLAID>
          <WorkGroupName>string</WorkGroupName>
          <CrewNumber>int</CrewNumber>
          <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>
        </ServiceRequest_History>
        <Errors>
          <Result xmlns="http://www.bartec-systems.com">int</Result>
          <Message xmlns="http://www.bartec-systems.com">string</Message>
        </Errors>
      </ServiceRequests_History_GetResult>
    </ServiceRequests_History_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>
    <ServiceRequests_History_Get xmlns="http://bartec-systems.com/">
      <token>string</token>
      <ServiceRequestID>int</ServiceRequestID>
      <ID>int</ID>
      <Date>dateTime</Date>
    </ServiceRequests_History_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>
    <ServiceRequests_History_GetResponse xmlns="http://bartec-systems.com/">
      <ServiceRequests_History_GetResult RecordCount="int" xmlns="http://www.bartec-systems.com/ServiceRequests_History_Get.xsd">
        <ServiceRequest_History>
          <id>int</id>
          <ServiceCode>string</ServiceCode>
          <UPRN>decimal</UPRN>
          <ServiceLocation>
            <BNG xsi:nil="true" xmlns="http://www.bartec-systems.com" />
            <Metric xsi:nil="true" xmlns="http://www.bartec-systems.com" />
          </ServiceLocation>
          <LandType>string</LandType>
          <DateRequested>dateTime</DateRequested>
          <DateChanged>dateTime</DateChanged>
          <DateClosed>dateTime</DateClosed>
          <ClosingCode>string</ClosingCode>
          <ClosingComments>string</ClosingComments>
          <ServiceClassName>string</ServiceClassName>
          <ServiceTypeName>string</ServiceTypeName>
          <ServiceStatusName>string</ServiceStatusName>
          <ExternalReference>string</ExternalReference>
          <ContactName>string</ContactName>
          <ContactTelephone>string</ContactTelephone>
          <ContactEmail>string</ContactEmail>
          <SLAID>int</SLAID>
          <WorkGroupName>string</WorkGroupName>
          <CrewNumber>int</CrewNumber>
          <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>
        </ServiceRequest_History>
        <ServiceRequest_History>
          <id>int</id>
          <ServiceCode>string</ServiceCode>
          <UPRN>decimal</UPRN>
          <ServiceLocation>
            <BNG xsi:nil="true" xmlns="http://www.bartec-systems.com" />
            <Metric xsi:nil="true" xmlns="http://www.bartec-systems.com" />
          </ServiceLocation>
          <LandType>string</LandType>
          <DateRequested>dateTime</DateRequested>
          <DateChanged>dateTime</DateChanged>
          <DateClosed>dateTime</DateClosed>
          <ClosingCode>string</ClosingCode>
          <ClosingComments>string</ClosingComments>
          <ServiceClassName>string</ServiceClassName>
          <ServiceTypeName>string</ServiceTypeName>
          <ServiceStatusName>string</ServiceStatusName>
          <ExternalReference>string</ExternalReference>
          <ContactName>string</ContactName>
          <ContactTelephone>string</ContactTelephone>
          <ContactEmail>string</ContactEmail>
          <SLAID>int</SLAID>
          <WorkGroupName>string</WorkGroupName>
          <CrewNumber>int</CrewNumber>
          <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>
        </ServiceRequest_History>
        <Errors>
          <Result xmlns="http://www.bartec-systems.com">int</Result>
          <Message xmlns="http://www.bartec-systems.com">string</Message>
        </Errors>
      </ServiceRequests_History_GetResult>
    </ServiceRequests_History_GetResponse>
  </soap12:Body>
</soap12:Envelope>