v1

latestOpenAPI 3.0.02026-07-142213168.2 KB
ClassificationInclusion

Get ClassificationInclusion records

Classification Inclusions connect classifications with entities like series, episodes, or campaigns, amongst others.

In order to retrieve a set of classification inclusions, at least one of the following filter parameters must be provided. Failing to do so renders a 400 Bad Request response.

  • ids[]
  • classified_id and classified_type
  • classified_id and classification_type
  • classification_id and classified_type
get/classification_inclusions

Query parameters

ids[]string[]

The list of IDs to filter by. Repeat this parameter for each ID you want to include in the filter. The brackets MUST be percent-encoded, per the requirements in RFC 3986 § 3.4.

page[number]integer

Select which page number to receive results for. Pages are numbered starting at 1.

page[size]integer

Indicate how many records to return per page. The maximum is 100.

classification_idstring uuid

Limit the result to classification inclusions linked to a classification with this ID.

classification_type'AlternateFeedType' | 'Genre' | 'Industry' | 'Language' | 'MediaRating'

The type of classification that the classification inclusions are linked to. Depending on the permissions of your credential, only a subset of these types are usable.

classified_idstring uuid

Limit the result to classification inclusions linked to a resource with this ID. You will have to use this filter together with either classified_type or classification_type.

classified_type'Series' | 'Season' | 'Episode'

Limit the result to classification inclusions linked to this type of entity.

qstring

Limit the result to classification inclusions linked to a classification containing the parameter value disregarding case.

sortstring[]

Specify how to sort the result. Please refer to either the top section or the JSON:API specification on how sorting works in general.

Response

Success

All 22 operations