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

Get ID Hierarchy for Consumption Data

Updated on February 8, 2016

Description

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

Version

9.0

HTTP Method

GET

Resource URL

/idHierarchy/consumptionData/(consumptionDataId)

Header

Field Name Value Comments
Authorization Basic credentials

Authorization Required

Yes

Parameters

Parameter Name Description
consumptionDataId Id of the consumption data record 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 consumption data record that has an id of 789.

GET  /idHierarchy/consumptionData/789

Example Response

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

<hierarchy>
    <accountId>987</accountId>
    <propertyId>345</propertyId>
    <propertyUseId>246</propertyUseId>
    <meterId>456</meterId>
    <consumptionDataId>789</consumptionDataId>
</hierarchy>
TEST