GET /groups/{pid}/episodes

bbci.co.uk

Summary: Get episodes by group, brand or series
Operation ID: Get_Episodes by group_
Auth: none
Description

Get episodes by group, brand or series

Parameters (9)

availability (string, query, required, default: available)

Whether to return all, or available programmes

Constraints: {'enum': ['all', 'available']}

initial_child_count (integer, query, required, default: 4)

The depth to return child entities.

Constraints: {'minimum': 1, 'maximum': 4}

mixin (array, query, optional)

Request additional data in the output

Constraints: {'enum': ['live', 'promotions']}

page (integer, query, required)

The page index.

per_page (integer, query, required)

The number of results to return.

pid (string, path, required)

The programme identifier.

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

rights (string, query, required, default: web)

The rights group to limit results to.

Constraints: {'enum': ['mobile', 'tv', 'web']}

sort (string, query, required)

The sort order of the results.

sort_direction (string, query, required)

Whether to sort ascending or descending

Constraints: {'enum': ['asc', 'desc']}

No probe data for this endpoint yet.