Request a new screenshot of an existing player

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

object

Player's screenshot details

Created
string (date-time)

Creation date in UTC

FileName
string

File name of the screenshot

Id
integer (int32)

Unique ID of the screenshot

Modified
string (date-time)

Modification date in UTC

Status
string

Status of the screenshot

Valid values[ "Pending", "InProgress", "Failed", "Finished" ]
400

Bad request

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

Access denied

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

Not found

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

Player is not initialized

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

Unexpected error

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