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.
bsn.api.main.devices.retrieve
______________________________________________________________
filter
string optional
An expression for filtering search results
______________________________________________________________
200: The device count is returned as an integer value
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
Return the information for a specified device on a network
bsn.api.main.devices.retrieve
______________________________________________________________
id
int
A unique identifier for the device
______________________________________________________________
200: Returns the Player Entity
304: The resource was not modified since the time specified in the “If-Modified-Since” header
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
Update a specified device. This applies only to player settings.
bsn.api.main.devices.update
______________________________________________________________
id
int
A unique identifier for the device
______________________________________________________________
The Player Entity
______________________________________________________________
204: The specified device was successfully updated
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
Replaces certain parameters on the specified device. Applies only to the player settings. See rfc6902.
bsn.api.main.devices.update
______________________________________________________________
id
int
A unique identifier for the device
______________________________________________________________
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
: The replacement value(s) for parameters that must be updated
______________________________________________________________
204: The parameters have been successfully replaced.
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 the specified device
bsn.api.main.devices.delete
______________________________________________________________
id
int
A unique identifier for the device
______________________________________________________________
204: The device was successfully deleted
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
Return the specified device information (specified by serial number)
bsn.api.main.devices.retrieve
______________________________________________________________
serial
string
The device serial number
______________________________________________________________
200: Returns the Player Entity
304: The resource was not modified since the time specified in the “If-Modified-Since” header
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
Update a specified device. This applies only to player settings.
bsn.api.main.devices.update
______________________________________________________________
serial
string
The device serial number
______________________________________________________________
The Player Entity
______________________________________________________________
204: The specified device was successfully updated
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
Replaces certain parameters on the specified device. Applies only to the player settings. See rfc6902.
bsn.api.main.devices.update
______________________________________________________________
serial
string
The device serial number
______________________________________________________________
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
: The replacement value(s) for parameters that must be updated
______________________________________________________________
204: The parameters have been successfully replaced.
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 the specified devices
bsn.api.main.devices.delete
______________________________________________________________
serial
string
The device serial number
______________________________________________________________
204: The device was successfully deleted
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
Return the array of all beacons defined for the player that is specified
bsn.api.main.devices.retrieve
______________________________________________________________
deviceId
int
A unique identifier for the device instance
______________________________________________________________
200: The collection of Player Beacon Entities
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
Return the array of all beacons defined for the player that is specified
bsn.api.main.devices.retrieve
______________________________________________________________
serial
string
The serial number of the device instance
______________________________________________________________
200: The collection of Player Beacon Entities
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
Returns a device beacon of a certain type associated with a specified device and the specified name
bsn.api.main.devices.retrieve
______________________________________________________________
deviceId
int
A unique identifier for the device instance
name
string
The name of the device beacon
______________________________________________________________
200: Returns the Player Beacon Entity
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 a specified device beacon from a specified device.
bsn.api.main.devices.update
______________________________________________________________
deviceId
int
A unique identifier for the device instance
name
string
The name of the device beacon
______________________________________________________________
204: The specified device beacon was successfully deleted from the device
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
Returns a device beacon of a certain type associated with a specified device and the specified name
bsn.api.main.devices.retrieve
______________________________________________________________
serial
string
The serial number of the device
name
string
The name of the device beacon
______________________________________________________________
200: Returns the Player Beacon Entity
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 a specified device beacon on a specified device.
bsn.api.main.devices.update
______________________________________________________________
serial
string
The serial number of the device
name
string
The name of the device beacon
______________________________________________________________
204: The specified device beacon was successfully deleted from the device
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
Create a device beacon.
bsn.api.main.devices.update
______________________________________________________________
id
int
A unique identifier for the device instance on which you want to create the beacon
______________________________________________________________
______________________________________________________________
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.
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
Create a device beacon on a specified device.
bsn.api.main.devices.update
______________________________________________________________
serial
string
The serial number of the device on which you want to create the beacon
______________________________________________________________
______________________________________________________________
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.
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
Returns a list of errors associated with a specified device
bsn.api.main.devices.retrieve
______________________________________________________________
id
int
A unique identifier for the device that is reporting the errors
______________________________________________________________
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
______________________________________________________________
200: Returns the Player Error Entity
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
Returns a list of errors associated with a specified device
bsn.api.main.devices.retrieve
______________________________________________________________
serial
string
The serial number of the device that is reporting the errors
______________________________________________________________
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
______________________________________________________________
200: Returns the Player Error Entity
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
Returns the downloads associated with a specified device
bsn.api.main.devices.retrieve
______________________________________________________________
id
int
The unique identifier for the device that has the download instances
______________________________________________________________
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
______________________________________________________________
200: Returns the Player Download Entity
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
Returns a list of downloads carried out by a specified device
bsn.api.main.devices.retrieve
______________________________________________________________
serial
string
The serial number of the device that has the download instances
______________________________________________________________
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
______________________________________________________________
200: Returns the Player Download Entity
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
Returns a list of screenshots uploaded by a specified device
bsn.api.main.devices.retrieve
______________________________________________________________
id
int
The unique identifier for the device
______________________________________________________________
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
______________________________________________________________
200: Returns the ScreenShot Entity
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
Returns a list of screenshots uploaded by a specified device
bsn.api.main.devices.retrieve
______________________________________________________________
serial
string
The device serial number
______________________________________________________________
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
______________________________________________________________
200: Returns the ScreenShot Entity
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
Returns a list of screenshots uploaded by a device.
bsn.api.main.devices.retrieve
______________________________________________________________
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
______________________________________________________________
200: Returns the ScreenShot Entity
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
Returns an object whose property names match tag keys and whose property values match tag values on the specified device
bsn.api.main.devices.retrieve
______________________________________________________________
id
int
The unique identifier for the device
______________________________________________________________
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.
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
Adds tags to a specified device
bsn.api.main.devices.update
______________________________________________________________
id
int
The unique identifier for the device
______________________________________________________________
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.
______________________________________________________________
204: The tags were added to the specified device
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
Remove tags from a specified device (specified by device id).
bsn.api.main.devices.update
______________________________________________________________
id
int
The unique identifier for the device
______________________________________________________________
list
string[]
An array of tag keys to delete
______________________________________________________________
204: The specified tag was successfully deleted from the device
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
Returns an object whose property names match tag keys and whose property values match tag values on the specified device
bsn.api.main.devices.retrieve
______________________________________________________________
serial
string
The device serial number
______________________________________________________________
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.
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
Adds one or more tags to a specified device (specified by device serial number).
bsn.api.main.devices.update
______________________________________________________________
serial
string
The device serial number
______________________________________________________________
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.
______________________________________________________________
204: The tags were added to the specified device
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
Removes one or more tags from a specified device (specified by device serial number).
bsn.api.main.devices.update
______________________________________________________________
serial
string
The device serial number
______________________________________________________________
list
string[]
An array of tag keys to delete
______________________________________________________________
204: The specified tag was successfully deleted from the device
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
Returns the list of player models supported by the current Main API version
bsn.api.main.devices.retrieve
______________________________________________________________
200: Returns the complete list of player models that are supported on this Main API version
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
Returns the list of player models supported by the current Main API version
bsn.api.main.devices.retrieve
______________________________________________________________
model
string
The player model
______________________________________________________________
200: Returns the complete list of player models that are supported on this Main API version
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
Returns the list of connectors available on a given device model
bsn.api.main.devices.retrieve
______________________________________________________________
model
string
The player model
______________________________________________________________
200: Returns the list of connectors available on a given device model
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
Returns the list of connectors available on a given device model.
bsn.api.main.devices.retrieve
______________________________________________________________
model
string
The player model
connector
string
The video connector (for example, "HDMI" or "DisplayPort")
______________________________________________________________
200: Returns the list of connectors available on a given device model
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
Returns the video modes supported by the specified connector on the specified device model
bsn.api.main.devices.retrieve
______________________________________________________________
model
string
The player model
connector
string
The video connector (for example, "HDMI" or "DisplayPort")
______________________________________________________________
200: The response body is an array of strings listing video modes supported by the specified connector on the specified device model.
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
Returns operational permissions granted to roles for specific business operations
bsn.api.main.operations.retrieve
______________________________________________________________
200: Returns the Business Operations Entity
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
Returns the list of permissions allowing or denying specific business operations to be executed on a specified device.
bsn.api.main.devices.retrieve
______________________________________________________________
id
int
A unique identifier for the device
______________________________________________________________
200: Returns an array of Permission entities
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
Applies permissions allowing or denying specific business operations to be executed on a specified device.
bsn.api.main.devices.update
______________________________________________________________
id
int
A unique identifier for the device
______________________________________________________________
An array of Permission entities
______________________________________________________________
204: The specified permissions were successfully granted
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
Removes custom permissions granted to execute business operations from a specified device
bsn.api.main.devices.update
______________________________________________________________
id
int
A unique identifier for the device
______________________________________________________________
An array of Permission entities
______________________________________________________________
204: The specified permissions were successfully deleted from the device
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
Returns the list of permissions allowing or denying specific business operations to be executed on a specified device
bsn.api.main.devices.retrieve
______________________________________________________________
serial
string
The serial number of the device
______________________________________________________________
200: Returns an array of Permission entities
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
Applies permissions allowing or denying specific business operations to be executed on a specified device
bsn.api.main.devices.update
______________________________________________________________
serial
string
The serial number of the device
______________________________________________________________
An array of Permission entities
______________________________________________________________
204: The specified permissions were successfully granted
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
Removes custom permissions granted to execute business operations from a specified device
bsn.api.main.devices.update
______________________________________________________________
serial
string
The serial number of the device
______________________________________________________________
An array of Permission entities
______________________________________________________________
204: The specified permissions were successfully deleted from the device
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
Validates an OAuth2 device access or refresh token on a specified device
bsn.api.main.devices.token.validate
______________________________________________________________
serial
string
The serial number of the device
token
string
An OAuth2 device access or refresh token issued for the specified device
______________________________________________________________
200: Returns the Token Info Entity
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
Revokes an OAuth2 device access or refresh token on a specified device
bsn.api.main.devices.token.revoke
______________________________________________________________
serial
string
The serial number of the device
token
string
An OAuth2 Device Access or Refresh Token issued for the specified device
______________________________________________________________
204: The specified token was successfully deleted from the device
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
Validates an OAuth2 device access or refresh token on a specified device
bsn.api.main.devices.token.validate
______________________________________________________________
id
int
A unique identifier for the device
token
string
An OAuth2 device access or refresh token issued for the specified device
______________________________________________________________
200: Returns the Token Info Entity
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
Revokes an OAuth2 device access or refresh token on a specified device
bsn.api.main.devices.revoke
______________________________________________________________
id
int
A unique identifier for the device
token
string
An OAuth2 device access or refresh token issued for the specified device
______________________________________________________________
204: The specified token was successfully deleted from the device
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