Web Service Documentation / Categories / Meter Services / Get Meter List

Get Meter List

Updated on August 8, 2016

Description

This web service retrieves a list of all the meters for a specific property or just the meters that you have access to. The property must already be shared with you.

Version

10.0

HTTP Method

GET

Resource URL

/property/(propertyId)/meter/list?myAccessOnly=(myAccessOnly)

Header

Field Name Value Comments
Authorization Basic credentials

Authorization Required

Yes

Parameters

Parameter Name Description
myAccessOnly Optional. Set to true to only return the meters you have access to otherwise return all the meters within the property.
propertyId Id to the property

XML Schemas

Request/Response Schema Name
Request None
Response response.xsd

Example Requests

The following example retrieves the list of all the meters for a property that has an id of 200.

GET  /property/200/meter/list

The following example retrieves the list of meters for a property that has an id of 200. Only meters that you have access to are returned.

GET  /property/200/meter/list?myAccessOnly=true

Example Response

The following example returns a list of meters that belong to the property that has an id of 200. The list contains web service links for you to call to retrieve information for each meter. Each link contains a hint that refers to the meter's name.

<response status="Ok">
    <links>
        <link httpMethod="GET" link="/meter/41"
              linkDescription="This is the GET url for this Meter." hint="Electric Main Meter"/>
        <link httpMethod="GET" link="/meter/23"
              linkDescription="This is the GET url for this Meter." hint="Water Main Meter"/>
    </links>
</response>
TEST