Devices Endpoints (2020/10)

This endpoint allows for management and monitoring of devices on the network. 

Base URL for these endpoints:  https://api.bsn.cloud/2020/10/REST/Devices

_________________________________________________________________________

GET /

Retrieves a list of devices on the network.

Required Scope Token

bsn.api.main.devices.retrieve

______________________________________________________________

Query String Parameters

filter string  optional

An expression for filtering search results

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 device 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 device instances that can be contained in the response body

______________________________________________________________

Response 

Success Response Body

200: Returns a paged list of Player Entity instances on a network. This will return not more than 100 entities along with the information necessary to return any other remaining pages.

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

DELETE /

Removes devices, specified by a filter, from a network. This allows multiple devices to be deleted at once.

Required Scope Token

bsn.api.main.devices.delete

______________________________________________________________

Query String Parameter

filter string required

An expression for filtering search results

______________________________________________________________

Response

Success Response Body

200: Returns the number of affected devices as an integer value.

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

GET /Regions/{*locationPath}/ 

Returns a region which contains all the players located in the specified path.

Required Scope Token

bsn.api.main.devices.retrieve

______________________________________________________________

Segment

locationPath string 

The parts of the returned player location path (country, province, city, etc.) that are common to all players. 

______________________________________________________________

Query String Parameter

filter string optional

An expression for filtering search results

______________________________________________________________

Response

Success Response Body

200: Returns the Players Region 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

GET /Count/ 

Retrieves the number of devices on the network matching the specified filter criteria. If no filter is included, this call returns the total number of devices on the network. 

Required Scope Token

bsn.api.main.devices.retrieve

______________________________________________________________

Query String Parameter

filter string optional

An expression for filtering search results

______________________________________________________________

Response

Success

200: The device count is returned as an integer value

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

GET /{id:int}/ 

Return the information for a specified device on a network

Required Scope Token

bsn.api.main.devices.retrieve

______________________________________________________________

Segment

id int 

A unique identifier for the device

______________________________________________________________

Response

Success Response 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

PUT /{id:int}/ 

Update a specified device. This applies only to player settings.

Required Scope Token

bsn.api.main.devices.update

______________________________________________________________

Segment

id int

A unique identifier for the device

______________________________________________________________

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: Either 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)

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

PATCH /{id:int}/ 

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

Required Scope Token

bsn.api.main.devices.update

______________________________________________________________

Segment

id int

A unique identifier for the device

______________________________________________________________

Request Body

The body is an array of entries with the following three properties:

• op string:  The type of operation - only "replace" is currently supported.

• path string:  The target location of the value that will be replaced. This location must exist for the operation to be successful.

• value object:  The replacement value(s) for parameters that must be updated

______________________________________________________________

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

DELETE /{id:int}/ 

Delete the specified device

Required Scope Token

bsn.api.main.devices.delete

______________________________________________________________

Segment

id int

A unique identifier for the device

______________________________________________________________

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

GET /{serial}/ 

Return the specified device information (specified by serial number)

Required Scope

bsn.api.main.devices.retrieve

______________________________________________________________

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

PUT /{serial}/ 

Update a specified device. This applies only to player settings.

Required Scope Token

bsn.api.main.devices.update

______________________________________________________________

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

PATCH /{serial}/ 

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

Required Scope Token

bsn.api.main.devices.update

______________________________________________________________

Segment

serial string

The device serial number 

______________________________________________________________

Request Body

The body is an array of entries with the following three properties:

______________________________________________________________

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

DELETE /{serial}/ 

Delete the specified devices

Required Scope Token

bsn.api.main.devices.delete

______________________________________________________________

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

GET /{deviceId:int}/Beacons/ 

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

Required Scope Token

bsn.api.main.devices.retrieve
______________________________________________________________

Segment

deviceId int

A unique identifier for the device instance

______________________________________________________________

Response

Success Response Body

200: The collection of Player Beacon Entities

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

GET /{serial}/Beacons/ 

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

Required Scope Token

bsn.api.main.devices.retrieve

______________________________________________________________

Segment

serial string

The serial number of the device instance

______________________________________________________________

Response

Success Response Body

200: The collection of Player Beacon Entities

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

GET /{deviceId:int}/Beacons/{name}/ 

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

Required Scope Token

bsn.api.main.devices.retrieve

______________________________________________________________

Segment

deviceId int

A unique identifier for the device instance

name string 

The name of the device 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

DELETE /{deviceId:int}/Beacons/{name}/ 

Delete a specified device beacon from a specified device.

Required Scope Token

bsn.api.main.devices.update

______________________________________________________________

Segment

deviceId int

A unique identifier for the device instance

name string 

The name of the device beacon

______________________________________________________________ 

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

GET /{serial}/Beacons/{name}/ 

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

Required Scope Token

bsn.api.main.devices.retrieve

______________________________________________________________

Segment

serial string 

The serial number of the device

name string 

The name of the device 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

DELETE /{serial}/Beacons/{name}/ 

Delete a specified device beacon on a specified device.

Required Scope Token

bsn.api.main.devices.update

______________________________________________________________

Segment

serial string 

The serial number of the device

name string 

The name of the device beacon

______________________________________________________________

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

POST /{id:int}/Beacons/ 

Create a device beacon.

Required Scope Token

bsn.api.main.devices.update

______________________________________________________________

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

POST /{serial}/Beacons/ 

Create a device beacon on a specified device.

Required Scope Token

bsn.api.main.devices.update

______________________________________________________________

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

GET /{id:int}/Errors/ 

Returns a list of errors associated with a specified device

Required Scope Token

bsn.api.main.devices.retrieve

______________________________________________________________

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

GET /{serial}/Errors/ 

Returns a list of errors associated with a specified device

Required Scope Token

bsn.api.main.devices.retrieve
______________________________________________________________

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

GET /{id:int}/Downloads/ 

Returns the downloads associated with a specified device

Required Scope Token

bsn.api.main.devices.retrieve
______________________________________________________________

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

GET /{serial}/Downloads/ 

Returns a list of downloads carried out by a specified device

Required Scope Token

bsn.api.main.devices.retrieve

______________________________________________________________

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

GET /{deviceid:int}/ScreenShots/ 

Returns a list of screenshots uploaded by a specified device

Required Scope Token

bsn.api.main.devices.retrieve

______________________________________________________________

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 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 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

GET /{serial}/ScreenShots/ 

Returns a list of screenshots uploaded by a specified device

Required Scope Token

bsn.api.main.devices.retrieve

______________________________________________________________

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 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 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

GET /ScreenShots/ 

Returns a list of screenshots uploaded by a device.

Required Scope Token

bsn.api.main.devices.retrieve

______________________________________________________________

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

GET /{id:int}/Tags/ 

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

Required Scope Token

bsn.api.main.devices.retrieve

______________________________________________________________

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

POST /{id:int}/Tags/ 

Adds tags to a specified device

Required Scope Token

bsn.api.main.devices.update

______________________________________________________________

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

DELETE /{id:int}/Tags/ 

Remove tags from a specified device (specified by device id).

Required Scope Token

bsn.api.main.devices.update

______________________________________________________________

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

GET /{serial}/Tags/ 

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

Required Scope Token

bsn.api.main.devices.retrieve

______________________________________________________________

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

POST /{serial}/Tags/ 

Adds one or more tags to a specified device (specified by device serial number).

Required Scope Token

bsn.api.main.devices.update
______________________________________________________________

Segment

serial string

The device serial number

______________________________________________________________

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

DELETE /{serial}/Tags/ 

Removes one or more tags from a specified device (specified by device serial number).

Required Scope Token

bsn.api.main.devices.update

______________________________________________________________

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

GET /Models/ 

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

Required Scope Token

bsn.api.main.devices.retrieve

______________________________________________________________

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

GET /Models/{model}/ 

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

Required Scope Token

bsn.api.main.devices.retrieve

______________________________________________________________

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)

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 provided player model does not exist (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

GET /Models/{model}/Connectors/ 

Returns the list of connectors available on a given device model

Required Scope Token

bsn.api.main.devices.retrieve

______________________________________________________________

Segment

model string

The player model

______________________________________________________________

Response

Success Response Body

200: Returns the list of connectors available on a given device model

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 provided player model does not exist or is incorrect 

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

GET /Models/{model}/Connectors/{connector}/ 

Returns the list of connectors available on a given device model. 

Required Scope Token

bsn.api.main.devices.retrieve

______________________________________________________________

Segment

model string 

The player model

connector string

The video connector (for example, "HDMI" or "DisplayPort")

______________________________________________________________

Response

Success Response Body

200: Returns the list of connectors available on a given device model

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 provided player model or connector does not exist or is incorrect

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

GET /Models/{model}/Connectors/{connector}/VideoModes/ 

Returns the video modes supported by the specified connector on the specified device model

Required Scope Token

bsn.api.main.devices.retrieve

______________________________________________________________

Segment

model string

The player model

connector string

The video connector (for example, "HDMI" or "DisplayPort")

______________________________________________________________

Response 

Success Response Body

200: The response body is an array of strings listing video modes supported by the specified connector on the specified device model.

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 provided player model or connector does not exist or is incorrect

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

GET /Operations/ 

Returns operational permissions granted to roles for specific business operations

Required Scope Token

bsn.api.main.operations.retrieve

______________________________________________________________

Response

Success Response Body

200: Returns the Business Operations 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

GET /{id:int}/Permissions/ 

Returns the list of permissions allowing or denying specific business operations to be executed on a specified device.

Required Scope Token

bsn.api.main.devices.retrieve
______________________________________________________________

Segment

id int 

A unique identifier for the device

______________________________________________________________

Response

Success Response Body

200: Returns an array of Permission entities 

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

POST /{id:int}/Permissions/ 

Applies permissions allowing or denying specific business operations to be executed on a specified device.

Required Scope Token

bsn.api.main.devices.update

______________________________________________________________

Segment

id int 

A unique identifier for the device

 ______________________________________________________________

Request Body

An array of Permission entities

______________________________________________________________

Response

Success

204: The specified permissions were successfully granted

Failure

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)

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

DELETE /{id:int}/Permissions/ 

Removes custom permissions granted to execute business operations from a specified device 

Required Scope Token

bsn.api.main.devices.update

______________________________________________________________

Segment

id int 

A unique identifier for the device

______________________________________________________________

Request Body

An array of Permission entities

______________________________________________________________

Response

Success

204: The specified permissions were 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

GET /{serial}/Permissions/ 

Returns the list of permissions allowing or denying specific business operations to be executed on a specified device

Required Scope Token

bsn.api.main.devices.retrieve

______________________________________________________________

Segment

serial string 

The serial number of the device

______________________________________________________________

Response

Success Response Body

200: Returns an array of Permission entities 

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

POST /{serial}/Permissions/ 

Applies permissions allowing or denying specific business operations to be executed on a specified device

Required Scope Token

bsn.api.main.devices.update

______________________________________________________________

Segment

serial string 

The serial number of the device

______________________________________________________________

Request Body

An array of Permission entities

______________________________________________________________

Response

Success

204: The specified permissions were successfully granted

Failure

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)

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

DELETE /{serial}/Permissions/ 

Removes custom permissions granted to execute business operations from a specified device 

Required Scope Token

bsn.api.main.devices.update

______________________________________________________________

Segment

serial string 

The serial number of the device

______________________________________________________________

Request Body

An array of Permission entities

______________________________________________________________

Response

Success

204: The specified permissions were 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

GET /{serial}/Tokens/{token}/ 

Validates an OAuth2 device access or refresh token on a specified device

Required Scope Token

bsn.api.main.devices.token.validate

______________________________________________________________

Segment

serial string

The serial number of the device

token string

An OAuth2 device access or refresh token issued for the specified device

______________________________________________________________

Response

Success Response Body

200: Returns the Token Info 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

DELETE /{serial}/Tokens/{token}/ 

Revokes an OAuth2 device access or refresh token on a specified device

Required Scope Token

bsn.api.main.devices.token.revoke

______________________________________________________________

Segment

serial string

The serial number of the device

token string

An OAuth2 Device Access or Refresh Token issued for the specified device

______________________________________________________________

Response

Success

204: The specified token 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

GET /{id:int}/Tokens/{token}/ 

Validates an OAuth2 device access or refresh token on a specified device

Required Scope Token

bsn.api.main.devices.token.validate

______________________________________________________________

Segment

id int 

A unique identifier for the device

token string 

An OAuth2 device access or refresh token issued for the specified device

______________________________________________________________

Response

Success Response Body

200: Returns the Token Info 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

DELETE /{id:int}/Tokens/{token}/ 

Revokes an OAuth2 device access or refresh token on a specified device

Required Scope Token

bsn.api.main.devices.revoke

______________________________________________________________

Segment

id int 

A unique identifier for the device

token string 

An OAuth2 device access or refresh token issued for the specified device

______________________________________________________________

Response

Success

204: The specified token 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