GET programmes

filter for subset of programmes that are audio-described

filter for subset of programmes that have availability

additional filter when availability=available

filter for subset of programmes that are available after or at the specified datetime

filter for a subset of programmes that are available for a given type

filter for subset of programmes that have PID as immediate parent

filter for subset of programmes that have PID as ancestor

filter for subset of programmes that have given duration

Control return of embargoed items (undocumented)

Constraints: {'enum': ['include', 'exclude', 'only']}

filter for subset of programmes that have given entity type

filter for subset of programmes with format

filter for subset of programmes with genre

filter for subset of programmes which belong to the given group pid

Constraints: {'minLength': 8, 'pattern': '^([0-9,a-d,f-h,j-n,p-t,v-z]){8,}$'}

filter for subset of programmes with title beginning with initial letter librarian style (ignoring leading 'The', 'An' (Welsh), etc) 0-9 a-z

Constraints: {'minLength': 1, 'maxLength': 1}

Programmes with (librarian) titles whose initial letter is equal/before given letter. Use with initial_letter_start for a range

Constraints: {'minLength': 1, 'maxLength': 1}

Programmes with (librarian) titles whose initial letter is equal/after given letter. Use with initial_letter_end for range.

Constraints: {'minLength': 1, 'maxLength': 1}

filter for subset of programmes with title beginning with initial letter

filter for subset of programmes with linked to versions which have the given item pids

filter for subset of programmes with master_brand

filter for subset of programmes with media set

filter for subset of programmes with media type

Mixins: * alternate_images: mixin to return the alternate images for a programme * ancestor_titles: mixin to return ancestor programme titles * availability: mixin to return programme availability information * available_simulcasts: mixin to return information about programmes that are currently available as simulcasts * available_versions: mixin to return information about programmes that are currently available on demand * available_webcasts: mixin to return information about programmes that are currently available as webcasts * contributions: mixin to return information about contributors to a programme * duration: mixin to return original version duration in programme concept entities * genre_groupings: mixin to return list of genre groupings * genre_groups: mixin to return list of genre groups * images: mixin to add image information for a programme * is_embeddable: mixin to add embeddable information for a programme * previous_next: mixin to return the programmes which appear before and after a programme (as determined by the sort applied in the request) * programme_type: mixin to return the programme type * related_links: mixin to return information about related links to a programme * titles: mixin to return ancestor programme titles * versions_availability: mixin to return information about programmes that are currently available

which page of results to return

Constraints: {'minimum': 1}

number of results in each page

Constraints: {'maximum': 300}

filter for programmes by partner ID

filter for programmes by partner PID

filter for a subset of programmes that are of the given payment_type

filter for subset of programmes with contributions by given people PID

Constraints: {'minLength': 8, 'pattern': '^([0-9,a-d,f-h,j-n,p-t,v-z]){8,}$'}

filter for subset of programmes having given PID

filter for subset of programmes which are promoted for given service

filter for subset of programmes matching supplied keyword/phrase (boolean operators permitted)

filter for subset of programmes that are signed

Sorts: * group_position: sort numerically by position in group, ascending * pid: sort alphabetically by PID, descending * position: sort numerically by position, ascending * promotion: sort by promotion rank, ascending * release_date: sort chronologically by release date, descending * relevance: sort by weighting of search term (use with q parameter) * scheduled_start: sort chronologically by scheduled start time/date, ascending * strict_title: sort alphabetically by title, ascending * title: sort by title librarian style (ignoring leading 'The', 'A', etc), ascending * tree: sort by root pid and then preorder tree sort. Requires entities to have release date.

Constraints: {'enum': ['group_position', 'pid', 'position', 'promotion', 'release_date', 'relevance', 'scheduled_start', 'strict_title', 'title', 'tree']}

Sort direction

Constraints: {'enum': ['ascending', 'descending']}

filter for subset of programmes with tag

filter for subset of programmes with a tag

filter for subset of programmes that are TLEOs

filter for subset of programmes with given PID as one of their versions