Get the provisioning session details

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

Responses
200

Returns the provisioning session details.

Expand All
object

Provisioning session

BoxId
string

Box ID of the connected player 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

EditionCode
string (uuid)

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

Errors
Array of object (V1.Models.ProvisioningSessionError)

List of errors of the provision session

object

Item of the Grassfish.Webservices.Rest.GrassfishServerAPI.V1.Models.ProvisioningSession.Errors

Created
string (date-time)

Creation date of the provisioning error relative to UTC time.

Level
string

Error levels of the provisioning session

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

Message of the provisioning error

Origin
string

Origins of the provisioning error

Valid values[ "Player", "Server" ]
Id
string

Unique ID of the provision session

PlayerHeartbeat
string (date-time)

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

RemoteIpAddress
string

Remote IP address of the provision session

ServerUrl
string

Server URL of the provision session

Status
string

States of the provisioning session

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

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

UserHeartbeat
string (date-time)

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

UserId
integer (int32)

Unique ID of the connected user of the provision session

Username
string

Unique username of the connected user of the provision session

400

Bad request

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

Unauthorized

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

Access denied

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

ProvisioningSession not found.

Expand All
object
Detail
string
Instance
string
Status
integer (int32)
Title
string
Type
string
property*
object additionalProperties
500

Unexpected error

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