rDWS Control Endpoints
Â
Base URL for these endpoints:Â https://ws.bsn.cloud/rest/v1/
_________________________________________________________________________
PUTÂ /control/reboot/Â
Reboots the player. The player will not send a response to a reboot request.
Request Body
crash_report
bool:Â Setting totrue
reboots the player and save a crash-report file to the brightsign-dumps folder. You should use this only when directed by BrightSign customer service, which may need the crash report when helping you troubleshoot a player.factory_reset
bool:Â Setting totrue
resets the player to the factory defaults, erasing all persistent registry settings for networking, security, and other applications.autorun
string: Setting todisable
disables the current autorun script (this is helpful for debugging).
Request Example (Simple Reboot)
This request has no body.
PUT /rest/v1/control/reboot/?destinationType=player&destinationName={{deviceSerial}} HTTP/1.1
Host: ws.bsn.cloud
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Request Example (Crash Report)
PUT /rest/v1/control/reboot/?destinationType=player&destinationName={{deviceSerial}} HTTP/1.1
Host: ws.bsn.cloud
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Content-Type: application/json
Content-Length: 56
This is the example request body:
{
"data": {
"crash_report": true
}
}
Request Example (Factory Reset)
This is the example request body:
Request Example (Disable Autorun)
This is the example request body:
Response Body
The server will return a success or error message. A successful response will almost always cause a reboot which will be indicated in the response.
result
object:Â The response objectsuccess
bool:Â Whether or not the operation was successfulreboot
bool: Whether or not the player is rebooting
Response Examples
Crash Report
Factory Reset
Disable Autorun
Â
GETÂ /control/dws-password/Â
Retrieves information about the current password of the local DWS (but not the password itself)Â such as whether the password is blank or invalid
Request Example
Response Body
success
bool: A flag indicating whether the password was successfully readpassword
Password{ }: A Password object that describes the DWS password. The following are possible values:isResultValid
bool: A flag indicating whether the DWS password is validisBlank
bool: A flag indicating whether the DWS password is blank (i.e. no password is required)
Response Example
Â
PUTÂ /control/dws-password/Â
Sets a new password for the local DWS (or removes the password requirement)
Request Body
password
string: The new local DWS password for the player. The absence of this parameter (or a blank string) will remove the password requirement for the DWS.previous_password
string: The previous DWS password. This parameter must be included. This value can be an empty string to indicate that the previous password was blank.
Request Example
This is the example request body:
Response Body
success
bool: A flag indicating whether the password was successfully setreboot
bool: A flag indicating whether the player will reboot to set the password
Response Example
Â
GETÂ /control/local-dws/Â
Retrieves the current state of the local DWS
Request Example
Response Body
success
bool: A flag indicating whether the local DWS is enabled or disabled
Response Example
Â
PUTÂ /control/local-dws/Â
Enables or disables the local DWS
Request Body
enable
bool: A flag indicating whether the local DWS should be enabled or disabled
Request Example
This is the example request body:
Response Body
success
bool: A flag indicating whether the local DWS was successfully enabled or disabledreboot
bool:Â A flag indicating whether the player will reboot to enable/disable the local DWS
Response Example