announcement

There has been a lapse in Environmental Protection Agency appropriations. EPA intends to keep the ENERGY STAR website, tools, and resources available, however they will not be updated regularly. If you submit a question, application, or request to EPA, it may not be processed during this period.

Web Service Documentation / Categories / Property Use Services / Get ID Hierarchy for Property Use

Get ID Hierarchy for Property Use

Updated on February 22, 2021

Description

This web service returns the accountId and propertyId that corresponds to a specific property use. The accountId returned is the Property Data Administrator (PDA). The corresponding property must already be shared with you or you must have pending share access.

Version

25.0

HTTP Method

GET

Resource URL

/idHierarchy/propertyUse/(propertyUseId)

Header

Field Name Value Comments
Authorization Basic credentials

Authorization Required

Yes

Parameters

Parameter Name Description
propertyUseId Id of the property use 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 property use that has an id of 587.

GET  /idHierarchy/propertyUse/587

Example Response

The following example returns the accountId and propertyId for a property use that has an id of 587.

<?xml version="1.0" encoding="UTF-8"?>
<hierarchy>
     <accountId>987</accountId>
     <username>johndoe</username>
     <propertyId>345</propertyId>
     <propertyUseId>587</propertyUseId>
</hierarchy>
TEST