7.0.0 • Published 5 years ago

@datafire/bbc v7.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

@datafire/bbc

Client library for BBC Nitro API

Installation and Usage

npm install --save @datafire/bbc
let bbc = require('@datafire/bbc').create({
  api_key: ""
});

.then(data => {
  console.log(data);
});

Description

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

Actions

getAPI

Get API definition

bbc.getAPI(null, context)

Input

This action has no parameters

Output

Output schema unknown

listAvailability

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

bbc.listAvailability({}, context)

Input

  • input object
    • sort string (values: scheduled_start): Sorts:
    • sort_direction string (values: ascending, descending): Sort direction
    • availability array: filter for subset of availabilities
    • descendants_of array: filter for subset of availabilities that have PID as ancestor
    • media_set array: filter for subset of availabilities with media set
    • page integer: which page of results to return
    • page_size integer: number of results in each page
    • territory array: filter for availabilities in given territory
    • debug boolean: Turn on debug information (undocumented)

Output

listBroadcasts

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.

bbc.listBroadcasts({}, context)

Input

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

Output

listGroups

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

bbc.listGroups({}, context)

Input

  • input object
    • sort string (values: pid): Sorts:
    • sort_direction string (values: descending): Sort direction
    • mixin array: Mixins:
    • for_descendants_of string: filter for groups related to given programme or its descendants
    • for_programme string: filter for subset of groups directly related to a given programme
    • group string: filter for subset of groups which belong to the given group pid
    • group_type array: filter for subset of groups that have the given group type
    • member string: filter for subset of groups which contain an entity with the given pid as a member
    • page integer: which page of results to return
    • page_size integer: number of results in each page
    • partner_id array: filter for groups by partner ID
    • partner_pid array: filter for groups by partner PID
    • pid array: filter for subset of seasons, collections, galleries or franchises having given PID
    • q string: filter for subset of groups matching supplied keyword/phrase (boolean operators permitted)
    • embargoed string (values: include, exclude, only): Control return of embargoed items (undocumented)

Output

listImages

Find metadata for images, particularly those in galleries

bbc.listImages({}, context)

Input

  • input object
    • sort string (values: group_position, pid): Sorts:
    • sort_direction string (values: ascending, descending): Sort direction
    • group string: filter for images belonging to the given group (i.e. Gallery)
    • image_type array: filter for images by type
    • is_alternate_image_for string: filter for alternate images by entity PID
    • is_image_for string: filter for images by entity PID
    • page integer: which page of results to return
    • page_size integer: number of results in each page
    • partner_id array: filter for images by partner ID
    • partner_pid array: filter for images by partner PID
    • pid array: filter for subset of images having given PID
    • q string: filter for subset of images matching supplied keyword/phrase (boolean operators permitted)
    • embargoed string (values: include, exclude, only): Control return of embargoed items (undocumented)

Output

listItems

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

bbc.listItems({}, context)

Input

  • input object
    • sort string (values: pid): Sorts:
    • sort_direction string (values: descending): Sort direction
    • mixin array: Mixins:
    • authority string: filter for subset of items that have an ID issued by the given authority
    • id array: filter for subset of items having given ID
    • id_type string: filter for subset of items that have given an ID of the given type
    • item_type array: filter for specific type(s) of items
    • page integer: which page of results to return
    • page_size integer: number of results in each page
    • partner_id array: filter for items by partner ID
    • partner_pid array: filter for items by partner PID
    • people string: filter for subset of items that have specified person involved
    • pid array: filter for subset of items matching one of the given PIDs
    • programme string: filter for subset of items that are part of the given programme
    • q string: filter for subset of items matching supplied keyword/phrase (boolean operators permitted)
    • segment_event string: filter for item with the given segment_event

Output

listMasterbrands

List all Master Brands

bbc.listMasterbrands({}, context)

Input

  • input object
    • sort string (values: mid): Sorts:
    • sort_direction string (values: ascending): Sort direction
    • mixin array: Mixins:
    • mid array: filter for subset of masterbrands that have given identifier
    • page integer: which page of results to return
    • page_size integer: number of results in each page
    • partner_id array: filter for masterbrands by partner ID
    • partner_pid array: filter for masterbrands by partner PID
    • q string: filter for subset of masterbrands matching supplied keyword/phrase (boolean operators permitted)

Output

listPeople

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)

bbc.listPeople({}, context)

Input

  • input object
    • authority string: filter for subset of people that have an ID issued by the given authority
    • has_external_id array: filter for people who have an external identifier
    • id array: filter for subset of people having given ID
    • id_type string: filter for subset of people that have given an ID of the given type
    • page integer: which page of results to return
    • page_size integer: number of results in each page
    • partner_id array: filter for people by partner ID
    • partner_pid array: filter for people by partner PID
    • pid array: filter for subset of people having given PID
    • programme string: filter for subset of people that have contributed to the given programme pid
    • q string: filter for subset of people matching supplied keyword/phrase (boolean operators permitted)

Output

listPips

Look inside pips entities

bbc.listPips({}, context)

Input

  • input object
    • page integer: which page of results to return
    • page_size integer: number of results in each page
    • q string: filter for subset of programmes matching supplied keyword/phrase (boolean operators permitted)

Output

listProgrammeDetails

Exposes programme information for a single pid

bbc.listProgrammeDetails({}, context)

Input

  • input object
    • page integer: which page of results to return
    • page_size integer: number of results in each page
    • partner_pid string: Filter for programme information by partner PID
    • pid string: Filter for programme information for the provided PID

Output

listProgrammes

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.

bbc.listProgrammes({}, context)

Input

  • input object
    • sort string (values: group_position, pid, position, promotion, release_date, relevance, scheduled_start, strict_title, title, tree): Sorts:
    • sort_direction string (values: ascending, descending): Sort direction
    • mixin array: Mixins:
    • audio_described array: filter for subset of programmes that are audio-described
    • availability array: filter for subset of programmes that have availability
    • availability_entity_type array: additional filter when availability=available
    • availability_from string: filter for subset of programmes that are available after or at the specified datetime
    • availability_type array: filter for a subset of programmes that are available for a given type
    • children_of array: filter for subset of programmes that have PID as immediate parent
    • descendants_of array: filter for subset of programmes that have PID as ancestor
    • duration array: filter for subset of programmes that have given duration
    • entity_type array: filter for subset of programmes that have given entity type
    • format array: filter for subset of programmes with format
    • genre array: filter for subset of programmes with genre
    • group string: filter for subset of programmes which belong to the given group pid
    • initial_letter string: filter for subset of programmes with title beginning with initial letter librarian style (ignoring leading 'The', 'An' (Welsh), etc) 0-9 a-z
    • initial_letter_end string: Programmes with (librarian) titles whose initial letter is equal/before given letter. Use with initial_letter_start for a range
    • initial_letter_start string: Programmes with (librarian) titles whose initial letter is equal/after given letter. Use with initial_letter_end for range.
    • initial_letter_strict array: filter for subset of programmes with title beginning with initial letter
    • item array: filter for subset of programmes with linked to versions which have the given item pids
    • master_brand array: filter for subset of programmes with master_brand
    • media_set string: filter for subset of programmes with media set
    • media_type array: filter for subset of programmes with media type
    • page integer: which page of results to return
    • page_size integer: number of results in each page
    • partner_id array: filter for programmes by partner ID
    • partner_pid array: filter for programmes by partner PID
    • payment_type array: filter for a subset of programmes that are of the given payment_type
    • people string: filter for subset of programmes with contributions by given people PID
    • pid array: filter for subset of programmes having given PID
    • promoted_for string: filter for subset of programmes which are promoted for given service
    • q string: filter for subset of programmes matching supplied keyword/phrase (boolean operators permitted)
    • signed array: filter for subset of programmes that are signed
    • tag_name string: filter for subset of programmes with tag
    • tag_scheme string: filter for subset of programmes with a tag
    • tleo array: filter for subset of programmes that are TLEOs
    • version array: filter for subset of programmes with given PID as one of their versions
    • embargoed string (values: include, exclude, only): Control return of embargoed items (undocumented)

Output

listPromotions

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

bbc.listPromotions({}, context)

Input

  • input object
    • mixin array: Mixins:
    • context string: filter for subset of promotions belonging to a given context
    • page integer: which page of results to return
    • page_size integer: number of results in each page
    • partner_id array: filter for promotions by partner ID
    • partner_pid array: filter for promotions by partner PID
    • pid array: filter for subset of promotions having given PID
    • promoted_by array: filter for subset of promotions having given promoted by
    • promoted_for array: filter for subset of promotions having given promoted for
    • q string: filter for subset of promotions matching supplied keyword/phrase (boolean operators permitted)
    • status array: filter for subset of promotions with status

Output

listSchedules

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

bbc.listSchedules({}, context)

Input

  • input object
    • sort string (values: start_date): Sorts:
    • sort_direction string (values: ascending, descending): Sort direction
    • mixin array: Mixins:
    • authority array: filter for subset of broadcasts and webcasts that have given authority
    • descendants_of array: filter for subset of broadcasts and webcasts that are descendants of the given programme PID
    • end_from string: filter for subset of broadcasts and webcasts that end on or later than the specified datetime
    • end_to string: filter for subset of broadcasts and webcasts that end on or earlier than the specified datetime
    • format array: filter for subset of broadcasts and webcasts that are classified in the given format ID
    • genre array: filter for subset of broadcasts and webcasts that are classified in the given genre ID
    • group string: filter for subset of broadcasts and webcasts that have programmes in the given group
    • id array: filter for subset of broadcasts and webcasts that have given identifier
    • id_type array: filter for subset of broadcasts and webcasts that have given id type
    • item array: filter for subset of broadcasts and webcasts with the given item performed on it
    • page integer: which page of results to return
    • page_size integer: number of results in each page
    • partner_id array: filter for broadcasts and webcasts by partner ID
    • partner_pid array: filter for broadcasts and webcasts by partner PID
    • people string: filter for subset of broadcasts and webcasts that have given contributor
    • pid array: filter for subset of broadcasts and webcasts having given PID
    • q string: filter for subset of broadcasts and webcasts matching supplied keyword/phrase (boolean operators permitted)
    • repeat boolean: filter to show either only repeats or non-repeats
    • schedule_day string: filter for subset of broadcasts and webcasts that start on the specified day (BBC time)
    • schedule_day_from string: filter for subset of broadcasts and webcasts that start on or after the specified day (BBC time)
    • schedule_day_to string: filter for subset of broadcasts and webcasts that start on or before the specified day (BBC time)
    • service_master_brand array: filter for subset of broadcasts and webcasts with given service master brand
    • sid array: filter for subset of broadcasts and webcasts that are on the specified linear service
    • start_from string: filter for subset of broadcasts and webcasts that start on or later than the specified datetime
    • start_to string: filter for subset of broadcasts and webcasts that start on or earlier than the specified datetime
    • version array: filter for subset of broadcasts and webcasts with given PID as their parent version

Output

getXSD

Get Schema definition

bbc.getXSD(null, context)

Input

This action has no parameters

Output

Output schema unknown

listServices

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

bbc.listServices({}, context)

Input

  • input object
    • end_from string: Return services that end on or later than the specified datetime
    • end_to string: filter for subset of broadcasts that end on or earlier than the specified datetime
    • mid array: filter for services by masterbrand MID
    • page integer: which page of results to return
    • page_size integer: number of results in each page
    • partner_id array: filter for services by partner ID
    • partner_pid array: filter for services by partner PID
    • q string: filter for subset of services matching supplied keyword/phrase (boolean operators permitted)
    • service_type array: filter for specified type of linear services
    • sid array: filter for specified linear service
    • start_from string: Return services that start on or later than the specified datetime
    • start_to string: Return services that start earlier than the specified datetime

Output

Get_Raw_brand

Get raw brand

bbc.Get_Raw_brand({
  "pid": ""
}, context)

Input

  • input object
    • pid required string

Output

v1.brands.pid.franchises.get

Get raw brand franchises

bbc.v1.brands.pid.franchises.get({
  "pid": ""
}, context)

Input

  • input object
    • pid required string

Output

Get_Raw_episode

Get raw episode

bbc.Get_Raw_episode({
  "pid": ""
}, context)

Input

  • input object
    • pid required string

Output

Get_Raw_ancestors

Get raw ancestors

bbc.Get_Raw_ancestors({
  "pid": ""
}, context)

Input

  • input object
    • pid required string

Output

Get_Raw_formats

Get raw formats

bbc.Get_Raw_formats({
  "pid": ""
}, context)

Input

  • input object
    • pid required string

Output

Get_Raw_genre_groups

Get raw genre groups

bbc.Get_Raw_genre_groups({
  "pid": ""
}, context)

Input

  • input object
    • pid required string

Output

Get_Raw_image

Get raw image

bbc.Get_Raw_image({
  "pid": ""
}, context)

Input

  • input object
    • pid required string

Output

Get_Raw_masterbrand

Get raw masterbrand

bbc.Get_Raw_masterbrand({
  "mbid": ""
}, context)

Input

  • input object
    • mbid required string

Output

Get_Raw_promotion

Get raw promotion

bbc.Get_Raw_promotion({
  "pid": ""
}, context)

Input

  • input object
    • pid required string

Output

listVersions

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.

bbc.listVersions({}, context)

Input

  • input object
    • availability array: filter for subset of versions that have availability
    • descendants_of array: filter for subset of versions having given programme PID
    • media_set array: filter for subset of versions with availability in the given media set
    • page integer: which page of results to return
    • page_size integer: number of results in each page
    • partner_id array: filter for versions by partner ID
    • partner_pid array: filter for versions by partner PID
    • payment_type array: filter for a subset of versions that are of the given payment_type
    • pid array: filter for subset of versions having given PID
    • embargoed string (values: include, exclude, only): Control return of embargoed items (undocumented)

Output

Definitions

ErrorModel

  • ErrorModel object
    • fault object
      • detail object
        • errorcode string
      • faultString string

accurate_programme_time

accurate_time

actual_start

  • actual_start string

advertising_allowed

  • advertising_allowed string

affected_by

  • affected_by object
    • filter array
      • items object
        • description required string
        • filter array
          • items object
            • description required string
            • name required string
        • name required string

alternate_images_mixin

  • alternate_images_mixin object
    • alternate_images required object
      • alternate_image array
        • items object
          • alternate_images required object
            • alternate_image array
          • href string
          • template_url required string
          • type string

ancestor_titles

ancestors

ancestors_titles

availability

availability-debug

availability_mixin

  • availability_mixin object
    • availability array
      • items object
        • status required status
        • version_types required object
          • version_type required array
            • items object

availability_of

  • availability_of object
    • href required string
    • pid required pid
    • result_type required string
    • type string

availability_type

  • availability_type string (values: ondemand, simulcast, webcast)

available_media_sets

  • available_media_sets object
    • media_sets object
      • media_set required array
        • items object
          • #text string
          • media_sets object
            • media_set required array

available_mixins

  • available_mixins object
    • availabilities required object
      • availabilities required object
        • availability required array
          • items object
            • accurate_end string
            • accurate_start string
            • available_versions_media_sets required available_versions_media_sets
            • media_availability_end string
            • media_availability_start string
            • payment_type string
            • scheduled_end string
            • scheduled_start string
            • status string
            • type string
        • type string
      • availability required array
        • items object
          • accurate_end string
          • accurate_start string
          • available_versions_media_sets required available_versions_media_sets
          • media_availability_end string
          • media_availability_start string
          • payment_type string
          • scheduled_end string
          • scheduled_start string
          • status string
          • type string
      • type string

available_simulcasts

available_versions

available_versions_element

  • available_versions_element object

available_versions_media_sets

  • available_versions_media_sets object
    • media_sets object
      • media_set required array
        • items object
          • actual_start string
          • name required string
          • territories object
            • media_sets object
            • territory array

available_webcasts

brand

broadcast

broadcastTime

  • broadcastTime
    • end string
    • start string
    • duration string

broadcast_of

broadcaster

  • broadcaster object
    • href required string
    • result_type required string
    • sid required sid

caption

  • caption string

catalogue_number

  • catalogue_number string

chapter

clip

clip_of

code

  • code string

collection

competition_warning

  • competition_warning boolean

containers_title

  • containers_title string

context

  • context object
    • cascades_to_descendants boolean
    • href string
    • pid required pid
    • result_type required string

contributions_mixin

contributions_mixin_contribution

  • contributions_mixin_contribution object

contributions_mixin_contributor

contributions_mixin_contributor_name

  • contributions_mixin_contributor_name object
    • name required object
      • family string
      • given string
      • name required object
        • family string
        • given string
        • presentation string
        • title string
      • presentation string
      • title string

contributor

contributor_name

  • contributor_name object
    • name required object
      • family string
      • given string
      • lang string
      • name required object
        • family string
        • given string
        • lang string
        • presentation string
        • title string
      • presentation string
      • title string

contributor_to

  • contributor_to object
    • href required string
    • result_type required string

credits_time

  • credits_time object
    • squeeze_end string
    • squeeze_start string

data

dateRange

  • dateRange object
    • end string
    • start string

date_range

datum

  • datum string

dependency_on

  • dependency_on object
    • filter string
    • value string

deprecated

  • deprecated object
    • deprecated_since required string
    • name required string
    • replaced_by string
    • replacement_type string
    • type required string

deprecatedReferenceElement

  • deprecatedReferenceElement
    • href required string
    • result_type required string
    • deprecated required boolean
    • deprecated_since required string
    • replaced_by required string

deprecationAttributes

  • deprecationAttributes object
    • deprecated required boolean
    • deprecated_since required string
    • replaced_by required string

deprecations

  • deprecations object

description

  • description string

dimensions

  • dimensions object
    • height integer
    • width integer

disambiguation

  • disambiguation string

embargoed

  • embargoed string (values: true, false)

end

  • end string

end_time

  • end_time string

episode

episode_of

error

error-name

  • error-name string

errors

expected_child_count

  • expected_child_count integer

expr

  • expr string

feed

feeds

filter

  • filter object
    • default string
    • depends_on string
    • deprecated boolean
    • deprecated_since string
    • guaranteed_until string
    • max_value integer
    • min_value integer
    • multiple_values boolean
    • name required string
    • option array
    • prefer string
    • prohibits array
    • release_status release_status_type
    • replaced_by string
    • required boolean
    • title required string
    • type required string

filters

focus_point

  • focus_point object
    • x integer
    • y integer

for_programme

  • for_programme object
    • href string

for_programmes

format

  • format object
    • #text string
    • format_id string

format-string

  • format-string string

franchise

franchises

gallery

genre

  • genre object
    • #text string
    • id string
    • type string

genreGroupingsType

  • genreGroupingsType object

genreGroupsType

  • genreGroupsType
    • href required string
    • result_type required string
    • deprecated required boolean
    • deprecated_since required string
    • replaced_by required string
    • genre_group array

genre_group

  • genre_group object
    • genres required object
    • id string
    • type string

genre_groupings

genre_groups

group-body

guidance_warnings

has_guidance

  • has_guidance boolean

highlight

id

  • id object
    • #text string
    • authority string
    • type string

identifier

  • identifier object
    • #text string
    • authority string
    • type string

identifiers

  • identifiers object

ids

  • ids object
    • id required array

image

image_link

  • image_link object
    • image required object

images_mixin

  • images_mixin object
    • images required object
      • image object
        • href string
        • images required object
          • image object
            • href string
            • inherited_from object
            • template_url required string
            • type string
        • inherited_from object
          • href string
          • result_type string
        • template_url required string
        • type string

is_audio_described

  • is_audio_described boolean

is_blanked

  • is_blanked boolean

is_concrete

  • is_concrete boolean

is_critical

  • is_critical boolean

is_downloadable

  • is_downloadable boolean

is_embeddable

  • is_embeddable boolean

is_external

  • is_external boolean

is_repeat

  • is_repeat boolean

is_signed

  • is_signed boolean

is_simulcast

  • is_simulcast boolean

is_stacked

  • is_stacked boolean

is_streamable

  • is_streamable boolean

item

item_of

items_for

long

  • long string

master_brand

master_brand_link

  • master_brand_link object
    • master_brand required object
      • href required string
      • master_brand required object
        • href required string
        • mid required mid
        • result_type required string
      • mid required mid
      • result_type required string

media_availability_time

media_profile_group

  • media_profile_group object
    • #text string
    • context string
    • pid pid
    • platform string
    • territory string
    • transport string

media_profile_groups

media_set

  • media_set string

media_type

  • media_type string (values: Video, Audio)

medium

  • medium string

message

  • message string

mid

  • mid string

mixin

  • mixin object
    • affected_by array
    • dependency_on array
    • depends_on string
    • deprecated boolean
    • deprecated_since string
    • guaranteed_until string
    • href string
    • name required string
    • prohibits array
    • release_status release_status_type
    • replaced_by string
    • title required string

mixins

music

music_code

  • music_code string

name

  • name string

next

  • next object
    • href required string

nitro

offset_in

  • offset_in object
    • href required string
    • offset integer
    • position number
    • programme required pid
    • version required pid

offsets

option

  • option object

original_version_duration

  • original_version_duration object
    • version object
      • duration string
      • href required string
      • pid required pid
      • version object
        • duration string
        • href required string
        • pid required pid

other

pagination

partner

pid

  • pid string

pidReference

  • pidReference object
    • href string
    • pid required pid
    • position integer
    • result_type required string

play_event

  • play_event object

play_events

  • play_events object

played_in_links

  • played_in_links object
    • played_in object
      • href string
      • played_in object
        • href string
        • result_type string
      • result_type string

position

  • position integer

presentation_title

  • presentation_title string

previous

  • previous object
    • href required string

previous_next_mixin

priority

  • priority integer

programme_formats

  • programme_formats object
    • format required array

programme_type

  • programme_type object
    • value required string

prohibits

  • prohibits object
    • filter array
      • items object
        • name required string
    • mixin array
      • items object
        • filter array
          • items object
            • name required string
        • mixin array
          • items object
            • name required string
        • name required string

promoted_by

  • promoted_by string

promoted_for

  • promoted_for string

promotion

promotion_of

publication_rights

  • publication_rights object
    • #text string
    • context string
    • platform string
    • territory string
    • transport string

published_time

publisher

  • publisher string

record_label

  • record_label string

recording_date

  • recording_date string

reference

  • reference
    • href required string
    • result_type required string
    • href_deprecated boolean
    • result_type_deprecated boolean

referenceAttributes

  • referenceAttributes object
    • href required string
    • result_type required string

region

  • region string

related_link

related_links

release_date_group

  • release_date_group object
    • release_date string
    • release_year string
    • release_year_month string

release_status_type

  • release_status_type string (values: alpha, beta, supported, deprecated)

release_title

  • release_title string

results

retryable

  • retryable boolean

revocation_status

  • revocation_status string

schedule_date

  • schedule_date string

scheduled

  • scheduled object
    • end string
    • start string

scheduled_publication_rights

scheduled_time

  • scheduled_time object
    • end string
    • start string

season

series

series_of

service

serviceReference

  • serviceReference object
    • href required string
    • result_type required string
    • sid required string

short

  • short string

sid

  • sid string

size

  • size object
    • units string

snippet_url

  • snippet_url string

sort

  • sort object
    • deprecated boolean
    • deprecated_since string
    • guaranteed_until string
    • is_default string
    • name required string
    • release_status release_status_type
    • replaced_by string
    • sort_direction array
    • title required string

sort_direction

  • sort_direction object
    • href required string
    • is_default required string
    • name required string
    • value required string

sorts

source_asset

source_media

  • source_media string

speech

start_time

  • start_time string

status

  • status string

synopses

title

  • title string

track_number

  • track_number string

track_side

  • track_side string

tx_time

  • tx_time object
    • credits_showing string
    • end string
    • start string

type

  • type string

types_with_id

  • types_with_id object
    • types required object
      • type required array
        • items object
          • id string
          • types required object
            • type required array

unstable_filters

  • unstable_filters object

unstable_mixins

  • unstable_mixins object

unstable_sorts

  • unstable_sorts object
    • sort array

updated_time

  • updated_time string

uri

  • uri string

url

  • url string

url_key

  • url_key string

version_availability

  • version_availability object
    • availability required object
      • availability required object
        • availability_end string
        • availability_start string
        • available_media_sets required available_media_sets
        • status string
      • availability_end string
      • availability_start string
      • available_media_sets required available_media_sets
      • status string

version_availability_mixin

  • version_availability_mixin object
    • version array
      • items object
        • availabilities array
          • items object
            • version_availability required array
        • competition_warning string
        • duration string
        • guidance_warnings guidance_warnings
        • pid pid
        • types required array
          • items object
            • type array
        • version array
          • items object
            • availabilities array
            • competition_warning string
            • duration string
            • guidance_warnings guidance_warnings
            • pid pid
            • types required array

version_group

version_of

version_types_with_id

  • version_types_with_id object
    • version_types required object
      • version_type required array
        • items object
          • id string
          • version_types required object
            • version_type required array

versions

versions_mixin

warning

  • warning object
    • #text string
    • short_description string
    • warning_code string

warning_items

  • warning_items object
    • warning array
      • items object
        • #text string
        • short_description string
        • warning array
          • items object
            • #text string
            • short_description string
            • warning_code string
        • warning_code string

warning_text

  • warning_text object
    • #text string
    • length string

warning_texts

  • warning_texts object
    • warning_text array
      • items object
        • #text string
        • length string
        • warning_text array
          • items object
            • #text string
            • length string

warnings

window

7.0.0

5 years ago

6.0.0

7 years ago

5.0.0

7 years ago

4.0.0

8 years ago

2.0.3

8 years ago

2.0.2

8 years ago

2.0.1

8 years ago

2.0.0

8 years ago

0.0.3

9 years ago

0.0.1

9 years ago