Retrieve event recordings and requests | NAGRAVISION Documentation Portal

Request

To retrieve recordings and/or requests for the user, send a GET request to:

https://<host>:<port>/cdvr/v1/recordings

This returns all the recordings/requests for the user, whether they are individual event recordings or ones that form part of a series recording request.

This API supports:

Filtering by status. This means that you can get a list of all recordings, or a list of all scheduled requests (that have not yet been recorded), and so on.
Filtering by recording IDs. This allows you to supply a list of recording IDs and get the details for just these recordings.
Limit on the number of records returned and specify paging.
Sorting results chronologically by broadcast date or by expiration date (ascending or descending in both cases).
Sorting results by the length of the duration of the recording (ascending or descending in both cases).
Sorting results on programme name in alphabetical order / reverse alphabetical order.
Optionally limiting the results to those specifically requested

Headers

Content-Type: application/json
Authorisation

Mandatory arguments

None

Optional arguments (in URL)

limit – the number of records to return
page – the page number to return (cannot be used without limit)
For example:?limit=10 returns the first 10 recordings.?limit=10&page=2 returns the second 10 recordings.
sort – the sort order of the returned recordings. It can be one of:CHRONOLOGICAL_ASCCHRONOLOGICAL_DESCEXPIRATION_ASCEXPIRATION_DESCDURATION_ASCDURATION_DESCMETADATA_ASCMETADATA_DESC
statuses – filters based on recording status. Available values are:SCHEDULEDRECORDINGRECORDEDFAILEDTo specify multiple values (e.g., if you want to get both scheduled and recorded requests), use the statuses parameter as many times as required.
For example:?statuses=SCHEDULED&statuses=RECORDED
recordingIDs – an optional array of RecodingIDs to limit the results to those with the supplied ID's.
Note that only recordings belonging to the account defined in the token will be returned.

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.

Example

A successful request returns a payload that looks like this:

[
  {
    "id": "7c589755-dbdf-434f-a6a8-666fdac06d28",
    "contentType": "movie",
    "duration": 1800,
    "end": "2018-10-19T01:30:00.000Z",
    "metadata": {
      "en_GB": {
        "title": "Die Hard",
        "description": "John McLane blah blah blah",
        "synopsis": "John McLane blah blah blah"
      }
    },
    "status": "RECORDED",
    "images": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
    "eventId": "eastenders_10297",
    "isReschedule": true,
    "isProtected": true,
    "channelId": "bbc1",
    "start": "2018-10-19T01:00:00.000Z",
    "contentId": "eastenders_10297c",
    "seriesId": "Friends",
    "seasonId": "Friends Season 1",
    "availability": {
      "start": "2018-10-19T01:01:01.001Z",
      "end": "2999-10-19T01:01:01.001Z"
    },
    "ratingPrecedence": {
      "predecessor": "12",
      "successor": "15"
    },
    "playback": {
      "iPad": {
        "drmId": "d1",
        "uri": "/xyz/a.ts"
      },
      "Android": {
        "drmId": "d2",
        "uri": "/xyz/b.ts"
      }
    },
    "tmsId": "EP021174500086"
    "contentType": "movie"
  }
 ]