PublicAPIService Web Service

PublicAPIService

Click here for a complete list of operations.

ECIFMAInsertMeterReadings

ECI Internal call for submitting meter readings from FMAudit.

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

<?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>
    <ECIFMAInsertMeterReadings xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <AssetMeterReadings>
        <AssetID>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </AssetID>
        <MACAddress>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </MACAddress>
        <IPAddress>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </IPAddress>
        <LastAuditDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </LastAuditDate>
        <Meters>
          <FMAMeterReading>
            <MeterCode xsi:nil="true" />
            <MeterDate xsi:nil="true" />
            <MeterReading xsi:nil="true" />
            <StatusMessage xsi:nil="true" />
          </FMAMeterReading>
          <FMAMeterReading>
            <MeterCode xsi:nil="true" />
            <MeterDate xsi:nil="true" />
            <MeterReading xsi:nil="true" />
            <StatusMessage xsi:nil="true" />
          </FMAMeterReading>
        </Meters>
      </AssetMeterReadings>
    </ECIFMAInsertMeterReadings>
  </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>
    <ECIFMAInsertMeterReadingsResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <ECIFMAInsertMeterReadingsResult>
        <MeterResults>
          <FMAMeterReading>
            <MeterCode xsi:nil="true" />
            <MeterDate xsi:nil="true" />
            <MeterReading xsi:nil="true" />
            <StatusMessage xsi:nil="true" />
          </FMAMeterReading>
          <FMAMeterReading>
            <MeterCode xsi:nil="true" />
            <MeterDate xsi:nil="true" />
            <MeterReading xsi:nil="true" />
            <StatusMessage xsi:nil="true" />
          </FMAMeterReading>
        </MeterResults>
        <Status>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Status>
        <StatusDescription>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </StatusDescription>
      </ECIFMAInsertMeterReadingsResult>
    </ECIFMAInsertMeterReadingsResponse>
  </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>
    <ECIFMAInsertMeterReadings xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <AssetMeterReadings>
        <AssetID>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </AssetID>
        <MACAddress>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </MACAddress>
        <IPAddress>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </IPAddress>
        <LastAuditDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </LastAuditDate>
        <Meters>
          <FMAMeterReading>
            <MeterCode xsi:nil="true" />
            <MeterDate xsi:nil="true" />
            <MeterReading xsi:nil="true" />
            <StatusMessage xsi:nil="true" />
          </FMAMeterReading>
          <FMAMeterReading>
            <MeterCode xsi:nil="true" />
            <MeterDate xsi:nil="true" />
            <MeterReading xsi:nil="true" />
            <StatusMessage xsi:nil="true" />
          </FMAMeterReading>
        </Meters>
      </AssetMeterReadings>
    </ECIFMAInsertMeterReadings>
  </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>
    <ECIFMAInsertMeterReadingsResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <ECIFMAInsertMeterReadingsResult>
        <MeterResults>
          <FMAMeterReading>
            <MeterCode xsi:nil="true" />
            <MeterDate xsi:nil="true" />
            <MeterReading xsi:nil="true" />
            <StatusMessage xsi:nil="true" />
          </FMAMeterReading>
          <FMAMeterReading>
            <MeterCode xsi:nil="true" />
            <MeterDate xsi:nil="true" />
            <MeterReading xsi:nil="true" />
            <StatusMessage xsi:nil="true" />
          </FMAMeterReading>
        </MeterResults>
        <Status>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Status>
        <StatusDescription>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </StatusDescription>
      </ECIFMAInsertMeterReadingsResult>
    </ECIFMAInsertMeterReadingsResponse>
  </soap12:Body>
</soap12:Envelope>