PublicAPIService Web Service

PublicAPIService

Click here for a complete list of operations.

getCustomersWithEquipOnContract

Returns a Customer Data array. The returned list contains only customers that have equipment on contract

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/getCustomersWithEquipOnContract"

<?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>
    <getCustomersWithEquipOnContract xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
    </getCustomersWithEquipOnContract>
  </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>
    <getCustomersWithEquipOnContractResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <getCustomersWithEquipOnContractResult>
        <TimeStamp>string</TimeStamp>
        <Details>
          <CustomerListDetail>
            <CustomerNumber xsi:nil="true" />
            <CustomerName xsi:nil="true" />
            <Active xsi:nil="true" />
          </CustomerListDetail>
          <CustomerListDetail>
            <CustomerNumber xsi:nil="true" />
            <CustomerName xsi:nil="true" />
            <Active xsi:nil="true" />
          </CustomerListDetail>
        </Details>
      </getCustomersWithEquipOnContractResult>
    </getCustomersWithEquipOnContractResponse>
  </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>
    <getCustomersWithEquipOnContract xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
    </getCustomersWithEquipOnContract>
  </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>
    <getCustomersWithEquipOnContractResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <getCustomersWithEquipOnContractResult>
        <TimeStamp>string</TimeStamp>
        <Details>
          <CustomerListDetail>
            <CustomerNumber xsi:nil="true" />
            <CustomerName xsi:nil="true" />
            <Active xsi:nil="true" />
          </CustomerListDetail>
          <CustomerListDetail>
            <CustomerNumber xsi:nil="true" />
            <CustomerName xsi:nil="true" />
            <Active xsi:nil="true" />
          </CustomerListDetail>
        </Details>
      </getCustomersWithEquipOnContractResult>
    </getCustomersWithEquipOnContractResponse>
  </soap12:Body>
</soap12:Envelope>