Web Service Documentation / Categories / Property Services / Edit Billboard Setting at Property Level for Account

Edit Billboard Setting at Property Level for Account

Updated on August 25, 2019

Description

This web service sets a desired "billboard" metric for the authenticated user's account and a specified property. After set, the front-end application will display the chosen metric in the billboard. The billboard is shown in the upper-right section of each property. You must have at least READ access to the property. Individual property level settings will be cleared if account level billboard setting changes are made.

For more information on account level billboard metric settings, see the "PUT /account/(accountId)" and "PUT /customer/(customerId)" documentation sections.

Version

22.0

HTTP Method

PUT

Resource URL

/property/(propertyId)/billboardMetricSetting

Header

Field Name Value Comments
Authorization Basic credentials
Content-Type application/xml

Authorization Required

Yes

Parameters

Parameter Name Description
propertyId Id to property

XML Schemas

Request/Response Schema Name
Request billboardMetricSettings.xsd
Response response.xsd

Example Request

The following example sets the billboard metric setting for your account and a property that has an id of 654321.

PUT  /property/654321/billboardMetricSetting

<?xml version="1.0" encoding="UTF-8"?>
<billboardMetricSetting>
     <billboardMetric>score</billboardMetric>
</billboardMetricSetting>

Example Response

The following example indicates that the energy performance project was successfully updated.

<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok">
     <links>
          <link httpMethod="GET" link="/property/654321/billboardMetricSetting" linkDescription="This is the GET url for the property level billboard setting."/>
     </links>
</response>
LIVE