Devices Endpoints (2022/06)

{serial}/GET

Return the specified device information

Segment

serial string

The device serial number

______________________________________________________________ 

Response

Success Response with Body

200: Returns the Player Entity

Success Response

304: The resource was not modified since the time specified in the “If-Modified-Since” header

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

404: The server cannot find the requested resource (the path does not exist)

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

{serial}/PUT

Update a specified device. Applies only to the player settings.

Segment

serial string 

The device serial number 

______________________________________________________________

Request Body

The Player Entity

______________________________________________________________

Response

Success

204: The specified device was successfully updated

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request or the request body is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

404: The server cannot find the requested resource (the path does not exist)

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

412: Precondition failed (the resource changed since the time specified in the “If-Unmodified-Since” header value)

415: The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)

5XX: Any 500 code is an internal server error

{serial}/PATCH

Replaces certain parameters on the specified device. Applies only to player settings. See rfc6902.

Segment

serial string

The serial number of the device to delete

______________________________________________________________

Request Body

These properties are entries in an array. Every entry must have all three of these properties:

op string:  The type of operation - in this case it is always "replace"

path string: A Uri path that references the location within the target document where the update will be performed

value:  The replacement value(s) for the id or serial of the group(s). This can be an array.

______________________________________________________________

Response

Success

204: The parameters have been successfully replaced.

Failure

400: Either the request or request body is malformed and therefore invalid

403: The supplied access token, though valid, doesn't provide access to this method

404: The server cannot find the requested resource (the path does not exist)

412: Precondition failed (the resource changed since the time specified in the “If-Unmodified-Since” header value)

415: The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)

5XX: Any 500 code is an internal server error

{serial}/DELETE

Delete the specified device

Segment

serial string

The device serial number 

______________________________________________________________

Response

Success

204: The device was successfully deleted

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

404: The server cannot find the requested resource (the path does not exist)

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

412: Precondition failed (the resource changed since the time specified in the “If-Unmodified-Since” header value)

5XX: Any 500 code is an internal server error

{deviceId:int}/Beacons/GET

Return the array of all beacons defined for the player that is specified

{serial}/Beacons/GET

Return the array of all beacons defined for the player that is specified

{serial}/Beacons/{name}/GET

Returns a device beacon of a certain type associated with a specified device and the specified name

Segment

serial string 

The serial number of the device

name string 

The name of the beacon

______________________________________________________________

Response

Success Response Body

200: Returns the Player Beacon Entity

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

404: The server cannot find the requested resource (the path does not exist)

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

{serial}/Beacons/{name}/DELETE

Delete a specified device beacon on a specified device.

Segment

serial string 

The serial number of the device

name string

The name of the beacon to delete

______________________________________________________________

Response

Success

204: The specified device beacon was successfully deleted from the device

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

404: The server cannot find the requested resource (the path does not exist)

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

{id:int}/Beacons/POST

Create a device beacon

Segment

id int 

A unique identifier for the device instance on which you want to create the beacon

______________________________________________________________

Request Body

The Player Beacon Entity

______________________________________________________________

Response

Success Response Body

201: Returns the new resource created and referenced by the Uri (given by the Location header field) in the response. The response includes the Player Beacon Entity.

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request or request body is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

404: The server cannot find the requested resource (the path does not exist)

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

415: The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)

5XX: Any 500 code is an internal server error

{serial}/Beacons/POST

Create a device beacon on a specified device.

Segment

serial string

The serial number of the device on which you want to create the beacon

______________________________________________________________

Request Body

The Player Beacon Entity

______________________________________________________________

Response

Success Response Body

201: Returns the new resource created and referenced by the Uri (given by the Location header field) in the response. The response includes the Player Beacon Entity.

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request or request body is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

404: The server cannot find the requested resource (the path does not exist)

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

415: The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)

5XX: Any 500 code is an internal server error

{id:int}/Errors/GET

Returns a list of errors associated with a specified device

Segment

id int 

A unique identifier for the device that is reporting the errors

______________________________________________________________

Query String Parameters

marker string optional

A value specifying which page to retrieve. This value is useful if the isTruncated entry in the response body of the previous GET call indicates that the number of error instances exceeds the pageSize.

This parameter is only required if you need more elements in the paged list than the pageSize (100).

pageSize int optional

The maximum number of error instances that can be contained in the response body. 

______________________________________________________________

Response

Success Response Body

200: Returns the Player Error Entity

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

404: The server cannot find the requested resource (the path does not exist)

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

{serial}/Errors/GET

Returns a list of errors associated with a specified device

Segment

serial string 

The serial number of the device that is reporting the errors

______________________________________________________________

Query String Parameters

marker string optional

A value specifying which page to retrieve. This value is useful if the isTruncated entry in the response body of the previous GET call indicates that the number of error instances exceeds the pageSize.

This parameter is only required if you need more elements in the paged list than the pageSize (100).

pageSize int optional

The maximum number of error instances that can be contained in the response body

______________________________________________________________

Response

Success Response Body

200: Returns the Player Error Entity

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

404: The server cannot find the requested resource (the path does not exist)

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

{id:int}/Downloads/GET

Returns the downloads associated with a specified device

Segment

id int 

The unique identifier for the device that has the download instances

______________________________________________________________

Query String Parameters

marker string optional

A value specifying which page to retrieve. This value is useful if the isTruncated entry in the response body of the previous GET call indicates that the number of download instances exceeds the pageSize.

This parameter is only required if you need more elements in the paged list than the pageSize (100).

pageSize int optional

The maximum number of download instances that can be contained in the response body

______________________________________________________________

Response

Success Response Body

200: Returns the Player Download Entity

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

404: The server cannot find the requested resource (the path does not exist)

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

{serial}/Downloads/GET

Returns a list of downloads carried out by a device (specified by serial number).

Segment

serial string

The serial number of the device that has the download instances

______________________________________________________________

Query String Parameters

marker string optional

A value specifying which page to retrieve. This value is useful if the isTruncated entry in the response body of the previous GET call indicates that the number of download instances exceeds the pageSize.

This parameter is only required if you need more elements in the paged list than the pageSize (100).

pageSize int optional

The maximum number of download instances that can be contained in the response body

______________________________________________________________

Response

Success Response Body

200: Returns the Player Download Entity 

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

404: The server cannot find the requested resource (the path does not exist)

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

{deviceid:int}/ScreenShots/GET

Returns a list of screenshots uploaded by a specified device 

Segment

id int

The unique identifier for the device

______________________________________________________________

Query String Parameters

marker string optional

A value specifying which page to retrieve. This value is useful if the isTruncated entry in the response body of the previous GET call indicates that the number of screenshot instances exceeds the pageSize.

This parameter is only required if you need more elements in the paged list than the pageSize (100).

pageSize int optional

The maximum number of screenshot instances that can be contained in the response body

______________________________________________________________

Response

Success Response Body

200: Returns the ScreenShot Entity

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

404: The server cannot find the requested resource (the path does not exist)

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

{serial}/ScreenShots/GET

Returns a list of screenshots uploaded by a specified device 

Segment

serial string

The device serial number

______________________________________________________________

Query String Parameters

marker string optional

A value specifying which page to retrieve. This value is useful if the isTruncated entry in the response body of the previous GET call indicates that the number of screenshot instances exceeds the pageSize.

This parameter is only required if you need more elements in the paged list than the pageSize (100).

pageSize int optional

The maximum number of screenshot instances that can be contained in the response body

______________________________________________________________

Response

Success Response Body

200: Returns the ScreenShot Entity

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

404: The server cannot find the requested resource (the path does not exist)

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

ScreenShots/GET

Returns a list of screenshots uploaded by a device.

Query String Parameters

projection string optional

This parameter currently supports only one placeholder (TOP({int},[Nodes])]) which limits the number of entities in a group. The possible value for {int} is any number from 1 to 100.

filter string optional

An expression for filtering search results

grouping string optional

A grouping expression for the filtered entities. This parameter can be used with the projection parameter to retrieve a certain number of screenshots for a large number of devices in one request (for example, 100 screenshots from 100 players).

sort string optional

An expression for sorting the search results. The sort expression specifies the entry used for sorting and the ascending/descending (ASC/DESC) sorting order (e.g. "[Device].[Serial] ASC")

marker string optional

A value specifying which page to retrieve. This value is useful if the isTruncated entry in the response body of the previous GET call indicates that the number of screenshot instances exceeds the pageSize.

This parameter is only required if you need more elements in the paged list than the pageSize (100).

pageSize int optional

The maximum number of screenshot instances that can be contained in the response body

______________________________________________________________

Response

Success Response Body

200: Returns the ScreenShot Entity

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

{id:int}/Tags/GET

Returns an object whose property names match tag keys and whose property values match tag values on a device

Segment

id int

The unique identifier for the device

______________________________________________________________

Response

Success Response Body

200: A collection of key value pairs where the key is tag name, and the value is tag value. See the Tags entry in Player Entity for more information.

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

404: The server cannot find the requested resource (the path does not exist)

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

{id:int}/Tags/POST

Adds tags to a specified device

Segment

id int

The unique identifier for the device

______________________________________________________________

Request Body

tags DynamicObject: A collection of key value pairs where the key is tag name, and the value is tag value.  See the Tags entry in Player Entity for more information.

______________________________________________________________

Response

Success

204: The tags were added to the specified device 

Failure

400: Either a tag with the specified key was already defined, the request is malformed and therefore invalid, or there is a conflict

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

404: The server cannot find the requested resource (the path does not exist)

415: The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)

5XX: Any 500 code is an internal server error

{id:int}/Tags/DELETE

Remove tags from a specified device

Segment

id int

The unique identifier for the device

______________________________________________________________

Request Body

list string[]: An array of tag keys to delete

______________________________________________________________

Response

Success

204: The specified tag was successfully deleted from the device

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request or request body is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

404: The server cannot find the requested resource (the path does not exist)

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

{serial}/Tags/GET

Returns an object whose property names match tag keys and whose property values match tag values on a device

Segment

serial string

The device serial number

______________________________________________________________

Response

Success Response Body

200: A collection of key value pairs where the key is tag name, and the value is tag value. See the Tags entry in Device Entity for more information.

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

404: The server cannot find the requested resource (the path does not exist)

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

{serial}/Tags/POST

Adds one or more tags to a specified device

Segment

serial string 

The device serial number

______________________________________________________________

Request Body

• [DynamicObject] tags: A collection of key value pairs where the key is tag name, and the value is tag value.  See the Tags entry in Player Entity for more information.

______________________________________________________________

Response

Success

204: The tags were added to the specified device

Failure

400: Either a tag with the specified key was already defined, the request is malformed and therefore invalid, or there is a conflict

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

404: The server cannot find the requested resource (the path does not exist)

415: The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)

5XX: Any 500 code is an internal server error

{serial}/Tags/DELETE

Removes one or more tags from a specified device

Segment

serial string 

The device serial number

______________________________________________________________

Request Body

list string[]: An array of tag keys to delete

______________________________________________________________

Response

Success

204: The specified tag was successfully deleted from the device

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request or request body is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

404: The server cannot find the requested resource (the path does not exist)

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

Models/GET

Returns the list of player models supported by the current Main API version

Response

Success Response Body

200: Returns the complete list of player models that are supported on this Main API version

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

Models/{model}/GET

Returns the list of player models supported by the current Main API version

Segment

model string 

The player model

______________________________________________________________

Response

Success Response Body

200: Returns the complete list of player models that are supported on this Main API version

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)