Get a specific favourite

Request

To retrieve a specific favourite, send a GET request to:

http://<host>:<port>/useractivityvault/v1/clientdata/account/{account}/favouriteslists/{favouriteListId}/content/{contentId}

Headers

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

Mandatory arguments

account – the ID of the account (in the path)
favouriteListId – the ID of the favourite list (in the path)
contentId – the ID of the content for which to retrieve favourites (in the path)

Other arguments

fields – specifies the fields to be included in the response.

Response

A successful request returns an HTTP 200 status.

A bad request returns an HTTP 400 status.

An unauthorised request returns an HTTP 401 status.

If the specified favourite cannot be found, the request returns an HTTP 404 status code.

Example

A successful request with a specified contentId of murder returns a payload that looks like this:

CODE

{
    "favourites": [
        {
            "favouriteListId": "48ebcf50-936e-11e9-b982-1b10c665e116",
            "contentId": "murder",
            "contentType": "asset",
            "name": "Murder",
            "categories": [
                "horror"
            ],
            "creationDate": "2019-06-21T08:07:24Z",
            "modifiedDate": "2019-06-21T08:07:24Z",
            "metadata": {
                "domain": "btv"
            }
        }
    ],
    "totalRecords": 1
}