Web Service Documentation / Categories / Meter Services / Get ID Hierarchy for Meter

Get ID Hierarchy for Meter

Updated on February 8, 2016

Description

This web service returns the accountId and propertyId that corresponds to a specific meter. The accountId returned is the Property Data Administrator (PDA). If the specified meter refers to an IT meter or a plant flow meter, then the corresponding propertyUseId that is associated to the specified meter is also returned, otherwise it is omitted. The meter must already be shared with you or you must have pending share access.

Version

9.0

HTTP Method

GET

Resource URL

/idHierarchy/meter/(meterId)

Header

Field Name Value Comments
Authorization Basic credentials

Authorization Required

Yes

Parameters

Parameter Name Description
meterId Id of the meter to retrieve the hierarchy

XML Schemas

Request/Response Schema Name
Request None
Response hierarchy.xsd

Example Request

The following example retrieves the hierarchy for a meter that has an id of 456.

GET  /idHierarchy/meter/456

Example Response

The following example returns the accountId and propertyId for a meter that has an id of 456. Also for this example, the specified meter is an IT meter so the corresponding propertyUseId (Data Center) that the meter is associated to is also returned, otherwise it is omitted.

<hierarchy>
    <accountId>987</accountId>
    <propertyId>345</propertyId>
    <propertyUseId>246</propertyUseId>
    <meterId>456</meterId>
</hierarchy>
LIVE