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 to true 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 to true resets the player to the factory defaults, erasing all persistent registry settings for networking, security, and other applications.

• autorun string: Setting to disable disables the current autorun script (this is helpful for debugging).

Request Example (Simple Reboot)

This request has no body.

Request Example (Crash Report)

This is the example request body:

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.

• resultobject: The response object

  • successbool: Whether or not the operation was successful

  • rebootbool: 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 read

• password Password{ }: A Password object that describes the DWS password. The following are possible values:

  • isResultValid bool: A flag indicating whether the DWS password is valid

  • isBlank 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 set

• reboot 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 disabled

• reboot bool: A flag indicating whether the player will reboot to enable/disable the local DWS

Response Example