Playout API
/
Episode items
/
Get location details.

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

List all locations in the episode

Request

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
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}/locations?inlineLevel=1' \
  -H 'X-API-Key: string' \
  -H '__Secure-jay_tracking: __Secure-jay_tracking=eyJzZX...'

Responses

Successfully retrieved list of locations

Bodyapplication/json
dataArray of objects(The response data)

The response data.

Example: [{"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"]}]}]
errorobject(The error response)

Represents a data response with a possible error.

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

Get location details.

Request

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.

locationIdstring(identifier)required

The identifier of the location

Query
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}/locations/{locationId}?inlineLevel=1' \
  -H 'X-API-Key: string' \
  -H '__Secure-jay_tracking: __Secure-jay_tracking=eyJzZX...'

Responses

Successfully retrieved location details

Bodyapplication/json
dataobject(The response data)

Represents a location

Example: {"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"]}]}
errorobject(The error response)

Represents a data response with a possible error.

Response
application/json
{
  "data": {
    "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": [ … ],
    "links": [ … ],
    "groupIds": [ … ],
    "groups": [ … ]
  }
}

List all costumes in the episode

Request

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
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}/costumes?inlineLevel=1' \
  -H 'X-API-Key: string' \
  -H '__Secure-jay_tracking: __Secure-jay_tracking=eyJzZX...'

Responses

Successfully retrieved list of costumes

Bodyapplication/json
dataArray of objects(The response data)

The response data.

Example: [{"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"}]
errorobject(The error response)

Represents a data response with a possible error.

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

Episode timeline

Information about timeline events with complete timing information.

Operations

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