Skip to main content
Skip table of contents

Media Card - VOD

Retrieving Media Card information for a VOD content item.

Request

To retrieve the Media Card information for a VOD content item, send a GET request to:

https://<host>:<port>/metadata/v1/vod/{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_EP013898090011",
  "type": "vod",
  "Title": "The North Remembers",
  "Description": "Tyrion arrives in King's Landing to counsel Joffrey; Stannis Baratheon plots an invasion to claim his late brother's throne; Daenerys and her three dragons search for allies and water; Bran presides over a threadbare Winterfell.",
  "Actors": [
    "Peter Dinklage",
    "Lena Headey",
    "Michelle Fairley",
    "Emilia Clarke",
    "Nikolaj Coster-Waldau",
    "Aidan Gillen",
    "Kit Harington",
    "Richard Madden",
    "Sophie Turner",
    "Maisie Williams",
    "Isaac Hempstead-Wright",
    "Jack Gleeson",
    "Charles Dance",
    "Alfie Allen",
    "Jerome Flynn",
    "Rory McCann",
    "Conleth Hill",
    "Iain Glen",
    "John Bradley",
    "James Cosmo",
    "Sibel Kekilli",
    "Liam Cunningham",
    "Stephen Dillane",
    "Natalie Dormer",
    "Carice van Houten",
    "Donald Sumpter",
    "Ron Donachie",
    "Julian Glover",
    "Robert Pugh",
    "Natalia Tena",
    "Oliver Ford Davies",
    "Mark Stanley",
    "Ben Crompton",
    "Joe Dempsie",
    "Ben Hawkey",
    "Eros Vlahos",
    "Roxanne McKee",
    "Amrita Acharia",
    "Elyes Gabel",
    "Steven Cole",
    "Kristian Nairn",
    "Esmé Bianco",
    "Dominic Carter",
    "Kerr Logan",
    "Tony Way",
    "Hannah Murray",
    "Karl Davies",
    "Ian Beattie",
    "Pat Mooney",
    "Sahara Knite",
    "Maisie Dee",
    "Antonia Christophers",
    "Callum Wharry",
    "Aimee Richardson",
    "Andrew Wilde",
    "Natalia Lee",
    "Gordon Fulton",
    "Marko Cindric",
    "Josephine Gillan",
    "Dennis Stokes"
  ],
  "Categories": [
    "Drama",
    "Fantasy"
  ],
  "Ratings": [
    {
      "Title": "TVMA",
      "code": "TVMA"
    }
  ],
  "contentId": "GLOBAL_EP013898090011",
  "isLTCU": false,
  "isSTCU": false,
  "media": {
    "AV_PlaylistName": {
      "fileName": "http://cdn-nagravision-a-01.vos360.video/Content/DASH/VOD/9627/2000/756de8ff-3749-4145-abc3-1cd7abdffd40/1afd64e8-80ae-98c8-0b2c-ab40c326b9fc/manifest.mpd",
      "uri": "http://cdn-nagravision-a-01.vos360.video/Content/DASH/VOD/9627/2000/756de8ff-3749-4145-abc3-1cd7abdffd40/1afd64e8-80ae-98c8-0b2c-ab40c326b9fc/manifest.mpd",
      "format": {}
    }
  },
  "products": [
    {
      "_id": "1591012355099_1591012355099",
      "id": "1591012355099_1591012355099",
      "startPurchase": 1590966000,
      "endPurchase": 1767139200,
      "price": {
        "startPurchase": 1590966000,
        "endPurchase": 1767139200,
        "currency": "GBP",
        "value": 20
      },
      "billingModel": {
        "period": 2592000
      },
      "startValidity": 1590966000,
      "endValidity": 1767139200,
      "type": "subscription",
      "title": "Box Sets",
      "isFreemium": false,
      "technicalTypes": [
        "SD",
        "HD",
        "DASH",
        "HLS"
      ],
      "contractType": "1",
      "freemiumType": "1",
      "Description": "Series Box Sets for Catch-up",
      "voditems": [
        {
          "_id": "GLOBAL_EP013898090011C2_NODE_1567766810000",
          "title": "EP013898090011",
          "productRefs": [
            "1591012355099_1591012355099"
          ],
          "nodeRefs": [
            "STCUParentNodeId_SYSTEM"
          ],
          "companyId": "GLOBAL",
          "contentRef": "GLOBAL_EP013898090011C2",
          "period": {
            "duration": 157680000,
            "start": 1591037260,
            "end": 1748717260
          },
          "type": "vod",
          "id": "GLOBAL_EP013898090011C2_NODE_1567766810000",
          "publishToEndUserDevices": true,
          "DisplayPriority": 52,
          "node": "STCUParentNodeId_SYSTEM"
        },
        {
          "_id": "GLOBAL_EP013898090011C2_NODE_1567766810000",
          "title": "EP013898090011",
          "productRefs": [
            "1591012355099_1591012355099"
          ],
          "nodeRefs": [
            "STCUParentNodeId_SYSTEM"
          ],
          "companyId": "GLOBAL",
          "contentRef": "GLOBAL_EP013898090011C2",
          "period": {
            "duration": 157680000,
            "start": 1591037260,
            "end": 1748717260
          },
          "type": "vod",
          "id": "GLOBAL_EP013898090011C2_NODE_1567766810000",
          "publishToEndUserDevices": true,
          "node": ""
        }
      ]
    }
  ],
  "series": {
    "id": "GLOBAL_8553063",
    "Title": "Game of Thrones",
    "seasons": [
      {
        "id": "GLOBAL_8553063_8",
        "Title": "Game of Thrones",
        "episodes": [
          {
            "id": "GLOBAL_EP013898090080",
            "Title": "The Iron Throne"
          }
        ]
      },
      {
        "id": "GLOBAL_8553063_7",
        "Title": "Game of Thrones",
        "episodes": [
          {
            "id": "GLOBAL_EP013898090072",
            "Title": "Beyond the Wall"
          }
        ]
      }
    ]
  }
}

See also

For full details of this API, see Content Discovery Facade API documentation.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.