Get a list of screens of an existing player

  • Published on Jan 24, 2025
  • 1 minute(s) reading time
Prev Next
Get
/v{version}/Players/{playerId}/Screens
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

version
stringRequired

The requested API version

Default"1.18"
Responses
200

OK

Array of object
object

Player's screen

DisplayName
string

Display name of the screen

Id
integer (int32)

Unique ID of screen

IsOn
boolean

If true, the screen is online. Default: false.

LastStatusChange
string (date-time)

Last time the screen's status was changed in UTC

LastUpdate
string (date-time)

Last time the screen was updated in UTC

Number
integer (int32)

Number of the screen

Minimum1.0
Maximum2.0
Orientation
integer (int32)

Orientation of the screen

PendingOrientation
integer (int32)

Pending orientation of the screen

Status
integer (int32)

Status of the screen

400

Bad request

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

Player access denied

404

Player not found.

500

Unexpected error

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