BBC - API BBC Nitro - APITree HUB

BBC / BBC Nitro

BBC Nitro

BBC Nitro is the BBC's application programming interface (API) for BBC Programmes Metadata.

License: Nitro Public License

Resources

Raw

Nitro Raw

GET

/v1/brands/{pid}/franchises/

Get raw brand franchises

Request

Path

Name	Data Type	Description
`pid`	string

Responses

200Nitro response

Body

Name Data Type Description

nitro

nitro

Properties

sorts sorts

sorts object

Properties

`unstable_sorts`	unstable_sorts
`sort`	array [sort]

results results

results object

Properties

`window`	window
`version_group`	version_group
`total`	integer
`speech`	speech
`service`	service
`series`	series
`season`	season
`promotion`	promotion
`page_size`	integer
`page`	integer
`other`	other
`music`	music
`more_than`	integer
`master_brand`	master_brand
`image`	image
`highlight`	highlight
`gallery`	gallery
`franchise`	franchise
`episode`	episode
`contributor`	contributor
`collection`	collection
`clip`	clip
`chapter`	chapter
`broadcast`	broadcast
`brand`	brand
`availability`	availability

pagination pagination

pagination object

Properties

`previous`	previous
`next`	next

mixins mixins

mixins object

Properties

`unstable_mixins`	unstable_mixins
`mixin`	array [mixin]

filters filters

filters object

Properties

`unstable_filters`	unstable_filters
`filter`	array [filter]

deprecations deprecations

deprecations object

Properties

deprecated array [deprecated]

GET

/v1/brands/{pid}

Get raw brand

Request

Path

Name	Data Type	Description
`pid`	string

Responses

200Nitro response

Body

Name Data Type Description

nitro

nitro

Properties

sorts sorts

sorts object

Properties

`unstable_sorts`	unstable_sorts
`sort`	array [sort]

results results

results object

Properties

`window`	window
`version_group`	version_group
`total`	integer
`speech`	speech
`service`	service
`series`	series
`season`	season
`promotion`	promotion
`page_size`	integer
`page`	integer
`other`	other
`music`	music
`more_than`	integer
`master_brand`	master_brand
`image`	image
`highlight`	highlight
`gallery`	gallery
`franchise`	franchise
`episode`	episode
`contributor`	contributor
`collection`	collection
`clip`	clip
`chapter`	chapter
`broadcast`	broadcast
`brand`	brand
`availability`	availability

pagination pagination

pagination object

Properties

`previous`	previous
`next`	next

mixins mixins

mixins object

Properties

`unstable_mixins`	unstable_mixins
`mixin`	array [mixin]

filters filters

filters object

Properties

`unstable_filters`	unstable_filters
`filter`	array [filter]

deprecations deprecations

deprecations object

Properties

deprecated array [deprecated]

GET

/v1/episodes/{pid}/ancestors/

Get raw ancestors

Request

Path

Name	Data Type	Description
`pid`	string

Responses

200Nitro response

Body

Name Data Type Description

nitro

nitro

Properties

sorts sorts

sorts object

Properties

`unstable_sorts`	unstable_sorts
`sort`	array [sort]

results results

results object

Properties

`window`	window
`version_group`	version_group
`total`	integer
`speech`	speech
`service`	service
`series`	series
`season`	season
`promotion`	promotion
`page_size`	integer
`page`	integer
`other`	other
`music`	music
`more_than`	integer
`master_brand`	master_brand
`image`	image
`highlight`	highlight
`gallery`	gallery
`franchise`	franchise
`episode`	episode
`contributor`	contributor
`collection`	collection
`clip`	clip
`chapter`	chapter
`broadcast`	broadcast
`brand`	brand
`availability`	availability

pagination pagination

pagination object

Properties

`previous`	previous
`next`	next

mixins mixins

mixins object

Properties

`unstable_mixins`	unstable_mixins
`mixin`	array [mixin]

filters filters

filters object

Properties

`unstable_filters`	unstable_filters
`filter`	array [filter]

deprecations deprecations

deprecations object

Properties

deprecated array [deprecated]

GET

/v1/episodes/{pid}/formats/

Get raw formats

Request

Path

Name	Data Type	Description
`pid`	string

Responses

200Nitro response

Body

Name Data Type Description

nitro

nitro

Properties

sorts sorts

sorts object

Properties

`unstable_sorts`	unstable_sorts
`sort`	array [sort]

results results

results object

Properties

`window`	window
`version_group`	version_group
`total`	integer
`speech`	speech
`service`	service
`series`	series
`season`	season
`promotion`	promotion
`page_size`	integer
`page`	integer
`other`	other
`music`	music
`more_than`	integer
`master_brand`	master_brand
`image`	image
`highlight`	highlight
`gallery`	gallery
`franchise`	franchise
`episode`	episode
`contributor`	contributor
`collection`	collection
`clip`	clip
`chapter`	chapter
`broadcast`	broadcast
`brand`	brand
`availability`	availability

pagination pagination

pagination object

Properties

`previous`	previous
`next`	next

mixins mixins

mixins object

Properties

`unstable_mixins`	unstable_mixins
`mixin`	array [mixin]

filters filters

filters object

Properties

`unstable_filters`	unstable_filters
`filter`	array [filter]

deprecations deprecations

deprecations object

Properties

deprecated array [deprecated]

GET

/v1/episodes/{pid}/genre_groups/

Get raw genre groups

Request

Path

Name	Data Type	Description
`pid`	string

Responses

200Nitro response

Body

Name Data Type Description

nitro

nitro

Properties

sorts sorts

sorts object

Properties

`unstable_sorts`	unstable_sorts
`sort`	array [sort]

results results

results object

Properties

`window`	window
`version_group`	version_group
`total`	integer
`speech`	speech
`service`	service
`series`	series
`season`	season
`promotion`	promotion
`page_size`	integer
`page`	integer
`other`	other
`music`	music
`more_than`	integer
`master_brand`	master_brand
`image`	image
`highlight`	highlight
`gallery`	gallery
`franchise`	franchise
`episode`	episode
`contributor`	contributor
`collection`	collection
`clip`	clip
`chapter`	chapter
`broadcast`	broadcast
`brand`	brand
`availability`	availability

pagination pagination

pagination object

Properties

`previous`	previous
`next`	next

mixins mixins

mixins object

Properties

`unstable_mixins`	unstable_mixins
`mixin`	array [mixin]

filters filters

filters object

Properties

`unstable_filters`	unstable_filters
`filter`	array [filter]

deprecations deprecations

deprecations object

Properties

deprecated array [deprecated]

GET

/v1/episodes/{pid}

Get raw episode

Request

Path

Name	Data Type	Description
`pid`	string

Responses

200Nitro response

Body

Name Data Type Description

nitro

nitro

Properties

sorts sorts

sorts object

Properties

`unstable_sorts`	unstable_sorts
`sort`	array [sort]

results results

results object

Properties

`window`	window
`version_group`	version_group
`total`	integer
`speech`	speech
`service`	service
`series`	series
`season`	season
`promotion`	promotion
`page_size`	integer
`page`	integer
`other`	other
`music`	music
`more_than`	integer
`master_brand`	master_brand
`image`	image
`highlight`	highlight
`gallery`	gallery
`franchise`	franchise
`episode`	episode
`contributor`	contributor
`collection`	collection
`clip`	clip
`chapter`	chapter
`broadcast`	broadcast
`brand`	brand
`availability`	availability

pagination pagination

pagination object

Properties

`previous`	previous
`next`	next

mixins mixins

mixins object

Properties

`unstable_mixins`	unstable_mixins
`mixin`	array [mixin]

filters filters

filters object

Properties

`unstable_filters`	unstable_filters
`filter`	array [filter]

deprecations deprecations

deprecations object

Properties

deprecated array [deprecated]

GET

/v1/images/{pid}

Get raw image

Request

Path

Name	Data Type	Description
`pid`	string

Responses

200Nitro response

Body

Name Data Type Description

nitro

nitro

Properties

sorts sorts

sorts object

Properties

`unstable_sorts`	unstable_sorts
`sort`	array [sort]

results results

results object

Properties

`window`	window
`version_group`	version_group
`total`	integer
`speech`	speech
`service`	service
`series`	series
`season`	season
`promotion`	promotion
`page_size`	integer
`page`	integer
`other`	other
`music`	music
`more_than`	integer
`master_brand`	master_brand
`image`	image
`highlight`	highlight
`gallery`	gallery
`franchise`	franchise
`episode`	episode
`contributor`	contributor
`collection`	collection
`clip`	clip
`chapter`	chapter
`broadcast`	broadcast
`brand`	brand
`availability`	availability

pagination pagination

pagination object

Properties

`previous`	previous
`next`	next

mixins mixins

mixins object

Properties

`unstable_mixins`	unstable_mixins
`mixin`	array [mixin]

filters filters

filters object

Properties

`unstable_filters`	unstable_filters
`filter`	array [filter]

deprecations deprecations

deprecations object

Properties

deprecated array [deprecated]

GET

/v1/master_brands/{mbid}

Get raw masterbrand

Request

Path

Name	Data Type	Description
`mbid`	string

Responses

200Nitro response

Body

Name Data Type Description

nitro

nitro

Properties

sorts sorts

sorts object

Properties

`unstable_sorts`	unstable_sorts
`sort`	array [sort]

results results

results object

Properties

`window`	window
`version_group`	version_group
`total`	integer
`speech`	speech
`service`	service
`series`	series
`season`	season
`promotion`	promotion
`page_size`	integer
`page`	integer
`other`	other
`music`	music
`more_than`	integer
`master_brand`	master_brand
`image`	image
`highlight`	highlight
`gallery`	gallery
`franchise`	franchise
`episode`	episode
`contributor`	contributor
`collection`	collection
`clip`	clip
`chapter`	chapter
`broadcast`	broadcast
`brand`	brand
`availability`	availability

pagination pagination

pagination object

Properties

`previous`	previous
`next`	next

mixins mixins

mixins object

Properties

`unstable_mixins`	unstable_mixins
`mixin`	array [mixin]

filters filters

filters object

Properties

`unstable_filters`	unstable_filters
`filter`	array [filter]

deprecations deprecations

deprecations object

Properties

deprecated array [deprecated]

GET

/v1/promotions/{pid}

Get raw promotion

Request

Path

Name	Data Type	Description
`pid`	string

Responses

200Nitro response

Body

Name Data Type Description

nitro

nitro

Properties

sorts sorts

sorts object

Properties

`unstable_sorts`	unstable_sorts
`sort`	array [sort]

results results

results object

Properties

`window`	window
`version_group`	version_group
`total`	integer
`speech`	speech
`service`	service
`series`	series
`season`	season
`promotion`	promotion
`page_size`	integer
`page`	integer
`other`	other
`music`	music
`more_than`	integer
`master_brand`	master_brand
`image`	image
`highlight`	highlight
`gallery`	gallery
`franchise`	franchise
`episode`	episode
`contributor`	contributor
`collection`	collection
`clip`	clip
`chapter`	chapter
`broadcast`	broadcast
`brand`	brand
`availability`	availability

pagination pagination

pagination object

Properties

`previous`	previous
`next`	next

mixins mixins

mixins object

Properties

`unstable_mixins`	unstable_mixins
`mixin`	array [mixin]

filters filters

filters object

Properties

`unstable_filters`	unstable_filters
`filter`	array [filter]

deprecations deprecations

deprecations object

Properties

deprecated array [deprecated]

feeds

Nitro data feeds

GET

/availabilities

Discover details of on-demand availability for programmes and their versions

Request

Query

Name	Data Type	Description
`debug`	boolean	Turn on debug information (undocumented)
`territory`	array	filter for availabilities in given territory
`page_size`	integer Default value: `10` Maximum: 300	number of results in each page
`page`	integer Default value: `1` Minimum: 1	which page of results to return
`media_set`	array	filter for subset of availabilities with media set
`descendants_of`	array	filter for subset of availabilities that have PID as ancestor
`availability`	array	filter for subset of availabilities
`sort_direction`	string Allowed values: - `ascending` - `descending`	Sort direction
`sort`	string Allowed values: - `scheduled_start`	Sorts: scheduled_start: sort chronologically by scheduled start time/date, ascending

Responses

200Unexpected error

Body

Name Data Type Description

ErrorModel

ErrorModel object

Properties

fault

200Nitro response

Body

Name Data Type Description

nitro

nitro

Properties

sorts sorts

sorts object

Properties

`unstable_sorts`	unstable_sorts
`sort`	array [sort]

results results

results object

Properties

`window`	window
`version_group`	version_group
`total`	integer
`speech`	speech
`service`	service
`series`	series
`season`	season
`promotion`	promotion
`page_size`	integer
`page`	integer
`other`	other
`music`	music
`more_than`	integer
`master_brand`	master_brand
`image`	image
`highlight`	highlight
`gallery`	gallery
`franchise`	franchise
`episode`	episode
`contributor`	contributor
`collection`	collection
`clip`	clip
`chapter`	chapter
`broadcast`	broadcast
`brand`	brand
`availability`	availability

pagination pagination

pagination object

Properties

`previous`	previous
`next`	next

mixins mixins

mixins object

Properties

`unstable_mixins`	unstable_mixins
`mixin`	array [mixin]

filters filters

filters object

Properties

`unstable_filters`	unstable_filters
`filter`	array [filter]

deprecations deprecations

deprecations object

Properties

deprecated array [deprecated]

GET

/broadcasts

Fetch metadata about linear Broadcasts and Services, allowing the generation of Television and Radio schedules and other datasets for broadcast items. Use /schedules instead of this feed as it is more efficient. Broadcasts will be deprecated in the future.

Request

Query

Name	Data Type	Description
`version`	array	filter for subset of broadcasts with given PID as their parent version
`start_to`	dateTime	filter for subset of broadcasts that start on or earlier than the specified datetime
`start_from`	dateTime	filter for subset of broadcasts that start on or later than the specified datetime
`sid`	array	filter for subset of broadcasts that are on the specified linear service
`service_master_brand`	array	filter for subset of broadcasts with given service master brand
`schedule_day_to`	date	filter for subset of broadcasts that start on or before the specified day (BBC time)
`schedule_day_from`	date	filter for subset of broadcasts that start on or after the specified day (BBC time)
`schedule_day`	date	filter for subset of broadcasts that start on the specified day (BBC time)
`q`	string	filter for subset of broadcasts matching supplied keyword/phrase (boolean operators permitted)
`pid`	array	filter for subset of broadcasts having given PID
`people`	string	filter for subset of broadcasts that have given contributor
`page_size`	integer Default value: `10` Maximum: 300	number of results in each page
`page`	integer Default value: `1` Minimum: 1	which page of results to return
`item`	array	filter for subset of broadcasts with the given item performed on it
`id`	array	filter for subset of broadcasts that have given identifier
`genre`	array	filter for subset of broadcasts that are classified in the given genre ID
`format`	array	filter for subset of broadcasts that are classified in the given format ID
`end_to`	dateTime	filter for subset of broadcasts that end on or earlier than the specified datetime
`end_from`	dateTime	filter for subset of broadcasts that end on or later than the specified datetime
`descendants_of`	array	filter for subset of broadcasts that are descendants of the given programme PID
`authority`	array	filter for subset of broadcasts that have given authority
`mixin`	array	Mixins: titles: return ancestor programme titles
`sort_direction`	string Allowed values: - `ascending` - `descending`	Sort direction
`sort`	string Allowed values: - `start_date`	Sorts: start_date: sort chronologically by scheduled start time/date, ascending

Responses

200Unexpected error

Body

Name Data Type Description

ErrorModel

ErrorModel object

Properties

fault

200Nitro response

Body

Name Data Type Description

nitro

nitro

Properties

sorts sorts

sorts object

Properties

`unstable_sorts`	unstable_sorts
`sort`	array [sort]

results results

results object

Properties

`window`	window
`version_group`	version_group
`total`	integer
`speech`	speech
`service`	service
`series`	series
`season`	season
`promotion`	promotion
`page_size`	integer
`page`	integer
`other`	other
`music`	music
`more_than`	integer
`master_brand`	master_brand
`image`	image
`highlight`	highlight
`gallery`	gallery
`franchise`	franchise
`episode`	episode
`contributor`	contributor
`collection`	collection
`clip`	clip
`chapter`	chapter
`broadcast`	broadcast
`brand`	brand
`availability`	availability

pagination pagination

pagination object

Properties

`previous`	previous
`next`	next

mixins mixins

mixins object

Properties

`unstable_mixins`	unstable_mixins
`mixin`	array [mixin]

filters filters

filters object

Properties

`unstable_filters`	unstable_filters
`filter`	array [filter]

deprecations deprecations

deprecations object

Properties

deprecated array [deprecated]

GET

/groups

Long-lived curated collections of programmes and more, including Collections, Seasons, Franchises and Galleries

Request

Query

Name	Data Type	Description
`embargoed`	string Allowed values: - `include` - `exclude` - `only`	Control return of embargoed items (undocumented)
`q`	string	filter for subset of groups matching supplied keyword/phrase (boolean operators permitted)
`pid`	array	filter for subset of seasons, collections, galleries or franchises having given PID
`partner_pid`	array	filter for groups by partner PID
`partner_id`	array	filter for groups by partner ID
`page_size`	integer Default value: `10` Maximum: 300	number of results in each page
`page`	integer Default value: `1` Minimum: 1	which page of results to return
`member`	string Pattern: `^([0-9,a-d,f-h,j-n,p-t,v-z]){8,}$` Minimum: 8	filter for subset of groups which contain an entity with the given pid as a member
`group_type`	array	filter for subset of groups that have the given group type
`group`	string Pattern: `^([0-9,a-d,f-h,j-n,p-t,v-z]){8,}$` Minimum: 8	filter for subset of groups which belong to the given group pid
`for_programme`	string Pattern: `^([0-9,a-d,f-h,j-n,p-t,v-z]){8,}$` Minimum: 8	filter for subset of groups directly related to a given programme
`for_descendants_of`	string Pattern: `^([0-9,a-d,f-h,j-n,p-t,v-z]){8,}$` Minimum: 8	filter for groups related to given programme or its descendants
`mixin`	array	Mixins: alternate_images: mixin to return the alternate images for a group group_for: mixin to return links to programme entities that group belongs to images: mixin to add image information for a group related_links: mixin to return related links for the group
`sort_direction`	string Allowed values: - `descending`	Sort direction
`sort`	string Allowed values: - `pid`	Sorts: pid: sort alphabetically by PID

Responses

200Unexpected error

Body

Name Data Type Description

ErrorModel

ErrorModel object

Properties

fault

200Nitro response

Body

Name Data Type Description

nitro

nitro

Properties

sorts sorts

sorts object

Properties

`unstable_sorts`	unstable_sorts
`sort`	array [sort]

results results

results object

Properties

`window`	window
`version_group`	version_group
`total`	integer
`speech`	speech
`service`	service
`series`	series
`season`	season
`promotion`	promotion
`page_size`	integer
`page`	integer
`other`	other
`music`	music
`more_than`	integer
`master_brand`	master_brand
`image`	image
`highlight`	highlight
`gallery`	gallery
`franchise`	franchise
`episode`	episode
`contributor`	contributor
`collection`	collection
`clip`	clip
`chapter`	chapter
`broadcast`	broadcast
`brand`	brand
`availability`	availability

pagination pagination

pagination object

Properties

`previous`	previous
`next`	next

mixins mixins

mixins object

Properties

`unstable_mixins`	unstable_mixins
`mixin`	array [mixin]

filters filters

filters object

Properties

`unstable_filters`	unstable_filters
`filter`	array [filter]

deprecations deprecations

deprecations object

Properties

deprecated array [deprecated]

GET

/images

Find metadata for images, particularly those in galleries

Request

Query

Name	Data Type	Description
`embargoed`	string Allowed values: - `include` - `exclude` - `only`	Control return of embargoed items (undocumented)
`q`	string	filter for subset of images matching supplied keyword/phrase (boolean operators permitted)
`pid`	array	filter for subset of images having given PID
`partner_pid`	array	filter for images by partner PID
`partner_id`	array	filter for images by partner ID
`page_size`	integer Default value: `10` Maximum: 300	number of results in each page
`page`	integer Default value: `1` Minimum: 1	which page of results to return
`is_image_for`	string Pattern: `^([0-9,a-d,f-h,j-n,p-t,v-z]){8,}$` Minimum: 8	filter for images by entity PID
`is_alternate_image_for`	string Pattern: `^([0-9,a-d,f-h,j-n,p-t,v-z]){8,}$` Minimum: 8	filter for alternate images by entity PID
`image_type`	array	filter for images by type
`group`	string Pattern: `^([0-9,a-d,f-h,j-n,p-t,v-z]){8,}$` Minimum: 8	filter for images belonging to the given group (i.e. Gallery)
`sort_direction`	string Allowed values: - `ascending` - `descending`	Sort direction
`sort`	string Allowed values: - `group_position` - `pid`	Sorts: group_position: sort numerically by position, ascending only pid: sort alphabetically by PID

Responses

200Unexpected error

Body

Name Data Type Description

ErrorModel

ErrorModel object

Properties

fault

200Nitro response

Body

Name Data Type Description

nitro

nitro

Properties

sorts sorts

sorts object

Properties

`unstable_sorts`	unstable_sorts
`sort`	array [sort]

results results

results object

Properties

`window`	window
`version_group`	version_group
`total`	integer
`speech`	speech
`service`	service
`series`	series
`season`	season
`promotion`	promotion
`page_size`	integer
`page`	integer
`other`	other
`music`	music
`more_than`	integer
`master_brand`	master_brand
`image`	image
`highlight`	highlight
`gallery`	gallery
`franchise`	franchise
`episode`	episode
`contributor`	contributor
`collection`	collection
`clip`	clip
`chapter`	chapter
`broadcast`	broadcast
`brand`	brand
`availability`	availability

pagination pagination

pagination object

Properties

`previous`	previous
`next`	next

mixins mixins

mixins object

Properties

`unstable_mixins`	unstable_mixins
`mixin`	array [mixin]

filters filters

filters object

Properties

`unstable_filters`	unstable_filters
`filter`	array [filter]

deprecations deprecations

deprecations object

Properties

deprecated array [deprecated]

GET

/items

Look inside programmes to find segments: chapters, tracks and more

Request

Query

Name	Data Type	Description
`segment_event`	string	filter for item with the given segment_event
`q`	string	filter for subset of items matching supplied keyword/phrase (boolean operators permitted)
`programme`	string Pattern: `^([0-9,a-d,f-h,j-n,p-t,v-z]){8,}$` Minimum: 8	filter for subset of items that are part of the given programme
`pid`	array	filter for subset of items matching one of the given PIDs
`people`	string	filter for subset of items that have specified person involved
`partner_pid`	array	filter for items by partner PID
`partner_id`	array	filter for items by partner ID
`page_size`	integer Default value: `10` Maximum: 300	number of results in each page
`page`	integer Default value: `1` Minimum: 1	which page of results to return
`item_type`	array	filter for specific type(s) of items
`id_type`	string	filter for subset of items that have given an ID of the given type
`id`	array	filter for subset of items having given ID
`authority`	string	filter for subset of items that have an ID issued by the given authority
`mixin`	array	Mixins: contributions: mixin to return information about contributors to items images: mixin to add image information for an item offset: mixin to return programme segment offsets, works in conjunction with programme filter play_event: mixin to return programme segment events, works in conjunction with programme or segment_event filters
`sort_direction`	string Allowed values: - `descending`	Sort direction
`sort`	string Allowed values: - `pid`	Sorts: pid: sort by pid, descending

Responses

200Unexpected error

Body

Name Data Type Description

ErrorModel

ErrorModel object

Properties

fault

200Nitro response

Body

Name Data Type Description

nitro

nitro

Properties

sorts sorts

sorts object

Properties

`unstable_sorts`	unstable_sorts
`sort`	array [sort]

results results

results object

Properties

`window`	window
`version_group`	version_group
`total`	integer
`speech`	speech
`service`	service
`series`	series
`season`	season
`promotion`	promotion
`page_size`	integer
`page`	integer
`other`	other
`music`	music
`more_than`	integer
`master_brand`	master_brand
`image`	image
`highlight`	highlight
`gallery`	gallery
`franchise`	franchise
`episode`	episode
`contributor`	contributor
`collection`	collection
`clip`	clip
`chapter`	chapter
`broadcast`	broadcast
`brand`	brand
`availability`	availability

pagination pagination

pagination object

Properties

`previous`	previous
`next`	next

mixins mixins

mixins object

Properties

`unstable_mixins`	unstable_mixins
`mixin`	array [mixin]

filters filters

filters object

Properties

`unstable_filters`	unstable_filters
`filter`	array [filter]

deprecations deprecations

deprecations object

Properties

deprecated array [deprecated]

GET

/master_brands

List all Master Brands

Request

Query

Name	Data Type	Description
`q`	string	filter for subset of masterbrands matching supplied keyword/phrase (boolean operators permitted)
`partner_pid`	array	filter for masterbrands by partner PID
`partner_id`	array	filter for masterbrands by partner ID
`page_size`	integer Default value: `10` Maximum: 300	number of results in each page
`page`	integer Default value: `1` Minimum: 1	which page of results to return
`mid`	array	filter for subset of masterbrands that have given identifier
`mixin`	array	Mixins: images: mixin to add image information for a masterbrand
`sort_direction`	string Allowed values: - `ascending`	Sort direction
`sort`	string Allowed values: - `mid`	Sorts: mid: sort by mid, ascending

Responses

200Unexpected error

Body

Name Data Type Description

ErrorModel

ErrorModel object

Properties

fault

200Nitro response

Body

Name Data Type Description

nitro

nitro

Properties

sorts sorts

sorts object

Properties

`unstable_sorts`	unstable_sorts
`sort`	array [sort]

results results

results object

Properties

`window`	window
`version_group`	version_group
`total`	integer
`speech`	speech
`service`	service
`series`	series
`season`	season
`promotion`	promotion
`page_size`	integer
`page`	integer
`other`	other
`music`	music
`more_than`	integer
`master_brand`	master_brand
`image`	image
`highlight`	highlight
`gallery`	gallery
`franchise`	franchise
`episode`	episode
`contributor`	contributor
`collection`	collection
`clip`	clip
`chapter`	chapter
`broadcast`	broadcast
`brand`	brand
`availability`	availability

pagination pagination

pagination object

Properties

`previous`	previous
`next`	next

mixins mixins

mixins object

Properties

`unstable_mixins`	unstable_mixins
`mixin`	array [mixin]

filters filters

filters object

Properties

`unstable_filters`	unstable_filters
`filter`	array [filter]

deprecations deprecations

deprecations object

Properties

deprecated array [deprecated]

GET

/people

The People feed allows you to search for the people and groups that contribute to programmes. This is the starting point for cast and crew credits, as well as finding contributors using external IDs (such as Wikipedia URLs)

Request

Query

Name	Data Type	Description
`q`	string	filter for subset of people matching supplied keyword/phrase (boolean operators permitted)
`programme`	string	filter for subset of people that have contributed to the given programme pid
`pid`	array	filter for subset of people having given PID
`partner_pid`	array	filter for people by partner PID
`partner_id`	array	filter for people by partner ID
`page_size`	integer Default value: `10` Maximum: 300	number of results in each page
`page`	integer Default value: `1` Minimum: 1	which page of results to return
`id_type`	string	filter for subset of people that have given an ID of the given type
`id`	array	filter for subset of people having given ID
`has_external_id`	array	filter for people who have an external identifier
`authority`	string	filter for subset of people that have an ID issued by the given authority

Responses

200Unexpected error

Body

Name Data Type Description

ErrorModel

ErrorModel object

Properties

fault

200Nitro response

Body

Name Data Type Description

nitro

nitro

Properties

sorts sorts

sorts object

Properties

`unstable_sorts`	unstable_sorts
`sort`	array [sort]

results results

results object

Properties

`window`	window
`version_group`	version_group
`total`	integer
`speech`	speech
`service`	service
`series`	series
`season`	season
`promotion`	promotion
`page_size`	integer
`page`	integer
`other`	other
`music`	music
`more_than`	integer
`master_brand`	master_brand
`image`	image
`highlight`	highlight
`gallery`	gallery
`franchise`	franchise
`episode`	episode
`contributor`	contributor
`collection`	collection
`clip`	clip
`chapter`	chapter
`broadcast`	broadcast
`brand`	brand
`availability`	availability

pagination pagination

pagination object

Properties

`previous`	previous
`next`	next

mixins mixins

mixins object

Properties

`unstable_mixins`	unstable_mixins
`mixin`	array [mixin]

filters filters

filters object

Properties

`unstable_filters`	unstable_filters
`filter`	array [filter]

deprecations deprecations

deprecations object

Properties

deprecated array [deprecated]

GET

/pips

Look inside pips entities

Request

Query

Name	Data Type	Description
`q`	string	filter for subset of programmes matching supplied keyword/phrase (boolean operators permitted)
`page_size`	integer Default value: `10` Maximum: 300	number of results in each page
`page`	integer Default value: `1` Minimum: 1	which page of results to return

Responses

200Unexpected error

Body

Name Data Type Description

ErrorModel

ErrorModel object

Properties

fault

200Nitro response

Body

Name Data Type Description

nitro

nitro

Properties

sorts sorts

sorts object

Properties

`unstable_sorts`	unstable_sorts
`sort`	array [sort]

results results

results object

Properties

`window`	window
`version_group`	version_group
`total`	integer
`speech`	speech
`service`	service
`series`	series
`season`	season
`promotion`	promotion
`page_size`	integer
`page`	integer
`other`	other
`music`	music
`more_than`	integer
`master_brand`	master_brand
`image`	image
`highlight`	highlight
`gallery`	gallery
`franchise`	franchise
`episode`	episode
`contributor`	contributor
`collection`	collection
`clip`	clip
`chapter`	chapter
`broadcast`	broadcast
`brand`	brand
`availability`	availability

pagination pagination

pagination object

Properties

`previous`	previous
`next`	next

mixins mixins

mixins object

Properties

`unstable_mixins`	unstable_mixins
`mixin`	array [mixin]

filters filters

filters object

Properties

`unstable_filters`	unstable_filters
`filter`	array [filter]

deprecations deprecations

deprecations object

Properties

deprecated array [deprecated]

GET

/programme_details

Exposes programme information for a single pid

Request

Query

Name	Data Type	Description
`pid`	string Pattern: `^([0-9,a-d,f-h,j-n,p-t,v-z]){8,}$` Minimum: 8	Filter for programme information for the provided PID
`partner_pid`	string Pattern: `^([0-9,a-d,f-h,j-n,p-t,v-z]){8,}$` Minimum: 8	Filter for programme information by partner PID
`page_size`	integer Default value: `10` Maximum: 300	number of results in each page
`page`	integer Default value: `1` Minimum: 1	which page of results to return

Responses

200Unexpected error

Body

Name Data Type Description

ErrorModel

ErrorModel object

Properties

fault

200Nitro response

Body

Name Data Type Description

nitro

nitro

Properties

sorts sorts

sorts object

Properties

`unstable_sorts`	unstable_sorts
`sort`	array [sort]

results results

results object

Properties

`window`	window
`version_group`	version_group
`total`	integer
`speech`	speech
`service`	service
`series`	series
`season`	season
`promotion`	promotion
`page_size`	integer
`page`	integer
`other`	other
`music`	music
`more_than`	integer
`master_brand`	master_brand
`image`	image
`highlight`	highlight
`gallery`	gallery
`franchise`	franchise
`episode`	episode
`contributor`	contributor
`collection`	collection
`clip`	clip
`chapter`	chapter
`broadcast`	broadcast
`brand`	brand
`availability`	availability

pagination pagination

pagination object

Properties

`previous`	previous
`next`	next

mixins mixins

mixins object

Properties

`unstable_mixins`	unstable_mixins
`mixin`	array [mixin]

filters filters

filters object

Properties

`unstable_filters`	unstable_filters
`filter`	array [filter]

deprecations deprecations

deprecations object

Properties

deprecated array [deprecated]

GET

/programmes

Fetch metadata about Programmes (brands, series, episodes, clips). By applying different filter restrictions this feed can be used in many ways, for example to retrieve all series belonging to a brand, all the episodes and/or clips for a specific series, or any TLEO objects for a masterbrand. Other filters permit restricting to specific formats and/or genres, and you can request specific versions (for example Signed or Audio-Described). Parameters may be combined in any way suitable for your application.

Request

Query

Name	Data Type	Description
`embargoed`	string Allowed values: - `include` - `exclude` - `only`	Control return of embargoed items (undocumented)
`version`	array	filter for subset of programmes with given PID as one of their versions
`tleo`	array	filter for subset of programmes that are TLEOs
`tag_scheme`	string	filter for subset of programmes with a tag
`tag_name`	string	filter for subset of programmes with tag
`signed`	array	filter for subset of programmes that are signed
`q`	string	filter for subset of programmes matching supplied keyword/phrase (boolean operators permitted)
`promoted_for`	string	filter for subset of programmes which are promoted for given service
`pid`	array	filter for subset of programmes having given PID
`people`	string Pattern: `^([0-9,a-d,f-h,j-n,p-t,v-z]){8,}$` Minimum: 8	filter for subset of programmes with contributions by given people PID
`payment_type`	array	filter for a subset of programmes that are of the given payment_type
`partner_pid`	array	filter for programmes by partner PID
`partner_id`	array	filter for programmes by partner ID
`page_size`	integer Default value: `10` Maximum: 300	number of results in each page
`page`	integer Default value: `1` Minimum: 1	which page of results to return
`media_type`	array	filter for subset of programmes with media type
`media_set`	string	filter for subset of programmes with media set
`master_brand`	array	filter for subset of programmes with master_brand
`item`	array	filter for subset of programmes with linked to versions which have the given item pids
`initial_letter_strict`	array	filter for subset of programmes with title beginning with initial letter
`initial_letter_start`	string Minimum: 1 Maximum: 1	Programmes with (librarian) titles whose initial letter is equal/after given letter. Use with initial_letter_end for range.
`initial_letter_end`	string Minimum: 1 Maximum: 1	Programmes with (librarian) titles whose initial letter is equal/before given letter. Use with initial_letter_start for a range
`initial_letter`	string Minimum: 1 Maximum: 1	filter for subset of programmes with title beginning with initial letter librarian style (ignoring leading 'The', 'An' (Welsh), etc) 0-9 a-z
`group`	string Pattern: `^([0-9,a-d,f-h,j-n,p-t,v-z]){8,}$` Minimum: 8	filter for subset of programmes which belong to the given group pid
`genre`	array	filter for subset of programmes with genre
`format`	array	filter for subset of programmes with format
`entity_type`	array	filter for subset of programmes that have given entity type
`duration`	array	filter for subset of programmes that have given duration
`descendants_of`	array	filter for subset of programmes that have PID as ancestor
`children_of`	array	filter for subset of programmes that have PID as immediate parent
`availability_type`	array	filter for a subset of programmes that are available for a given type
`availability_from` Deprecated	dateTime	filter for subset of programmes that are available after or at the specified datetime
`availability_entity_type`	array	additional filter when availability=available
`availability`	array	filter for subset of programmes that have availability
`audio_described`	array	filter for subset of programmes that are audio-described
`mixin`	array	Mixins: alternate_images: mixin to return the alternate images for a programme ancestor_titles: mixin to return ancestor programme titles availability: mixin to return programme availability information available_simulcasts: mixin to return information about programmes that are currently available as simulcasts available_versions: mixin to return information about programmes that are currently available on demand available_webcasts: mixin to return information about programmes that are currently available as webcasts contributions: mixin to return information about contributors to a programme duration: mixin to return original version duration in programme concept entities genre_groupings: mixin to return list of genre groupings genre_groups: mixin to return list of genre groups images: mixin to add image information for a programme is_embeddable: mixin to add embeddable information for a programme previous_next: mixin to return the programmes which appear before and after a programme (as determined by the sort applied in the request) programme_type: mixin to return the programme type related_links: mixin to return information about related links to a programme titles: mixin to return ancestor programme titles versions_availability: mixin to return information about programmes that are currently available
`sort_direction`	string Allowed values: - `ascending` - `descending`	Sort direction
`sort`	string Allowed values: - `group_position` - `pid` - `position` - `promotion` - `release_date` - `relevance` - `scheduled_start` - `strict_title` - `title` - `tree`	Sorts: group_position: sort numerically by position in group, ascending pid: sort alphabetically by PID, descending position: sort numerically by position, ascending promotion: sort by promotion rank, ascending release_date: sort chronologically by release date, descending relevance: sort by weighting of search term (use with q parameter) scheduled_start: sort chronologically by scheduled start time/date, ascending strict_title: sort alphabetically by title, ascending title: sort by title librarian style (ignoring leading 'The', 'A', etc), ascending tree: sort by root pid and then preorder tree sort. Requires entities to have release date.

Responses

200Unexpected error

Body

Name Data Type Description

ErrorModel

ErrorModel object

Properties

fault

200Nitro response

Body

Name Data Type Description

nitro

nitro

Properties

sorts sorts

sorts object

Properties

`unstable_sorts`	unstable_sorts
`sort`	array [sort]

results results

results object

Properties

`window`	window
`version_group`	version_group
`total`	integer
`speech`	speech
`service`	service
`series`	series
`season`	season
`promotion`	promotion
`page_size`	integer
`page`	integer
`other`	other
`music`	music
`more_than`	integer
`master_brand`	master_brand
`image`	image
`highlight`	highlight
`gallery`	gallery
`franchise`	franchise
`episode`	episode
`contributor`	contributor
`collection`	collection
`clip`	clip
`chapter`	chapter
`broadcast`	broadcast
`brand`	brand
`availability`	availability

pagination pagination

pagination object

Properties

`previous`	previous
`next`	next

mixins mixins

mixins object

Properties

`unstable_mixins`	unstable_mixins
`mixin`	array [mixin]

filters filters

filters object

Properties

`unstable_filters`	unstable_filters
`filter`	array [filter]

deprecations deprecations

deprecations object

Properties

deprecated array [deprecated]

GET

/promotions

Details of short-term editorially curated "promotions", for instance those programmes featured on iPlayer today

Request

Query

Name	Data Type	Description
`status`	array	filter for subset of promotions with status
`q`	string	filter for subset of promotions matching supplied keyword/phrase (boolean operators permitted)
`promoted_for`	array	filter for subset of promotions having given promoted for
`promoted_by`	array	filter for subset of promotions having given promoted by
`pid`	array	filter for subset of promotions having given PID
`partner_pid`	array	filter for promotions by partner PID
`partner_id`	array	filter for promotions by partner ID
`page_size`	integer Default value: `10` Maximum: 300	number of results in each page
`page`	integer Default value: `1` Minimum: 1	which page of results to return
`context`	string Pattern: `^([0-9,a-d,f-h,j-n,p-t,v-z]){8,}$` Minimum: 8	filter for subset of promotions belonging to a given context
`mixin`	array	Mixins: related_links: mixin to return information about related links to a promotion

Responses

200Unexpected error

Body

Name Data Type Description

ErrorModel

ErrorModel object

Properties

fault

200Nitro response

Body

Name Data Type Description

nitro

nitro

Properties

sorts sorts

sorts object

Properties

`unstable_sorts`	unstable_sorts
`sort`	array [sort]

results results

results object

Properties

`window`	window
`version_group`	version_group
`total`	integer
`speech`	speech
`service`	service
`series`	series
`season`	season
`promotion`	promotion
`page_size`	integer
`page`	integer
`other`	other
`music`	music
`more_than`	integer
`master_brand`	master_brand
`image`	image
`highlight`	highlight
`gallery`	gallery
`franchise`	franchise
`episode`	episode
`contributor`	contributor
`collection`	collection
`clip`	clip
`chapter`	chapter
`broadcast`	broadcast
`brand`	brand
`availability`	availability

pagination pagination

pagination object

Properties

`previous`	previous
`next`	next

mixins mixins

mixins object

Properties

`unstable_mixins`	unstable_mixins
`mixin`	array [mixin]

filters filters

filters object

Properties

`unstable_filters`	unstable_filters
`filter`	array [filter]

deprecations deprecations

deprecations object

Properties

deprecated array [deprecated]

GET

/schedules

Dates, Times, Schedules: when and where are programmes being shown?

Request

Query

Name	Data Type	Description
`version`	array	filter for subset of broadcasts and webcasts with given PID as their parent version
`start_to`	dateTime	filter for subset of broadcasts and webcasts that start on or earlier than the specified datetime
`start_from`	dateTime	filter for subset of broadcasts and webcasts that start on or later than the specified datetime
`sid`	array	filter for subset of broadcasts and webcasts that are on the specified linear service
`service_master_brand`	array	filter for subset of broadcasts and webcasts with given service master brand
`schedule_day_to`	date	filter for subset of broadcasts and webcasts that start on or before the specified day (BBC time)
`schedule_day_from`	date	filter for subset of broadcasts and webcasts that start on or after the specified day (BBC time)
`schedule_day`	date	filter for subset of broadcasts and webcasts that start on the specified day (BBC time)
`repeat`	boolean	filter to show either only repeats or non-repeats
`q`	string	filter for subset of broadcasts and webcasts matching supplied keyword/phrase (boolean operators permitted)
`pid`	array	filter for subset of broadcasts and webcasts having given PID
`people`	string	filter for subset of broadcasts and webcasts that have given contributor
`partner_pid`	array	filter for broadcasts and webcasts by partner PID
`partner_id`	array	filter for broadcasts and webcasts by partner ID
`page_size`	integer Default value: `10` Maximum: 300	number of results in each page
`page`	integer Default value: `1` Minimum: 1	which page of results to return
`item`	array	filter for subset of broadcasts and webcasts with the given item performed on it
`id_type`	array	filter for subset of broadcasts and webcasts that have given id type
`id`	array	filter for subset of broadcasts and webcasts that have given identifier
`group`	string Pattern: `^([0-9,a-d,f-h,j-n,p-t,v-z]){8,}$` Minimum: 8	filter for subset of broadcasts and webcasts that have programmes in the given group
`genre`	array	filter for subset of broadcasts and webcasts that are classified in the given genre ID
`format`	array	filter for subset of broadcasts and webcasts that are classified in the given format ID
`end_to`	dateTime	filter for subset of broadcasts and webcasts that end on or earlier than the specified datetime
`end_from`	dateTime	filter for subset of broadcasts and webcasts that end on or later than the specified datetime
`descendants_of`	array	filter for subset of broadcasts and webcasts that are descendants of the given programme PID
`authority`	array	filter for subset of broadcasts and webcasts that have given authority
`mixin`	array	Mixins: ancestor_titles: return ancestor programme titles images: mixin to add image information for broadcasts and webcasts titles: return ancestor programme titles
`sort_direction`	string Allowed values: - `ascending` - `descending`	Sort direction
`sort`	string Allowed values: - `start_date`	Sorts: start_date: sort chronologically by scheduled start time/date, ascending

Responses

200Unexpected error

Body

Name Data Type Description

ErrorModel

ErrorModel object

Properties

fault

200Nitro response

Body

Name Data Type Description

nitro

nitro

Properties

sorts sorts

sorts object

Properties

`unstable_sorts`	unstable_sorts
`sort`	array [sort]

results results

results object

Properties

`window`	window
`version_group`	version_group
`total`	integer
`speech`	speech
`service`	service
`series`	series
`season`	season
`promotion`	promotion
`page_size`	integer
`page`	integer
`other`	other
`music`	music
`more_than`	integer
`master_brand`	master_brand
`image`	image
`highlight`	highlight
`gallery`	gallery
`franchise`	franchise
`episode`	episode
`contributor`	contributor
`collection`	collection
`clip`	clip
`chapter`	chapter
`broadcast`	broadcast
`brand`	brand
`availability`	availability

pagination pagination

pagination object

Properties

`previous`	previous
`next`	next

mixins mixins

mixins object

Properties

`unstable_mixins`	unstable_mixins
`mixin`	array [mixin]

filters filters

filters object

Properties

`unstable_filters`	unstable_filters
`filter`	array [filter]

deprecations deprecations

deprecations object

Properties

deprecated array [deprecated]

GET

/services

The services feed exposes the linear broadcast "services" from PIPs. These are the actual services which broadcast programmes (eg bbc_one_oxford is the service for BBC One in Oxford).

Request

Query

Name	Data Type	Description
`start_to`	dateTime	Return services that start earlier than the specified datetime
`start_from`	dateTime	Return services that start on or later than the specified datetime
`sid`	array	filter for specified linear service
`service_type`	array	filter for specified type of linear services
`q`	string	filter for subset of services matching supplied keyword/phrase (boolean operators permitted)
`partner_pid`	array	filter for services by partner PID
`partner_id`	array	filter for services by partner ID
`page_size`	integer Default value: `10` Maximum: 300	number of results in each page
`page`	integer Default value: `1` Minimum: 1	which page of results to return
`mid`	array	filter for services by masterbrand MID
`end_to`	dateTime	filter for subset of broadcasts that end on or earlier than the specified datetime
`end_from`	dateTime	Return services that end on or later than the specified datetime

Responses

200Unexpected error

Body

Name Data Type Description

ErrorModel

ErrorModel object

Properties

fault

200Nitro response

Body

Name Data Type Description

nitro

nitro

Properties

sorts sorts

sorts object

Properties

`unstable_sorts`	unstable_sorts
`sort`	array [sort]

results results

results object

Properties

`window`	window
`version_group`	version_group
`total`	integer
`speech`	speech
`service`	service
`series`	series
`season`	season
`promotion`	promotion
`page_size`	integer
`page`	integer
`other`	other
`music`	music
`more_than`	integer
`master_brand`	master_brand
`image`	image
`highlight`	highlight
`gallery`	gallery
`franchise`	franchise
`episode`	episode
`contributor`	contributor
`collection`	collection
`clip`	clip
`chapter`	chapter
`broadcast`	broadcast
`brand`	brand
`availability`	availability

pagination pagination

pagination object

Properties

`previous`	previous
`next`	next

mixins mixins

mixins object

Properties

`unstable_mixins`	unstable_mixins
`mixin`	array [mixin]

filters filters

filters object

Properties

`unstable_filters`	unstable_filters
`filter`	array [filter]

deprecations deprecations

deprecations object

Properties

deprecated array [deprecated]

GET

/versions

The versions feed exposes editorial "Versions" of programmes. These are concepts used to capture different presentations of an overall programme: for example, versions of a programme may include one with sign language, one with audio description, one edited for content and more. Versions are also important to understand for broadcasts: a linear broadcast or an ondemand is always of a specific version, not merely of a programme.

Request

Query

Name	Data Type	Description
`embargoed`	string Allowed values: - `include` - `exclude` - `only`	Control return of embargoed items (undocumented)
`pid`	array	filter for subset of versions having given PID
`payment_type`	array	filter for a subset of versions that are of the given payment_type
`partner_pid`	array	filter for versions by partner PID
`partner_id`	array	filter for versions by partner ID
`page_size`	integer Default value: `10` Maximum: 300	number of results in each page
`page`	integer Default value: `1` Minimum: 1	which page of results to return
`media_set`	array	filter for subset of versions with availability in the given media set
`descendants_of`	array	filter for subset of versions having given programme PID
`availability`	array	filter for subset of versions that have availability

Responses

200Unexpected error

Body

Name Data Type Description

ErrorModel

ErrorModel object

Properties

fault

200Nitro response

Body

Name Data Type Description

nitro

nitro

Properties

sorts sorts

sorts object

Properties

`unstable_sorts`	unstable_sorts
`sort`	array [sort]

results results

results object

Properties

`window`	window
`version_group`	version_group
`total`	integer
`speech`	speech
`service`	service
`series`	series
`season`	season
`promotion`	promotion
`page_size`	integer
`page`	integer
`other`	other
`music`	music
`more_than`	integer
`master_brand`	master_brand
`image`	image
`highlight`	highlight
`gallery`	gallery
`franchise`	franchise
`episode`	episode
`contributor`	contributor
`collection`	collection
`clip`	clip
`chapter`	chapter
`broadcast`	broadcast
`brand`	brand
`availability`	availability

pagination pagination

pagination object

Properties

`previous`	previous
`next`	next

mixins mixins

mixins object

Properties

`unstable_mixins`	unstable_mixins
`mixin`	array [mixin]

filters filters

filters object

Properties

`unstable_filters`	unstable_filters
`filter`	array [filter]

deprecations deprecations

deprecations object

Properties

deprecated array [deprecated]

schema

Nitro metadata

GET

/schema

Models

ErrorModel

accurate_programme_time

accurate_time

Name Data Type Description

accurate_time broadcastTime

broadcastTime object

Properties

`start`	dateTime
`end`	dateTime
`duration`	string Pattern: `^(-)?P(?:([0-9,.])Y)?(?:([0-9,.])M)?(?:([0-9,.])W)?(?:([0-9,.])D)?(?:T(?:([0-9,.])H)?(?:([0-9,.])M)?(?:([0-9,.]*)S)?)?$`

Extends

dateRange

Properties

Name	Data Type	Description
`start`	dateTime
`end`	dateTime

actual_start

advertising_allowed

affected_by

alternate_images_mixin

ancestor_titles

ancestors

Name Data Type Description

ancestors reference

reference object

Properties

`result_type`	string
`href`	string
`result_type_deprecated`	boolean
`href_deprecated`	boolean

Extends

referenceAttributes

Properties

Name	Data Type	Description
`result_type`	string
`href`	string

ancestors_titles

availability

Properties

Name Data Type Description

status status

status string

scheduled_time scheduled_time

scheduled_time object

Properties

`start`	dateTime
`end`	dateTime

revocation_status revocation_status

revocation_status string

media_set array [media_set]

media_set string

media_availability_time media_availability_time

media_availability_time dateRange

dateRange object

Properties

`start`	dateTime
`end`	dateTime

availability_type availability_type

availability_type Allowed values:
- ondemand
- simulcast
- webcast

availability_of array [availability_of]

availability_of object

Properties

type string

result_type string

pid pid

pid string
Pattern: ([a-z0-9\.\-]+|.*PID.*)

href string

availability-debug availability-debug

availability-debug object

Properties

territory string

service serviceReference

serviceReference object

Properties

`sid`	string
`result_type`	string
`href`	string

media_profile_groups media_profile_groups

media_profile_groups object

Properties

media_profile_group array [media_profile_group]

media_profile_group object

Properties

`transport`	string
`territory`	string
`platform`	string
`pid`	pid
`context`	string
`text`	string

availability_of pidReference

pidReference object

Properties

result_type string

position integer

pid pid

pid string
Pattern: ([a-z0-9\.\-]+|.*PID.*)

href string

actual_start actual_start

actual_start dateTime

accurate_programme_time accurate_programme_time

accurate_programme_time dateRange

dateRange object

Properties

`start`	dateTime
`end`	dateTime

availability-debug

Properties

Name Data Type Description

territory string

service serviceReference

serviceReference object

Properties

`sid`	string
`result_type`	string
`href`	string

media_profile_groups media_profile_groups

media_profile_groups object

Properties

media_profile_group array [media_profile_group]

media_profile_group object

Properties

transport string

territory string

platform string

pid pid

pid string
Pattern: ([a-z0-9\.\-]+|.*PID.*)

context string

text string

availability_of pidReference

pidReference object

Properties

result_type string

position integer

pid pid

pid string
Pattern: ([a-z0-9\.\-]+|.*PID.*)

href string

availability_mixin

availability_of

availability_type

available_media_sets

available_mixins

available_simulcasts

available_versions

available_versions_element

available_versions_media_sets

available_webcasts

brand

Properties

Name Data Type Description

uri uri

uri string

updated_time updated_time

updated_time dateTime

title title

title string

synopses synopses

synopses object

Properties

short short

short string

medium medium

medium string

long long

long string

release_date_group release_date_group

release_date_group object

Properties

`release_year_month`	string Pattern: `[0-9]{4}-[0-9]{2}`
`release_year`	string Pattern: `[0-9]{4}`
`release_date`	string Pattern: `^[0-9]{4}-[0-9]{2}-[0-9]{2}.*$`

related_links related_links

related_links object

Properties

related_link array [related_link]

related_link object

Properties

uri uri

uri string

type type

type string

title title

title string

synopses synopses

synopses object

Properties

`short`	short
`medium`	medium
`long`	long

position position

position integer

pid pid

pid string
Pattern: ([a-z0-9\.\-]+|.*PID.*)

is_external is_external

is_external boolean

availability

programme_type programme_type

programme_type object

Properties

value string

programme_formats programme_formats

programme_formats object

Properties

format array [format]

format object

Properties

`format_id`	string
`text`	string

previous_next_mixin previous_next_mixin

previous_next_mixin object

Properties

previous_next

pid pid

pid string
Pattern: ([a-z0-9\.\-]+|.*PID.*)

partner partner

partner pid

pid string
Pattern: ([a-z0-9\.\-]+|.*PID.*)

master_brand_link master_brand_link

master_brand_link object

Properties

master_brand

items_for items_for

items_for reference

reference object

Properties

`result_type`	string
`href`	string
`result_type_deprecated`	boolean
`href_deprecated`	boolean

Extends

referenceAttributes

Properties

Name	Data Type	Description
`result_type`	string
`href`	string

is_embeddable is_embeddable

is_embeddable boolean

images_mixin images_mixin

images_mixin object

Properties

images

image_link image_link

image_link object

Properties

image object

identifiers identifiers

identifiers object

Properties

identifier array [identifier]

identifier object

Properties

`type`	string
`authority`	string
`text`	string

genre_groupings genre_groupings

genre_groupings genreGroupingsType

genreGroupingsType object

Properties

genre_group array [genre_group]

genre_group object

Properties

`type`	string
`id`	string
`genres`

franchises franchises

franchises reference

reference object

Properties

`result_type`	string
`href`	string
`result_type_deprecated`	boolean
`href_deprecated`	boolean

Extends

referenceAttributes

Properties

Name	Data Type	Description
`result_type`	string
`href`	string

expected_child_count expected_child_count

expected_child_count integer

embargoed embargoed

embargoed Allowed values:
- true
- false