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

Get ID Hierarchy for Property

Updated on February 22, 2021

Description

This web service returns the accountId that corresponds to a specific property. The accountId returned is the Property Data Administrator (PDA). The property must already be shared with you or you must have pending share access. If the property is a child property, this web service will not provide its parent property.

Version

25.0

HTTP Method

GET

Resource URL

/idHierarchy/property/(propertyId)

Header

Field Name Value Comments
Authorization Basic credentials

Authorization Required

Yes

Parameters

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

GET  /idHierarchy/property/345

Example Response

The following example returns the accountId for a property that has an id of 345.

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