Get a list of player file sync status overviews

Prev Next
Get
/v{version}/FileSync/Status
Security
API Key
Header parameter nameX-ApiKey

Api Key

API Key
Header parameter nameX-Session-Id

Session Id

Path parameters
version
stringRequired

The requested API version

Default"1.18"
Query parameters
locationId
integer (int32)

Unique ID of the location

Responses
200

OK

Array of object
object

Status overview of file sync players

BoxId
string

Box ID of the player

City
string

City of the player

Count
integer (int32)

Total amount of files to by synced

Country
string

Country of the player

CustomId
string

Custom ID of the player

ErrorReceived
string (date-time)

Date of receiving the last error in UTC

LastAccess
string (date-time)

Last access date of player in UTC

LastRequest
string (date-time)

Date of the last request in UTC

LocationId
integer (int32)

Unique ID of the location

PlayerId
integer (int32)

Unique ID of the player

PlayerName
string

Name of the player

ProjectNames
string

Project's names

ScreenGroupNames
string

Screen group names

SyncedCount
integer (int32)

Amount of synced files

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
500

Unexpected error

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