This endpoint allows for management and monitoring of devices on the network.
Base URL for these endpoints: https://api.bsn.cloud/2022/06/REST/Devices
_________________________________________________________________________
GET /
Retrieves a list of devices on the network.
...
bsn.api.main.devices.retrieve
______________________________________________________________
Query String Parameters
filter string optional
An expression for filtering search results. The default value is null.
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. This defaults to the maximum allowed page size (100).
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
...
| Code Block |
|---|
GET /2022/06/REST/Devices/?marker=Mj0kwMTU2&pageSize=1&filter=%5BModel%5D%20IS%20%27HD1024%27&sort=%5BLastModifiedDate%5D%20ASC HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate |
______________________________________________________________
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.
...
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
Failure Response
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
...
bsn.api.main.devices.delete
______________________________________________________________
Query String Parameter
filter string required
An expression for filtering search results.
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
...
| Code Block |
|---|
DELETE /2022/06/REST/Devices/?filter=%5BModel%5D%20IS%20%27HD1024%27 HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate |
______________________________________________________________
Success Response Body
200: Returns the number of affected devices as an integer value.
Failure Response
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, or it is rejected in accordance to the business rules
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
...
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
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
...
| Code Block |
|---|
GET /2022/06/REST/Devices/Regions/US/?filter=%5BModel%5D%20IS%20%27HD1024%27 HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate |
______________________________________________________________
Success Response Body
200: Returns thePlayers Region Entity.
...
bsn.api.main.devices.retrieve
______________________________________________________________
Query String Parameter
filter string optional
An expression for filtering search results.
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
...
| Code Block |
|---|
GET /2022/06/REST/Devices/Count/?filter=%5BModel%5D%20IS%20%27HD1024%27 HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate |
______________________________________________________________
Success Response
200: The device count is returned as an integer value.
...
bsn.api.main.devices.retrieve
______________________________________________________________
Segment
id int
A unique identifier for the device
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
...
| Code Block |
|---|
GET /2022/06/REST/Devices/12345/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
If-Modified-Since: Wed, 13 Mar 2024 15:51:01 GMT
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate |
______________________________________________________________
Success Response with Body
...
bsn.api.main.devices.update
______________________________________________________________
Segment
id int
A unique identifier for the device
______________________________________________________________
Request Body
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
...
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
______________________________________________________________
Success Response
204: The specified device was successfully updated
...
bsn.api.main.devices.update
______________________________________________________________
Segment
id int
A unique identifier for the device
______________________________________________________________
Request Body
These properties are entries in an array. Every entry must have all three of these properties:
op string: The type of operation - in this case it is always "replace"
path string: A Uri path that references the location within the target document where the update will be performed
value object: The replacement value(s) for the parameters that must be updated
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
...
| Code Block | ||
|---|---|---|
| ||
[
{
"op": "replace",
"path": "/settings/description/",
"value": "Main Screen Player"
}
] |
______________________________________________________________
Success Response
204: The parameters have been successfully replaced.
...
bsn.api.main.devices.delete
______________________________________________________________
Segment
id int
A unique identifier for the device to delete
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
...
| Code Block |
|---|
DELETE /2022/06/REST/Devices/12345/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}}
If-Unmodified-Since: Wed, 13 Mar 2024 15:51:01 GMT
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate |
______________________________________________________________
Success Response
204: The device was successfully deleted
...
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)
...
bsn.api.main.devices.retrieve
______________________________________________________________
Segment
serial string
The device serial number
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
...
| Code Block |
|---|
GET /2022/06/REST/Devices/46D89C101139/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
If-Modified-Since: Wed, 13 Mar 2024 15:51:01 GMT
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate |
______________________________________________________________
Success Response with Body
...
bsn.api.main.devices.update
______________________________________________________________
Segment
serial string
The device serial number
______________________________________________________________
Request Body
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
...
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
______________________________________________________________
Success Response
204: The specified device was successfully updated
...
bsn.api.main.devices.update
______________________________________________________________
Segment
serial string
The serial number of the device to delete
______________________________________________________________
Request Body
These properties are entries in an array. Every entry must have all three of these properties:
op string: The type of operation - in this case it is always "replace"
path string: A Uri path that references the location within the target document where the update will be performed
value object: The replacement value(s) for the parameters that must be updated.
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
...
| Code Block | ||
|---|---|---|
| ||
[
{
"op": "replace",
"path": "/settings/description/",
"value": "Main Screen Player"
}
] |
______________________________________________________________
Success Response
204: The parameters have been successfully replaced.
...
bsn.api.main.devices.delete
______________________________________________________________
Segment
serial string
The device serial number
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
...
| Code Block |
|---|
DELETE /2022/06/REST/Devices/46D89C101139/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}}
If-Unmodified-Since: Wed, 13 Mar 2024 15:51:01 GMT
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate |
______________________________________________________________
Success Response
204: The device was successfully deleted
...
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)
...
bsn.api.main.devices.retrieve
______________________________________________________________
Segment
deviceId int
A unique identifier for the device instance
______________________________________________________________
Success Response Body
200: The collection of Player Beacon Entities
...
bsn.api.main.devices.retrieve
______________________________________________________________
Segment
serial string
The serial number of the device instance
______________________________________________________________
Success Response Body
200: The collection of Player Beacon Entities
...
bsn.api.main.devices.retrieve
______________________________________________________________
Segment
deviceId int
A unique identifier for the device instance
name string
The name of the device beacon
______________________________________________________________
Success Response Body
200: Returns the Player Beacon Entity
...
bsn.api.main.devices.update
______________________________________________________________
Segment
deviceId int
A unique identifier for the device instance
name string
The name of the device beacon
______________________________________________________________
Success Response
204: The specified device beacon was successfully deleted from the device
...
404: The server cannot find the requested resource (the path does not exist)
...
bsn.api.main.devices.retrieve
______________________________________________________________
Segment
serial string
The serial number of the device
name string
The name of the beacon
______________________________________________________________
Success Response Body
200: Returns thePlayer Beacon Entity
...
bsn.api.main.devices.update
______________________________________________________________
Segment
serial string
The serial number of the device
name string
The name of the beacon to delete
______________________________________________________________
Success Response
204: The specified device beacon was successfully deleted from the device
...
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)
...
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
______________________________________________________________
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 thePlayer Beacon Entity.
...
bsn.api.main.devices.update
______________________________________________________________
Segment
serial string
The serial number of the device on which you want to create the beacon
______________________________________________________________
Request Body
______________________________________________________________
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 thePlayer Beacon Entity.
...
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.
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
...
| Code Block |
|---|
GET /2022/06/REST/Devices/12345/Errors/?pageSize=1&marker=a9DH34d23Bh0 HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate |
______________________________________________________________
Success Response Body
200: Returns the Player Error Entity
...
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
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
...
| Code Block |
|---|
GET /2022/06/REST/Devices/46D89C101139/Errors/?pageSize=1&marker=Vsh54Uh9Mn0s HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate |
______________________________________________________________
Success Response Body
200: Returns the Player Error Entity
...
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
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
...
| Code Block |
|---|
GET /2022/06/REST/Devices/12345/Downloads/?pageSize=3&marker=BN548plV2hZW4tWW HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json, application/*
Accept-Encoding: gzip,deflate |
______________________________________________________________
Success Response Body
200: Returns thePlayer Download Entity
...
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
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
...
| Code Block |
|---|
GET /2022/06/REST/Devices/46D89C101139/Downloads/?pageSize=3&marker=W4tWW3hcnMsMTcyMU478ngh HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json, application/*
Accept-Encoding: gzip,deflate |
______________________________________________________________
Success Response Body
200: Returns the Player Download Entity
...
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 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
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
...
| Code Block |
|---|
GET /2022/06/REST/Devices/1234567/ScreenShots/?marker=SE4ODYzNF230OTv&pageSize=1 HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate |
______________________________________________________________
Success Response Body
200: Returns theScreenShot Entity
...
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 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
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
...
| Code Block |
|---|
GET /2022/06/REST/Devices/CFD02W901738/ScreenShots/?marker=G140faj35k8as&pageSize=1 HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate |
______________________________________________________________
Success Response Body
200: Returns theScreenShot Entity
...
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
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
...
| Code Block |
|---|
GET /2022/06/REST/Devices/ScreenShots/?marker=MTgzMDA1MTQ5MiwxODMwMDUxNDky&projection=TOP%283%2C%5BNodes%5D%29&pageSize=1&filter=%5BgroupName%5D%20IS%20%27Default%27&grouping=%5BSerial%5D&sort=%5BId%5D%20ASC HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json, application/*
Accept-Encoding: gzip,deflate |
______________________________________________________________
Success Response Body
200: Returns theScreenShot Entity
...
bsn.api.main.devices.retrieve
______________________________________________________________
Segment
id int
The unique identifier for the device
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
...
| Code Block |
|---|
GET /2022/06/REST/Devices/12345/Tags/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate |
______________________________________________________________
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 inPlayer Entity for more information.
...
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 inPlayer Entity for more information.
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
...
| Code Block | ||
|---|---|---|
| ||
{
"Number::[Device].<Number>":"1",
"Boolean::[Device].<Boolean>":true
} |
______________________________________________________________
Success Response
204: The tags were added to the specified device
...
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
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
...
| Code Block | ||
|---|---|---|
| ||
[ "Number::[Device].<Number>", "Boolean::[Device].<Boolean>" ] |
______________________________________________________________
Success Response
204: The specified tag was successfully deleted from the device
...
404: The server cannot find the requested resource (the path does not exist)
...
bsn.api.main.devices.retrieve
______________________________________________________________
Segment
serial string
The device serial number
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
...
| Code Block |
|---|
GET /2022/06/REST/Devices/35F89C022150/Tags/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate |
______________________________________________________________
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 thePlayer Entity for more information.
...
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 thePlayer Entity for more information.
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
...
| Code Block | ||
|---|---|---|
| ||
{
"Number::[Device].<Number>":"1",
"Boolean::[Device].<Boolean>":true
} |
______________________________________________________________
Success Response
204: The tags were added to the specified device
...
bsn.api.main.devices.update
______________________________________________________________
Segment
serial string
The device serial number
______________________________________________________________
Request Body
list string[]: An array of tag keys to delete
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
...
| Code Block | ||
|---|---|---|
| ||
[ "Number::[Device].<Number>", "Boolean::[Device].<Boolean>" ] |
______________________________________________________________
Success Response
204: The specified tag was successfully deleted from the device
...
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)
...
bsn.api.main.devices.retrieve
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
| Code Block |
|---|
GET /2022/06/REST/Devices/Models/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate |
______________________________________________________________
Success Response Body
200: Returns the complete list of player models that are supported on this Main API version
...
bsn.api.main.devices.retrieve
______________________________________________________________
Segment
model string
The player model
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
...
| Code Block |
|---|
GET /2022/06/REST/Devices/Models/XD1034/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate |
______________________________________________________________
Success Response Body
200: Returns the complete list of player models that are supported on this Main API version
...
bsn.api.main.devices.retrieve
______________________________________________________________
Segment
model string
The player model
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
...
| Code Block |
|---|
GET /2022/06/REST/Devices/Models/XD1034/Connectors/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate |
______________________________________________________________
Success Response Body
200: Returns the list of connectors available on a given device model.
...
bsn.api.main.devices.retrieve
______________________________________________________________
Segment
model string
The player model
connector string
The video connector (for example, "HDMI" or "DisplayPort")
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
...
| Code Block |
|---|
GET /2022/06/REST/Devices/Models/XD1034/Connectors/HDMI/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate |
______________________________________________________________
Success Response Body
200: Returns the list of connectors available on a given device model.
...
bsn.api.main.devices.retrieve
______________________________________________________________
Segment
model string
The player model
connector string
The video connector (for example, "HDMI" or "DisplayPort")
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
...
| Code Block | ||
|---|---|---|
| ||
GET /2022/06/REST/Devices/Models/XD1034/Connectors/HDMI/VideoModes/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate |
______________________________________________________________
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.
...
bsn.api.main.operations.retrieve
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
| Code Block |
|---|
GET /2022/06/REST/Devices/Operations/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate |
______________________________________________________________
Success Response Body
200: Returns the Business Operations Entity
...
bsn.api.main.devices.retrieve
______________________________________________________________
Segment
id int
A unique identifier for the device
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
...
| Code Block |
|---|
GET /2022/06/REST/Devices/12345/Permissions/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate |
______________________________________________________________
Success Response Body
200: Returns an array of Permission entities
...
bsn.api.main.devices.update
______________________________________________________________
Segment
id int
A unique identifier for the device
______________________________________________________________
Request Body
An array of Permission entities
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
...
| Code Block | ||
|---|---|---|
| ||
[
{
"entityId": 12345,
"operationUID": "7d71c53e-ae40-59c4-f972-28e8b4dfabcf",
"principal": {
"login": "JaneDoe@brightsign.biz",
"type": "User",
"id": 54321
},
"isFixed": false,
"isInherited": false,
"isAllowed": false,
"creationDate": "0001-01-01T00:00:00"
}
] |
______________________________________________________________
Success Response
204: The specified permissions were successfully granted
...
bsn.api.main.devices.update
______________________________________________________________
Segment
id int
A unique identifier for the device
______________________________________________________________
Request Body
An array of Permission entities
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
...
| Code Block | ||
|---|---|---|
| ||
[
{
"entityId": 12345,
"operationUID": "7d71c53e-ae40-59c4-f972-28e8b4dfabcf",
"principal": {
"login": "JaneDoe@brightsign.biz",
"type": "User",
"id": 54321
},
"isFixed": false,
"isInherited": false,
"isAllowed": false,
"creationDate": "0001-01-01T00:00:00"
}
] |
______________________________________________________________
Success Response
204: The specified permissions were successfully deleted from the device
...
bsn.api.main.devices.retrieve
______________________________________________________________
Segment
serial string
The serial number of the device
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
...
| Code Block |
|---|
GET /2022/06/REST/Devices/46D89C001033/Permissions/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate |
______________________________________________________________
Success Response Body
200: Returns an array of Permission entities
...
bsn.api.main.devices.update
______________________________________________________________
Segment
serial string
The serial number of the device
______________________________________________________________
Request Body
An array of Permission entities
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
...
| Code Block | ||
|---|---|---|
| ||
[
{
"entityId": 12345,
"operationUID": "7d71c53e-ae40-59c4-f972-28e8b4dfabcf",
"principal": {
"login": "JaneDoe@brightsign.biz",
"type": "User",
"id": 54321
},
"isFixed": false,
"isInherited": false,
"isAllowed": false,
"creationDate": "0001-01-01T00:00:00"
}
] |
______________________________________________________________
Success Response
204: The specified permissions were successfully granted
...
bsn.api.main.devices.update
______________________________________________________________
Segment
serial string
The serial number of the device
______________________________________________________________
Request Body
An array of Permission entities
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
...
| Code Block | ||
|---|---|---|
| ||
[
{
"entityId": 12345,
"operationUID": "7d71c53e-ae40-59c4-f972-28e8b4dfabcf",
"principal": {
"login": "JaneDoe@brightsign.biz",
"type": "User",
"id": 54321
},
"isFixed": false,
"isInherited": false,
"isAllowed": false,
"creationDate": "0001-01-01T00:00:00"
}
] |
______________________________________________________________
Success Response
204: The specified permissions were successfully deleted from the device
...
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
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
...
| Code Block |
|---|
GET /2022/06/REST/Device/47G49C000042/Tokens/{{Token}}/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UsersAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate |
______________________________________________________________
Success Response Body
200: Returns theToken Info Entity
...
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
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
...
| Code Block |
|---|
DELETE /2022/06/REST/Device/47G49C000042/Tokens/{{Token}}/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate |
______________________________________________________________
Success Response
204: The specified token was successfully deleted from the device
...
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
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
...
| Code Block |
|---|
GET /2022/06/REST/Device/123456/Tokens/{{Token}}/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate |
______________________________________________________________
Success Response Body
200: Returns the Token Info Entity
...
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
______________________________________________________________
Request Example
The example request parameters and headers are set as follows:
...
| Code Block |
|---|
DELETE /2022/06/REST/Device/123456/Tokens/{{Token}}/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate |
______________________________________________________________
Success Response
204: The specified token was successfully deleted from the device
...