Web Service Documentation / Categories / Meter Services / Get What Changed Consumption Data Meter List

Get What Changed Consumption Data Meter List

Updated on February 12, 2018

Description

This web service returns a list of meters that have had their consumption data changed since a user specified date. The list of meters returned are account specific. The returned list only shows meters that you have permission to view. Results are returned in increments of 1,000 per set. Consumption data edits that trigger a meter to be included in the returned list may have been performed by any user with write access to the meter. The list returns links to each meter's consumption data.

Version

19.0

HTTP Method

GET

Resource URL

/customer/(customerId)/meter/consumptionData/whatChanged?date=(YYYY-MM-DD)

Header

Field Name Value Comments
Authorization Basic credentials

Authorization Required

Yes

Parameters

Parameter Name Description
customerId Id to the customer
date Indicates the starting date of the desired range of time. Must be a valid date formatted as YYYY-MM-DD. The ending date of the desired range of time is set to the current date. The ending date cannot be changed.
nextPageKey Optional. Used as a reference key to determine what results to include in the next page. This is not a page number. This is typically omitted on the initial call and is provided if the results are paginated.
previousPageKey Optional. Used as a reference key to determine what results to include in the previous page. This is not a page number. This is typically omitted on the initial call and is provided if the results are paginated.

XML Schemas

Request/Response Schema Name
Request None
Response response.xsd

Example Request

The following example retrieves the first page of a list of meters that had their consumption data changed since July 31, 2010. These properties are for the customer that has an id of 100.

GET  /customer/100/meter/consumptionData/whatChanged?nextPageKey=3000&date=2010-07-31

Example Responses

The following example returns the second set of meters in customerId 100 that have had their consumption data changed since July 31, 2010. The list contains web service links for you to call and retrieve information for each property.

<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok">
    <links>
        <link httpMethod="GET" link="/meter/861/consumptionData" linkDescription="This is the GET url for this meter's consumption data." hint="Electric Meter"/>
        <link httpMethod="GET" link="/meter/341/consumptionData" linkDescription="This is the GET url for this meter's consumption data." hint="NG Meter"/>

        ...

        <link httpMethod="GET" link="customer/100/meter/consumptionData/whatChanged?nextPageKey=4000&date=2010-07-31" linkDescription="next page"/>
        <link httpMethod="GET" link="customer/100/meter/consumptionData/whatChanged?previousPageKey=3000&date=2010-07-31" linkDescription="previous page"/>
    </links>
</response>

A list with no meters is returned. No meters have had their consumption data changed.

<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok">
    <links/>
</response>
LIVE