CollectiveAPIWebService Web Service

CollectiveAPIWebService

Click here for a complete list of operations.

ServiceRequests_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/ServiceRequests_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>
    <ServiceRequests_Detail_Get xmlns="http://bartec-systems.com/">
      <token>string</token>
      <ServiceRequestIDs>
        <int>int</int>
        <int>int</int>
      </ServiceRequestIDs>
      <ServiceCodes>
        <string>string</string>
        <string>string</string>
      </ServiceCodes>
    </ServiceRequests_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>
    <ServiceRequests_Detail_GetResponse xmlns="http://bartec-systems.com/">
      <ServiceRequests_Detail_GetResult RecordCount="int" xmlns="http://www.bartec-systems.com/ServiceRequests_Get2.xsd">
        <ServiceRequest>
          <Crew>
            <ID xmlns="http://www.bartec-systems.com">int</ID>
            <CrewNumber xmlns="http://www.bartec-systems.com">int</CrewNumber>
            <WorkGroup xsi:nil="true" xmlns="http://www.bartec-systems.com" />
            <Description xmlns="http://www.bartec-systems.com">string</Description>
            <DefaultSize xmlns="http://www.bartec-systems.com">int</DefaultSize>
            <StartTime xmlns="http://www.bartec-systems.com">time</StartTime>
            <EndTime xmlns="http://www.bartec-systems.com">time</EndTime>
            <WorkingMinutes xmlns="http://www.bartec-systems.com">int</WorkingMinutes>
            <NonworkingMinutes xmlns="http://www.bartec-systems.com">int</NonworkingMinutes>
            <RecordStamp xsi:nil="true" xmlns="http://www.bartec-systems.com" />
          </Crew>
          <LandType>
            <ID xmlns="http://www.bartec-systems.com">int</ID>
            <Name xmlns="http://www.bartec-systems.com">string</Name>
            <RecordStamp xsi:nil="true" xmlns="http://www.bartec-systems.com" />
          </LandType>
          <Notes>
            <Note xsi:nil="true" />
            <Note xsi:nil="true" />
          </Notes>
          <AttachedDocuments>
            <AttachedDocument xsi:nil="true" />
            <AttachedDocument xsi:nil="true" />
          </AttachedDocuments>
          <RelatedServiceRequests>
            <RelatedServiceRequest xsi:nil="true" />
            <RelatedServiceRequest xsi:nil="true" />
          </RelatedServiceRequests>
          <RelatedPremises>
            <Location xsi:nil="true" />
            <Location xsi:nil="true" />
          </RelatedPremises>
          <DateClosed>dateTime</DateClosed>
          <ClosingCode>string</ClosingCode>
          <ClosingComments>string</ClosingComments>
          <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>
        <ServiceRequest>
          <Crew>
            <ID xmlns="http://www.bartec-systems.com">int</ID>
            <CrewNumber xmlns="http://www.bartec-systems.com">int</CrewNumber>
            <WorkGroup xsi:nil="true" xmlns="http://www.bartec-systems.com" />
            <Description xmlns="http://www.bartec-systems.com">string</Description>
            <DefaultSize xmlns="http://www.bartec-systems.com">int</DefaultSize>
            <StartTime xmlns="http://www.bartec-systems.com">time</StartTime>
            <EndTime xmlns="http://www.bartec-systems.com">time</EndTime>
            <WorkingMinutes xmlns="http://www.bartec-systems.com">int</WorkingMinutes>
            <NonworkingMinutes xmlns="http://www.bartec-systems.com">int</NonworkingMinutes>
            <RecordStamp xsi:nil="true" xmlns="http://www.bartec-systems.com" />
          </Crew>
          <LandType>
            <ID xmlns="http://www.bartec-systems.com">int</ID>
            <Name xmlns="http://www.bartec-systems.com">string</Name>
            <RecordStamp xsi:nil="true" xmlns="http://www.bartec-systems.com" />
          </LandType>
          <Notes>
            <Note xsi:nil="true" />
            <Note xsi:nil="true" />
          </Notes>
          <AttachedDocuments>
            <AttachedDocument xsi:nil="true" />
            <AttachedDocument xsi:nil="true" />
          </AttachedDocuments>
          <RelatedServiceRequests>
            <RelatedServiceRequest xsi:nil="true" />
            <RelatedServiceRequest xsi:nil="true" />
          </RelatedServiceRequests>
          <RelatedPremises>
            <Location xsi:nil="true" />
            <Location xsi:nil="true" />
          </RelatedPremises>
          <DateClosed>dateTime</DateClosed>
          <ClosingCode>string</ClosingCode>
          <ClosingComments>string</ClosingComments>
          <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>
        <Errors>
          <Result xmlns="http://www.bartec-systems.com">int</Result>
          <Message xmlns="http://www.bartec-systems.com">string</Message>
        </Errors>
      </ServiceRequests_Detail_GetResult>
    </ServiceRequests_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>
    <ServiceRequests_Detail_Get xmlns="http://bartec-systems.com/">
      <token>string</token>
      <ServiceRequestIDs>
        <int>int</int>
        <int>int</int>
      </ServiceRequestIDs>
      <ServiceCodes>
        <string>string</string>
        <string>string</string>
      </ServiceCodes>
    </ServiceRequests_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>
    <ServiceRequests_Detail_GetResponse xmlns="http://bartec-systems.com/">
      <ServiceRequests_Detail_GetResult RecordCount="int" xmlns="http://www.bartec-systems.com/ServiceRequests_Get2.xsd">
        <ServiceRequest>
          <Crew>
            <ID xmlns="http://www.bartec-systems.com">int</ID>
            <CrewNumber xmlns="http://www.bartec-systems.com">int</CrewNumber>
            <WorkGroup xsi:nil="true" xmlns="http://www.bartec-systems.com" />
            <Description xmlns="http://www.bartec-systems.com">string</Description>
            <DefaultSize xmlns="http://www.bartec-systems.com">int</DefaultSize>
            <StartTime xmlns="http://www.bartec-systems.com">time</StartTime>
            <EndTime xmlns="http://www.bartec-systems.com">time</EndTime>
            <WorkingMinutes xmlns="http://www.bartec-systems.com">int</WorkingMinutes>
            <NonworkingMinutes xmlns="http://www.bartec-systems.com">int</NonworkingMinutes>
            <RecordStamp xsi:nil="true" xmlns="http://www.bartec-systems.com" />
          </Crew>
          <LandType>
            <ID xmlns="http://www.bartec-systems.com">int</ID>
            <Name xmlns="http://www.bartec-systems.com">string</Name>
            <RecordStamp xsi:nil="true" xmlns="http://www.bartec-systems.com" />
          </LandType>
          <Notes>
            <Note xsi:nil="true" />
            <Note xsi:nil="true" />
          </Notes>
          <AttachedDocuments>
            <AttachedDocument xsi:nil="true" />
            <AttachedDocument xsi:nil="true" />
          </AttachedDocuments>
          <RelatedServiceRequests>
            <RelatedServiceRequest xsi:nil="true" />
            <RelatedServiceRequest xsi:nil="true" />
          </RelatedServiceRequests>
          <RelatedPremises>
            <Location xsi:nil="true" />
            <Location xsi:nil="true" />
          </RelatedPremises>
          <DateClosed>dateTime</DateClosed>
          <ClosingCode>string</ClosingCode>
          <ClosingComments>string</ClosingComments>
          <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>
        <ServiceRequest>
          <Crew>
            <ID xmlns="http://www.bartec-systems.com">int</ID>
            <CrewNumber xmlns="http://www.bartec-systems.com">int</CrewNumber>
            <WorkGroup xsi:nil="true" xmlns="http://www.bartec-systems.com" />
            <Description xmlns="http://www.bartec-systems.com">string</Description>
            <DefaultSize xmlns="http://www.bartec-systems.com">int</DefaultSize>
            <StartTime xmlns="http://www.bartec-systems.com">time</StartTime>
            <EndTime xmlns="http://www.bartec-systems.com">time</EndTime>
            <WorkingMinutes xmlns="http://www.bartec-systems.com">int</WorkingMinutes>
            <NonworkingMinutes xmlns="http://www.bartec-systems.com">int</NonworkingMinutes>
            <RecordStamp xsi:nil="true" xmlns="http://www.bartec-systems.com" />
          </Crew>
          <LandType>
            <ID xmlns="http://www.bartec-systems.com">int</ID>
            <Name xmlns="http://www.bartec-systems.com">string</Name>
            <RecordStamp xsi:nil="true" xmlns="http://www.bartec-systems.com" />
          </LandType>
          <Notes>
            <Note xsi:nil="true" />
            <Note xsi:nil="true" />
          </Notes>
          <AttachedDocuments>
            <AttachedDocument xsi:nil="true" />
            <AttachedDocument xsi:nil="true" />
          </AttachedDocuments>
          <RelatedServiceRequests>
            <RelatedServiceRequest xsi:nil="true" />
            <RelatedServiceRequest xsi:nil="true" />
          </RelatedServiceRequests>
          <RelatedPremises>
            <Location xsi:nil="true" />
            <Location xsi:nil="true" />
          </RelatedPremises>
          <DateClosed>dateTime</DateClosed>
          <ClosingCode>string</ClosingCode>
          <ClosingComments>string</ClosingComments>
          <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>
        <Errors>
          <Result xmlns="http://www.bartec-systems.com">int</Result>
          <Message xmlns="http://www.bartec-systems.com">string</Message>
        </Errors>
      </ServiceRequests_Detail_GetResult>
    </ServiceRequests_Detail_GetResponse>
  </soap12:Body>
</soap12:Envelope>