Drop-downs

All drop-down list values which are available in the API are mapped to the API reference attribute in the drop-down list in WHATS'ON:

Every time a value is added to the drop-down list by an administrator, the API reference is automatically populated with the same value assigned to the description. However, the administrator can edit the API reference value to match the value of an external system.

In order to know which values are allowed for a specific drop-down list, each API has its own list of drop-downs which can be retrieved.

Request

For example, to know the possible values for the channelGroup drop-down list in the Rights API, use following call :

GET http://server/rights/v1/channelGroups

Response

The response returns the list of allowed values. The id in the response corresponds to the API Reference in WHATS'ON and is the value that needs to be passed when creating or updating data via the API.

[
    {
        "id": "All",
        "name": "All"
    },
    {
        "id": "BBC 1",
        "name": "BBC 1"
    },
    {
        "id": "BBC 2",
        "name": "BBC 2"
    }
]