Versions Compared

Old Version 10

changes.mady.by.user BrightSign TechDocs

Saved on

compared with

New Version 11

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. "[device].[serial] 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 paged list of Player Entity instances on a network. This will return not more than 100 entities along with the information necessary to return any other remaining pages.

/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 expression for filtering search results.

Response Body

Returns the Players 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 Player Entity

PUT

Update the specified device (specified by id).

Parameters

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

Request Body

The Player Entity

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/{serial}/

GET

Return the specified device information (specified by serial number)

Parameters

  • [string] serial: The device serial number 

Response Body

Returns the Player Entity

/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 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 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 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 Beacon Entity.

/Devices/{serial}/Beacons/

POST

Create a device beacon.

Parameters

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

Request Body

The Player 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 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 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 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 Player 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 Player Download Entity 

    /Devices/{id:int}/ScreenShots/

    GET

    Returns a list of screenshots uploaded by

    the

    a device (specified by device id)

    URL

    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

    Response Body

    Returns the ScreenShot 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 ScreenShot Entity


    /Devices/Operations/

    GET

    Returns Business Operations for devices.

    Response Body

    /Devices/{device_id||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

    POST

    Adds one or more tags to the specified device.

    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.

    DELETE

    Removes one or more tags from the specified device.

    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.

    /Devices/Models/

    GET

    Returns a list of player models that are supported by BSN.

    Response Body

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

    /Devices/Models/{model}

    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"). 

    /Devices/Models/{model}/Connectors/

    GET

    Returns a list of video connectors supported by the specified model.

    Response Body

    The response body is an array of strings specifying video connectors supported by the model. The following are valid values:

    • "HDMI"
    • "VGA"
    • "Component"

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

    GET

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

    Parameters

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

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

    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.