Get a list of playlist version items of an existing playlist version

  • Published on Jan 24, 2025
  • 1 minute(s) reading time
Prev Next
Get
/v{version}/Players/{playerId}/PlaylistVersions/{playlistVersionId}
Security
API Key
Header parameter nameX-ApiKey

Api Key

API Key
Header parameter nameX-Session-Id

Session Id

Path parameters
playerId
integer (int32) Required

Unique ID of the player

playlistVersionId
integer (int32) Required

Unique ID of the playlist version

version
stringRequired

The requested API version

Default"1.18"
Responses
200

OK

Array of object
object

A response model for a playlist version item i.e. spot instance

DailyFrom
string

Daily from time of the playlist version item

Pattern[0-9]{2}\:[0-9]{2}(\:[0-9]{2})?
DailyTo
string

Daily to time of the playlist version item

Pattern[0-9]{2}\:[0-9]{2}(\:[0-9]{2})?
DurationSeconds
integer (int32)

Duration in seconds of the playlist version item

Id
integer (int32)

Unique ID of the playlist version item

Loops
object

Loops limit of the playlist version item

One
boolean
Two
boolean
Three
boolean
Four
boolean
Five
boolean
Six
boolean
Mute
boolean

If true, the item is muted. Default: false.

Name
string

Name of the playlist version item

SequenceNumber
integer (int32)

Position of the playlist version item

SpotId
integer (int32)

Unique ID of the spot of the playlist version item

ValidFrom
string (date-time)

Valid from date of the playlist version item

ValidTo
string (date-time)

Valid to date of the playlist version item

ValidWeekDays
object

Weekdays limit of the playlist version item

Sunday
boolean
Monday
boolean
Tuesday
boolean
Wednesday
boolean
Thursday
boolean
Friday
boolean
Saturday
boolean
Holiday
boolean
400

Bad request

Expand All
object
ValidationErrors
object
property*
Array of string additionalProperties
string
403

Player access denied

404

Player or playlist version not found.

500

Unexpected error

Expand All
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties