rDWS Display Control Endpoints

these display control apis can only be used on moka displays that have built in brightsign players and are only available in bos 9 0 189 and above base url for these endpoints https //ws bsn cloud/rest/ get /v1/display control/ returns all control settings for a display that is connected to a brightsign player request example get /rest/v1/display control/?destinationtype=player\&destinationname={{playerserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json response body 200 200 this returns the display control settings, as shown in the example below response example { "data" { "result" { "tvinfo" { "macaddress" "ff\ ff\ ff\ ff\ ff\ ff", "wifimacaddress" "ff\ ff\ ff\ ff\ ff\ ff", "serialno" "1234567890", "osversion" "v8 am963bs 0020015", "hwrevision" 1 }, "whitebalance" { "redbalance" 120, "greenbalance" 120, "bluebalance" 120 }, "volume" 50, "brightness" 50, "contrast" 50, "idlestandbytimeout" 50, "powersetting" "on", "videooutput" "hdmi1", "sdconnection" "brightsign", "alwaysconnectedenabled" true } } } get /v1/display control/brightness/ returns the brightness settings for a display that is connected to a brightsign player request example get /rest/v1/display control/brightness/?destinationtype=player\&destinationname={{playerserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json response body 200 200 this returns the brightness setting for the display, as shown in the example below response example { "data" { "result" { "brightness" 100 } } } put /v1/display control/brightness/ changes the brightness setting of a display connected to a brightsign player request example put /rest/v1/display control/brightness/?destinationtype=player\&destinationname={{playerserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json content type application/json content length 14 this is the example request body { "brightness" 100 } response body 200 200 this returns the updated brightness setting for the display, as shown in the example below response example { "data" { "result" { "success" true, "brightness" 100 } } } get /v1/display control/contrast/ returns the contrast settings for a display that is connected to a brightsign player request example get /rest/v1/display control/contrast/?destinationtype=player\&destinationname={{playerserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json response body 200 200 this returns the contrast setting for the display, as shown in the example below response example { "data" { "result" { "contrast" 45 } } } put /v1/display control/contrast/ changes the contrast of a display connected to a brightsign player request example put /rest/v1/display control/contrast/?destinationtype=player\&destinationname={{playerserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json content type application/json content length 22 this is the example request body { "contrast" 45 } response body 200 200 this returns the updated contrast setting for the display, as shown in the example below response example { "data" { "result" { "success" true, "contrast" 45 } } } get /v1/display control/always connected/ returns the connection settings for a display that is connected to a brightsign player request example get /rest/v1/display control/always connected/?destinationtype=player\&destinationname={{playerserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json response body 200 200 this returns the connection setting for the display, as shown in the example below response example { "data" { "result" { "enabled" true } } } put /v1/display control/always connected/ changes the connection setting of a display connected to a brightsign player request example put /rest/v1/display control/always connected/?destinationtype=player\&destinationname={{playerserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json content type application/json content length 23 this is the example request body { "enable" true } response body 200 200 returns the connection setting for the display as true , as shown in the example below response example { "data" { "result" { "success" true, "enable" true } } } put /v1/display control/firmware/ changes the firmware setting for a display connected to a brightsign player request example put /rest/v1/display control/firmware/?destinationtype=player\&destinationname={{playerserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json content type application/json content length 105 the example request body can be filepath or url { "filepath" "path/to/firmware/relative/to/sd", } { "url" "https //example com/tv firmware zip" } response body 202 202 this updates the firmware and reboots the player, as shown in the example below response example { "data" { "result" { "success" true, "reboot" true } } } get /v1/display control/info/ returns the settings about the brightsign player that is connected to a display request example get /rest/v1/display control/info/?destinationtype=player\&destinationname={{playerserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json response body 200 200 this returns information about a display that is connected to a brightsign player, as shown in the example below response example { "data" { "result" { "macaddress" "ff\ ff\ ff\ ff\ ff\ ff", "serialno" "1234567890", "osversion" "v8 am963bs 0020015", "hwrevision" 2, "wifimacaddress" "ff\ ff\ ff\ ff\ ff\ ff" } } } get /v1/display control/power settings/ returns the power settings for a display that is connected to a brightsign player request example get /rest/v1/display control/power settings/?destinationtype=player\&destinationname={{playerserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json response body 200 200 this returns the power setting for the display, as shown in the example below response example { "data" { "result" { "setting" "on" } } } put /v1/display control/power settings/ changes the power setting for a display connected to a brightsign player request example put /rest/v1/display control/power settings/?destinationtype=player\&destinationname={{playerserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json content type application/json content length 38 this is the example request body { "setting" "standby" } response body 200 200 this returns the updated power setting for the display, as shown in the example below response example { "data" { "result" { "success" true, "setting" "standby" } } } get /v1/display control/standby timeout/ returns the standby/timeout settings for a display that is connected to a brightsign player request example get /rest/v1/display control/standby timeout/?destinationtype=player\&destinationname={{playerserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json response body 200 200 this returns the standby/timeout setting for the display, as shown in the example below response example { "data" { "result" { "seconds" 60 } } } put /v1/display control/standby timeout/ changes the standby/timeout setting of a display connected to a brightsign player request example put /rest/v1/display control/standby timeout/?destinationtype=player\&destinationname={{playerserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json content type application/json content length 19 this is the example request body { "seconds" 60 } response body 200 200 this returns the updated standby/timeout setting for the display, as shown in the example below response example { "data" { "result" { "success" true, "seconds" 60 } } } get /v1/display control/sd connection/ returns the sd connection settings for a display that is connected to a brightsign player request example get /rest/v1/display control/sd connection/?destinationtype=player\&destinationname={{playerserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json response body 200 200 this returns the sd connection setting for the display, as shown in the example below response example { "data" { "result" { "connection" "brightsign" } } } put /v1/display control/sd connection/ changes the sd connection setting of a display connected to a brightsign player the sd card control is passed either to the display ( display ) or the brightsign player ( brightsign ) request example put /rest/v1/display control/sd connection/?destinationtype=player\&destinationname={{playerserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json content type application/json content length 19 this is the example request body { "connection" "display" } response body 200 200 this returns the updated sd connection setting for the display, as shown in the example below response example { "data" { "result" { "success" true, "connection" "display" } } } get /v1/display control/video output/ returns the video output settings for a display that is connected to a brightsign player request example get /rest/v1/display control/video output/?destinationtype=player\&destinationname={{playerserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json response body 200 200 this returns the video output setting for the display, as shown in the example below response example { "data" { "result" { "output" "hdmi1" } } } put /v1/display control/video output/ changes the video output setting of a display connected to a brightsign player request example put /rest/v1/display control/video output/?destinationtype=player\&destinationname={{playerserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json content type application/json content length 18 this is the example request body { "output" "hdmi2" } response body 200 200 this returns the updated video output connection setting for the display, as shown in the example below response example { "data" { "result" { "success" true, "output" "hdmi2" } } } get /v1/display control/volume/ returns the volume settings for a display that is connected to a brightsign player request example get /rest/v1/display control/volume/?destinationtype=player\&destinationname={{playerserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json response body 200 200 this returns the volume setting for the display, as shown in the example below response example { "data" { "result" { "volume" 50 } } } put /v1/display control/volume/ changes the volume of a display connected to a brightsign player request example put /rest/v1/display control/volume/?destinationtype=player\&destinationname={{playerserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json content type application/json content length 16 this is the example request body { "volume" 100 } response body 200 200 this returns the updated volume setting for the display, as shown in the example below response example { "data" { "result" { "success" true, "volume" 100 } } } get /v1/display control/white balance/ returns the white balance settings for a display that is connected to a brightsign player request example get /rest/v1/display control/white balance/?destinationtype=player\&destinationname={{playerserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json response body 200 200 this returns the white balance setting for the display, as shown in the example below response example { "data" { "result" { "redbalance" 120, "greenbalance" 120, "bluebalance" 120 } } } put /v1/display control/white balance/ changes the white balance of a display connected to a brightsign player request example put /rest/v1/display control/white balance/?destinationtype=player\&destinationname={{playerserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json content type application/json content length 58 this is the example request body { "redbalance" 120, "greenbalance" 120, "bluebalance" 120 } response body 200 200 this returns the updated white balance setting for the display, as shown in the example below response example { "data" { "result" { "success" true, "redbalance" 120, "greenbalance" 120, "bluebalance" 120 } } }