Get an existing player by ID

  • Published on Jan 24, 2025
  • 2 minute(s) reading time
Prev Next
Get
/v{version}/Players/{playerId}
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"
Query parameters
includeScreens
boolean

If true, the property Screens is populated. Default: false.

Responses
200

OK

Expand All
object

Player

AdditionalData
object

Additional data of player

property*
string additionalProperties
Address
string

Address of the player

BoxId
string

Box ID of the player

BoxState
string

Box state of the player

Valid values[ "New", "Activated", "Reserved", "Deleted", "Undefined" ]
City
string

City of the player

ConfigurationGroupId
integer (int32)

Unique ID of the configuration group of the player

Minimum1.0
Maximum2147483647.0
Country
string

Country of the player

Created
string (date-time)

Creation date in UTC

CustomId
string

Custom ID of the player

EditionId
integer (int32)

Unique ID of the edition of the player

Minimum1.0
Maximum2147483647.0
Email
string

Email address of the player

FaxNumber
string

Fax number of the player

Id
integer (int32)

Unique ID of the player

IsInstalled
boolean

If true, the player is installed. Default: false.

IsLicensed
boolean

If true, the player is licensed. Default: false.

IsOnline
boolean

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

LastAccess
string (date-time)

Last access date of the player in UTC

Latitude
number (double)

Latitude of the player

LicenseType
string

License type of the player

Valid values[ "Player", "NoLicense", "EntryPlayer", "StandardPlayer", "AdvancedPlayer", "InteractivePlayer", "MultiDisplayPlayer3", "MultiDisplayPlayer4", "AndroidTablet", "SmartScreen", "CiscoIEC4600", "CiscoEdge300340", "DoorSign", "EPaperDisplay", "EPaperManagerPC", "DirectoryDisplay", "Sensor", "DsPlayerEntry", "DsPlayerEntrySaas", "DsPlayerAdvanced", "DsPlayerAdvancedSaas", "DsPlayerPro", "DsPlayerProSaas", "DsPlayerProPlus", "DsPlayerProPlusSaas", "ColorDoorSignPlayer", "ColorDoorSignPlayerSaas", "EPaperDoorSignPlayer", "EPaperDoorSignPlayerSaas", "AudioPlayer", "AudioPlayerSaas", "XPeriencePlatform10", "XPeriencePlatform50", "XPeriencePlatformUnlimited", "EslControlBaseStation", "EslControlExtension100", "EslControlExtension500", "TftEsl", "TftEslInteractive", "StaffWatchSoftware", "TabletInformation", "TabletMediaControl", "TabletNotification" ]
LocationId
integer (int32)

Unique ID of the location of the player

Minimum1.0
Maximum2147483647.0
Longitude
number (double)

Longitude of the player

Modified
string (date-time)

Modification date in UTC

Name
string

Name of the player

PendingTimezoneId
integer (int32)

Unique ID of the desired timezone of the player

Minimum1.0
Maximum2147483647.0
PhoneNumber
string

Phone number of the player

PostCode
string

Postal code of the player

ProvisioningState
string

Provisioning state of the player

Valid values[ "Undefined", "RedirectingPlayer", "PlayerConnected", "PlayerInitializationRequested", "PlayerInitialized" ]
ReadNotificationsCount
integer (int64)

Number of read player notifications

RootPasswordSet
boolean

If true, the root password of the player is already set. Default: false.

Screens
Array of object (V1.Models.Screen)

Screens of player

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

TemperatureUnit
string

Temperature unit of the player

Valid values[ "Undefined", "Celsius", "Fahrenheit" ]
TimezoneId
integer (int32)

Unique ID of the current timezone of the player

Minimum1.0
Maximum2147483647.0
TransferStatus
string

Transfer status of the player

Valid values[ "Complete", "Pending", "Overdue" ]
UnreadNotificationsCount
integer (int64)

Number of unread player notifications

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