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 Parameters

crash_report bool: Pass the body parameter {“crash_report": true}. To be used only when directed by BrightSign customer service. This will reboot the player and save a crash-report file to the brightsign-dumps folder. Customer service may request the crash report when helping you troubleshoot a player.
factory_reset bool: Pass the body parameter {“factory_reset”: true}. This resets the player to factory defaults, erasing all persistent registry settings for networking, security, and other applications.
autorun string: Pass the body parameter {“autorun”: “disable”}. This disables the current autorun script, and this is especially helpful for debugging purposes.

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)

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

This is the example request body:

{
    "data": {
        "factory_reset": true
    }
}

Request Example (Disable Autorun)

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": {
        "autorun": "disable"
    }
}

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

{
    "data": {
        "result": {
            "success": true,
            "message": "A reboot has been initiated (with crash report)"
        }
    },
    "route": "/v1/control/reboot",
    "method": "PUT"
}

Factory Reset

{
    "data": {
        "result": {
            "success": true,
            "message": "A reboot has been initiated (with factory reset)"
        }
    },
    "route": "/v1/control/reboot",
    "method": "PUT"
}

Disable Autorun

{
    "data": {
        "result": {
            "success": true,
            "message": "A reboot has been initiated"
        }
    },
    "route": "/v1/control/reboot",
    "method": "PUT"
}

Endpoints:

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

GET /rest/v1/control/dws-password/?destinationType=player&destinationName={{deviceSerial}} HTTP/1.1
Host: ws.bsn.cloud
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json

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

{
    "route": "/v1/control/dws-password",
    "method": "GET",
    "data": {
        "result": {
            "success": true,
            "password": {
                "isResultValid": true,
                "isBlank": true
            }
        }
    }
}

PUT /control/dws-password/

Sets a new password for the local DWS (or removes the password requirement)

Request Body Parameters

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

PUT /rest/v1/control/dws-password/?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: 106

This is the example request body:

{
	"data": {
		"password": "newpassword",
		"previous_password": "oldpassword"
	}
}

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

{
    "data": {
        "result": {
            "success": true,
            "reboot": false
        }
    },
    "route": "/v1/control/dws-password",
    "method": "PUT"
}

GET /control/local-dws/

Retrieves the current state of the local DWS

Request Example

GET /rest/v1/control/local-dws/?destinationType=player&destinationName=27D33C000051 HTTP/1.1
Host: ws.bsn.cloud
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json

Response Body

success bool: A flag indicating whether the local DWS is enabled or disabled

Response Example

{
    "route": "/v1/control/local-dws",
    "method": "GET",
    "data": {
        "result": {
            "success": true,
            "value": true
        }
    }
}

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

PUT /rest/v1/control/local-dws/?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: 50

This is the example request body:

{
    "data": {
        "enable": true
    }
}

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

{
    "data": {
        "result": {
            "success": true,
            "reboot": true
        }
    },
    "route": "/v1/control/local-dws",
    "method": "PUT"
}