Web Service Documentation / Categories / Meter Services / Get Meter List
Updated on August 8, 2016
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.
23.0
GET
/property/(propertyId)/meter/list?myAccessOnly=(myAccessOnly)
Field Name | Value | Comments |
---|---|---|
Authorization | Basic credentials |
Yes
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 |
Request/Response | Schema Name |
---|---|
Request | None |
Response | response.xsd |
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
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.
<?xml version="1.0" encoding="UTF-8"?>
<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>