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 expression 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 of Device Entity 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 expression 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 expression for filtering search results.

______________________________________________________________

Response Body

Returns the Device Region Entity

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 expression 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

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

______________________________________________________________

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

PUT  /{serial}/ 

Update a device, specified by serial number, on a network.

Parameters

serial string

The device serial number

______________________________________________________________

Request Body

The Device Entity

______________________________________________________________

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

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

POST  /{id:int}/Beacons/ 

Create a device beacon.

Parameters

id int

A unique identifier for the device instance 

______________________________________________________________

Request Body

The Device Beacon Entity

______________________________________________________________

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.

POST  /{serial}/Beacons/ 

Create a device beacon.

Parameters

serial string

The serial number of the device instance 

______________________________________________________________

Request Body

The Device Beacon Entity

______________________________________________________________

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.

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

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

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

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

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 DeviceScreenShot Entity

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 DeviceScreenShot Entity

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 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 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<string>

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 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 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<string>

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 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 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

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

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

______________________________________________________________

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

______________________________________________________________

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

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

______________________________________________________________

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

______________________________________________________________

Response Body

On success this method returns a status code 2XX, on failure it returns a status code of 5XX