announcement

During the current lapse in appropriations, EPA intends to keep the ENERGY STAR website, tools, and resources available, however they will not be updated regularly. Many services may not be available during this time.

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

Get Property List

Updated on February 17, 2020

Description

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.

Version

25.0

HTTP Method

GET

Resource URL

/account/(accountId)/property/list

Header

Field Name Value Comments
Authorization Basic credentials

Authorization Required

Yes

Parameters

Parameter Name Description
accountId Id to account

XML Schemas

Request/Response Schema Name
Request None
Response response.xsd

Example Request

The following example retrieves a list of properties for the account that has an id of 100.

GET  /account/100/property/list

Example Responses

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>
LIVE