Get the provisioning session details

  • Updated on Aug 9, 2024
  • Published on Aug 8, 2024
  • 1 minute(s) reading time
Prev Next
Get
/v{version}/PlayerProvisioning/quick/status/{tpid}

The quick install feature must be activated on the server via server configuration.

Path parameters
tpid
stringRequired

Unique ID of the temporary provisioning

version
stringRequired

The requested API version

Default"1.17"
Responses
200

OK

Expand All
object

Provisioning session

Id
string

Unique ID of the provision session

UniqueHardwareId
string

Identifier of the connected player of the provision session e.g. MAC address

Status
string

Status of the provision session

Valid values[ "Created", "UserConnected", "RedirectingPlayer", "Redirected", "Cancelled" ]
BoxId
string

Box ID of the connected player of the provision session

ServerUrl
string

Server URL of the provision session

CustomerCode
string

Custom code of the connected player of the provision session

CustomerId
integer (int32)

Unique ID of the customer of the provision session

Username
string

Unique username of the connected user of the provision session

UserId
integer (int32)

Unique ID of the connected user of the provision session

EditionCode
string (uuid)

Unique code of the edition of the connected player of the provision session

Example00000000-0000-0000-0000-000000000000
RemoteIpAddress
string

Remote IP address of the provision session

PlayerHeartbeat
string (date-time)

Last heart beat time of the connected player of the provision session relative to UTC time

UserHeartbeat
string (date-time)

Last heart beat time of the connected user of the provision session relative to UTC time

Errors
Array of object (V1.Models.ProvisioningSessionError)

List of errors of the provision session

object

Item of the

Origin
string

Origin of the provisioning error

Valid values[ "Player", "Server" ]
Created
string (date-time)

Creation date of the provisioning error relative to UTC time.

Level
string

Error level of the provisioning error

Valid values[ "Critical", "Error", "Warning", "Information" ]
Message
string

Message of the provisioning error

400

Bad request

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

Access denied

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

ProvisioningSession not found.

500

Unexpected error

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