Asset

The following code examples show the side by side comparison of the asset entity between version 1 and version 2 of the TV API.

{
  "id": "27eede00-0977-3222-9cb5-6d8705e23783",
  "title": "Animal Park Summer Special",
  "type": "episode",
  "number": 6,
  "total": 15,
  "relatedAsset": {
    "series": {
      "id": "62f012b5-2d83-3340-bed5-1c236d94bc85",
      "title": "Animal Park Summer Special",
      "tag": [],
      "media": [],
      "subject": [{
        "code": "asset:patv:231673",
        "profile": "asset"
      }]
    },
    "season": {
      "id": "537562a4-cd80-3474-b683-2de9678786e2",
      "title": "Animal Park Summer Special Season 3",
      "number": 3,
      "tag": [],
      "media": [],
      "subject": [{
        "code": "asset:patv:58475",
        "profile": "asset"
      }]
    }
  },
  "tag": [{
    "id": "genre:nature",
    "name": "Nature"
  }, {
    "id": "genre:animals",
    "name": "Animals"
  }, {
    "id": "genre:environment",
    "name": "Environment"
  }],
  "summary": {
    "short": "Keepers try to save the life of a newborn wallaby.",
    "medium": "Kate Humble and Ben Fogle join keepers trying to save the life of a newborn wallaby, while Jean Johansson welcomes a European elk to its new home at Longleat."
  },
  "media": [{
    "kind": "picture:series",
    "copyright": "WARNING: Use of this copyright image is subject to the terms of use of BBC Pictures' Digital Picture Service (BBC Pictures) as s",
    "expiryDate": "2018-09-03",
    "rendition": {
      "default": {
        "href": "http://s3-tv-api-images.s3-website-eu-west-1.amazonaws.com/asset/webANXanimparksummer.jpg"
      }
    }
  }],
  "subject": [{
    "code": "asset:patv:3052478",
    "profile": "asset"
  }]
}
{
    "id": "b408d29d-c81d-59f9-9b7a-4ad3a879aa78",
    "type": "episode",
    "number": 6,
    "certification": {},
    "meta": {
        "episode": "6"
    },
    "category": [],
    "attribute": [],
    "summary": {
        "medium": "Kate Humble and Ben Fogle join keepers trying to save the life of a newborn wallaby, while Jean Johansson welcomes a European elk to its new home at Longleat",
        "short": "Keepers try to save the life of a newborn wallaby"
    },
    "media": [],
    "related": [
        {
            "type": "season",
            "id": "ed425416-7511-5724-91a7-06f5e940b959",
            "title": "Animal Park Summer Special Season 3",
            "number": 3,
            "media": []
        },
        {
            "type": "series",
            "id": "d573e458-2f23-5d38-84b7-8f696fc2e1a9",
            "title": "Animal Park Summer Special",
            "media": [
                {
                    "kind": "image:asset",
                    "rendition": {
                        "default": {
                            "href": "https://tv.assets.pressassociation.io/446c295e-cfa7-5b7a-b64e-2f92a3d29c83.jpg"
                        }
                    }
                }
            ]
        }
    ],
    "link": [
        {
            "rel": "contributor",
            "href": "https://tv.api.pressassociation.io/v2/asset/b408d29d-c81d-59f9-9b7a-4ad3a879aa78/contributor"
        }
    ],
    "createdAt": "2018-08-01T12:56:20.352Z",
    "updatedAt": "2018-08-01T12:56:20.352Z"
}

New

Previous

Description

$.attribute

These would be associated with the asset when included within a schedule endpoint response.

The attribute array contains optional flags that where previously identified as boolean properties in the JSON object. As you can see in the examples include subtitles and strong-language flag is added to the channel.

$.media.kind

$.media.kind

The kind value on the logo has been changed to image:logo from picture:logo related assets media are no longer promoted to the main asset.

$.media.rendition.transparent-light
$.media.rendition.transparent-dark

The light and dark renditions of the channel logos have been removed. Only the default channel logo is exposed.

$.category

$.tag

Category and sub category of the asset

$.related

$.relatedAsset

A type value has been added to show the relation to the asset. These related assets contain their own relevant media.

$.meta

This adds enriched meta data around the asset which currently wasn't available in version 1

$.createdAt

The timestamp the asset was created.

$.updatedAt

The timestamp of the last time the asset was updated.

$.deletedAt

The timestamp when the asset was flagged as deleted