Channel

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

{
  "id":"4a92277d-03f8-3d71-9fc0-43dcb844daa9",
  "epg":"108",
  "title":"Sky Atlantic HD",
  "type":"tv",
  "hd":true,
  "regional":false,
  "media":[
    {
      "kind":"picture:logo",
      "rendition":{
        "default":{
          "href":"http://tv.static.press.net/logo/p346834.png"
        },
        "transparent-light":{
          "href":"http://tv.static.press.net/logo/p2201710171629.png"
        },
        "transparent-dark":{
          "href":"http://tv.static.press.net/logo/p1201710171629.png"
        }
      }
    }
  ],
  "subject":[
    {
      "code":"channel:patv:1629",
      "profile":"channel"
    }
  ]
}
{
  "id":"17430b79-ac54-55a9-8530-1b62247e9d9f",
  "epg":"108",
  "title":"Sky Atlantic HD",
  "attribute":[
    "hd"
  ],
  "meta":{

  },
  "category":[
    {
      "code":"entertainment",
      "name":"Entertainment"
    }
  ],
  "media":[
    {
      "kind":"image:logo",
      "rendition":{
        "default":{
          "href":"https://tv-staging.assets.pressassociation.io/207ae079-f7b1-5685-a025-eef4cd530d3a.png"
        }
      }
    }
  ],
  "subject":[
    {
      "code":"channel:patv:1629",
      "profile":"channel"
    }
  ]
}

Fields

New

Previous

Description

$.attribute

type
hd
regional

The attribute array contains optional flags that where previously identified as boolean properties in the JSON object. As you can see in the example the hd flag is added to the channel.

$.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.

$.media.kind

$.media.kind

The kind value on the logo has been changed to image:logo from picture:logo

$.category

The addition of the category object has been added. This adds enriched meta data around the channel which currently wasn't available in version 1.

Collection Query Parameters

New

Previous

Description

limit
offset
query

These query parameters have been removed from version 2 of the API. If you feel these parameters add value for you, please get in touch.

aliases

The aliases query parameter enables the PA legacy IDs to be exposed. Please add this to your request if you would like to see the Legacy PA IDs.

start

The Start query parameters allows you to retrieve different states of a channel i.e its name on a specific date. Leaving the parameter empty will return the current channels state. This parameter is useful for looking up channel name changes or rebranding.

scheduleStart
scheduleEnd
scheduleUpdatedSince

The combination of these query parameters add the ability to retrieve a list of channel that have had there schedule updated within a given range. See API Reference for more details.