PublicAPIService Web Service

PublicAPIService

Click here for a complete list of operations.

ECIFMACustomerList

ECI Internal call that will return a listing of customer accounts.

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

<?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>
    <ECIFMACustomerList xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <OnlyWithMetersDue>
        <Value>boolean</Value>
        <Valid>boolean</Valid>
      </OnlyWithMetersDue>
      <IncludeNewEquipment>
        <Value>boolean</Value>
        <Valid>boolean</Valid>
      </IncludeNewEquipment>
      <OptionalParameters>
        <NameValuePair>
          <Name>string</Name>
          <Value>string</Value>
        </NameValuePair>
        <NameValuePair>
          <Name>string</Name>
          <Value>string</Value>
        </NameValuePair>
      </OptionalParameters>
    </ECIFMACustomerList>
  </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>
    <ECIFMACustomerListResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <ECIFMACustomerListResult>
        <Customers>
          <TimeStamp>string</TimeStamp>
          <Details>
            <CustomerListDetail xsi:nil="true" />
            <CustomerListDetail xsi:nil="true" />
          </Details>
        </Customers>
        <Status>string</Status>
        <StatusDescription>string</StatusDescription>
        <OptionalParameters>
          <NameValuePair>
            <Name>string</Name>
            <Value>string</Value>
          </NameValuePair>
          <NameValuePair>
            <Name>string</Name>
            <Value>string</Value>
          </NameValuePair>
        </OptionalParameters>
      </ECIFMACustomerListResult>
    </ECIFMACustomerListResponse>
  </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>
    <ECIFMACustomerList xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <OnlyWithMetersDue>
        <Value>boolean</Value>
        <Valid>boolean</Valid>
      </OnlyWithMetersDue>
      <IncludeNewEquipment>
        <Value>boolean</Value>
        <Valid>boolean</Valid>
      </IncludeNewEquipment>
      <OptionalParameters>
        <NameValuePair>
          <Name>string</Name>
          <Value>string</Value>
        </NameValuePair>
        <NameValuePair>
          <Name>string</Name>
          <Value>string</Value>
        </NameValuePair>
      </OptionalParameters>
    </ECIFMACustomerList>
  </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>
    <ECIFMACustomerListResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <ECIFMACustomerListResult>
        <Customers>
          <TimeStamp>string</TimeStamp>
          <Details>
            <CustomerListDetail xsi:nil="true" />
            <CustomerListDetail xsi:nil="true" />
          </Details>
        </Customers>
        <Status>string</Status>
        <StatusDescription>string</StatusDescription>
        <OptionalParameters>
          <NameValuePair>
            <Name>string</Name>
            <Value>string</Value>
          </NameValuePair>
          <NameValuePair>
            <Name>string</Name>
            <Value>string</Value>
          </NameValuePair>
        </OptionalParameters>
      </ECIFMACustomerListResult>
    </ECIFMACustomerListResponse>
  </soap12:Body>
</soap12:Envelope>