Web Service Documentation / Categories / Property Services / Get Energy Performance Project List

Get Energy Performance Project List

Updated on December 10, 2013

Description

This web service retrieves a list of all the energy performance projects for a specific property. The property must already be shared to you.

Version

10.0

HTTP Method

GET

Resource URL

/property/(propertyId)/energyPerformanceProject/list

Header

Field Name Value Comments
Authorization Basic credentials

Authorization Required

Yes

Parameters

Parameter Name Description
propertyId Id to property

XML Schemas

Request/Response Schema Name
Request None
Response response.xsd

Example Request

The following example retrieves the list of energy performance projects for a property that has an id of 200.

GET  /property/200/energyPerformanceProject/list

Example Response

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

<response status="Ok">
    <links>
        <link httpMethod="GET" link="/energyPerformanceProject/11"
           linkDescription="This is the GET url for this Energy Performance Project."
           hint="Switch to LEDs" id="11"/>
        <link httpMethod="GET" link="/energyPerformanceProject/43"
           linkDescription="This is the GET url for this Energy Performance Project."
           hint="Upgrade Insulation" id="43"/>
    </links>
</response>
TEST