Web Service Documentation / Categories / Property Services / Get Property List
Updated on February 17, 2020
This web service returns a list of properties for a specific customer that are shared with you. The properties returned may have been shared from other contacts to the specified accountId. The properties may also be owned by the specified accountId.
23.0
GET
/account/(accountId)/property/list
Field Name | Value | Comments |
---|---|---|
Authorization | Basic credentials |
Yes
Parameter Name | Description |
---|---|
accountId | Id to account |
Request/Response | Schema Name |
---|---|
Request | None |
Response | response.xsd |
The following example retrieves a list of properties for the account that has an id of 100.
GET /account/100/property/list
The following example returns a list of properties that are shared with you that belong to the account that has an id of 100. The list contains web service links for you to call to retrieve information for each property. Each link contains a hint that refers to the property's name.
<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok">
<links>
<link id="86" httpMethod="GET" link="/building/86" linkDescription="This is the GET url for this Building." hint="ACME Convenience Store"/>
<link id="34" httpMethod="GET" link="/building/34" linkDescription="This is the GET url for this Building." hint="ACME Grocery"/>
</links>
</response>
A list with no properties is returned. There are no properties that are shared with you.
<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok">
<links/>
</response>