Playout API
/
Episode timeline

Media Jay Playout API (2025-08-04)

The playout API of the Media Jay application provides access to the playout data and orchestrates extended queries.

Authentication

To access the endpoints you require a X-API-Key in the header. Partners, please contact Transfermedia support@transfermedia.de to retrieve one.

Versioning

To use a specific implementation version of this API place it to the request header X-API-Version. If the header is missed the latest implementation version 2025-08-04 is used. The response header X-API-Version returns the implementation version the request was processed with.

Further documentation

For further details please visit the documentation or contact Transfermedia support@transfermedia.de.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Development Server

https://docs.jay-metadata.com/_mock/apis/playout/latest/openapi/

Session Tracking

APIs for managing user tracking sessions. These endpoints allow clients to create, retrieve, and delete tracking sessions which are used for analytics and user behavior tracking.

Operations

Formats

Access to formats metadata (aka movie collections or series).

Operations

Episodes

Access to episode metadata and general information.

Operations

Episode items

Information about episode items.

Operations

Episode timeline

Information about timeline events with complete timing information.

Operations

Retrieve all timeline events for an episode

Request

Retrieves all timeline events from an episode with optional time filtering.

Timeline events represent time-based points or ranges within the content where interactive elements, metadata, or other content enhancements are available. These events are the foundation for interactive video experiences and synchronized metadata display.

Timeline events enable precisely timed interactions, product placements, character information, and other contextual content to appear at appropriate moments during playback.

The timeline events system supports two types of time filtering:

  1. Millisecond-based filtering: Using the absolute time in milliseconds from the start

  2. Timecode filtering: Using industry-standard SMPTE timecode (hh:mm:ss:ff)

Each event has a kind that indicates what type of content it represents (scene, product, character, etc.) and contains references or inline data about that content.

Args:

request: the complete request. playout_id: The playout identifier (aka tenant identifier) for authentication and content selection. episode_id: The specific episode identifier to retrieve timeline from. filter_time: Optional timestamp in milliseconds to find events active at that time. filter_time_tc: Optional timecode in hh:mm:ss:ff format for time-based filtering. inline_level: The number of levels to expand inner object inline.

Returns:

ResultResponse[List[PlayoutTimelineEvent]]: A chronologically ordered list of timeline events, each with start/end times and associated content references or inline data.

Raises:

ApiHttpException: When the episode is not found, or when timeline or description data is unavailable or invalid.

Path
playoutIdstring(playout identifier)required

The playout identifier (aka tenant identifier) addressing the correct content of the streaming platform.

episodeIdstring(episode identifier)required

The episode identifier.

Query
filterTimeinteger(time of interest)

The time in milliseconds to get the scene for.

filterTimecodestring(time code (hh:mm:ss:ff) of interest)^\d\d:\d\d:\d\d:\d\d$

The time code (hh:mm:ss:ff) to get the scene for.

inlineLevelinteger(inline level)[ 0 .. 4 ]

The number of levels to expand inner object inline. The lower this number the faster the response.

Default 0
Example: inlineLevel=1
Headers
X-API-Keystring(X-Api-Key)required

Required. API access key for authorized use of the checkout endpoints. Partners, please contact Transfermedia to retrieve a valid key.

__Secure-jay_trackingstring( Secure-Jay Tracking)

Tracking session header for user tracking and analytics. This is set by the /playouts/tracking/session endpoint.

Example: __Secure-jay_tracking=eyJzZX...
curl -i -X GET \
  'https://docs.jay-metadata.com/_mock/apis/playout/latest/openapi/playouts/{playoutId}/episodes/{episodeId}/timeline/events?filterTime=0&filterTimecode=string&inlineLevel=1' \
  -H 'X-API-Key: string' \
  -H '__Secure-jay_tracking: __Secure-jay_tracking=eyJzZX...'

Responses

Successfully retrieved timeline events with complete timing information

Bodyapplication/json
dataArray of objects(The response data)

The response data.

Example: [{"id":"string","kind":"<<enum 'PlayoutKindType'>>","character":{"id":"string","kind":"<<enum 'PlayoutKindType'>>","role":"string","name":"string","gender":"string","salutationTitle":"string","givenName":"string","linkingName":"string","familyName":"string","age":0,"yearOfBirth":"string","placeOfBirth":"string","countryOfBirth":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"locationIds":["item"],"locations":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","name":"string","title":"string","subtitle":"string","description":"string","street":"string","addition":"string","postcode":"string","city":"string","country":"string","longitude":"string","latitude":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}]}],"costumeIds":["item"],"costumes":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","type":"string","name":"string","brand":"string","subtitle":"string","description":"string","gender":"string","category":"string","fit":"string","material":"string","color":"string","colorCode":"string","country":"string","images":[{"url":"string","copyright":"string"}],"imagesLogo":"string","imagesLogoCopyright":"string","links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","variantsCompact":"string","variants":[{"title":"string","content":"string","sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","cartUrl":"string","basketProductId":"string"}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"linkedToProductIds":["item"],"linkedToProducts":["item"],"basketProductId":"string"}],"productIds":["item"],"products":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","type":"string","name":"string","brand":"string","subtitle":"string","description":"string","gender":"string","category":"string","fit":"string","material":"string","color":"string","colorCode":"string","country":"string","images":[{"url":"string","copyright":"string"}],"imagesLogo":"string","imagesLogoCopyright":"string","links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","variantsCompact":"string","variants":[{"title":"string","content":"string","sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","cartUrl":"string","basketProductId":"string"}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"linkedToProductIds":["item"],"linkedToProducts":["item"],"basketProductId":"string"}],"propIds":["item"],"props":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","type":"string","name":"string","brand":"string","subtitle":"string","description":"string","gender":"string","category":"string","fit":"string","material":"string","color":"string","colorCode":"string","country":"string","images":[{"url":"string","copyright":"string"}],"imagesLogo":"string","imagesLogoCopyright":"string","links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","variantsCompact":"string","variants":[{"title":"string","content":"string","sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","cartUrl":"string","basketProductId":"string"}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"linkedToProductIds":["item"],"linkedToProducts":["item"],"basketProductId":"string"}]},"actor":{"id":"string","kind":"<<enum 'PlayoutKindType'>>","role":"string","name":"string","gender":"string","salutationTitle":"string","givenName":"string","linkingName":"string","familyName":"string","age":0,"yearOfBirth":"string","placeOfBirth":"string","countryOfBirth":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"locationIds":["item"],"locations":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","name":"string","title":"string","subtitle":"string","description":"string","street":"string","addition":"string","postcode":"string","city":"string","country":"string","longitude":"string","latitude":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}]}],"costumeIds":["item"],"costumes":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","type":"string","name":"string","brand":"string","subtitle":"string","description":"string","gender":"string","category":"string","fit":"string","material":"string","color":"string","colorCode":"string","country":"string","images":[{"url":"string","copyright":"string"}],"imagesLogo":"string","imagesLogoCopyright":"string","links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","variantsCompact":"string","variants":[{"title":"string","content":"string","sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","cartUrl":"string","basketProductId":"string"}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"linkedToProductIds":["item"],"linkedToProducts":["item"],"basketProductId":"string"}],"productIds":["item"],"products":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","type":"string","name":"string","brand":"string","subtitle":"string","description":"string","gender":"string","category":"string","fit":"string","material":"string","color":"string","colorCode":"string","country":"string","images":[{"url":"string","copyright":"string"}],"imagesLogo":"string","imagesLogoCopyright":"string","links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","variantsCompact":"string","variants":[{"title":"string","content":"string","sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","cartUrl":"string","basketProductId":"string"}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"linkedToProductIds":["item"],"linkedToProducts":["item"],"basketProductId":"string"}],"propIds":["item"],"props":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","type":"string","name":"string","brand":"string","subtitle":"string","description":"string","gender":"string","category":"string","fit":"string","material":"string","color":"string","colorCode":"string","country":"string","images":[{"url":"string","copyright":"string"}],"imagesLogo":"string","imagesLogoCopyright":"string","links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","variantsCompact":"string","variants":[{"title":"string","content":"string","sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","cartUrl":"string","basketProductId":"string"}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"linkedToProductIds":["item"],"linkedToProducts":["item"],"basketProductId":"string"}]},"location":{"id":"string","kind":"<<enum 'PlayoutKindType'>>","name":"string","title":"string","subtitle":"string","description":"string","street":"string","addition":"string","postcode":"string","city":"string","country":"string","longitude":"string","latitude":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}]},"costume":{"id":"string","kind":"<<enum 'PlayoutKindType'>>","type":"string","name":"string","brand":"string","subtitle":"string","description":"string","gender":"string","category":"string","fit":"string","material":"string","color":"string","colorCode":"string","country":"string","images":[{"url":"string","copyright":"string"}],"imagesLogo":"string","imagesLogoCopyright":"string","links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","variantsCompact":"string","variants":[{"title":"string","content":"string","sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","cartUrl":"string","basketProductId":"string"}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"linkedToProductIds":["item"],"linkedToProducts":["item"],"basketProductId":"string"},"prop":{"id":"string","kind":"<<enum 'PlayoutKindType'>>","type":"string","name":"string","brand":"string","subtitle":"string","description":"string","gender":"string","category":"string","fit":"string","material":"string","color":"string","colorCode":"string","country":"string","images":[{"url":"string","copyright":"string"}],"imagesLogo":"string","imagesLogoCopyright":"string","links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","variantsCompact":"string","variants":[{"title":"string","content":"string","sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","cartUrl":"string","basketProductId":"string"}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"linkedToProductIds":["item"],"linkedToProducts":["item"],"basketProductId":"string"},"product":{"id":"string","kind":"<<enum 'PlayoutKindType'>>","type":"string","name":"string","brand":"string","subtitle":"string","description":"string","gender":"string","category":"string","fit":"string","material":"string","color":"string","colorCode":"string","country":"string","images":[{"url":"string","copyright":"string"}],"imagesLogo":"string","imagesLogoCopyright":"string","links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","variantsCompact":"string","variants":[{"title":"string","content":"string","sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","cartUrl":"string","basketProductId":"string"}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"linkedToProductIds":["item"],"linkedToProducts":["item"],"basketProductId":"string"},"music":{"id":"string","kind":"<<enum 'PlayoutKindType'>>","name":"string","subtitle":"string","description":"string","artist":"string","album":"string","duration":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}]},"ticket":{"id":"string","kind":"<<enum 'PlayoutKindType'>>","name":"string","location":"string","description":"string","playtimes":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"productIds":["item"],"products":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","type":"string","name":"string","brand":"string","subtitle":"string","description":"string","gender":"string","category":"string","fit":"string","material":"string","color":"string","colorCode":"string","country":"string","images":[{"url":"string","copyright":"string"}],"imagesLogo":"string","imagesLogoCopyright":"string","links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","variantsCompact":"string","variants":[{"title":"string","content":"string","sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","cartUrl":"string","basketProductId":"string"}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"linkedToProductIds":["item"],"linkedToProducts":["item"],"basketProductId":"string"}]},"theme":{"id":"string","kind":"<<enum 'PlayoutKindType'>>","name":"string","subtitle":"string","author":"string","dateCreated":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"productIds":["item"],"products":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","type":"string","name":"string","brand":"string","subtitle":"string","description":"string","gender":"string","category":"string","fit":"string","material":"string","color":"string","colorCode":"string","country":"string","images":[{"url":"string","copyright":"string"}],"imagesLogo":"string","imagesLogoCopyright":"string","links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","variantsCompact":"string","variants":[{"title":"string","content":"string","sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","cartUrl":"string","basketProductId":"string"}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"linkedToProductIds":["item"],"linkedToProducts":["item"],"basketProductId":"string"}]},"basic":{"id":"string","kind":"<<enum 'PlayoutKindType'>>","name":"string","subtitle":"string","description":"string","brand":"string","material":"string","color":"string","colorCode":"string","dimensions":"string","ingredients":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"productIds":["item"],"products":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","type":"string","name":"string","brand":"string","subtitle":"string","description":"string","gender":"string","category":"string","fit":"string","material":"string","color":"string","colorCode":"string","country":"string","images":[{"url":"string","copyright":"string"}],"imagesLogo":"string","imagesLogoCopyright":"string","links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","variantsCompact":"string","variants":[{"title":"string","content":"string","sku":"string","price":"string","priceFloat":0,"originalPrice":"string","currency":"string","cartUrl":"string","basketProductId":"string"}],"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}],"linkedToProductIds":["item"],"linkedToProducts":["item"],"basketProductId":"string"}]},"start":0,"end":0,"startTc":"string","endTc":"string","scene":"string","groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"characters":["item"],"actorIds":["item"],"actors":["item"],"locationIds":["item"],"locations":["item"],"costumeIds":["item"],"costumes":["item"],"productIds":["item"],"products":["item"],"propIds":["item"],"props":["item"],"ticketIds":["item"],"tickets":["item"],"themeIds":["item"],"themes":["item"],"basicIds":["item"],"basics":["item"],"musicIds":["item"],"musics":["item"]}]}]
errorobject(The error response)

Represents a data response with a possible error.

Response
application/json
{
  "data": [
    { … }
  ]
}

Episode groups

Information about existing groups.

Operations

Episode scenes

Information about the scenes.

Operations

Episode companies involved

Information about the involved companies.

Operations

API information

Operations