PublicAPIService Web Service

PublicAPIService

Click here for a complete list of operations.

getMeterDueList

Returns the meter due summary for the specified customer.

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: rt.gfidigital.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://digitalgateway.com/WebServices/PublicAPIService/getMeterDueList"

<?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>
    <getMeterDueList xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <CustomerNumber>
        <ID>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </ID>
        <Code>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Code>
      </CustomerNumber>
      <dtBillingCutoffDate>
        <Value>dateTime</Value>
        <ValueAsString>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ValueAsString>
        <Valid>boolean</Valid>
      </dtBillingCutoffDate>
    </getMeterDueList>
  </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>
    <getMeterDueListResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <getMeterDueListResult>
        <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>
        <Details>
          <MeterDueEquipmentDetail>
            <EquipmentNumber xsi:nil="true" />
            <Address xsi:nil="true" />
            <City xsi:nil="true" />
            <State xsi:nil="true" />
            <Zip xsi:nil="true" />
            <Contact xsi:nil="true" />
            <ContactPhone xsi:nil="true" />
            <Item xsi:nil="true" />
            <ItemDescription xsi:nil="true" />
            <Make xsi:nil="true" />
            <Model xsi:nil="true" />
            <SerialNumber xsi:nil="true" />
            <Details xsi:nil="true" />
          </MeterDueEquipmentDetail>
          <MeterDueEquipmentDetail>
            <EquipmentNumber xsi:nil="true" />
            <Address xsi:nil="true" />
            <City xsi:nil="true" />
            <State xsi:nil="true" />
            <Zip xsi:nil="true" />
            <Contact xsi:nil="true" />
            <ContactPhone xsi:nil="true" />
            <Item xsi:nil="true" />
            <ItemDescription xsi:nil="true" />
            <Make xsi:nil="true" />
            <Model xsi:nil="true" />
            <SerialNumber xsi:nil="true" />
            <Details xsi:nil="true" />
          </MeterDueEquipmentDetail>
        </Details>
      </getMeterDueListResult>
    </getMeterDueListResponse>
  </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: rt.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>
    <getMeterDueList xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <CustomerNumber>
        <ID>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </ID>
        <Code>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Code>
      </CustomerNumber>
      <dtBillingCutoffDate>
        <Value>dateTime</Value>
        <ValueAsString>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ValueAsString>
        <Valid>boolean</Valid>
      </dtBillingCutoffDate>
    </getMeterDueList>
  </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>
    <getMeterDueListResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <getMeterDueListResult>
        <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>
        <Details>
          <MeterDueEquipmentDetail>
            <EquipmentNumber xsi:nil="true" />
            <Address xsi:nil="true" />
            <City xsi:nil="true" />
            <State xsi:nil="true" />
            <Zip xsi:nil="true" />
            <Contact xsi:nil="true" />
            <ContactPhone xsi:nil="true" />
            <Item xsi:nil="true" />
            <ItemDescription xsi:nil="true" />
            <Make xsi:nil="true" />
            <Model xsi:nil="true" />
            <SerialNumber xsi:nil="true" />
            <Details xsi:nil="true" />
          </MeterDueEquipmentDetail>
          <MeterDueEquipmentDetail>
            <EquipmentNumber xsi:nil="true" />
            <Address xsi:nil="true" />
            <City xsi:nil="true" />
            <State xsi:nil="true" />
            <Zip xsi:nil="true" />
            <Contact xsi:nil="true" />
            <ContactPhone xsi:nil="true" />
            <Item xsi:nil="true" />
            <ItemDescription xsi:nil="true" />
            <Make xsi:nil="true" />
            <Model xsi:nil="true" />
            <SerialNumber xsi:nil="true" />
            <Details xsi:nil="true" />
          </MeterDueEquipmentDetail>
        </Details>
      </getMeterDueListResult>
    </getMeterDueListResponse>
  </soap12:Body>
</soap12:Envelope>