| Panel | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
ON THIS PAGE
|
...
/Devices//Devices/{id}/- Id will be an integer (int)
/Devices/{serial}- Serial will be a string
Response Body
On success this method returns a status code 204, on failure it returns a status code of 500.
/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.
...
filter: An expression for filtering search results.
Response Body
The device count is returned as an integer value.
...
Returns Business Operations for devices.
Response Body
[string] uid: A unique identifier for the Operation instance.[string] singularName: The name of the operation in singular form. This value is useful for displaying in entity properties dialogs.[string] pluralName: The name of the operation in plural form. This value is useful for displaying in User and Role properties dialogs.[string] fullName: The name of the current operation along with its parent operations (if any). Since many operation names aren't unique, this value is useful for differentiating similar business operations.[string] targetEntity: The object type affected by the operation (in this case, "Device")[Operation{}] parent: An Operation instance indicating the operation from which permissions are inherited. This value will be Null if there is no parent operation.[Operations[]]descendants: An array of Operation instances that inherit permissions from this operation. This value is Null if there are no descendant operations.[Permissions[] permissions: An array of Permission instances indicating permissions associated with this operation
...
/Devices/{device_Id||serial}/Beacons/
GET
Returns a list of persistent BLE beacons associated with the device.
Response Body
POST
...
URL Parameters
Request Body
Response Body
/Devices/{device_Id||serial}/Beacons/{beacon
_idId}/
GET
...
URL Parameters
Request Body
Response Body
DELETE
...
URL Parameters
Request Body
Response BodyDelete a beacon.
{deviceId:int}/Beacons/{beaconId:int}- beaconId will be an integer (int)
{serial}/Beacons/{beaconId:int}- Serial will be a string
/Devices/{device_id||serial}/Errors/
GET
Returns a list of errors associated with the specified device.
URL Parameters
marker: A value specifying which page to retrieve. This value is useful if theisTruncatedentry in the response body of the previous GET call indicates that the number of Error instances exceeds thepageSize.pageSize: The maximum number of Error instances that can be contained in the response bodyfilter: 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. "[error].[timestamp] ASC")
Response Body
[int] totalItemCount: The total number of errors[int] matchingItemCount: The total number of errors that match thefiltercriteria specified in the request[int] pageSize: The maximum number of errors that can be returned in a single response[bool] isTruncated: A flag indicating whether thetotalItemCountexceeds thepageSize[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 Error object instances describing errors associated with the device
/Devices/{device_id||serial}/Downloads/
GET
Returns a list of file downloads carried out by the specified device.
URL Parameters
marker: A value specifying which page to retrieve. This value is useful if theisTruncatedentry in the response body of the previous GET call indicates that the number of Download instances exceeds thepageSize.pageSize: The maximum number of Download instances that can be contained in the response bodyfilter: 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 thefiltercriteria 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 thetotalItemCountexceeds thepageSize[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}/ScreenShots/
GET
Returns a list of screenshots uploaded by the specified device
URL Parameters
marker: A value specifying which page to retrieve. This value is useful if theisTruncatedentry in the response body of the previous GET call indicates that the number of Screenshot instances exceeds thepageSize.pageSize: The maximum number of Screenshot instances that can be contained in the response bodyfilter: 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 thefiltercriteria 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 thetotalItemCountexceeds thepageSize[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 asyyyy-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 asyyyy-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||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 keyvalue: 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 keyvalue: 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 its supported by the specified player model.
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.