Devices Endpoints (2017/01)

this endpoint allows for management and monitoring of devices on the network base url for these endpoints https //api brightsignnetwork com/2017/01/rest/devices get / retrieves a list of devices on the network parameters filter string an filter expressions in the main api (2017/01) docid\ l8mfvfdghpy9xgiuquwcm for filtering search results sort string 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 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 pagesize int the maximum number of device instances that can be contained in the response body response body returns a paged list entity (2017/01) docid\ yn3gu asyfisjdxgbjdvb of device entity (2017/01) docid\ s8ft5mv m2461imnvdi2 instances on a network this will return not more than 100 entities along with the information necessary to return any other remaining pages delete / removes devices, specified by a filter, from a network this allows multiple devices to be deleted at once parameters filter string an filter expressions in the main api (2017/01) docid\ l8mfvfdghpy9xgiuquwcm for filtering search results response body returns the number of affected devices as an integer value get /regions/{ locationpath}/ returns a region which contains all the players located in the specified path parameters locationpath string the parts of the returned player location path (country, province, city, etc ) that are common to all players filter string an filter expressions in the main api (2017/01) docid\ l8mfvfdghpy9xgiuquwcm for filtering search results response body returns the device region entity (2017/01) docid\ fvpmtod58odago6usivij 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 parameters filter string an filter expressions in the main api (2017/01) docid\ l8mfvfdghpy9xgiuquwcm for filtering search results response body the device count is returned as an integer value get /{id\ int}/ return the information for a device, specified by device id, on a network parameters id int a unique identifier for the device instance response body returns the device entity (2017/01) docid\ s8ft5mv m2461imnvdi2 put /{id\ int}/ update the specified device (specified by id) parameters id int a unique identifier for the device instance request body the device entity (2017/01) docid\ s8ft5mv m2461imnvdi2 response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx delete /{id\ int}/ delete the specified devices (devices are specified by id) parameters id int a unique identifier for the device instance response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx get /{serial}/ return the specified device information (specified by serial number) parameters serial string the device serial number response body returns the device entity (2017/01) docid\ s8ft5mv m2461imnvdi2 put /{serial}/ update a device, specified by serial number, on a network parameters serial string the device serial number request body the device entity (2017/01) docid\ s8ft5mv m2461imnvdi2 response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx delete /{serial}/ delete the specified devices (devices are specified by serial number) parameters serial string the device serial number response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx get /{deviceid\ int}/beacons/{beaconid\ int?}/ returns a list of apple, eddystoneurl, or eddystone uid device beacons associated with a specified device parameters deviceid int the unique identifier for the device instance beaconid int the unique identifier of the device beacon response body returns the device beacon entity (2017/01) docid\ ef5dbjg mdt euxd k ob get /{serial}/beacons/{beaconid\ int?}/ returns a list of apple, eddystoneurl, or eddystone uid device beacons associated with a specified device parameters serial string the serial number for the device instance beaconid int the unique identifier of the device beacon response body returns the device beacon entity (2017/01) docid\ ef5dbjg mdt euxd k ob post /{id\ int}/beacons/ create a device beacon parameters id int a unique identifier for the device instance request body the device beacon entity (2017/01) docid\ ef5dbjg mdt euxd k ob response body returns a 201 status code and the new resource created and referenced by the uri (given by the location header field) in the response the response includes the device beacon entity (2017/01) docid\ ef5dbjg mdt euxd k ob post /{serial}/beacons/ create a device beacon parameters serial string the serial number of the device instance request body the device beacon entity (2017/01) docid\ ef5dbjg mdt euxd k ob response body returns a 201 status code and the new resource created and referenced by the uri (given by the location header field) in the response the response includes the device beacon entity (2017/01) docid\ ef5dbjg mdt euxd k ob delete /{deviceid\ int}/beacons/{beaconid\ int}/ delete a specified device beacon from a specified device parameters deviceid int a unique identifier for the device instance beaconid int the unique identifier of the device beacon response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx delete /{serial}/beacons/{beaconid\ int}/ delete a specified device beacon from a specified device parameters serial string the serial number of the device instance beaconid int the unique identifier of the device beacon response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx get /{id\ int}/errors/ returns a list of errors associated with the specified device parameters id int a unique identifier for the device that is reporting the errors marker string 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 pagesize int the maximum number of error instances that can be contained in the response body response body returns the device error entity (2017/01) docid 4ptuwgrwgzpw3vyoqu0xh get /{serial}/errors/ returns a list of errors associated with a device (specified by serial number) parameters serial string the serial number of the device that is reporting the errors marker string 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 pagesize int the maximum number of error instances that can be contained in the response body response body returns the device error entity (2017/01) docid 4ptuwgrwgzpw3vyoqu0xh get /{id\ int}/downloads/ returns the downloads associated with a device (specified by device id) parameters id int the unique identifier for the device that has the download instances marker string 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 pagesize int the maximum number of download instances that can be contained in the response body response body returns the device download entity (2017/01) docid\ ts gpkwt z0vqu32cqj43 get /{serial}/downloads/ returns a list of downloads carried out by a device (specified by serial number) parameters serial string the serial number of the device that has the download instances marker string 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 pagesize int the maximum number of download instances that can be contained in the response body response body returns the device download entity (2017/01) docid\ ts gpkwt z0vqu32cqj43 get /{id\ int}/screenshots/ returns a list of screenshots uploaded by a device (specified by device id) parameters id int a unique identifier for the device instance marker string 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 pagesize int the maximum number of screenshot instances that can be contained in the response body response body returns the device screenshot entity (2017/01) docid\ irlfsb6bzzef0172w4uqg get /{serial}/screenshots/ returns a list of screenshots uploaded by a device (specified by device serial number) parameters serial string the device serial number marker string 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 pagesize int the maximum number of screenshot instances that can be contained in the response body response body returns the device screenshot entity (2017/01) docid\ irlfsb6bzzef0172w4uqg get /{id\ int}/tags/ returns a list of tags associated with a specified device parameters id int a unique identifier for the device instance response body a collection of key value pairs where the key is tag name, and the value is tag value see the tags entry in device entity (2017/01) docid\ s8ft5mv m2461imnvdi2 for more information post /{id\ int}/tags/ adds tags to a specified device (specified by device id) parameters id int a unique identifier for the device instance request body tags dictionary\<string, string> creates one or more tags the specified tags must not be previously defined since this method won't override existing tag values see the tags entry in device entity (2017/01) docid\ s8ft5mv m2461imnvdi2 for more information response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx delete /{id\ int}/tags/ remove tags from a specified device (specified by device id) parameters id int a unique identifier for the device instance request body list list a list of tag keys response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx get /{serial}/tags/ returns a list of tags associated with a specified device (specified by device serial number) parameter serial string the serial number of the device response body a collection of key value pairs where the key is tag name, and the value is tag value see the tags entry in device entity (2017/01) docid\ s8ft5mv m2461imnvdi2 for more information post /{serial}/tags/ adds one or more tags to a specified device (specified by device serial number) parameter serial string the serial number of the device request body tags dictionary\<string, string> creates one or more tags the specified tags must not be previously defined since this method won't override existing tag values see the tags entry in device entity (2017/01) docid\ s8ft5mv m2461imnvdi2 for more information response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx delete /{serial}/tags/ removes one or more tags from a specified device (specified by device serial number) parameters serial string the serial number of the device request body list list a list of tag keys response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx get /models/ returns the complete list of supported models parameter model string the player model response body returns the complete list of player models that are supported on this api version get /models/{model}/connectors/ returns the list of connectors available on a given device model to implement this resource, you should first run /devices/models/ parameter model string the player model response body returns the list of connectors available on a given device model get /models/{model}/connectors/{connector}/videomodes/ returns the video modes docid\ qpml112mbhek7lbdguxnv supported by the specified connector on the specified device model to implement this resource, you should first run /devices/models/connectors/ parameters model string the player model connector string the video connector (for example, "hdmi" or "displayport") response body the response body is an array of strings listing video modes docid\ qpml112mbhek7lbdguxnv supported by the specified connector on the specified device model get /operations/ returns operational permissions granted to roles for specific business operations response body returns the business operations entity (2017/01) docid\ fwdujpp aohpf3res sz get /{id\ int}/permissions/ includes object permissions for a given device instance parameters id int a unique identifier for the device instance response body returns the permission entity (2017/01) docid\ horbsqti93 eafzzftgmy post /{id\ int}/permissions/ add permissions to a specified device (specified by device id) parameters id int a unique identifier for the device instance request body the permission entity (2017/01) docid\ horbsqti93 eafzzftgmy response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx delete /{id\ int}/permissions/ delete permissions from a specified device (specified by device id) parameters id int a unique identifier for the device instance request body the permission entity (2017/01) docid\ horbsqti93 eafzzftgmy response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx get /{serial}/permissions/ includes object permissions for a given device instance parameters serial string the serial number of the device response returns the permission entity (2017/01) docid\ horbsqti93 eafzzftgmy post /{serial}/permissions/ add permissions to a device which is specified by serial number parameters serial string the serial number of the device request body the permission entity (2017/01) docid\ horbsqti93 eafzzftgmy response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx delete /{serial}/permissions/ delete permissions from a specified device (specified by serial number) parameters serial string the serial number of the device request body the permission entity (2017/01) docid\ horbsqti93 eafzzftgmy response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx