Page Comparison

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

GET

...

URL Parameters

Request Body

Response Body

DELETE

Delete a beacon.

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

  • beaconId will be an integer (int)
• {serial}/Beacons/{beaconId:int}
  • 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/{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 the isTruncated entry in the response body of the previous GET call indicates that the number of Error instances exceeds the pageSize.
• pageSize: The maximum number of Error 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. "[error].[timestamp] ASC")

Response Body

• [int] totalItemCount: The total number of errors
• [int] matchingItemCount: The total number of errors that match the filter criteria 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 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 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 the isTruncated entry in the response body of the previous GET call indicates that the number of Download instances exceeds the pageSize.
• pageSize: The maximum number of 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}/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 the isTruncated entry in the response body of the previous GET call indicates that the number of Screenshot instances exceeds the pageSize.
• 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