PublicAPIService Web Service

PublicAPIService

Click here for a complete list of operations.

getContact

Returns the details for the specified Contact.

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

<?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>
    <getContact xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <ContactNumber>
        <ID>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </ID>
        <Code>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Code>
      </ContactNumber>
    </getContact>
  </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>
    <getContactResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <getContactResult>
        <ContactNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </ContactNumber>
        <FirstName>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </FirstName>
        <LastName>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </LastName>
        <MiddleName>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </MiddleName>
        <PrefName>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </PrefName>
        <PrefFullName>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </PrefFullName>
        <Address>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Address>
        <City>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </City>
        <State>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </State>
        <Zip>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Zip>
        <Country>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Country>
        <Phone1>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Phone1>
        <Phone2>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Phone2>
        <Fax>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Fax>
        <Email>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Email>
        <Remarks>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Remarks>
        <SalesRep>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </SalesRep>
        <PreferredContactMethod>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </PreferredContactMethod>
        <EmailType>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </EmailType>
        <IncludeMeterInstructions>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </IncludeMeterInstructions>
        <ContactType>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </ContactType>
        <ContactTypeDescription>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ContactTypeDescription>
        <CustomerNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </CustomerNumber>
        <CustomerName>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </CustomerName>
        <Active>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </Active>
      </getContactResult>
    </getContactResponse>
  </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>
    <getContact xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <ContactNumber>
        <ID>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </ID>
        <Code>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Code>
      </ContactNumber>
    </getContact>
  </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>
    <getContactResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <getContactResult>
        <ContactNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </ContactNumber>
        <FirstName>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </FirstName>
        <LastName>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </LastName>
        <MiddleName>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </MiddleName>
        <PrefName>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </PrefName>
        <PrefFullName>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </PrefFullName>
        <Address>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Address>
        <City>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </City>
        <State>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </State>
        <Zip>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Zip>
        <Country>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Country>
        <Phone1>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Phone1>
        <Phone2>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Phone2>
        <Fax>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Fax>
        <Email>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Email>
        <Remarks>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Remarks>
        <SalesRep>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </SalesRep>
        <PreferredContactMethod>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </PreferredContactMethod>
        <EmailType>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </EmailType>
        <IncludeMeterInstructions>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </IncludeMeterInstructions>
        <ContactType>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </ContactType>
        <ContactTypeDescription>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ContactTypeDescription>
        <CustomerNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </CustomerNumber>
        <CustomerName>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </CustomerName>
        <Active>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </Active>
      </getContactResult>
    </getContactResponse>
  </soap12:Body>
</soap12:Envelope>