PublicAPIService Web Service

PublicAPIService

Click here for a complete list of operations.

getVendorList

This function retrieves a list of Vendor Numbers. If the Timestamp is given then only the Vendor records that have been added or updated since the timestamp will be returned.

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

<?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>
    <getVendorList 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>
    </getVendorList>
  </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>
    <getVendorListResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <getVendorListResult>
        <TimeStamp>string</TimeStamp>
        <Details>
          <VendorListDetail>
            <Vendor xsi:nil="true" />
            <Name xsi:nil="true" />
            <Active xsi:nil="true" />
          </VendorListDetail>
          <VendorListDetail>
            <Vendor xsi:nil="true" />
            <Name xsi:nil="true" />
            <Active xsi:nil="true" />
          </VendorListDetail>
        </Details>
      </getVendorListResult>
    </getVendorListResponse>
  </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>
    <getVendorList 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>
    </getVendorList>
  </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>
    <getVendorListResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <getVendorListResult>
        <TimeStamp>string</TimeStamp>
        <Details>
          <VendorListDetail>
            <Vendor xsi:nil="true" />
            <Name xsi:nil="true" />
            <Active xsi:nil="true" />
          </VendorListDetail>
          <VendorListDetail>
            <Vendor xsi:nil="true" />
            <Name xsi:nil="true" />
            <Active xsi:nil="true" />
          </VendorListDetail>
        </Details>
      </getVendorListResult>
    </getVendorListResponse>
  </soap12:Body>
</soap12:Envelope>