Get a single bookmark for a content item

Request

To get a single bookmark for a content for a profile, send a GET request to:

BASH

https://<host>:<port>/useractivityvault/v1/clientdata/account/{account}/user/{userId}/bookmarks/{contentId}

When the user starts playout for a content, the client app should make this request to check if there is a bookmark for the content, and if so, offer to play it from the point where they stopped watching.

Note that a bookmark’s position (as returned by this endpoint) is expressed in seconds, while content duration (returned from MDS or Content Discovery Facade) is expressed in minutes.

Headers

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

Mandatory arguments

account – the account ID (in the path)
userId – the profile ID (in the path)
contentId – the ID of the content for which to return the bookmark (in the path)

Other arguments

pretty – specifies that the output should be pretty-printed (that is, in human-readable format) (query parameter)

Response

A successful request returns an HTTP 200 status.

If there is no bookmark for the specified profile and content, the request returns an HTTP 204 status.

A bad request returns an HTTP 400 status.

An unauthorised request returns an HTTP 401 status.

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

Example

JSON

{
    "account": "1",
    "userId": "Oliver",
    "deviceId": "333",
    "contentId": "trainspottingg",
    "name": "n",
    "contentType": "asset",
    "position": 30,
    "creationDate": "2021-01-22T08:47:41Z",
    "modifiedDate": "2021-01-22T08:47:41Z",
    "metadata": {},
    "tags": [
        "In Progress"
    ]
    "tenantId": "operator01"
}