Retrieve series recordings and requests

Request

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

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

This API supports:

Limiting the number of records returned
Paging

Headers

Content-Type: application/json
Authorisation

Mandatory arguments

None

Other 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.

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:

CODE

[
  {
    "recordings": [
      {
        "duration": 1800,
        "id": "7c589755-dbdf-434f-a6a8-666fdac06d28",
        "metadata": {
          "en_GB": {
            "title": "Die Hard",
            "description": "John McLane blah blah blah",
            "synopsis": "John McLane blah blah blah"
          }
        },
        "status": "RECORDED",
        "end": "2018-10-19T01:30:00.000Z",
        "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",
        "productRefs": "productsRefs : [\"productRefOne\"]",
        "Categories": "Categories : [\"News\"]",
        "tvChannel": "Channel Number : 500 ",
        "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"
      }
    ],
    "id": "string",
    "metadata": {
      "additionalProp1": {},
      "additionalProp2": {},
      "additionalProp3": {}
    },
    "images": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
    "seriesType": "SEASON",
    "recordingOptions": [
      "ALL_EPISODES"
    ],
    "channelId": "string",
    "seriesId": "string",
    "isMaybeMissingEpisodes": true,
    "missedEpisodes": [
      {
        "reason": "LACK_OF_QUOTA",
        "episodeNumber": 1,
        "seasonNumber": 2,
        "contentRef": "content_xyz",
        "seriesRef": "ser_xyz",
        "seasonRef": "ep_abc"
      }
    ]
  }
]

Note that the response includes a list of missed episodes (if there are any) – that is, episodes that could not be recorded, for example, due to lack of quota.