GET /groups

Control return of embargoed items (undocumented)

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

filter for groups related to given programme or its descendants

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

filter for subset of groups directly related to a given programme

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

filter for subset of groups 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 groups that have the given group type

filter for subset of groups which contain an entity with the given pid as a member

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

Mixins: * alternate_images: mixin to return the alternate images for a group * group_for: mixin to return links to programme entities that group belongs to * images: mixin to add image information for a group * related_links: mixin to return related links for the group

which page of results to return

Constraints: {'minimum': 1}

number of results in each page

Constraints: {'maximum': 300}

filter for groups by partner ID

filter for groups by partner PID

filter for subset of seasons, collections, galleries or franchises having given PID

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

Sorts: * pid: sort alphabetically by PID

Constraints: {'enum': ['pid']}

Sort direction

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