B-Deploy Device Endpoints (v2)

these endpoints allow users to automatically provision brightsign players over the internet this endpoint handles everything regarding individual players if you add your serial number to brightsign’s cloud storage with an associated player name, provisioning package name, and the url where the provisioning package is hosted the url is optional it can be left blank if using a setup package base url for these endpoints https //provision bsn cloud/rest device/v2/device/ get retrieves a device object associated with the b deploy account url parameters id string string the unique identifier of the device object to retrieve if this parameter is not included in the url, the get request will return all device objects associated with the account request example id is set to abcd123456789 get /rest device/v2/device/? id=abcd123456789 http/1 1 host provision bsn cloud content type application/json authorization {{bearer token}} success response body 200 200 contains a single device object if the id is specified in the url; otherwise, this property contains the following total int int the total number of device objects that belong to the b deploy account matched int int the number of device objects contained in the response players device\[ ] device\[ ] an array of device objects each device object can contain the following properties id string string the unique identifier of the device object serial string string the serial number of the player represented by the device object createdat string string a utc timestamp indicating when the device setup object was created the date/time is formatted as yyyy mm ddthh\ mm\ ss sssz updatedat string string a utc timestamp indicating when the device setup object was last modified the date/time is formatted as yyyy mm ddthh\ mm\ ss sssz url string string optional optional a value of the partner application url specified for a device to use when finding the application to download client string string v string string failure response 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 5xx 5xx any 500 code is an internal server error post adds a device object to the b deploy account you must pass an application package url to directly download an application package to your device request body username string string the bsn cloud username serial string string the serial number of the player represented by the device object name string string the name of the setup file networkname string string the name of the network model string string optional optional the player model desc string string the player description userdata string string optional optional allows you to send additional header information with your setup or application package url string string optional optional the url from which the player will download its presentation as part of the final provisioning step request example post /rest device/v2/device http/1 1 host provision bsn cloud content type application/json authorization {{bearer token}} content length 252 this is an example request body with a url { "username" "janedoe\@brightsign biz", "serial" "abcd00000001", "name" null, "networkname" "test", "model" "", "desc" "jane's player", "userdata" "", "url" "https //provisiondemo brightsignnetwork com/autorun zip" } success response 201 201 the unique identifier of the device object failure response 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 415 415 the server cannot accept the data representation that you sent (as specified in the header) 5xx 5xx any 500 code is an internal server error put modifies a device object associated with the b deploy account request body id string string the unique identifier of the device object to retrieve username string string the bsn cloud username serial string string the serial number of the player represented by the device object name string string the name of the setup file networkname string string the name of the network model string string optional optional the player model desc string string the player description userdata string string optional optional allows you to send additional header information with your setup or application package request example url is set to 123456789 put /rest device/v2/device? id=123456789 http/1 1 host provision bsn cloud content type application/json authorization {{bearer token}} content length 283 this is the example request body { " id" "123456789", "username" "janedoe\@brightsign biz", "serial" "abcd00000001", "name" "provisiontest", "networkname" "test", "model" "", "desc" "jane's player", "setupid" "abcd123456789", "userdata" "" } success response 200 200 the existing device setup has been updated failure response 400 400 either the request or request body is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 415 415 the server cannot accept the data representation that you sent (as specified in the header) 5xx 5xx any 500 code is an internal server error delete removes a device object from the b deploy account url parameters you can pass either the id or the serial number of the player id string string optional optional the player database record identifier serial string string optional optional the unique identifier of the player request example delete /rest device/v2/device? id=123456789 http/1 1 host provision bsn cloud content type application/json authorization {{bearer token}} success response 200 200 the specified device object has been removed failure response 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 5xx 5xx any 500 code is an internal server error