PublicAPIService Web Service

PublicAPIService

Click here for a complete list of operations.

addEquipmentMeterReadings

This function add/update the meter readings for the specified meter reading group.

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

<?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>
    <addEquipmentMeterReadings xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <ReadingGroup>
        <EquipmentNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </EquipmentNumber>
        <optMake>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </optMake>
        <optModel>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </optModel>
        <optSerialNumber>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </optSerialNumber>
        <optMacID>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </optMacID>
        <MeterSource>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </MeterSource>
        <ReadingDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </ReadingDate>
        <Readings>
          <MeterReading>
            <MeterID xsi:nil="true" />
            <optMeterType xsi:nil="true" />
            <Reading xsi:nil="true" />
            <OverridePreviousMeter xsi:nil="true" />
          </MeterReading>
          <MeterReading>
            <MeterID xsi:nil="true" />
            <optMeterType xsi:nil="true" />
            <Reading xsi:nil="true" />
            <OverridePreviousMeter xsi:nil="true" />
          </MeterReading>
        </Readings>
      </ReadingGroup>
    </addEquipmentMeterReadings>
  </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>
    <addEquipmentMeterReadingsResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <addEquipmentMeterReadingsResult>
        <ApiResult>boolean</ApiResult>
        <Details>
          <ResultDetail>
            <ResultType>int</ResultType>
            <ResultCode>int</ResultCode>
            <ResultString>string</ResultString>
          </ResultDetail>
          <ResultDetail>
            <ResultType>int</ResultType>
            <ResultCode>int</ResultCode>
            <ResultString>string</ResultString>
          </ResultDetail>
        </Details>
      </addEquipmentMeterReadingsResult>
    </addEquipmentMeterReadingsResponse>
  </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>
    <addEquipmentMeterReadings xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <ReadingGroup>
        <EquipmentNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </EquipmentNumber>
        <optMake>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </optMake>
        <optModel>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </optModel>
        <optSerialNumber>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </optSerialNumber>
        <optMacID>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </optMacID>
        <MeterSource>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </MeterSource>
        <ReadingDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </ReadingDate>
        <Readings>
          <MeterReading>
            <MeterID xsi:nil="true" />
            <optMeterType xsi:nil="true" />
            <Reading xsi:nil="true" />
            <OverridePreviousMeter xsi:nil="true" />
          </MeterReading>
          <MeterReading>
            <MeterID xsi:nil="true" />
            <optMeterType xsi:nil="true" />
            <Reading xsi:nil="true" />
            <OverridePreviousMeter xsi:nil="true" />
          </MeterReading>
        </Readings>
      </ReadingGroup>
    </addEquipmentMeterReadings>
  </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>
    <addEquipmentMeterReadingsResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <addEquipmentMeterReadingsResult>
        <ApiResult>boolean</ApiResult>
        <Details>
          <ResultDetail>
            <ResultType>int</ResultType>
            <ResultCode>int</ResultCode>
            <ResultString>string</ResultString>
          </ResultDetail>
          <ResultDetail>
            <ResultType>int</ResultType>
            <ResultCode>int</ResultCode>
            <ResultString>string</ResultString>
          </ResultDetail>
        </Details>
      </addEquipmentMeterReadingsResult>
    </addEquipmentMeterReadingsResponse>
  </soap12:Body>
</soap12:Envelope>