Retrieving related product information

If channels or programmes have any related products, the identifiers for those products will be returned in the productRefs field. For channels, if the productRefs list is empty, then the channel is free-to-air (FTA). If a programme productRefs list is empty, it means that the programme is included with the access to its channel, be that FTA or not. If the channel or programme does have associated products, it should be assumed that one of the products must be purchased/subscribed for access to that channel. A request to the MDS BTV products API should be made to display the product information.

Request

To retrieve product information for a channel or event, send a GET request to:

https://<host>:<port>/metadata/delivery/[provider]/btv/products

Headers

Authorization: Bearer – bearer token
Content-Type: application/json

Mandatory arguments

provider - Narrows down queries to a single service provider to allow for API clarity and security.

Other arguments

All these arguments are query parameters:

filter - A list of key/value pairs, where key is the fieldname and value is the value the field should be.
sort - A list of pairs, where a pair is a list containing a field name and a sort order with 1 ascending, and -1 is descending.
fields - A list of fields names to return in the response.
offset - The number of records to skip for pagination.
limit - The number of records to return for pagination.
cache - Sets or unsets HTTP headers; TRUE allows CDN caching, FALSE prevents CDN caching.
pretty - TRUE returns human-readable formatted JSON, FALSE returns compact and efficient JSON.

Response

A successful request returns an HTTP 200 status.

A bad request returns an HTTP 400 status.

An unsuccessful request returns an HTTP 401 status.

Example

The productRefs is passed from the service or programme as the id in the products API.

XML

https://server:port/metadata/delivery/[provider]/btv/products?filter={"id":"LYS000494276"}&fields=["price.currency","price.endPurchase","price.startPurchase","price.value","type"]