Content Comparison

Base URL for these endpoints:  https://ws.bsn.cloud/rest/v1/

_________________________________________________________________________

GET /v1/display-control/ 

...

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: This returns the display control settings, as shown in the example below.

...

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: This returns the brightness setting for the display, as shown in the example below.

...

{
  "value": 100
}

Response Body

200: This returns the updated brightness setting for the display, as shown in the example below.

...

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: This returns the contrast setting for the display, as shown in the example below.

...

{
  "contrast": 45
}

Response Body

200: This returns the updated contrast setting for the display, as shown in the example below.

...

{
  "data": {
    "result": {
      "success": true,
      "contrast": 45
    }
  }
}

GET /v1/display-control/

...

always-

...

connected/ 

Returns the fast tv start settings for a display that is connected to a BrightSign player.

...

GET /rest/v1/display-control/fastalways-tv-startconnected/?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: This returns the fast tv start setting for the display, as shown in the example below.

...

{
  "data": {
    "result": {
      "enabled": true
    }
  }
}

PUT /v1/display-control/

...

always-

...

connected/  

Changes the fast start setting of a display connected to a BrightSign player.

...

PUT /rest/v1/display-control/fastalways-tv-startconnected/?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

...

{
  "enable": true
}

Response Body

200: Returns the fast start setting for the display as true, as shown in the example below.

...

{
  "filepath": "path/to/firmware/relative/to/sd",
  "url": "https://example.com/tv-firmware.zip"
}

Response Body

202: This updates the firmware and reboots the player, as shown in the example below.

...

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: This returns the information about the BrightSign player that is connected to a display, as shown in the example below.

...

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: This returns the power setting for the display, as shown in the example below.

...

{
  "setting": "standby"
}

Response Body

200: This returns the updated power setting for the display, as shown in the example below.

...

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: This returns the standby/timeout setting for the display, as shown in the example below.

...

{
  "seconds": 60
}

Response Body

200: This returns the updated standby/timeout setting for the display, as shown in the example below.

...

{
  "data": {
    "result": {
      "success": true,
      "seconds": 60
    }
  }
}

GET /v1/display-control/

...

sd-connection/ 

Returns the USB connection settings for a display that is connected to a BrightSign player.

...

GET /rest/v1/display-control/usbsd-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: This returns the USB connection setting for the display, as shown in the example below.

...

{
  "data": {
    "result": {
      "connection": "brightsign"
    }
  }
}

PUT /v1/display-control/

...

sd-connection/  

Changes the USB connection setting of a display connected to a BrightSign player.

...

PUT /rest/v1/display-control/usbsd-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

...

{
  "connection": "tv"
}

Response Body

200: This returns the updated USB connection setting for the display, as shown in the example below.

...

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: This returns the video output setting for the display, as shown in the example below.

...

{
  "output": "HDMI2"
}

Response Body

200: This returns the updated video output connection setting for the display, as shown in the example below.

...

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: This returns the volume setting for the display, as shown in the example below.

...

{
  "volume": 100
}

Response Body

200: This returns the updated volume setting for the display, as shown in the example below.

...

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: This returns the white balance setting for the display, as shown in the example below.

...

{
  "redBalance": 120,
  "greenBalance": 120,
  "blueBalance": 120
}

Response Body

200: This returns the updated white balance setting for the display, as shown in the example below.

...