PublicAPIService Web Service

PublicAPIService

Click here for a complete list of operations.

getCustomerList

Returns a Customer list. The returned list contains any new or updated Customers since the previous timestamp.

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

<?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>
    <getCustomerList xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <TimeStamp>string</TimeStamp>
    </getCustomerList>
  </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>
    <getCustomerListResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <getCustomerListResult>
        <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>
      </getCustomerListResult>
    </getCustomerListResponse>
  </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>
    <getCustomerList xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <TimeStamp>string</TimeStamp>
    </getCustomerList>
  </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>
    <getCustomerListResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <getCustomerListResult>
        <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>
      </getCustomerListResult>
    </getCustomerListResponse>
  </soap12:Body>
</soap12:Envelope>