Web Service Documentation / Categories / Property Services / Get Billboard Setting at Property Level for Account
Updated on August 25, 2019
This web service returns 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 for the authenticated user. The billboard is shown in the upper-right section of each property. You must have at least READ access to the property to view the billboard setting.
23.0
GET
/property/(propertyId)/billboardMetricSetting
Field Name | Value | Comments |
---|---|---|
Authorization | Basic credentials |
Yes
Parameter Name | Description |
---|---|
propertyId | Id to property |
Request/Response | Schema Name |
---|---|
Request | None |
Response | billboardMetrics.xsd |
The following example returns the billboard metric setting for a property that has an id of 654321. This setting is specific to the authenticated user's view of the billboard.
GET /property/654321/billboardMetricSetting
The following example returns the billboard metric setting.
<?xml version="1.0" encoding="UTF-8"?>
<billboardMetricSetting>
<billboardMetric>score</billboardMetric>
</billboardMetricSetting>