{ "feeds": { "feed": [ { "name": "Programmes", "rel": "feed", "href": "/nitro/api/programmes", "title": "Start here for programmes metadata: Brands, Series, Episodes and Clips", "release_status": "supported", "filters": { "filter": [ { "name": "audio_described", "type": "boolean", "title": "filter for subset of programmes that are audio-described", "release_status": "supported", "option": [ { "value": "true", "title": "filter for programmes that are audio-described", "href": "/nitro/api/programmes?audio_described=true" }, { "value": "false", "title": "filter for programmes that are not audio-described", "href": "/nitro/api/programmes?audio_described=false" } ] }, { "name": "availability", "type": "string", "title": "filter for subset of programmes that have availability", "multiple_values": true, "release_status": "supported", "option": [ { "value": "available", "title": "filter for programmes that are available", "release_status": "supported", "href": "/nitro/api/programmes?availability=available" }, { "value": "pending", "title": "filter for programmes that are expected to become available imminently", "release_status": "supported", "href": "/nitro/api/programmes?availability=pending" } ] }, { "name": "availability", "type": "daytime_duration", "title": "filter for programmes that will become available within given duration", "multiple_values": true, "release_status": "supported" }, { "name": "availability_entity_type", "type": "string", "title": "additional filter when availability=available", "release_status": "supported", "option": [ { "value": "episode", "title": "filter for programmes with available episodes", "href": "/nitro/api/programmes?availability_entity_type=episode" }, { "value": "clip", "title": "filter for programmes with available clips", "href": "/nitro/api/programmes?availability_entity_type=clip" } ] }, { "name": "availability_from", "type": "datetime", "title": "filter for subset of programmes that are available after or at the specified datetime", "release_status": "deprecated", "deprecated": true, "deprecated_since": "2014-01-22" }, { "name": "availability_type", "type": "string", "title": "filter for a subset of programmes that are available for a given type", "release_status": "supported", "default": "ondemand", "depends_on": "availability", "multiple_values": true, "option": [ { "value": "ondemand", "title": "filters programmes based on availability type of ondemand" }, { "value": "webcast", "title": "filters programmes based on availability type of webcast" }, { "value": "simulcast", "title": "filters programmes based on availability type of simulcast" } ] }, { "name": "children_of", "type": "PID", "title": "filter for subset of programmes that have PID as immediate parent", "multiple_values": true, "release_status": "supported" }, { "name": "descendants_of", "type": "PID", "title": "filter for subset of programmes that have PID as ancestor", "multiple_values": true, "release_status": "supported" }, { "name": "duration", "type": "string", "title": "filter for subset of programmes that have given duration", "release_status": "supported", "option": [ { "value": "short", "title": "filter for programmes that have short duration (< 5m)", "href": "/nitro/api/programmes?duration=short" }, { "value": "medium", "title": "filter for programmes that have medium duration (5m - 30m)", "href": "/nitro/api/programmes?duration=medium" }, { "value": "long", "title": "filter for programmes that have long duration (> 30m)", "href": "/nitro/api/programmes?duration=long" } ] }, { "name": "entity_type", "type": "string", "title": "filter for subset of programmes that have given entity type", "multiple_values": true, "release_status": "supported", "option": [ { "value": "brand", "title": "filter for programmes that are brands", "href": "/nitro/api/programmes?entity_type=brand" }, { "value": "series", "title": "filter for programmes that are series", "href": "/nitro/api/programmes?entity_type=series" }, { "value": "episode", "title": "filter for programmes that are episodes", "href": "/nitro/api/programmes?entity_type=episode" }, { "value": "clip", "title": "filter for programmes that are clips", "href": "/nitro/api/programmes?entity_type=clip" } ] }, { "name": "format", "type": "string", "title": "filter for subset of programmes with format", "multiple_values": true, "release_status": "supported" }, { "name": "genre", "type": "string", "title": "filter for subset of programmes with genre", "multiple_values": true, "release_status": "supported" }, { "name": "group", "type": "PID", "title": "filter for subset of programmes which belong to the given group pid", "release_status": "supported" }, { "name": "initial_letter", "type": "character", "title": "filter for subset of programmes with title beginning with initial letter librarian style (ignoring leading 'The', 'An' (Welsh), etc) 0-9 a-z", "release_status": "supported" }, { "name": "initial_letter_end", "type": "character", "title": "Programmes with (librarian) titles whose initial letter is equal/before given letter. Use with initial_letter_start for a range", "release_status": "supported" }, { "name": "initial_letter_start", "type": "character", "title": "Programmes with (librarian) titles whose initial letter is equal/after given letter. Use with initial_letter_end for range.", "release_status": "supported" }, { "name": "initial_letter_strict", "type": "character", "title": "filter for subset of programmes with title beginning with initial letter", "multiple_values": true, "release_status": "supported" }, { "name": "item", "type": "PID", "title": "filter for subset of programmes with linked to versions which have the given item pids", "multiple_values": true, "release_status": "supported" }, { "name": "master_brand", "type": "string", "title": "filter for subset of programmes with master_brand", "multiple_values": true, "release_status": "supported" }, { "name": "media_set", "type": "string", "title": "filter for subset of programmes with media set", "release_status": "supported" }, { "name": "media_type", "type": "string", "title": "filter for subset of programmes with media type", "release_status": "supported", "option": [ { "value": "audio", "title": "filter for programmes that are audio only", "href": "/nitro/api/programmes?media_type=audio" }, { "value": "audio_video", "title": "filter for programmes that are video only", "href": "/nitro/api/programmes?media_type=audio_video" } ] }, { "name": "page", "type": "integer", "title": "which page of results to return", "min_value": 1, "default": "1", "release_status": "supported" }, { "name": "page_size", "type": "integer", "title": "number of results in each page", "min_value": 0, "max_value": 300, "default": "10", "release_status": "supported" }, { "name": "partner_id", "type": "PID", "title": "filter for programmes by partner ID", "release_status": "supported", "multiple_values": true, "prefer": "partner_pid" }, { "name": "partner_pid", "type": "PID", "title": "filter for programmes by partner PID", "release_status": "supported", "multiple_values": true, "default": "s0000001" }, { "name": "payment_type", "type": "string", "title": "filter for a subset of programmes that are of the given payment_type", "release_status": "supported", "default": "free", "depends_on": "availability", "option": [ { "value": "free", "title": "filter for programmes with no payment_type or with type free" }, { "value": "bbcstore", "title": "filter for programmes with payment_type bbcstore" }, { "value": "uscansvod", "title": "filter for programmes with payment_type uscansvod" } ] }, { "name": "people", "type": "PID", "title": "filter for subset of programmes with contributions by given people PID", "release_status": "supported" }, { "name": "pid", "type": "PID", "title": "filter for subset of programmes having given PID", "multiple_values": true, "release_status": "supported" }, { "name": "promoted_for", "type": "string", "title": "filter for subset of programmes which are promoted for given service", "release_status": "supported" }, { "name": "q", "type": "string", "title": "filter for subset of programmes matching supplied keyword/phrase (boolean operators permitted)", "release_status": "supported" }, { "name": "signed", "type": "string", "title": "filter for subset of programmes that are signed", "release_status": "supported", "option": [ { "value": "exclusive", "title": "filter for programmes that are signed", "href": "/nitro/api/programmes?signed=exclusive" }, { "value": "inclusive", "title": "filter for programmes regardless of signedness", "href": "/nitro/api/programmes?signed=inclusive" }, { "value": "exclude", "title": "filter for programmes that are not signed", "href": "/nitro/api/programmes?signed=exclude" } ] }, { "name": "tag_name", "type": "string", "title": "filter for subset of programmes with tag", "release_status": "supported" }, { "name": "tag_scheme", "type": "string", "title": "filter for subset of programmes with a tag", "release_status": "supported" }, { "name": "tleo", "type": "boolean", "title": "filter for subset of programmes that are TLEOs", "release_status": "supported", "option": [ { "value": "true", "title": "filter for programmes that are TLEOs", "href": "/nitro/api/programmes?tleo=true" }, { "value": "false", "title": "filter for programmes that are not TLEOs", "href": "/nitro/api/programmes?tleo=false" } ] }, { "name": "version", "type": "PID", "title": "filter for subset of programmes with given PID as one of their versions", "multiple_values": true, "release_status": "supported" } ] }, "sorts": { "sort": [ { "name": "group_position", "is_default": "false", "title": "sort numerically by position in group, ascending", "release_status": "supported", "sort_direction": { "name": "sort_direction", "value": "ascending", "is_default": "true", "href": "/nitro/api/programmes?sort=group_position&sort_direction=ascending" } }, { "name": "pid", "is_default": "true", "title": "sort alphabetically by PID, descending", "release_status": "supported", "sort_direction": [ { "name": "sort_direction", "value": "ascending", "is_default": "false", "href": "/nitro/api/programmes?sort=pid&sort_direction=ascending" }, { "name": "sort_direction", "value": "descending", "is_default": "true", "href": "/nitro/api/programmes?sort=pid&sort_direction=descending" } ] }, { "name": "position", "is_default": "false", "title": "sort numerically by position, ascending", "release_status": "supported", "sort_direction": [ { "name": "sort_direction", "value": "ascending", "is_default": "true", "href": "/nitro/api/programmes?sort=position&sort_direction=ascending" }, { "name": "sort_direction", "value": "descending", "is_default": "false", "href": "/nitro/api/programmes?sort=position&sort_direction=descending" } ] }, { "name": "promotion", "is_default": "false", "title": "sort by promotion rank, ascending", "release_status": "supported" }, { "name": "release_date", "is_default": "false", "title": "sort chronologically by release date, descending", "release_status": "supported", "sort_direction": [ { "name": "sort_direction", "value": "ascending", "is_default": "false", "href": "/nitro/api/programmes?sort=release_date&sort_direction=ascending" }, { "name": "sort_direction", "value": "descending", "is_default": "true", "href": "/nitro/api/programmes?sort=release_date&sort_direction=descending" } ] }, { "name": "relevance", "is_default": "false", "title": "sort by weighting of search term (use with q parameter)", "release_status": "supported" }, { "name": "scheduled_start", "is_default": "false", "title": "sort chronologically by scheduled start time/date, ascending", "release_status": "supported", "sort_direction": [ { "name": "sort_direction", "value": "ascending", "is_default": "true", "href": "/nitro/api/programmes?sort=scheduled_start&sort_direction=ascending" }, { "name": "sort_direction", "value": "descending", "is_default": "false", "href": "/nitro/api/programmes?sort=scheduled_start&sort_direction=descending" } ] }, { "name": "strict_title", "is_default": "false", "title": "sort alphabetically by title, ascending", "release_status": "supported", "sort_direction": [ { "name": "sort_direction", "value": "ascending", "is_default": "true", "href": "/nitro/api/programmes?sort=strict_title&sort_direction=ascending" }, { "name": "sort_direction", "value": "descending", "is_default": "false", "href": "/nitro/api/programmes?sort=strict_title&sort_direction=descending" } ] }, { "name": "title", "is_default": "false", "title": "sort by title librarian style (ignoring leading 'The', 'A', etc), ascending", "release_status": "supported", "sort_direction": [ { "name": "sort_direction", "value": "ascending", "is_default": "true", "href": "/nitro/api/programmes?sort=title&sort_direction=ascending" }, { "name": "sort_direction", "value": "descending", "is_default": "false", "href": "/nitro/api/programmes?sort=title&sort_direction=descending" } ] }, { "name": "tree", "is_default": "false", "title": "sort by root pid and then preorder tree sort. Requires entities to have release date.", "release_status": "supported", "sort_direction": [ { "name": "sort_direction", "value": "ascending", "is_default": "false", "href": "/nitro/api/programmes?sort=tree&sort_direction=ascending" }, { "name": "sort_direction", "value": "descending", "is_default": "true", "href": "/nitro/api/programmes?sort=tree&sort_direction=descending" } ] } ] }, "mixins": { "mixin": [ { "name": "alternate_images", "title": "mixin to return the alternate images for a programme", "release_status": "supported", "dependency_on": { "filter": "tleo", "value": "true" } }, { "name": "ancestor_titles", "title": "mixin to return ancestor programme titles", "release_status": "supported", "href": "/nitro/api/programmes?mixin=ancestor_titles" }, { "name": "availability", "title": "mixin to return programme availability information", "depends_on": "availability", "release_status": "supported" }, { "name": "available_simulcasts", "title": "mixin to return information about programmes that are currently available as simulcasts", "release_status": "supported", "href": "/nitro/api/programmes?mixin=available_simulcasts" }, { "name": "available_versions", "title": "mixin to return information about programmes that are currently available on demand", "release_status": "supported", "href": "/nitro/api/programmes?mixin=available_versions", "affected_by": { "filter": [ { "name": "payment_type", "description": "payment type filter" } ] } }, { "name": "available_webcasts", "title": "mixin to return information about programmes that are currently available as webcasts", "release_status": "supported", "href": "/nitro/api/programmes?mixin=available_webcasts" }, { "name": "contributions", "title": "mixin to return information about contributors to a programme", "release_status": "supported", "href": "/nitro/api/programmes?mixin=contributions" }, { "name": "duration", "title": "mixin to return original version duration in programme concept entities", "release_status": "supported", "href": "/nitro/api/programmes?mixin=duration" }, { "name": "genre_groupings", "title": "mixin to return list of genre groupings", "release_status": "supported", "href": "/nitro/api/programmes?mixin=genre_groupings", "prohibits": { "mixin": { "name": "genre_groups" } } }, { "name": "genre_groups", "title": "mixin to return list of genre groups", "release_status": "deprecated", "deprecated": true, "deprecated_since": "2015-03-19", "replaced_by": "genre_groupings", "href": "/nitro/api/programmes?mixin=genre_groups", "prohibits": { "mixin": { "name": "genre_groupings" } } }, { "name": "images", "title": "mixin to add image information for a programme", "release_status": "supported", "href": "/nitro/api/programmes?mixin=images" }, { "name": "is_embeddable", "title": "mixin to add embeddable information for a programme", "release_status": "supported", "href": "/nitro/api/programmes?mixin=is_embeddable" }, { "name": "previous_next", "title": "mixin to return the programmes which appear before and after a programme (as determined by the sort applied in the request)", "release_status": "supported", "dependency_on": [ { "filter": "children_of" }, { "filter": "group" }, { "filter": "promoted_for" } ] }, { "name": "related_links", "title": "mixin to return information about related links to a programme", "release_status": "supported", "href": "/nitro/api/programmes?mixin=related_links" }, { "name": "titles", "title": "mixin to return ancestor programme titles", "release_status": "deprecated", "deprecated": true, "deprecated_since": "2013-11-14", "replaced_by": "ancestor_titles", "href": "/nitro/api/programmes?mixin=titles" }, { "name": "versions_availability", "title": "mixin to return information about programmes that are currently available", "release_status": "deprecated", "href": "/nitro/api/programmes?mixin=versions_availability" } ] }, "deprecations": { "deprecated": [ { "name": "availability_from", "type": "filter", "deprecated_since": "2014-01-22" }, { "name": "versions_availability", "type": "mixin", "deprecated_since": "2015-11-10", "replaced_by": "available_versions", "replacement_type": "mixin" }, { "name": "titles", "type": "mixin", "deprecated_since": "2013-11-14", "replaced_by": "ancestor_titles", "replacement_type": "mixin" }, { "name": "genre_groups", "type": "mixin", "deprecated_since": "2015-03-19", "replaced_by": "genre_groupings", "replacement_type": "mixin" }, { "name": "genre_groups", "type": "element", "deprecated_since": "2015-03-23", "replaced_by": "genre_groupings", "replacement_type": "element" }, { "name": "image", "type": "element", "deprecated_since": "2014-07-09", "replaced_by": "images", "replacement_type": "mixin" } ] } }, { "name": "Availability", "rel": "feed", "href": "/nitro/api/availabilities", "title": "Discover details of on-demand availability for programmes and their versions", "release_status": "supported", "filters": { "filter": [ { "name": "availability", "type": "string", "title": "filter for subset of availabilities", "release_status": "supported", "option": { "value": "available", "title": "filter for availabilities that are available", "href": "/nitro/api/availabilities?availability=available" } }, { "name": "descendants_of", "type": "PID", "title": "filter for subset of availabilities that have PID as ancestor", "multiple_values": true, "release_status": "supported" }, { "name": "media_set", "type": "string", "title": "filter for subset of availabilities with media set", "multiple_values": true, "release_status": "supported" }, { "name": "page", "type": "integer", "title": "which page of results to return", "min_value": 1, "default": "1", "release_status": "supported" }, { "name": "page_size", "type": "integer", "title": "number of results in each page", "min_value": 0, "max_value": 300, "default": "10", "release_status": "supported" }, { "name": "territory", "type": "string", "title": "filter for availabilities in given territory", "release_status": "supported", "option": [ { "value": "uk", "title": "filter for only UK availabilities", "href": "/nitro/api/availabilities?territory=uk" }, { "value": "nonuk", "title": "filter for only non-UK availabilities", "href": "/nitro/api/availabilities?territory=nonuk" }, { "value": "world", "title": "filter for global availabilities", "href": "/nitro/api/availabilities?territory=world" } ] } ] }, "sorts": { "sort": { "name": "scheduled_start", "is_default": "true", "title": "sort chronologically by scheduled start time/date, ascending", "release_status": "supported", "sort_direction": [ { "name": "sort_direction", "value": "ascending", "is_default": "false", "href": "/nitro/api/availabilities?sort=scheduled_start&sort_direction=ascending" }, { "name": "sort_direction", "value": "descending", "is_default": "true", "href": "/nitro/api/availabilities?sort=scheduled_start&sort_direction=descending" } ] } } }, { "name": "Broadcasts", "rel": "feed", "href": "/nitro/api/broadcasts", "title": "Build schedules and find metadata for TV and radio broadcasts", "release_status": "supported", "filters": { "filter": [ { "name": "authority", "type": "string", "title": "filter for subset of broadcasts that have given authority", "multiple_values": true, "release_status": "supported" }, { "name": "descendants_of", "type": "PID", "title": "filter for subset of broadcasts that are descendants of the given programme PID", "multiple_values": true, "release_status": "supported" }, { "name": "end_from", "type": "datetime", "title": "filter for subset of broadcasts that end on or later than the specified datetime", "release_status": "supported" }, { "name": "end_to", "type": "datetime", "title": "filter for subset of broadcasts that end on or earlier than the specified datetime", "release_status": "supported" }, { "name": "format", "type": "string", "title": "filter for subset of broadcasts that are classified in the given format ID", "multiple_values": true, "release_status": "supported" }, { "name": "genre", "type": "string", "title": "filter for subset of broadcasts that are classified in the given genre ID", "multiple_values": true, "release_status": "supported" }, { "name": "id", "type": "string", "title": "filter for subset of broadcasts that have given identifier", "multiple_values": true, "release_status": "supported" }, { "name": "item", "type": "PID", "title": "filter for subset of broadcasts with the given item performed on it", "multiple_values": true, "release_status": "supported" }, { "name": "page", "type": "integer", "title": "which page of results to return", "min_value": 1, "default": "1", "release_status": "supported" }, { "name": "page_size", "type": "integer", "title": "number of results in each page", "min_value": 0, "max_value": 300, "default": "10", "release_status": "supported" }, { "name": "people", "type": "string", "title": "filter for subset of broadcasts that have given contributor", "release_status": "supported" }, { "name": "pid", "type": "PID", "title": "filter for subset of broadcasts having given PID", "multiple_values": true, "release_status": "supported" }, { "name": "q", "type": "string", "title": "filter for subset of broadcasts matching supplied keyword/phrase (boolean operators permitted)", "release_status": "supported" }, { "name": "schedule_day", "type": "date", "title": "filter for subset of broadcasts that start on the specified day (BBC time)", "release_status": "supported" }, { "name": "schedule_day_from", "type": "date", "title": "filter for subset of broadcasts that start on or after the specified day (BBC time)", "release_status": "supported" }, { "name": "schedule_day_to", "type": "date", "title": "filter for subset of broadcasts that start on or before the specified day (BBC time)", "release_status": "supported" }, { "name": "service_master_brand", "type": "string", "title": "filter for subset of broadcasts with given service master brand", "multiple_values": true, "release_status": "supported" }, { "name": "sid", "type": "string", "title": "filter for subset of broadcasts that are on the specified linear service", "multiple_values": true, "release_status": "supported" }, { "name": "start_from", "type": "datetime", "title": "filter for subset of broadcasts that start on or later than the specified datetime", "release_status": "supported" }, { "name": "start_to", "type": "datetime", "title": "filter for subset of broadcasts that start on or earlier than the specified datetime", "release_status": "supported" }, { "name": "version", "type": "PID", "title": "filter for subset of broadcasts with given PID as their parent version", "multiple_values": true, "release_status": "supported" } ] }, "sorts": { "sort": { "name": "start_date", "is_default": "true", "title": "sort chronologically by scheduled start time/date, ascending", "release_status": "supported", "sort_direction": [ { "name": "sort_direction", "value": "ascending", "is_default": "true", "href": "/nitro/api/broadcasts?sort=start_date&sort_direction=ascending" }, { "name": "sort_direction", "value": "descending", "is_default": "false", "href": "/nitro/api/broadcasts?sort=start_date&sort_direction=descending" } ] } }, "mixins": { "mixin": { "name": "titles", "title": "return ancestor programme titles", "release_status": "supported", "href": "/nitro/api/broadcasts?mixin=titles" } }, "deprecations": { "deprecated": [ { "name": "image", "type": "element", "deprecated_since": "2014-07-09", "replaced_by": "images", "replacement_type": "mixin" } ] } }, { "name": "Groups", "rel": "feed", "href": "/nitro/api/groups", "title": "Find metadata for curated groups: seasons, collections, galleries or franchises", "release_status": "supported", "filters": { "filter": [ { "name": "for_descendants_of", "type": "PID", "title": "filter for groups related to given programme or its descendants", "release_status": "supported" }, { "name": "for_programme", "type": "PID", "title": "filter for subset of groups directly related to a given programme", "release_status": "supported" }, { "name": "group", "type": "PID", "title": "filter for subset of groups which belong to the given group pid", "release_status": "supported" }, { "name": "group_type", "type": "string", "title": "filter for subset of groups that have the given group type", "multiple_values": true, "release_status": "supported", "option": [ { "value": "collection", "title": "filter for groups that are collections", "href": "/nitro/api/groups?group_type=collection" }, { "value": "franchise", "title": "filter for groups that are franchises", "href": "/nitro/api/groups?group_type=franchise" }, { "value": "gallery", "title": "filter for groups that are galleries", "href": "/nitro/api/groups?group_type=gallery" }, { "value": "season", "title": "filter for groups that are seasons", "href": "/nitro/api/groups?group_type=season" } ] }, { "name": "member", "type": "PID", "title": "filter for subset of groups which contain an entity with the given pid as a member", "release_status": "supported" }, { "name": "page", "type": "integer", "title": "which page of results to return", "min_value": 1, "default": "1", "release_status": "supported" }, { "name": "page_size", "type": "integer", "title": "number of results in each page", "min_value": 0, "max_value": 300, "default": "10", "release_status": "supported" }, { "name": "partner_id", "type": "PID", "title": "filter for groups by partner ID", "release_status": "supported", "multiple_values": true, "prefer": "partner_pid" }, { "name": "partner_pid", "type": "PID", "title": "filter for groups by partner PID", "release_status": "supported", "multiple_values": true, "default": "s0000001" }, { "name": "pid", "type": "PID", "title": "filter for subset of seasons, collections, galleries or franchises having given PID", "multiple_values": true, "release_status": "supported" }, { "name": "q", "type": "string", "title": "filter for subset of groups matching supplied keyword/phrase (boolean operators permitted)", "release_status": "supported" } ] }, "sorts": { "sort": { "name": "pid", "is_default": "true", "title": "sort alphabetically by PID", "release_status": "supported", "sort_direction": { "name": "sort_direction", "value": "descending", "is_default": "true", "href": "/nitro/api/groups?sort=pid&sort_direction=descending" } } }, "mixins": { "mixin": [ { "name": "alternate_images", "title": "mixin to return the alternate images for a group", "release_status": "supported", "href": "/nitro/api/groups?mixin=alternate_images" }, { "name": "group_for", "title": "mixin to return links to programme entities that group belongs to", "release_status": "supported", "href": "/nitro/api/groups?mixin=group_for" }, { "name": "images", "title": "mixin to add image information for a group", "release_status": "supported", "href": "/nitro/api/groups?mixin=images" }, { "name": "related_links", "title": "mixin to return related links for the group", "release_status": "supported", "href": "/nitro/api/groups?mixin=related_links" } ] } }, { "name": "Images", "rel": "feed", "href": "/nitro/api/images", "title": "Find metadata for images", "release_status": "supported", "filters": { "filter": [ { "name": "group", "type": "PID", "title": "filter for images belonging to the given group (i.e. Gallery)", "release_status": "supported", "prohibits": { "filter": [ { "name": "is_image_for" }, { "name": "is_alternate_image_for" } ] } }, { "name": "image_type", "type": "string", "title": "filter for images by type", "multiple_values": true, "release_status": "supported", "option": [ { "value": "standard", "title": "select standard type images", "href": "/nitro/api/images?image_type=standard" }, { "value": "podcast", "title": "select podcast type images", "href": "/nitro/api/images?image_type=podcast" }, { "value": "store", "title": "select store type images", "href": "/nitro/api/images?image_type=store" }, { "value": "portrait", "title": "select portrait type images", "href": "/nitro/api/images?image_type=portrait" }, { "value": "letterbox", "title": "select letterbox type images", "href": "/nitro/api/images?image_type=letterbox" } ] }, { "name": "is_alternate_image_for", "type": "PID", "title": "filter for alternate images by entity PID", "release_status": "supported", "prohibits": { "filter": [ { "name": "is_image_for" }, { "name": "group" } ] } }, { "name": "is_image_for", "type": "PID", "title": "filter for images by entity PID", "release_status": "supported", "prohibits": { "filter": [ { "name": "group" }, { "name": "is_alternate_image_for" } ] } }, { "name": "page", "type": "integer", "title": "which page of results to return", "min_value": 1, "default": "1", "release_status": "supported" }, { "name": "page_size", "type": "integer", "title": "number of results in each page", "min_value": 0, "max_value": 300, "default": "10", "release_status": "supported" }, { "name": "partner_id", "type": "PID", "title": "filter for images by partner ID", "release_status": "supported", "multiple_values": true, "prefer": "partner_pid" }, { "name": "partner_pid", "type": "PID", "title": "filter for images by partner PID", "release_status": "supported", "multiple_values": true, "default": "s0000001" }, { "name": "pid", "type": "PID", "title": "filter for subset of images having given PID", "multiple_values": true, "release_status": "supported" }, { "name": "q", "type": "string", "title": "filter for subset of images matching supplied keyword/phrase (boolean operators permitted)", "release_status": "supported" } ] }, "sorts": { "sort": [ { "name": "group_position", "is_default": "false", "title": "sort numerically by position, ascending only", "release_status": "supported", "sort_direction": { "name": "sort_direction", "value": "ascending", "is_default": "true", "href": "/nitro/api/images?sort=group_position&sort_direction=ascending" } }, { "name": "pid", "is_default": "true", "title": "sort alphabetically by PID", "release_status": "supported", "sort_direction": [ { "name": "sort_direction", "value": "ascending", "is_default": "false", "href": "/nitro/api/images?sort=pid&sort_direction=ascending" }, { "name": "sort_direction", "value": "descending", "is_default": "true", "href": "/nitro/api/images?sort=pid&sort_direction=descending" } ] } ] } }, { "name": "Items", "rel": "feed", "href": "/nitro/api/items", "title": "Look inside programmes to find segments: chapters, tracks and more", "filters": { "filter": [ { "name": "authority", "type": "string", "title": "filter for subset of items that have an ID issued by the given authority", "release_status": "supported" }, { "name": "id", "type": "ID", "title": "filter for subset of items having given ID", "multiple_values": true, "release_status": "supported" }, { "name": "id_type", "type": "string", "title": "filter for subset of items that have given an ID of the given type", "release_status": "supported" }, { "name": "item_type", "type": "string", "multiple_values": true, "title": "filter for specific type(s) of items", "release_status": "supported", "option": [ { "value": "chapter", "title": "filter for only chapter items", "href": "/nitro/api/items?item_type=chapter" }, { "value": "highlight", "title": "filter for only highlight items", "href": "/nitro/api/items?item_type=highlight" }, { "value": "music", "title": "filter for only music items", "href": "/nitro/api/items?item_type=music" }, { "value": "speech", "title": "filter for only speech items", "href": "/nitro/api/items?item_type=speech" }, { "value": "other", "title": "filter for only other items", "href": "/nitro/api/items?item_type=other" } ] }, { "name": "page", "type": "integer", "title": "which page of results to return", "min_value": 1, "default": "1", "release_status": "supported" }, { "name": "page_size", "type": "integer", "title": "number of results in each page", "min_value": 0, "max_value": 300, "default": "10", "release_status": "supported" }, { "name": "partner_id", "type": "PID", "title": "filter for items by partner ID", "release_status": "supported", "multiple_values": true, "prefer": "partner_pid" }, { "name": "partner_pid", "type": "PID", "title": "filter for items by partner PID", "release_status": "supported", "multiple_values": true, "default": "s0000001" }, { "name": "people", "type": "string", "title": "filter for subset of items that have specified person involved", "release_status": "supported" }, { "name": "pid", "type": "PID", "title": "filter for subset of items matching one of the given PIDs", "multiple_values": true, "release_status": "supported" }, { "name": "programme", "type": "PID", "title": "filter for subset of items that are part of the given programme", "release_status": "supported" }, { "name": "q", "type": "string", "title": "filter for subset of items matching supplied keyword/phrase (boolean operators permitted)", "release_status": "supported" }, { "name": "segment_event", "type": "string", "title": "filter for item with the given segment_event", "release_status": "supported" } ] }, "sorts": { "sort": { "name": "pid", "is_default": "true", "title": "sort by pid, descending", "release_status": "supported", "sort_direction": { "name": "sort_direction", "value": "descending", "is_default": "true", "href": "/nitro/api/items?sort=pid&sort_direction=descending" } } }, "mixins": { "mixin": [ { "name": "contributions", "title": "mixin to return information about contributors to items", "release_status": "supported", "href": "/nitro/api/items?mixin=contributions" }, { "name": "images", "title": "mixin to add image information for an item", "release_status": "supported", "href": "/nitro/api/items?mixin=images" }, { "name": "offset", "title": "mixin to return programme segment offsets, works in conjunction with programme filter", "depends_on": "programme", "release_status": "deprecated", "deprecated": true, "deprecated_since": "2014-05-06", "replaced_by": "play_event" }, { "name": "play_event", "title": "mixin to return programme segment events, works in conjunction with programme or segment_event filters", "release_status": "supported", "dependency_on": [ { "filter": "programme" }, { "filter": "segment_event" } ] } ] }, "deprecations": { "deprecated": [ { "name": "offset", "type": "mixin", "deprecated_since": "2014-05-06", "replaced_by": "play_event", "replacement_type": "mixin" } ] } }, { "name": "Masterbrands", "rel": "feed", "href": "/nitro/api/master_brands", "title": "List all Master Brands", "filters": { "filter": [ { "name": "mid", "type": "string", "title": "filter for subset of masterbrands that have given identifier", "multiple_values": true, "release_status": "supported" }, { "name": "page", "type": "integer", "title": "which page of results to return", "min_value": 1, "default": "1", "release_status": "supported" }, { "name": "page_size", "type": "integer", "title": "number of results in each page", "min_value": 0, "max_value": 300, "default": "10", "release_status": "supported" }, { "name": "partner_id", "type": "PID", "title": "filter for masterbrands by partner ID", "release_status": "supported", "multiple_values": true, "prefer": "partner_pid" }, { "name": "partner_pid", "type": "PID", "title": "filter for masterbrands by partner PID", "release_status": "supported", "multiple_values": true, "default": "s0000001" }, { "name": "q", "type": "string", "title": "filter for subset of masterbrands matching supplied keyword/phrase (boolean operators permitted)", "release_status": "supported" } ] }, "sorts": { "sort": { "name": "mid", "is_default": "true", "title": "sort by mid, ascending", "release_status": "supported", "sort_direction": { "name": "sort_direction", "value": "ascending", "is_default": "true", "href": "/nitro/api/master_brands?sort=mid&sort_direction=ascending" } } }, "mixins": { "mixin": { "name": "images", "title": "mixin to add image information for a masterbrand", "release_status": "supported", "href": "/nitro/api/master_brands?mixin=images" } } }, { "name": "People", "rel": "feed", "href": "/nitro/api/people", "title": "Find the people behind and in programmes: cast, crew, guests and more", "release_status": "supported", "filters": { "filter": [ { "name": "authority", "type": "string", "title": "filter for subset of people that have an ID issued by the given authority", "release_status": "supported" }, { "name": "has_external_id", "type": "boolean", "title": "filter for people who have an external identifier", "release_status": "supported", "option": [ { "value": "true", "title": "filter for people who have an external identifier", "href": "/nitro/api/people?has_external_id=true" }, { "value": "false", "title": "filter for people who do not have an external identifier", "href": "/nitro/api/people?has_external_id=false" } ] }, { "name": "id", "type": "ID", "title": "filter for subset of people having given ID", "multiple_values": true, "release_status": "supported" }, { "name": "id_type", "type": "string", "title": "filter for subset of people that have given an ID of the given type", "release_status": "supported" }, { "name": "page", "type": "integer", "title": "which page of results to return", "min_value": 1, "default": "1", "release_status": "supported" }, { "name": "page_size", "type": "integer", "title": "number of results in each page", "min_value": 0, "max_value": 300, "default": "10", "release_status": "supported" }, { "name": "partner_id", "type": "PID", "title": "filter for people by partner ID", "release_status": "supported", "multiple_values": true, "prefer": "partner_pid" }, { "name": "partner_pid", "type": "PID", "title": "filter for people by partner PID", "release_status": "supported", "multiple_values": true, "default": "s0000001" }, { "name": "pid", "type": "PID", "title": "filter for subset of people having given PID", "multiple_values": true, "release_status": "supported" }, { "name": "programme", "type": "string", "title": "filter for subset of people that have contributed to the given programme pid", "release_status": "supported" }, { "name": "q", "type": "string", "title": "filter for subset of people matching supplied keyword/phrase (boolean operators permitted)", "release_status": "supported" } ] } }, { "name": "Pips", "rel": "feed", "href": "/nitro/api/pips", "title": "Look inside pips entities", "release_status": "supported", "filters": { "filter": [ { "name": "page", "type": "integer", "title": "which page of results to return", "min_value": 1, "default": "1", "release_status": "supported" }, { "name": "page_size", "type": "integer", "title": "number of results in each page", "min_value": 0, "max_value": 300, "default": "10", "release_status": "supported" }, { "name": "q", "type": "string", "title": "filter for subset of programmes matching supplied keyword/phrase (boolean operators permitted)", "release_status": "supported" } ] } }, { "name": "ProgrammeDetails", "rel": "feed", "href": "/nitro/api/programme_details", "title": "Exposes programme information for a single pid", "release_status": "supported", "filters": { "filter": [ { "name": "page", "type": "integer", "title": "which page of results to return", "min_value": 1, "default": "1", "release_status": "supported" }, { "name": "page_size", "type": "integer", "title": "number of results in each page", "min_value": 0, "max_value": 300, "default": "10", "release_status": "supported" }, { "name": "partner_pid", "type": "PID", "title": "Filter for programme information by partner PID", "release_status": "supported" }, { "name": "pid", "type": "PID", "title": "Filter for programme information for the provided PID", "required": true, "release_status": "supported" } ] } }, { "name": "Promotions", "rel": "feed", "href": "/nitro/api/promotions", "title": "Discover metadata for content promotions", "release_status": "supported", "filters": { "filter": [ { "name": "context", "type": "PID", "title": "filter for subset of promotions belonging to a given context", "multiple_values": false, "release_status": "supported" }, { "name": "page", "type": "integer", "title": "which page of results to return", "min_value": 1, "default": "1", "release_status": "supported" }, { "name": "page_size", "type": "integer", "title": "number of results in each page", "min_value": 0, "max_value": 300, "default": "10", "release_status": "supported" }, { "name": "partner_id", "type": "PID", "title": "filter for promotions by partner ID", "release_status": "supported", "multiple_values": true, "prefer": "partner_pid" }, { "name": "partner_pid", "type": "PID", "title": "filter for promotions by partner PID", "release_status": "supported", "multiple_values": true, "default": "s0000001" }, { "name": "pid", "type": "PID", "title": "filter for subset of promotions having given PID", "multiple_values": true, "release_status": "supported" }, { "name": "promoted_by", "type": "string", "title": "filter for subset of promotions having given promoted by", "multiple_values": true, "release_status": "supported" }, { "name": "promoted_for", "type": "string", "title": "filter for subset of promotions having given promoted for", "multiple_values": true, "release_status": "supported" }, { "name": "q", "type": "string", "title": "filter for subset of promotions matching supplied keyword/phrase (boolean operators permitted)", "release_status": "supported" }, { "name": "status", "type": "string", "title": "filter for subset of promotions with status", "release_status": "supported", "option": { "value": "current", "title": "filter current promotions", "href": "/nitro/api/promotions?status=current" } } ] }, "mixins": { "mixin": { "name": "related_links", "title": "mixin to return information about related links to a promotion", "release_status": "supported", "href": "/nitro/api/promotions?mixin=related_links" } } }, { "name": "Schedules", "rel": "feed", "href": "/nitro/api/schedules", "title": "Build schedules and find metadata for TV and radio broadcasts and webcasts", "release_status": "supported", "filters": { "filter": [ { "name": "authority", "type": "string", "title": "filter for subset of broadcasts and webcasts that have given authority", "multiple_values": true, "release_status": "supported" }, { "name": "descendants_of", "type": "PID", "title": "filter for subset of broadcasts and webcasts that are descendants of the given programme PID", "multiple_values": true, "release_status": "supported" }, { "name": "end_from", "type": "datetime", "title": "filter for subset of broadcasts and webcasts that end on or later than the specified datetime", "release_status": "supported" }, { "name": "end_to", "type": "datetime", "title": "filter for subset of broadcasts and webcasts that end on or earlier than the specified datetime", "release_status": "supported" }, { "name": "format", "type": "string", "title": "filter for subset of broadcasts and webcasts that are classified in the given format ID", "multiple_values": true, "release_status": "supported" }, { "name": "genre", "type": "string", "title": "filter for subset of broadcasts and webcasts that are classified in the given genre ID", "multiple_values": true, "release_status": "supported" }, { "name": "group", "type": "PID", "title": "filter for subset of broadcasts and webcasts that have programmes in the given group", "release_status": "supported" }, { "name": "id", "type": "string", "title": "filter for subset of broadcasts and webcasts that have given identifier", "multiple_values": true, "release_status": "supported" }, { "name": "id_type", "type": "string", "title": "filter for subset of broadcasts and webcasts that have given id type", "multiple_values": true, "release_status": "supported" }, { "name": "item", "type": "PID", "title": "filter for subset of broadcasts and webcasts with the given item performed on it", "multiple_values": true, "release_status": "supported" }, { "name": "page", "type": "integer", "title": "which page of results to return", "min_value": 1, "default": "1", "release_status": "supported" }, { "name": "page_size", "type": "integer", "title": "number of results in each page", "min_value": 0, "max_value": 300, "default": "10", "release_status": "supported" }, { "name": "partner_id", "type": "PID", "title": "filter for broadcasts and webcasts by partner ID", "release_status": "supported", "multiple_values": true, "prefer": "partner_pid" }, { "name": "partner_pid", "type": "PID", "title": "filter for broadcasts and webcasts by partner PID", "release_status": "supported", "multiple_values": true, "default": "s0000001" }, { "name": "people", "type": "string", "title": "filter for subset of broadcasts and webcasts that have given contributor", "release_status": "supported" }, { "name": "pid", "type": "PID", "title": "filter for subset of broadcasts and webcasts having given PID", "multiple_values": true, "release_status": "supported" }, { "name": "q", "type": "string", "title": "filter for subset of broadcasts and webcasts matching supplied keyword/phrase (boolean operators permitted)", "release_status": "supported" }, { "name": "repeat", "type": "boolean", "title": "filter to show either only repeats or non-repeats", "release_status": "supported" }, { "name": "schedule_day", "type": "date", "title": "filter for subset of broadcasts and webcasts that start on the specified day (BBC time)", "release_status": "supported" }, { "name": "schedule_day_from", "type": "date", "title": "filter for subset of broadcasts and webcasts that start on or after the specified day (BBC time)", "release_status": "supported" }, { "name": "schedule_day_to", "type": "date", "title": "filter for subset of broadcasts and webcasts that start on or before the specified day (BBC time)", "release_status": "supported" }, { "name": "service_master_brand", "type": "string", "title": "filter for subset of broadcasts and webcasts with given service master brand", "multiple_values": true, "release_status": "supported" }, { "name": "sid", "type": "string", "title": "filter for subset of broadcasts and webcasts that are on the specified linear service", "multiple_values": true, "release_status": "supported" }, { "name": "start_from", "type": "datetime", "title": "filter for subset of broadcasts and webcasts that start on or later than the specified datetime", "release_status": "supported" }, { "name": "start_to", "type": "datetime", "title": "filter for subset of broadcasts and webcasts that start on or earlier than the specified datetime", "release_status": "supported" }, { "name": "version", "type": "PID", "title": "filter for subset of broadcasts and webcasts with given PID as their parent version", "multiple_values": true, "release_status": "supported" } ] }, "sorts": { "sort": { "name": "start_date", "is_default": "true", "title": "sort chronologically by scheduled start time/date, ascending", "release_status": "supported", "sort_direction": [ { "name": "sort_direction", "value": "ascending", "is_default": "true", "href": "/nitro/api/schedules?sort=start_date&sort_direction=ascending" }, { "name": "sort_direction", "value": "descending", "is_default": "false", "href": "/nitro/api/schedules?sort=start_date&sort_direction=descending" } ] } }, "mixins": { "mixin": [ { "name": "ancestor_titles", "title": "return ancestor programme titles", "release_status": "supported", "href": "/nitro/api/schedules?mixin=ancestor_titles" }, { "name": "images", "title": "mixin to add image information for broadcasts and webcasts", "release_status": "supported", "href": "/nitro/api/schedules?mixin=images" }, { "name": "titles", "title": "return ancestor programme titles", "release_status": "deprecated", "deprecated_since": "2014-01-31", "replaced_by": "ancestor_titles", "href": "/nitro/api/schedules?mixin=titles" } ] }, "deprecations": { "deprecated": [ { "name": "titles", "type": "mixin", "deprecated_since": "2014-01-31", "replaced_by": "ancestor_titles", "replacement_type": "mixin" } ] } }, { "name": "Services", "rel": "feed", "href": "/nitro/api/services", "title": "Information about the linear services used for broadcast transmissions", "release_status": "supported", "filters": { "filter": [ { "name": "end_from", "type": "datetime", "title": "Return services that end on or later than the specified datetime", "release_status": "supported" }, { "name": "end_to", "type": "datetime", "title": "filter for subset of broadcasts that end on or earlier than the specified datetime", "release_status": "supported" }, { "name": "mid", "type": "string", "title": "filter for services by masterbrand MID", "release_status": "supported", "multiple_values": true }, { "name": "page", "type": "integer", "title": "which page of results to return", "min_value": 1, "default": "1", "release_status": "supported" }, { "name": "page_size", "type": "integer", "title": "number of results in each page", "min_value": 0, "max_value": 300, "default": "10", "release_status": "supported" }, { "name": "partner_id", "type": "PID", "title": "filter for services by partner ID", "release_status": "supported", "multiple_values": true, "prefer": "partner_pid" }, { "name": "partner_pid", "type": "PID", "title": "filter for services by partner PID", "release_status": "supported", "multiple_values": true, "default": "s0000001" }, { "name": "q", "type": "string", "title": "filter for subset of services matching supplied keyword/phrase (boolean operators permitted)", "release_status": "supported" }, { "name": "service_type", "type": "string", "title": "filter for specified type of linear services", "multiple_values": true, "release_status": "supported", "option": [ { "value": "Interactive", "title": "Return only Interactive services", "href": "/nitro/api/services?service_type=Interactive" }, { "value": "Local Radio", "title": "Return only Local Radio services", "href": "/nitro/api/services?service_type=Local+Radio" }, { "value": "Master Brand Only", "title": "Return only Master Brand services", "href": "/nitro/api/services?service_type=Master+Brand+Only" }, { "value": "National Radio", "title": "Return only National Radio services", "href": "/nitro/api/services?service_type=National+Radio" }, { "value": "On Demand", "title": "Return only On Demand services", "href": "/nitro/api/services?service_type=On+Demand" }, { "value": "Regional Radio", "title": "Return only Regional Radio services", "href": "/nitro/api/services?service_type=Regional+Radio" }, { "value": "Simulcast", "title": "Return only Simulcast services", "href": "/nitro/api/services?service_type=Simulcast" }, { "value": "TV", "title": "Return only TV services", "href": "/nitro/api/services?service_type=TV" }, { "value": "Web Only", "title": "Return only Web Only services", "href": "/nitro/api/services?service_type=Web+Only" }, { "value": "Webcast", "title": "Return only Webcast services", "href": "/nitro/api/services?service_type=Webcast" } ] }, { "name": "sid", "type": "string", "title": "filter for specified linear service", "multiple_values": true, "release_status": "supported" }, { "name": "start_from", "type": "datetime", "title": "Return services that start on or later than the specified datetime", "release_status": "supported" }, { "name": "start_to", "type": "datetime", "title": "Return services that start earlier than the specified datetime", "release_status": "supported" } ] } }, { "name": "Versions", "rel": "feed", "href": "/nitro/api/versions", "title": "Metadata on editorial programme versions: original, signed, audio-described, etc", "release_status": "supported", "filters": { "filter": [ { "name": "availability", "type": "string", "title": "filter for subset of versions that have availability", "release_status": "supported", "option": { "value": "available", "title": "filter for versions that are available", "href": "/nitro/api/versions?availability=available" } }, { "name": "descendants_of", "type": "PID", "title": "filter for subset of versions having given programme PID", "multiple_values": true, "release_status": "supported" }, { "name": "media_set", "type": "string", "title": "filter for subset of versions with availability in the given media set", "multiple_values": true, "release_status": "supported" }, { "name": "page", "type": "integer", "title": "which page of results to return", "min_value": 1, "default": "1", "release_status": "supported" }, { "name": "page_size", "type": "integer", "title": "number of results in each page", "min_value": 0, "max_value": 300, "default": "10", "release_status": "supported" }, { "name": "partner_id", "type": "PID", "title": "filter for versions by partner ID", "release_status": "supported", "multiple_values": true, "prefer": "partner_pid" }, { "name": "partner_pid", "type": "PID", "title": "filter for versions by partner PID", "release_status": "supported", "multiple_values": true, "default": "s0000001" }, { "name": "payment_type", "type": "string", "title": "filter for a subset of versions that are of the given payment_type", "release_status": "supported", "default": "free", "depends_on": "availability", "option": [ { "value": "free", "title": "filter for versions with no payment_type or with type free" }, { "value": "bbcstore", "title": "filter for versions with payment_type bbcstore" }, { "value": "uscansvod", "title": "filter for versions with payment_type uscansvod" } ] }, { "name": "pid", "type": "PID", "title": "filter for subset of versions having given PID", "multiple_values": true, "release_status": "supported" } ] }, "deprecations": { "deprecated": [ { "name": "version_types", "type": "element", "deprecated_since": "2015-05-05", "replaced_by": "types", "replacement_type": "element" } ] } } ], "deprecations": { "deprecated": [ { "name": "nitro.api.bbci.co.uk", "type": "host", "deprecated_since": "2015-12-24", "replaced_by": "programmes.api.bbc.com", "replacement_type": "host" }, { "name": "data.bbc.co.uk", "type": "host", "deprecated_since": "2015-12-24", "replaced_by": "programmes.api.bbc.com", "replacement_type": "host" }, { "name": "d.bbc.co.uk", "type": "host", "deprecated_since": "2015-12-24", "replaced_by": "programmes.api.bbc.com", "replacement_type": "host" } ] } } }