Web Service Documentation / Categories / Property Services / Get Billboard Setting at Property Level for Customer

Get Billboard Setting at Property Level for Customer

Updated on August 25, 2019

Description

This web service returns the set "billboard" metric for a specified account and property combination. The billboard is displayed in the upper-right section of each property. You must be connected with the customer and must have at least READ permission on the property to view the customer's billboard metric setting.

Version

19.0

HTTP Method

GET

Resource URL

/customer/(customerId)/property/(propertyId)/billboardMetricSetting

Header

Field Name Value Comments
Authorization Basic credentials

Authorization Required

Yes

Parameters

Parameter Name Description
customerId Id of the customer
propertyId Id to property

XML Schemas

Request/Response Schema Name
Request None
Response billboardMetricSettings.xsd

Example Request

The following example returns the billboard metric setting for a customer that has an id of 123 and a property that has an id of 654321.

GET  /customer/123/property/654321/billboardMetricSetting

Example Response

The following example returns the billboard metric setting.

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