Change an existing screen of an existing player

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

Api Key

API Key
Header parameter nameX-Session-Id

Session Id

Path parameters
number
integer (int32) Required

Number of the player's screen

playerId
integer (int32) Required

Unique ID of the player

version
stringRequired

The requested API version

Default"1.18"
Body parameters

Change request that contains the new information of the player's screen

object

Player's screen

DisplayName
string

Display name of the screen

IsOn
boolean

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

Number
integer (int32)

Number of the screen

Minimum1.0
Maximum2.0
PendingOrientation
integer (int32)

Pending orientation of the screen

Responses
200

OK

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