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

Get ID Hierarchy for Use Detail

Updated on February 8, 2016

Description

This web service returns the accountId, propertyId, and propertyUseId that corresponds to a specific use detail record. 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

9.0

HTTP Method

GET

Resource URL

/idHierarchy/useDetails/(useDetailId)

Header

Field Name Value Comments
Authorization Basic credentials

Authorization Required

Yes

Parameters

Parameter Name Description
useDetailId Id of the use detail 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 use detail that has an id of 411.

GET  /idHierarchy/useDetails/411

Example Response

The following example returns the accountId, propertyId, and propertyUseId for a use record that has an id of 411.

<hierarchy>
    <accountId>987</accountId>
    <propertyId>345</propertyId>
    <propertyUseId>587</propertyUseId>
    <useDetailId>411</useDetailId>
</hierarchy>
LIVE