PublicAPIService Web Service

PublicAPIService

Click here for a complete list of operations.

getCallListForWorkOrder

Returns the calls for the specified work order that have been updated since the specified time.

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 /PIP/publicAPIService.asmx HTTP/1.1
Host: einfo.gfidigital.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://digitalgateway.com/WebServices/PublicAPIService/getCallListForWorkOrder"

<?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>
    <getCallListForWorkOrder xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <WorkOrderNumber>
        <ID>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </ID>
        <Code>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Code>
      </WorkOrderNumber>
      <TimeStamp>string</TimeStamp>
    </getCallListForWorkOrder>
  </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>
    <getCallListForWorkOrderResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <getCallListForWorkOrderResult>
        <TimeStamp>string</TimeStamp>
        <Details>
          <CallListDetail>
            <CallNumber xsi:nil="true" />
            <ParentCallNumber xsi:nil="true" />
            <MasterParentCallNumber xsi:nil="true" />
            <EquipmentNumber xsi:nil="true" />
            <ModelNumber xsi:nil="true" />
            <SerialNumber xsi:nil="true" />
            <StatusCode xsi:nil="true" />
            <HoldCode xsi:nil="true" />
            <TechnicianNumber xsi:nil="true" />
            <CallDate xsi:nil="true" />
            <CreateDate xsi:nil="true" />
            <LastUpdate xsi:nil="true" />
          </CallListDetail>
          <CallListDetail>
            <CallNumber xsi:nil="true" />
            <ParentCallNumber xsi:nil="true" />
            <MasterParentCallNumber xsi:nil="true" />
            <EquipmentNumber xsi:nil="true" />
            <ModelNumber xsi:nil="true" />
            <SerialNumber xsi:nil="true" />
            <StatusCode xsi:nil="true" />
            <HoldCode xsi:nil="true" />
            <TechnicianNumber xsi:nil="true" />
            <CallDate xsi:nil="true" />
            <CreateDate xsi:nil="true" />
            <LastUpdate xsi:nil="true" />
          </CallListDetail>
        </Details>
      </getCallListForWorkOrderResult>
    </getCallListForWorkOrderResponse>
  </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 /PIP/publicAPIService.asmx HTTP/1.1
Host: einfo.gfidigital.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>
    <getCallListForWorkOrder xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <WorkOrderNumber>
        <ID>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </ID>
        <Code>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Code>
      </WorkOrderNumber>
      <TimeStamp>string</TimeStamp>
    </getCallListForWorkOrder>
  </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>
    <getCallListForWorkOrderResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <getCallListForWorkOrderResult>
        <TimeStamp>string</TimeStamp>
        <Details>
          <CallListDetail>
            <CallNumber xsi:nil="true" />
            <ParentCallNumber xsi:nil="true" />
            <MasterParentCallNumber xsi:nil="true" />
            <EquipmentNumber xsi:nil="true" />
            <ModelNumber xsi:nil="true" />
            <SerialNumber xsi:nil="true" />
            <StatusCode xsi:nil="true" />
            <HoldCode xsi:nil="true" />
            <TechnicianNumber xsi:nil="true" />
            <CallDate xsi:nil="true" />
            <CreateDate xsi:nil="true" />
            <LastUpdate xsi:nil="true" />
          </CallListDetail>
          <CallListDetail>
            <CallNumber xsi:nil="true" />
            <ParentCallNumber xsi:nil="true" />
            <MasterParentCallNumber xsi:nil="true" />
            <EquipmentNumber xsi:nil="true" />
            <ModelNumber xsi:nil="true" />
            <SerialNumber xsi:nil="true" />
            <StatusCode xsi:nil="true" />
            <HoldCode xsi:nil="true" />
            <TechnicianNumber xsi:nil="true" />
            <CallDate xsi:nil="true" />
            <CreateDate xsi:nil="true" />
            <LastUpdate xsi:nil="true" />
          </CallListDetail>
        </Details>
      </getCallListForWorkOrderResult>
    </getCallListForWorkOrderResponse>
  </soap12:Body>
</soap12:Envelope>