PublicAPIService


Click here for a complete list of operations.

getContactDataList

Returns a Contact Data list. The returned list contains all Contact data, based on the list of contact IDs, 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 /PublicAPIService.asmx HTTP/1.1
Host: langcompany.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://digitalgateway.com/WebServices/PublicAPIService/getContactDataList"

<?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>
    <getContactDataList xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <Contacts>
        <TimeStamp>string</TimeStamp>
        <Details>
          <ContactListDetail>
            <ContactNumber xsi:nil="true" />
            <LastName xsi:nil="true" />
            <FirstName xsi:nil="true" />
            <Active xsi:nil="true" />
          </ContactListDetail>
          <ContactListDetail>
            <ContactNumber xsi:nil="true" />
            <LastName xsi:nil="true" />
            <FirstName xsi:nil="true" />
            <Active xsi:nil="true" />
          </ContactListDetail>
        </Details>
      </Contacts>
      <TimeStamp>string</TimeStamp>
    </getContactDataList>
  </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>
    <getContactDataListResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <getContactDataListResult>
        <TimeStamp>string</TimeStamp>
        <Details>
          <ContactData>
            <ContactNumber xsi:nil="true" />
            <FirstName xsi:nil="true" />
            <LastName xsi:nil="true" />
            <MiddleName xsi:nil="true" />
            <PrefName xsi:nil="true" />
            <PrefFullName xsi:nil="true" />
            <Address xsi:nil="true" />
            <City xsi:nil="true" />
            <State xsi:nil="true" />
            <Zip xsi:nil="true" />
            <Country xsi:nil="true" />
            <Phone1 xsi:nil="true" />
            <Phone2 xsi:nil="true" />
            <Fax xsi:nil="true" />
            <Email xsi:nil="true" />
            <Remarks xsi:nil="true" />
            <SalesRep xsi:nil="true" />
            <PreferredContactMethod xsi:nil="true" />
            <EmailType xsi:nil="true" />
            <IncludeMeterInstructions xsi:nil="true" />
            <ContactType xsi:nil="true" />
            <ContactTypeDescription xsi:nil="true" />
            <CustomerNumber xsi:nil="true" />
            <CustomerName xsi:nil="true" />
            <Active xsi:nil="true" />
          </ContactData>
          <ContactData>
            <ContactNumber xsi:nil="true" />
            <FirstName xsi:nil="true" />
            <LastName xsi:nil="true" />
            <MiddleName xsi:nil="true" />
            <PrefName xsi:nil="true" />
            <PrefFullName xsi:nil="true" />
            <Address xsi:nil="true" />
            <City xsi:nil="true" />
            <State xsi:nil="true" />
            <Zip xsi:nil="true" />
            <Country xsi:nil="true" />
            <Phone1 xsi:nil="true" />
            <Phone2 xsi:nil="true" />
            <Fax xsi:nil="true" />
            <Email xsi:nil="true" />
            <Remarks xsi:nil="true" />
            <SalesRep xsi:nil="true" />
            <PreferredContactMethod xsi:nil="true" />
            <EmailType xsi:nil="true" />
            <IncludeMeterInstructions xsi:nil="true" />
            <ContactType xsi:nil="true" />
            <ContactTypeDescription xsi:nil="true" />
            <CustomerNumber xsi:nil="true" />
            <CustomerName xsi:nil="true" />
            <Active xsi:nil="true" />
          </ContactData>
        </Details>
      </getContactDataListResult>
    </getContactDataListResponse>
  </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 /PublicAPIService.asmx HTTP/1.1
Host: langcompany.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>
    <getContactDataList xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <Contacts>
        <TimeStamp>string</TimeStamp>
        <Details>
          <ContactListDetail>
            <ContactNumber xsi:nil="true" />
            <LastName xsi:nil="true" />
            <FirstName xsi:nil="true" />
            <Active xsi:nil="true" />
          </ContactListDetail>
          <ContactListDetail>
            <ContactNumber xsi:nil="true" />
            <LastName xsi:nil="true" />
            <FirstName xsi:nil="true" />
            <Active xsi:nil="true" />
          </ContactListDetail>
        </Details>
      </Contacts>
      <TimeStamp>string</TimeStamp>
    </getContactDataList>
  </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>
    <getContactDataListResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <getContactDataListResult>
        <TimeStamp>string</TimeStamp>
        <Details>
          <ContactData>
            <ContactNumber xsi:nil="true" />
            <FirstName xsi:nil="true" />
            <LastName xsi:nil="true" />
            <MiddleName xsi:nil="true" />
            <PrefName xsi:nil="true" />
            <PrefFullName xsi:nil="true" />
            <Address xsi:nil="true" />
            <City xsi:nil="true" />
            <State xsi:nil="true" />
            <Zip xsi:nil="true" />
            <Country xsi:nil="true" />
            <Phone1 xsi:nil="true" />
            <Phone2 xsi:nil="true" />
            <Fax xsi:nil="true" />
            <Email xsi:nil="true" />
            <Remarks xsi:nil="true" />
            <SalesRep xsi:nil="true" />
            <PreferredContactMethod xsi:nil="true" />
            <EmailType xsi:nil="true" />
            <IncludeMeterInstructions xsi:nil="true" />
            <ContactType xsi:nil="true" />
            <ContactTypeDescription xsi:nil="true" />
            <CustomerNumber xsi:nil="true" />
            <CustomerName xsi:nil="true" />
            <Active xsi:nil="true" />
          </ContactData>
          <ContactData>
            <ContactNumber xsi:nil="true" />
            <FirstName xsi:nil="true" />
            <LastName xsi:nil="true" />
            <MiddleName xsi:nil="true" />
            <PrefName xsi:nil="true" />
            <PrefFullName xsi:nil="true" />
            <Address xsi:nil="true" />
            <City xsi:nil="true" />
            <State xsi:nil="true" />
            <Zip xsi:nil="true" />
            <Country xsi:nil="true" />
            <Phone1 xsi:nil="true" />
            <Phone2 xsi:nil="true" />
            <Fax xsi:nil="true" />
            <Email xsi:nil="true" />
            <Remarks xsi:nil="true" />
            <SalesRep xsi:nil="true" />
            <PreferredContactMethod xsi:nil="true" />
            <EmailType xsi:nil="true" />
            <IncludeMeterInstructions xsi:nil="true" />
            <ContactType xsi:nil="true" />
            <ContactTypeDescription xsi:nil="true" />
            <CustomerNumber xsi:nil="true" />
            <CustomerName xsi:nil="true" />
            <Active xsi:nil="true" />
          </ContactData>
        </Details>
      </getContactDataListResult>
    </getContactDataListResponse>
  </soap12:Body>
</soap12:Envelope>