Retrieve seasons for a series

Request

To retrieve the seasons of a specified series for which the user has recordings, send a GET request to:

CODE

https://<host>:<port>/cdvr/v2/recordings/browse/series/{seriesId}

This returns:

The total number of seasons in the series for which the user has recordings
The total number of episodes in the series for which the user has recordings
A list of seasons for which the user has recordings, including the season ID, season number, and number of recorded episodes for each, in season number order

You can use the season ID that is returned for a season to get the recordings for that season.

Headers

Content-Type: application/json
Authorisation

Mandatory arguments

seriesId – the ID of the series (in the URL)

Optional arguments (in URL)

Although this endpoint supports pagination, you are recommended not to use it, as paginated responses make it difficult for the client to determine the number of recorded episodes that are directly linked to the series as opposed to ones under the seasons.

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 seasons.
- ?limit=10&page=2 returns the second 10 seasons.
deviceType – the device type to filter by

Response

A successful request returns an HTTP 200 status (even if there are no recordings or seasons for the series).

If the requested series does not exist, the request returns an HTTP 404 status.

Example

A successful request returns a payload that looks like this:

JSON

{
    "totalSeasons": 5,
    "totalEpisodes": 48,
    "seasons": [
    {
        "seasonId": "series_cgprid01_season01",
        "seasonNumber": 1,
        "totalEpisodes": 10
    },
    {
        "seasonId": "series_cgprid01_season02",
        "seasonNumber": 2,
        "totalEpisodes": 10
    },
    {
        "seasonId": "series_cgprid01_season03"
        "totalEpisodes": 10
    },
    {
        "seasonId": "series_cgprid01_season04",
        "seasonNumber": 4,
        "totalEpisodes": 10
    },
    {
        "seasonId": "series_cgprid01_season05",
        "seasonNumber": 5,
        "totalEpisodes": 8
    }
    ]
}