rDWS Information Endpoints

base url for these endpoints https //ws bsn cloud/rest/v1/ get /info/ retrieves general information about the player request example get /rest/v1/info/?destinationtype=player\&destinationname={{deviceserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json response serial string string the serial number of the player model string string the model number of the device (e g "xd234") connectiontype string string the currently active network interface, which can be either "ethernet" or "wifi" ethernet object object an object containing information about the ethernet connection this property will only be available if there's a valid ethernet connection on the player the object can contain the following properties ipv4 object object an object containing information about the ipv4 configuration the object can contain the following properties address string string the assigned ipv4 address netmask string string the ipv4 network mask family string string ipv4 mac string string the mac address of the network interface internal bool bool true if the network interface is a loopback or similar interface that is not remotely accessible; otherwise false cidr string string the assigned ipv4 address with the routing prefix in cidr notation if the netmask is invalid, this property is set to null ipv6 object object an object containing information about the ipv6 configuration address string string the assigned ipv6 address netmask string string the ipv6 network mask family string string ipv6 mac string string the mac address of the network interface internal bool bool true if the network interface is a loopback or similar interface that is not remotely accessible; otherwise false cidr string string the assigned ipv4 address with the routing prefix in cidr notation if the netmask is invalid, this property is set to null bootversion string string the current version of the boot loader fwversion string string the current version of firmware installed on the player uptime string string the amount of time (as a human readable string) that the player has been powered on and working correctly uptimeseconds int int the amount of time (in seconds) that the player has been powered on and working correctly extensions extension\[ ] extension\[ ] an array of extension objects describing firmware extensions currently installed on the player blessings blessing\[ ] blessing\[ ] an array of blessing objects describing proprietary codecs that are currently authorized on the player response example { "route" "/v1/info", "method" "get", "data" { "result" { "serial" "re433d006644", "uptime" "30 minutes", "uptimeseconds" 1832, "model" "xd1035", "fwversion" "9 0 97", "bootversion" "9 0 85", "family" "cobra", "isplayer" true, "power" { "result" { "battery" "absent", "source" "ac", "switch mode" "hard" } }, "poe" { "result" { "status" "inactive" } }, "extensions" { "result" { "extensions" \[] } }, "blessings" { "result" { "ac3" false, "eac3" false } }, "networking" { "result" { "description" "test player", "name" "xd5 re433d006644" } }, "bvnpipelines" { "result" { "pipelines" \[] } }, "bvncomponents" { "result" { "components" \[] } }, "hardware features" { "hdmi" true, "component video" false, "vga" false, "two channel audio" true, "ethernet" true, "usb" true, "serial port 0" true, "serial port 1" false, "gpio connector" true, "svc button" true, "reset button" true, "rtc" true, "settings rom" false, "microsd" false, "sdhc" true, "six channel audio" false, "ir blaster" true, "wifi" false, "serial port 2" false, "audio input" false, "cec" true, "battery" false, "portrait lcd" false, "hdmi input" false, "digital tuner" false, "spdif" true, "audio input loopback" false, "msata" false, "ac3" false, "eac3" false, "onboard storage" true, "no 4k decode" false, "no bluetooth" false, "no poe" false, "internal storage only" false, "disable packet capture" false, "disable bsn cloud" false, "brightear" false, "disable dws" false }, "api features" { "video" true }, "active features" { "legacydws" true }, "connectiontype" "eth0", "ethernet" \[ { "interfacename" "eth0", "interfacetype" "ethernet", "ipv4" \[ { "address" "123 456 7 890", "netmask" "255 255 255 0", "family" "ipv4", "mac" "90\ ac 3f 2a 01 79", "internal" false, "cidr" "192 168 1 174/24" } ], "ipv6" \[ { "address" "2600 1700\ dac0 2060 23", "netmask" "ffff\ ffff\ ffff\ ffff\ ffff\ ffff\ ffff\ ffff", "family" "ipv6", "mac" "90\ ac 3f 2a 01 79", "internal" false, "cidr" "2600 1700\ dac0 2060 23/128", "scopeid" 0 }, { "address" "2600 1700\ dac0 2060 92ac 3fff\ fe2a 179", "netmask" "ffff\ ffff\ ffff\ ffff ", "family" "ipv6", "mac" "90\ ac 3f 2a 01 79", "internal" false, "cidr" "2600 1700\ dac0 2060 92ac 3fff\ fe2a 179/64", "scopeid" 0 }, { "address" "fe80 92ac 3fff\ fe2a 179", "netmask" "ffff\ ffff\ ffff\ ffff ", "family" "ipv6", "mac" "90\ ac 3f 2a 01 79", "internal" false, "cidr" "fe80 92ac 3fff\ fe2a 179/64", "scopeid" 2 } ] } ], "wireless" \[], "interfaces" \[], "bsnce" true } } } get /time/ retrieves the date and time as configured on the player the date/time value is formatted as "yyyy mm dd hh\ mm\ ss \<timezone>" this call is identical to using the node js® time api request example get /rest/v1/time/?destinationtype=player\&destinationname={{deviceserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json response example { "route" "/v1/time", "method" "get", "data" { "result" { "time" "2018 10 18 14 34 34 pdt", "timezone mins" null, "timezone name" "america/los angeles", "timezone abbr" "pdt", "year" 2018, "month" 10, "date" 18, "hour" 14, "minute" 34, "second" 34, "millisecond" 569 } } } put /time/ sets the date/time on the player request body time string string the time to set on the player, formatted as "hh\ mm\ ss \<timezone>" date string string the date to set on the player, formatted as "yyyy mm dd" applytimezone bool bool a flag specifying whether the date and time should be applied using the time zone configured on the player ( true ) or the utc time zone ( false ) request example put /rest/v1/time/?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 117 this is the example request body { "data" { "time" "22 00 00", "date" "2023 11 07", "applytimezone" true } } response example a successful response would be a 200 200 status code with the following body { "data" { "result" true } } get /health/ retrieves the current status of the player currently, this endpoint is only used to determine if a player can respond to a websockets request; it cannot determine the error state of a player request example get /rest/v1/health/?destinationtype=player\&destinationname={{deviceserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json response body status string string the player status the only possible value is "active" statustime string string the date and time the player responded to the status request the date/time is formatted as "yyyy mm dd hh\ mm\ ss \<timezone>" response example { "route" "/v1/health", "method" "get", "data" { "result" { "status" "active", "statustime" "2024 01 30 07 38 05 pst" } } }