Web Service Documentation / Categories / Property Use Services / Get Property Use List

Get Property Use List

Updated on July 17, 2013

Description

This web service returns the list of property uses for a specific property. The property must already be shared with you.

Version

23.0

HTTP Method

GET

Resource URL

/property/(propertyId)/propertyUse/list

Header

Field Name Value Comments
Authorization Basic credentials

Authorization Required

Yes

Parameters

Parameter Name Description
propertyId Id of the property

XML Schemas

Request/Response Schema Name
Request None
Response response.xsd

Example Request

The following example retrieves the property uses for the property that has an id of 396.

GET  /property/396/propertyUse/list

Example Response

The following example returns a list of property uses for the property that has an id of 396. The list contains web service links for you to call to retrieve information for each property use. Each link contains a hint that refers to the property use's name.

<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok">
    <links>
        <link httpMethod="GET" link="/propertyUse/2" linkDescription="This is the GET url for this Property Use." hint="Broadway School"/>
        <link httpMethod="GET" link="/propertyUse/3" linkDescription="This is the GET url for this Property Use." hint="Broadway School Office"/>
    </links>
</response>
LIVE