Media Card - Series

Retrieving Media Card information for a series.

Request

To retrieve the Media Card information for a series, send a GET request to:

https://<host>:<port>/metadata/v1/series/{id}/mediacard

Headers

Cache-Control – Caching rules for clients and web proxies
Content-Encoding - The compression level of the response

Mandatory arguments

id - The identifier of the content the mediacard concerns.

Other arguments

All these arguments are query parameters:

fields - A list of field names to return in the response.
deviceType - The type of the device making the query (e.g. Android) to filter out irrelevant results.
Accept-Language - The language (locale) of the response data.

Response

A successful request returns an HTTP 200 status.

A bad request returns an HTTP 400 status.

An unsuccessful request returns an HTTP 401 status.

The number of seasons presented as part of the series response (for example, the latest two seasons), and the number of episodes presented in each season (for example, the latest episode per season), are set in the backend configuration.

The recommendations portion of the response is driven by a related recommendation based on the content; certain parts of the response are turned on or off through backend configuration.

Example

Click here to see an example.

JS

{

{
  "id": "GLOBAL_10110333",
  "type": "series",
  "Title": "Lucky Dog",
  "Description": "Animal trainers rescue difficult-to-love and untrained dogs that find themselves at the neighborhood animal shelter. The trainers then tackle the involved task of transforming dogs with behavioral issues into model pets, using sound training methods that viewers can use at home to train their own dogs. Each episode showcases the story of the success story of a rehabilitated dog and the family that takes it home.",
  "Categories": [],
  "Ratings": [
    {
      "Title": "TVG",
      "code": "TVG"
    }
  ],
  "series": {
    "id": "GLOBAL_10110333",
    "Title": "Lucky Dog",
    "seasons": [
      {
        "id": "GLOBAL_10110333_9",
        "Title": "Lucky Dog",
        "episodes": [
          {
            "id": "GLOBAL_11331_20220521150000",
            "Title": "Lucky Dog"
          }
        ]
      },
      {
        "id": "GLOBAL_10110333_8",
        "Title": "Lucky Dog",
        "episodes": [
          {
            "id": "GLOBAL_11331_20220528150000",
            "Title": "Lucky Dog"
          }
        ]
      }
    ]
  }
}