Versions Compared

Old Version 9

changes.mady.by.user BrightSign TechDocs

Saved on

compared with

New Version Current

changes.mady.by.user BrightSign TechDocs

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This endpoint allows for management and monitoring of devices on the network. For constraints on headers, see REST API.

/Devices/

GET

Retrieves a list of devices on the network.

Parameters

  • [string] filter:  An expression for filtering search results.
  • [string] sort: 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. "[deviceDevice].[serialSerial] ASC")
  • [string] marker: 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.
  • [int] pageSize: The maximum number of Device instances that can be contained in the response body

Response Body

  • Returns a a paged list of Player Entity instances  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

  • [string] filter:  An expression for filtering search results.

Response Body

Returns the number of affected devices as an integer value.

/Devices/Regions/{*locationPath}/

GET

Returns a region which contains all the players located in the specified path.

Parameters

  • [string] locationPath:  The parts of the returned player location path (country, province, city, etc.) that are common to all players. 
  • [string] filter:  An  An expression for filtering search results.

Response Body

Returns the Players Device Region Entity.

/Devices/Count/

GET

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

  • [string] filter:  An expression for filtering search results.

Response Body

The device count is returned as an integer value.

/Devices/{id:int}/

GET

Return the information for a device, specified by device id, on a network

Parameters

  • [int] id: A unique identifier for the device instance

Response Body

Returns the Device Entity

PUT

Update the specified device (specified by id).

Parameters

  • [int] id: 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

Delete the specified devices (devices are specified by id)

Parameters

  • [int] id: 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.


Panel
borderColor#3D3D3D
bgColor#F4F4F4
titleColor#3D3D3D
borderWidth0
titleBGColor#3D3D3D
borderStylesolid

ON THIS PAGE

Table of Contents
maxLevel3
indent20px



/Devices/{

id:int

serial}/

GET

Return the information for specified device information (specified by serial number)

Parameters

  • [string] serial: The device serial number 

Response Body

Returns the Device Entity

PUT

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

Parameters

Return the specified device information (
  • [intstring] idserial: A unique identifier for the device instance

Response Body

Returns the Player Entity

/Devices/{serial}/

GET

  • 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

Delete the specified devices (devices are specified by serial number)

Parameters

  • [string] serial: The device serial number 

Response Body

Returns the Player EntityOn success this method returns a status code 2XX, on failure it returns a status code of 5XX.

/Devices/{deviceId:int}/Beacons/{beaconId:int?}/

GET

Returns a list of Apple, EddystoneUrl, or Eddystone Uid device beacons associated with a specified device.

Parameters

  • [int] deviceId: The unique identifier for the device instance
  • [int] beaconId: The unique identifier of the device beacon

Response Body

Returns the Player the Device Beacon Entity

/Devices/{serial}/Beacons/{beaconId:int?}/

GET

Returns a list of Apple, EddystoneUrl, or Eddystone Uid device beacons associated with a specified device.

Parameters

  • [string] serial: The serial number for the device instance
  • [int] beaconId: The unique identifier of the device beacon

Response Body

Returns the Player the Device Beacon Entity

/Devices/{id:int}/Beacons/

POST

Create a device beacon.

Parameters

  • [int] id: A unique identifier for the device instance 

Request Body

The Player 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 Player Device Beacon Entity.

/Devices/{serial}/Beacons/

POST

Create a device beacon.

Parameters

  • [string] serial: The serial number of the device instance 

Request Body

The Player 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 Player Device Beacon Entity.

/Devices/{deviceId:int}/Beacons/{beaconId:int}/

DELETE

Delete a specified device beacon from a specified device.

Parameters

  • [int] deviceId: A unique identifier for the device instance
  • [int] beaconId: 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.

/Devices/{serial}/Beacons/{beaconId:int}/

DELETE

Delete a specified device beacon from a specified device.

Parameters

  • [string] serial: The serial number of the device instance
  • [int] beaconId: 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.


/Devices/{id:int}/Errors/

GET

Returns a list of errors associated with the specified device.

Parameters

  • [int] id: A unique identifier for the device that is reporting the errors
  • [string] marker: 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.
  • [int] pageSize: The maximum number of error instances that can be contained in the response body

Response Body

Returns the Player the Device Error Entity

/Devices/{serial}/Errors/

GET

Returns a list of errors associated with a device (specified by serial number).

Parameters

  • [string] serial: The serial number of the device that is reporting the errors
  • [string] marker: 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.
  • [int] pageSize: The maximum number of Error instances that can be contained in the response body

Response Body

Returns the Player Device Error Entity

/Devices/Operations/

GET

Returns Business Operations for devices.

Response Body

/Devices/{

device_id||serial

id:int}/Downloads/

GET

Returns

a list of file downloads carried out by the specified device.

URL Parameters

marker: A

the downloads associated with a device (specified by device id).

Parameters

  • [int] id:  The unique identifier for the device that has the download instances
  • [string] marker:  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 download instances exceeds the pageSize.
  • [int] pageSize: The   The maximum number of Download download instances that can be contained in the response body
  • filter:  An expression for filtering search results.
  • sort: 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. "[download].[filename] ASC")

Response Body

  • [int] totalItemCount: The total number of downloads
  • [int] matchingItemCount: The total number of downloads that match the filter criteria specified in the request
  • [int] pageSize: The maximum number of downloads that can be returned in a single response
  • [bool] isTruncated: A flag indicating whether the totalItemCount exceeds the pageSize
  • [string] nextMarker: A value that can be included with a subsequent GET call to return additional results that have been truncated
  • [string] sortExpression: The sort expression specified in the URL
  • [string] filterExpression: The filter expression specified in the URL
  • [Device[]] items: An array of Download object instances describing downloads associated with the device
/Devices/{device_id||serial

Response Body

Returns the Device Download Entity

/Devices/{serial}/Downloads/

GET

Returns a list of downloads carried out by a device (specified by serial number).

Parameters

  • [string] serial: The serial number of the device that has the download instances
  • [string] marker: 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.
  • [int] pageSize: The maximum number of download instances that can be contained in the response body

Response Body

Returns the Device Download Entity

/Devices/{id:int}/ScreenShots/

GET

Returns a list of screenshots uploaded by

the

a device (specified by device id)

URL Parameters

Parameters

  • [int] id: A unique identifier for the device instance
  • [string] marker: 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.
  • [int] pageSize: The maximum number of Screenshot instances that can be contained in the response body
  • filter:  An expression for filtering search results.
  • sort: 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. "[screenshot].[timestamp] ASC")

Response Body

  • [int] totalItemCount: The total number of screenshots
  • [int] matchingItemCount: The total number of screenshots that match the filter criteria specified in the request
  • [int] pageSize: The maximum number of screenshots that can be returned in a single response
  • [bool] isTruncated: A flag indicating whether the totalItemCount exceeds the pageSize
  • [string] nextMarker: A value that can be included with a subsequent GET call to return additional results that have been truncated
  • [string] sortExpression: The sort expression specified in the URL
  • [string] filterExpression: The filter expression specified in the URL
  • [Device[]] items: An array of Screenshot object instances describing downloads associated with the device
    • [int] id: A unique identifier for the Screenshot instance
    • [string] groupName: The name of the BSN group to which the player producing the screenshot belongs
    • [string] utcTimestamp: A UTC timestamp indicating when the screenshot was taken on the player. The date/time is formatted as yyyy-mm-ddThh:mm:ss.sssZ.
    • [string] localTimestamp: A timestamp indicating the local time (as it is specified in the player settings) when the screenshot was taken on the player. The date/time is formatted as yyyy-mm-ddThh:mm:ss.sss.
    • [int] width: The width (in pixels) of the screenshot image
    • [int] height: The height (in pixels) of the screenshot image
    • [string] filePath: The location of the image file in the server directory
    • [string] thumbPath: The location of the image thumbnail in the server directory
/Devices/{device_id||

Response Body

Returns the DeviceScreenShot Entity

/Devices/{serial}/ScreenShots/

GET

Returns a list of screenshots uploaded by a device (specified by device serial number).

Parameters

  • [string] serial: The device serial number
  • [string] marker: 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.
  • [int] pageSize: The maximum number of Screenshot instances that can be contained in the response body

Response Body

Returns the DeviceScreenShot Entity

/Devices/{id:int}/Tags/

GET

Returns a list of tags associated with a specified device 

Parameters

  • [int] id: 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

Adds tags to a specified device (specified by device id).

Parameters

  • [int] id: A unique identifier for the device instance

Request Body

  • [Dictionary<string, string>] tags: 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

Remove tags from a specified device (specified by device id).

Parameters

  • [int] id: A unique identifier for the device instance

Request Body

  • [List<string>] 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.

/Devices/{serial}/Tags/

GET

Returns

an object that represents tags assigned to the specified device.

Response Body

Each tag is formatted as follows: "<value_type>::<tag_type>.<tag_key>":"<value>".

  • value_type: "string" or "number"
  • tag_type: "[Device]" (a user-defined key/value) or "[sys].[Device]" (a system-defined key/value)
  • tag_key: The tag key
    • value: The tag value

    a list of tags associated with a specified device (specified by device serial number).

    Parameters

    • [string] serial: The device serial number

    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

    Adds one or more tags to

    the

    a specified device (specified by device serial number).

    Request Body

    The request body is an object conatining tag key/value pairs. Each tag must be formatted as follows: "<value_type>::<tag_type>.<tag_key>":"<value>".

    • value_type: "string" or "number"
    • tag_type: "[Device]" (a user-defined key/value) or "[sys].[Device]" (a system-defined key/value)
    • tag_key: The tag key
    • value: The tag value

    Response Body

    The server returns code 204 upon success

    Parameters

    • [string] serial: The device serial number

    Request Body

    • [Dictionary<string, string>] tags: 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

    Removes one or more tags from

    the

    a specified device (specified by device serial number).

    Request Body

    The request body is an array of tag keys. Each tag key must be formatted as follows: "<value_type>::<tag_type>.<tag_key>".

    • value_type: "string" or "number"
    • tag_type: "[Device]" (a user-defined key/value) or "[sys].[Device]" (a system-defined key/value)
    • tag_key: The tag key

    Response Body

    The server returns code 204 upon success

    Parameters

    • [string] serial: The device serial number

    Request Body

    • [List<string>] 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.

    /Devices/Models/

    GET

    Returns

    a

    the complete list of

    player

    supported models

    that are supported by BSN.

    .

    Parameters

    • [string] model: The player model 

    Response Body

    The response body is an array of strings specifying supported player models.

    Returns the complete list of player models that are supported on this API version

    /Devices/Models/{model}/Connectors/

    GET

    Returns the

    model number of the specified model.

    Response Body

    If the specified model is supported, the server returns a string containing the model number (e.g. "XT1143"). 

    list of connectors available on a given device model. To implement this resource, you should first run /Devices/Models/.

    Parameters

    • [string] model:  The player model 

    Response Body

    Returns the list of connectors available on a given device model

    /Devices/Models/{model}/Connectors/{connector}/VideoModes/

    GET

    Returns

    a list of video connectors

    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

    • [string] model: The player model 
    • [string] connector:  The video connector (for example, "HDMI" or "DisplayPort")

    Response Body

    The response body is an array of strings

    specifying

    listing video

    connectors

    modes supported by the

    model. The following are valid values:
  • "HDMI"
  • "VGA"
    • "Component"

    specified connector on the specified device model.

    /Devices/Operations/

    GET

    Returns operational permissions granted to roles for specific business operations

    Response Body

    Returns the Business Operations Entity

    /Devices/

    Models/

    {

    model

    id:int}/

    Connectors/{connector?}

    Permissions/

    GET

    Includes object permissions for a given device instance.

    Parameters

    • [int] id: A unique identifier for the device instance

    Response Body

    Returns the

    specified video connector if it's supported by the specified player model

     Permission Entity

    POST

    Add permissions to a specified device (specified by device id).

    Parameters

    • [int] id: 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

    Delete permissions from a specified device (specified by device id).

    Parameters

    • [stringint]  model
    • [string] connector

    Response Body

    If the specified video connector is supported, the response body will contain the connector name as a string. Otherwise, it will return code 404
    • id: 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.

    /Devices/

    Models/

    {

    model

    serial}/

    Connectors/{connector}/VideoModes

    Permissions/

    GET

    Returns a list of video modes supported by the specified connector on the specified model.

    Response Body

    The response body is an array of strings listing video modes supported by the specified connector on the specified model.

    Includes object permissions for a given device instance.

    Parameters

    • [string] serial: The serial number of the device

    Response

    Returns the Permission Entity

    POST

    Add permissions to a device which is specified by serial number

    Parameters

    • [string] serial: 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

    Delete permissions from a specified device (specified by serial number)

    Parameters

    • [string] serial: 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