Media Card - Live Programme

Retrieving Media Card information for a live programme.

Request

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

https://<host>:<port>/metadata/v1/epg/{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 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_11331_20220514150000",
  "type": "btv",
  "Title": "Lucky Dog",
  "Description": "A 2-year-old rescue dog could be the perfect match for a couple with young children.",
  "broadcast": {
    "start": 1652540400,
    "end": 1652542200,
    "duration": 1800
  },
  "Actors": [
    "Eric Wiese",
    "Rashi Khanna Wiese"
  ],
  "Categories": [
    "Reality",
    "Animals",
    "Pets"
  ],
  "Ratings": [
    {
      "Title": "TVG",
      "code": "TVG"
    }
  ],
  "eventId": "GLOBAL_11331_20220514150000",
  "contentId": "GLOBAL_EP017729500226",
  "isStartOver": false,
  "isCatchUp": false,
  "isLTCU": false,
  "isSTCU": false,
  "guardTimeStart": 0,
  "guardTimeEnd": 0,
  "channel": {
    "id": "GLOBAL_11331",
    "logo": "CBS",
    "number": 17
  },
  "products": [
    {
      "_id": "1578493849402_1578493849402",
      "id": "1578493849402_1578493849402",
      "startPurchase": 1577836800,
      "endPurchase": 1767225599,
      "price": {
        "startPurchase": 1577836800,
        "endPurchase": 1767225599,
        "currency": "GBP",
        "value": 50
      },
      "billingModel": {
        "period": 2592000
      },
      "startValidity": 1577836800,
      "endValidity": 1767225599,
      "type": "subscription",
      "title": "Silver Pack",
      "isFreemium": false,
      "technicalTypes": [
        "SD",
        "HD",
        "DASH",
        "HLS"
      ],
      "contractType": "1",
      "Description": "English Content"
    },
    {
      "_id": "Subscrption_Solution",
      "id": "Subscrption_Solution",
      "startPurchase": 1534876200,
      "endPurchase": 1767225540,
      "price": {
        "startPurchase": 1534876200,
        "endPurchase": 1767225540,
        "currency": "GBP",
        "value": 100
      },
      "billingModel": {
        "period": 2592000
      },
      "startValidity": 1534789800,
      "endValidity": 1767225540,
      "type": "subscription",
      "title": "Gold Pack",
      "isFreemium": false,
      "freemium": {
        "start": 1534962600,
        "end": 1588098599,
        "validityPeriod": 53049600
      },
      "regions": [
        "N/A"
      ],
      "technicalTypes": [
        "SD",
        "HD",
        "DASH",
        "HLS"
      ],
      "AllowDownload2Go": false,
      "LicenseDuration": "P100Y0M0DT0H0M0S",
      "contractType": "1",
      "freemiumType": "1",
      "Description": "Gold Pack Contains All The Channels"
    }
  ],
  "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"
          }
        ]
      }
    ]
  },
  "recommendations": [
    {
      "contentType": "BTV",
      "deeplinkType": null,
      "vodTechnicalId": null,
      "btvProgrammeId": "GLOBAL_11331_20220514150000",
      "deeplinkId": null,
      "editorialId": "9015479-F-P-PDL_3",
      "seriesId": "my_series",
      "seasonId": null
    },
    {
      "contentType": "DEEPLINK",
      "deeplinkType": "VOD",
      "vodTechnicalId": null,
      "btvProgrammeId": null,
      "deeplinkId": "deeplink_example",
      "editorialId": "contentRef",
      "seriesId": "134136",
      "seasonId": null
    }
  ],
  "favourite": {
    "favouriteListId": "d597c2c0-ab57-11ec-a361-511f7aa29b94",
    "contentId": "GLOBAL_11331_20220514150000",
    "contentType": "BTV",
    "categories": [],
    "metadata": {}
  },
  "bookmark": {
    "contentId": "GLOBAL_11331_20220514150000",
    "contentType": "series",
    "position": 1,
    "metadata": {
      "episodeId": "GLOBAL_11331_20220528150000"
    },
    "tags": []
  },
  "cast": [
    {
      "dateOfBirth": "1990-04-22",
      "name": "Dirk Galuba",
      "bio": "Dirk Galuba grew up in Bremen and graduated from high schoolthere. He then began studying medicine at the Westfälische Wilhelms-Universität in Münster,which he soon dropped out in favor of studying acting. He then studied German language and literature and theatre studies for four semesters before attending the Westfälische Schauspielschule in Bochum.\n\t\t\t\t\t\t\n\t\t\t\t\t\tDirk Galuba has been married to an Italian woman since April 2019 in his third marriage, is childless and lives near Munich.",
      "playlist": [
        {
          "id": "GLOBAL_11331_20220514150000",
          "images": [],
          "role": [
            "Werner Saalfeld",
            "Director",
            "Producer"
          ]
        },
        {
          "id": "GLOBAL_11331_20220514150000",
          "images": [],
          "role": [
            "Werner Saalfeld",
            "Director",
            "Producer"
          ]
        }
      ],
      "images": [],
      "externalIds": [],
      "type": "cast",
      "id": "PERSON_000001"
    }
  ],
  "recordings": [
    {
      "id": "77f44f7a-7b91-4436-9c5a-aa86a2c08ffe",
      "eventId": "GLOBAL_11331_20220514150000",
      "status": "RECORDED",
      "playback": {
        "ATV": {
          "drmId": null,
          "technicalId": "1648470934217",
          "uri": "http://cdn-nagravision-a-01.vos360.video/Content/DASH/LLCU/bd0fac7f-9588-4deb-a5ba-184df37e80cc/manifest.mpd"
        },
        "Chrome": {
          "drmId": null,
          "technicalId": "1648470934217",
          "uri": "http://cdn-nagravision-a-01.vos360.video/Content/DASH/LLCU/bd0fac7f-9588-4deb-a5ba-184df37e80cc/manifest.mpd"
        },
        "IOS": {
          "drmId": null,
          "technicalId": "1648471101715",
          "uri": "http://cdn-nagravision-a-01.vos360.video/Content/HLS/LLCU/bd0fac7f-9588-4deb-a5ba-184df37e80cc/index.m3u8"
        },
        "Android": {
          "drmId": null,
          "technicalId": "1648470934217",
          "uri": "http://cdn-nagravision-a-01.vos360.video/Content/DASH/LLCU/bd0fac7f-9588-4deb-a5ba-184df37e80cc/manifest.mpd"
        }
      }
    }
  ]
}