Devices Endpoints (2020/10)

this endpoint allows for management and monitoring of devices on the network base url for these endpoints https //api bsn cloud/2020/10/rest/devices get / retrieves a list of devices on the network required scope token bsn api main devices retrieve query string parameters filter string string optional optional an filtering and sorting expressions in the main api docid 3l0afyd3xooe ytvfk2vs for filtering search results sort string string optional optional an expression for sorting the search results the sort expression specifies the entry used for sorting and the ascending/descending (asc/desc) sorting order (e g " \[device] \[serial] asc ") marker string string optional optional a value specifying which page to retrieve this value is useful if the istruncated entry in the response body of the previous get call indicates that the number of device instances exceeds the pagesize this parameter is only required if you need more elements in the paged list than the pagesize (100) pagesize int int optional optional the maximum number of device instances that can be contained in the response body response success response body 200 200 returns a paged list entity (2020/10) docid\ joielmbbiwrnzeqzvpqqa of player entity (2020/10) docid\ klxwxuju fg9an8cre3ww instances on a network this will return not more than 100 entities along with the information necessary to return any other remaining pages failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 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 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error delete / removes devices, specified by a filter, from a network this allows multiple devices to be deleted at once required scope token bsn api main devices delete query string parameter filter string string required required an filtering and sorting expressions in the main api docid 3l0afyd3xooe ytvfk2vs for filtering search results response success response body 200 200 returns the number of affected devices as an integer value failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 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 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /regions/{ locationpath}/ returns a region which contains all the players located in the specified path required scope token bsn api main devices retrieve segment locationpath string string the parts of the returned player location path (country, province, city, etc ) that are common to all players query string parameter filter string string optional optional an filtering and sorting expressions in the main api docid 3l0afyd3xooe ytvfk2vs for filtering search results response success response body 200 200 returns the players region entity (2020/10) docid\ tytiv4 ipu 5qezf8ztbo failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 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 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /count/ retrieves the number of devices on the network matching the specified filter criteria if no filter is included, this call returns the total number of devices on the network required scope token bsn api main devices retrieve query string parameter filter string string optional optional an filtering and sorting expressions in the main api docid 3l0afyd3xooe ytvfk2vs for filtering search results response success 200 200 the device count is returned as an integer value failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 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 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /{id\ int}/ return the information for a specified device on a network required scope token bsn api main devices retrieve segment id int int a unique identifier for the device response success response body 200 200 returns the player entity (2020/10) docid\ klxwxuju fg9an8cre3ww success response 304 304 the resource was not modified since the time specified in the “if modified since” header failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 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 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error put /{id\ int}/ update a specified device this applies only to player settings required scope token bsn api main devices update segment id int int a unique identifier for the device request body the player entity (2020/10) docid\ klxwxuju fg9an8cre3ww response success 204 204 the specified device was successfully updated failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 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 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 412 412 precondition failed (the resource changed since the time specified in the “if unmodified since” header value) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 5xx any 500 code is an internal server error patch /{id\ int}/ replaces certain parameters on the specified device applies only to the player settings see rfc6902 https //datatracker ietf org/doc/html/rfc6902 required scope token bsn api main devices update segment id int int a unique identifier for the device request body the body is an array of entries with the following three properties op string string the type of operation only "replace" is currently supported path string string the target location of the value that will be replaced this location must exist for the operation to be successful value object object the replacement value(s) for parameters that must be updated response success 204 204 the parameters have been successfully replaced failure 400 400 either the request or request body is malformed and therefore invalid 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 412 412 precondition failed (the resource changed since the time specified in the “if unmodified since” header value) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 5xx any 500 code is an internal server error delete /{id\ int}/ delete the specified device required scope token bsn api main devices delete segment id int int a unique identifier for the device response success 204 204 the device was successfully deleted failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 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 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 412 412 precondition failed (the resource changed since the time specified in the “if unmodified since” header value) 5xx 5xx any 500 code is an internal server error get /{serial}/ return the specified device information (specified by serial number) required scope bsn api main devices retrieve segment serial string string the device serial number response success response with body 200 200 returns the player entity (2020/10) docid\ klxwxuju fg9an8cre3ww success response 304 304 the resource was not modified since the time specified in the “if modified since” header failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 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 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error put /{serial}/ update a specified device this applies only to player settings required scope token bsn api main devices update segment serial string string the device serial number request body the player entity (2020/10) docid\ klxwxuju fg9an8cre3ww response success 204 204 the specified device was successfully updated failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request or the 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 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 412 412 precondition failed (the resource changed since the time specified in the “if unmodified since” header value) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 5xx any 500 code is an internal server error patch /{serial}/ replaces certain parameters on the specified device applies only to the player settings see rfc6902 https //datatracker ietf org/doc/html/rfc6902 required scope token bsn api main devices update segment serial string string the device serial number request body the body is an array of entries with the following three properties op string string the type of operation only "replace" is currently supported path string string the target location of the value that will be replaced this location must exist for the operation to be successful value object object the replacement value(s) for parameters that must be updated response success 204 204 the parameters have been successfully replaced failure 400 400 either the request or request body is malformed and therefore invalid 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 412 412 precondition failed (the resource changed since the time specified in the “if unmodified since” header value) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 5xx any 500 code is an internal server error delete /{serial}/ delete the specified devices required scope token bsn api main devices delete segment serial string string the device serial number response success 204 204 the device was successfully deleted failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 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 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 412 412 precondition failed (the resource changed since the time specified in the “if unmodified since” header value) 5xx 5xx any 500 code is an internal server error get /{deviceid\ int}/beacons/ return the array of all beacons defined for the player that is specified required scope token bsn api main devices retrieve segment deviceid int int a unique identifier for the device instance response success response body 200 200 the collection of player beacon entity (2020/10) docid\ iqky6rgsewy rtplhv yz failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 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 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /{serial}/beacons/ return the array of all beacons defined for the player that is specified required scope token bsn api main devices retrieve segment serial string string the serial number of the device instance response success response body 200 200 the collection of player beacon entity (2020/10) docid\ iqky6rgsewy rtplhv yz failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 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 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /{deviceid\ int}/beacons/{name}/ returns a device beacon of a certain type associated with a specified device and the specified name required scope token bsn api main devices retrieve segment deviceid int int a unique identifier for the device instance name string string the name of the device beacon response success response body 200 200 returns the player beacon entity (2020/10) docid\ iqky6rgsewy rtplhv yz failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 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 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error delete /{deviceid\ int}/beacons/{name}/ delete a specified device beacon from a specified device required scope token bsn api main devices update segment deviceid int int a unique identifier for the device instance name string string the name of the device beacon response success 204 204 the specified device beacon was successfully deleted from the device failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 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 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /{serial}/beacons/{name}/ returns a device beacon of a certain type associated with a specified device and the specified name required scope token bsn api main devices retrieve segment serial string string the serial number of the device name string string the name of the device beacon response success response body 200 200 returns the player beacon entity (2020/10) docid\ iqky6rgsewy rtplhv yz failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 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 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error delete /{serial}/beacons/{name}/ delete a specified device beacon on a specified device required scope token bsn api main devices update segment serial string string the serial number of the device name string string the name of the device beacon response success 204 204 the specified device beacon was successfully deleted from the device failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 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 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error post /{id\ int}/beacons/ create a device beacon required scope token bsn api main devices update segment id int int a unique identifier for the device instance on which you want to create the beacon request body the player beacon entity (2020/10) docid\ iqky6rgsewy rtplhv yz response success response body 201 201 returns the new resource created and referenced by the uri (given by the location header field) in the response the response includes the player beacon entity (2020/10) docid\ iqky6rgsewy rtplhv yz failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 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 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 5xx any 500 code is an internal server error post /{serial}/beacons/ create a device beacon on a specified device required scope token bsn api main devices update segment serial string string the serial number of the device on which you want to create the beacon request body the player beacon entity (2020/10) docid\ iqky6rgsewy rtplhv yz response success response body 201 201 returns the new resource created and referenced by the uri (given by the location header field) in the response the response includes the player beacon entity (2020/10) docid\ iqky6rgsewy rtplhv yz failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 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 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 5xx any 500 code is an internal server error get /{id\ int}/errors/ returns a list of errors associated with a specified device required scope token bsn api main devices retrieve segment id int int a unique identifier for the device that is reporting the errors query string parameters marker string string optional optional a value specifying which page to retrieve this value is useful if the istruncated entry in the response body of the previous get call indicates that the number of error instances exceeds the pagesize this parameter is only required if you need more elements in the paged list than the pagesize (100) pagesize int int optional optional the maximum number of error instances that can be contained in the response body response success response body 200 200 returns the player error entity (2020/10) docid\ uoy6unz 8zxpbjxzohcyj failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 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 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /{serial}/errors/ returns a list of errors associated with a specified device required scope token bsn api main devices retrieve segment serial string string the serial number of the device that is reporting the errors query string parameters marker string string optional optional a value specifying which page to retrieve this value is useful if the istruncated entry in the response body of the previous get call indicates that the number of error instances exceeds the pagesize this parameter is only required if you need more elements in the paged list than the pagesize (100) pagesize int int optional optional the maximum number of error instances that can be contained in the response body response success response body 200 200 returns the player error entity (2020/10) docid\ uoy6unz 8zxpbjxzohcyj failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 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 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /{id\ int}/downloads/ returns the downloads associated with a specified device required scope token bsn api main devices retrieve segment id int int the unique identifier for the device that has the download instances query string parameters marker string string optional optional a value specifying which page to retrieve this value is useful if the istruncated entry in the response body of the previous get call indicates that the number of download instances exceeds the pagesize this parameter is only required if you need more elements in the paged list than the pagesize (100) pagesize int int optional optional the maximum number of download instances that can be contained in the response body response success response body 200 200 returns the player download entity (2020/10) docid\ dqna1yvu91zwwptzj4s8q failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 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 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /{serial}/downloads/ returns a list of downloads carried out by a specified device required scope token bsn api main devices retrieve segment serial string string the serial number of the device that has the download instances query string parameters marker string string optional optional a value specifying which page to retrieve this value is useful if the istruncated entry in the response body of the previous get call indicates that the number of download instances exceeds the pagesize this parameter is only required if you need more elements in the paged list than the pagesize (100) pagesize int int optional optional the maximum number of download instances that can be contained in the response body response success response body 200 200 returns the player download entity (2020/10) docid\ dqna1yvu91zwwptzj4s8q failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 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 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /{deviceid\ int}/screenshots/ returns a list of screenshots uploaded by a specified device required scope token bsn api main devices retrieve segment id int int the unique identifier for the device query string parameters marker string string optional optional a value specifying which page to retrieve this value is useful if the istruncated entry in the response body of the previous get call indicates that the number of download instances exceeds the pagesize this parameter is only required if you need more elements in the paged list than the pagesize (100) pagesize int int optional optional the maximum number of download instances that can be contained in the response body response success response body 200 200 returns the screenshot entity (2020/10) docid\ xsvdmrsjly0yvygldy2bo failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 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 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /{serial}/screenshots/ returns a list of screenshots uploaded by a specified device required scope token bsn api main devices retrieve segment serial string string the device serial number query string parameters marker string string optional optional a value specifying which page to retrieve this value is useful if the istruncated entry in the response body of the previous get call indicates that the number of download instances exceeds the pagesize this parameter is only required if you need more elements in the paged list than the pagesize (100) pagesize int int optional optional the maximum number of download instances that can be contained in the response body response success response body 200 200 returns the screenshot entity (2020/10) docid\ xsvdmrsjly0yvygldy2bo failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 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 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /screenshots/ returns a list of screenshots uploaded by a device required scope token bsn api main devices retrieve query string parameters projection string string optional optional this parameter currently supports only one placeholder ( top({int},\[nodes])] ) which limits the number of entities in a group the possible value for {int} is any number from 1 to 100 filter string string optional optional an filtering and sorting expressions in the main api docid 3l0afyd3xooe ytvfk2vs for filtering search results grouping string string optional optional a grouping expression for the filtered entities this parameter can be used with the projection parameter to retrieve a certain number of screenshots for a large number of devices in one request (for example, 100 screenshots from 100 players) sort string string optional optional an expression for sorting the search results the sort expression specifies the entry used for sorting and the ascending/descending (asc/desc) sorting order (e g "\[device] \[serial] asc") marker string string optional optional a value specifying which page to retrieve this value is useful if the istruncated entry in the response body of the previous get call indicates that the number of screenshot instances exceeds the pagesize this parameter is only required if you need more elements in the paged list than the pagesize (100) pagesize int int optional optional the maximum number of screenshot instances that can be contained in the response body response success response body 200 200 returns the screenshot entity (2020/10) docid\ xsvdmrsjly0yvygldy2bo failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 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 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /{id\ int}/tags/ returns an object whose property names match tag keys and whose property values match tag values on the specified device required scope token bsn api main devices retrieve segment id int int the unique identifier for the device response success response body 200 200 a collection of key value pairs where the key is tag name, and the value is tag value see the tags entry in player entity (2020/10) docid\ klxwxuju fg9an8cre3ww for more information failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 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 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error post /{id\ int}/tags/ adds tags to a specified device required scope token bsn api main devices update segment id int int the unique identifier for the device request body tags dynamicobject dynamicobject a collection of key value pairs where the key is tag name, and the value is tag value see the tags entry in player entity (2020/10) docid\ klxwxuju fg9an8cre3ww for more information response success 204 204 the tags were added to the specified device failure 400 400 either a tag with the specified key was already defined, the request is malformed and therefore invalid, or there is a conflict 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 404 404 the server cannot find the requested resource (the path does not exist) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 5xx any 500 code is an internal server error delete /{id\ int}/tags/ remove tags from a specified device (specified by device id) required scope token bsn api main devices update segment id int int the unique identifier for the device request body list string\[] string\[] an array of tag keys to delete response success 204 204 the specified tag was successfully deleted from the device failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 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 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /{serial}/tags/ returns an object whose property names match tag keys and whose property values match tag values on the specified device required scope token bsn api main devices retrieve segment serial string string the device serial number response success response body 200 200 a collection of key value pairs where the key is tag name, and the value is tag value see the tags entry in player entity (2020/10) docid\ klxwxuju fg9an8cre3ww for more information failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 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 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error post /{serial}/tags/ adds one or more tags to a specified device (specified by device serial number) required scope token bsn api main devices update segment serial string string the device serial number request body tags dynamicobject dynamicobject a collection of key value pairs where the key is tag name, and the value is tag value see the tags entry in player entity (2020/10) docid\ klxwxuju fg9an8cre3ww for more information response success 204 204 the tags were added to the specified device failure 400 400 either a tag with the specified key was already defined, the request is malformed and therefore invalid, or there is a conflict 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 404 404 the server cannot find the requested resource (the path does not exist) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 5xx any 500 code is an internal server error delete /{serial}/tags/ removes one or more tags from a specified device (specified by device serial number) required scope token bsn api main devices update segment serial string string the device serial number request body list string\[] string\[] an array of tag keys to delete response success 204 204 the specified tag was successfully deleted from the device failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 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 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /models/ returns the list of player models supported by the current main api version required scope token bsn api main devices retrieve response success response body 200 200 returns the complete list of player models that are supported on this main api version failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 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 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /models/{model}/ returns the list of player models supported by the current main api version required scope token bsn api main devices retrieve segment model string string the player model response success response body 200 200 returns the complete list of player models that are supported on this main api version failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 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 404 404 the provided player model does not exist (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /models/{model}/connectors/ returns the list of connectors available on a given device model required scope token bsn api main devices retrieve segment model string string the player model response success response body 200 200 returns the list of connectors available on a given device model failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 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 404 404 the provided player model does not exist or is incorrect 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /models/{model}/connectors/{connector}/ returns the list of connectors available on a given device model required scope token bsn api main devices retrieve segment model string string the player model connector string string the video connector (for example, "hdmi" or "displayport") response success response body 200 200 returns the list of connectors available on a given device model failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 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 404 404 the provided player model or connector does not exist or is incorrect 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /models/{model}/connectors/{connector}/videomodes/ returns the video modes docid\ qpml112mbhek7lbdguxnv supported by the specified connector on the specified device model required scope token bsn api main devices retrieve segment model string string the player model connector string string the video connector (for example, "hdmi" or "displayport") response success response body 200 200 the response body is an array of strings listing video modes docid\ qpml112mbhek7lbdguxnv supported by the specified connector on the specified device model failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 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 404 404 the provided player model or connector does not exist or is incorrect 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /operations/ returns operational permissions granted to roles for specific business operations required scope token bsn api main operations retrieve response success response body 200 200 returns the business operations entity (2020/10) docid\ ychro4ocgshfhae1gvygf failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 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 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /{id\ int}/permissions/ returns the list of permissions allowing or denying specific business operations to be executed on a specified device required scope token bsn api main devices retrieve segment id int int a unique identifier for the device response success response body 200 200 returns an array of permission entity (2020/10) docid 9p ncidl9xh7qdpkxgodl entities failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 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 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error post /{id\ int}/permissions/ applies permissions allowing or denying specific business operations to be executed on a specified device required scope token bsn api main devices update segment id int int a unique identifier for the device request body an array of permission entity (2020/10) docid 9p ncidl9xh7qdpkxgodl entities response success 204 204 the specified permissions were successfully granted failure 400 400 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 404 404 the server cannot find the requested resource (the path does not exist) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 5xx any 500 code is an internal server error delete /{id\ int}/permissions/ removes custom permissions granted to execute business operations from a specified device required scope token bsn api main devices update segment id int int a unique identifier for the device request body an array of permission entity (2020/10) docid 9p ncidl9xh7qdpkxgodl entities response success 204 204 the specified permissions were successfully deleted from the device failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 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 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /{serial}/permissions/ returns the list of permissions allowing or denying specific business operations to be executed on a specified device required scope token bsn api main devices retrieve segment serial string string the serial number of the device response success response body 200 200 returns an array of permission entity (2020/10) docid 9p ncidl9xh7qdpkxgodl entities failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 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 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error post /{serial}/permissions/ applies permissions allowing or denying specific business operations to be executed on a specified device required scope token bsn api main devices update segment serial string string the serial number of the device request body an array of permission entity (2020/10) docid 9p ncidl9xh7qdpkxgodl entities response success 204 204 the specified permissions were successfully granted failure 400 400 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 404 404 the server cannot find the requested resource (the path does not exist) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 5xx any 500 code is an internal server error delete /{serial}/permissions/ removes custom permissions granted to execute business operations from a specified device required scope token bsn api main devices update segment serial string string the serial number of the device request body an array of permission entity (2020/10) docid 9p ncidl9xh7qdpkxgodl entities response success 204 204 the specified permissions were successfully deleted from the device failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 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 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /{serial}/tokens/{token}/ validates an oauth2 device access or refresh token on a specified device required scope token bsn api main devices token validate segment serial string string the serial number of the device token string string an oauth2 device access or refresh token issued for the specified device response success response body 200 200 returns the token info entity (2020/10) docid 0x0nmgjzaehzv5yrqeyxr failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 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 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error delete /{serial}/tokens/{token}/ revokes an oauth2 device access or refresh token on a specified device required scope token bsn api main devices token revoke segment serial string string the serial number of the device token string string an oauth2 device access or refresh token issued for the specified device response success 204 204 the specified token was successfully deleted from the device failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 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 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /{id\ int}/tokens/{token}/ validates an oauth2 device access or refresh token on a specified device required scope token bsn api main devices token validate segment id int int a unique identifier for the device token string string an oauth2 device access or refresh token issued for the specified device response success response body 200 200 returns the token info entity (2020/10) docid 0x0nmgjzaehzv5yrqeyxr failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 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 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error delete /{id\ int}/tokens/{token}/ revokes an oauth2 device access or refresh token on a specified device required scope token bsn api main devices revoke segment id int int a unique identifier for the device token string string an oauth2 device access or refresh token issued for the specified device response success 204 204 the specified token was successfully deleted from the device failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 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 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error