Web Service Documentation / Categories / Building Services / Get Building List

Get Building List

Updated on December 10, 2013

Description

This web service returns a list of buildings for a specific property that is shared with you.

Version

10.0

HTTP Method

GET

Resource URL

/property/(propertyId)/building/list

Header

Field Name Value Comments
Authorization Basic credentials

Authorization Required

Yes

Parameters

Parameter Name Description
propertyId Id to the property

XML Schemas

Request/Response Schema Name
Request None
Response response.xsd

Example Request

The following example retrieves a list of buildings for a property that has an id of 200.

GET  /property/200/building/list

Example Response

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response status="Ok">
    <links>
        <link httpMethod="GET" link="/building/86"
              linkDescription="This is the GET url for this Building." hint="ACME Convenience Store"/>
        <link httpMethod="GET" link="/building/34"
              linkDescription="This is the GET url for this Building." hint="ACME Grocery"/>
    </links>
</response>
TEST