All device entities are structured as follows:
entity:
...
Id int
...
: A unique identifier for the device instance
...
Serial string
...
:
...
The device serial number
...
Name string
...
: The device name
...
ConcatUnitNameAndSerial bool
...
: The device-naming method: True indicates that clients should append the device serial number to the device name, False indicates that nothing should be appended to the device name.
...
Description string
...
: A customer-defined description of the device. The description does not need to be unique within the scope of the account.
...
CurrentSubscription DeviceSubscription
...
: See Device Subscription Entity
...
TargetGroup GroupInfo:
...
Id int
...
: The unique identifier for the group instance to which the device belongs.
...
Name string
...
: The name of the group instance to which the device belongs
...
TaggedGroups TaggedGroupInfo[]
...
:
...
Id int
...
: The unique identifier for the tagged group
...
Name string
...
: The name of the tagged group
...
TargetBrightWall BrightWallInfo
...
:
...
Id int?
...
: A unique identifier for the BrightWall
...
Name string
...
: The BrightWall name
...
TargetBrightWallScreenNumber Nullable<byte>:
...
ReportedGroup GroupInfo
...
:
...
Id int
...
:
...
The unique identifier for the reported group
...
Name string
...
: The name of the reported group
...
ReportedBrightWall BrightWallInfo
...
:
...
Id int
...
: The identifier and primary key of the BrightWall instance.
...
Name string
...
: The user-defined name of the BrightWall instance. This alternate key must be unique in the scope of the BSN account.
...
ReportedBrightWallScreenNumber Nullable<byte>: The BrightWall screen number that the device reported belonging to when it last synchronized with the server. This value is set to Null when the device is assigned to a group instance.
...
Presentation PresentationInfo
...
: See
...
...
Model DeviceModel
...
: The device model name and suffix
...
Family DeviceFamily
...
: The model family of the device ("Sebring", "Pagani", etc.)
...
LastModifiedDate DateTime
...
: A UTC timestamp indicating when the player instance was last modified.
...
See DateTime
...
for more information about this data type.
...
Autorun DeviceAutorun
...
:
...
Version string
...
: The current presentation autorun version assigned to the group
...
IsCustom bool
...
: Whether the autorun is a standard BrightAuthor file (false) or a custom-built file (true)
...
MinFirmwares DeviceFirmware[
...
]
...
: An array of
...
firmware instances indicating the minimum firmware version required to run the autorun on a player. Since different model families can have different minimum firmware requirements, this array can contain more than one
...
firmware instance.
...
version string
...
: The firmware version number
...
supportedModels string[
...
]
...
: An array of string values indicating which model numbers (e.g. "XDx233") apply for the minimum-firmware requirement
...
IsRevoked bool
...
: Whether or not
...
the current presentation autorun version is supported/in service
FirmwareVersion string: The version of firmware that the device was using the last time it synced with the server.
...
CardSize string
...
: The total size of the device storage. This information is displayed in the format “{0} MiB” or “{0:F2} GiB” (where F2 is equivalent to a fixed-point number with two decimal digits (e.g. “1.75 GiB”)).
...
CardFreeSize string
...
: The amount of free space on the device storage. This information is displayed in the format “{0} MiB” or “{0:F2} GiB” (where F2 is equivalent to a fixed-point number with two decimal digits (e.g. “1.75 GiB”)).
...
TargetTimeZone string
...
: The string name of the time zone that the device should use
...
ReportedTimeZone string
...
: The string name of the time zone that the device reported using the last time it synced with the server.
...
ScreenColor string
...
: The background color of the screen
...
ContentCheckPeriod DeviceConnectionsPeriod
...
: Represents the time interval between synchronization events, when the device checks with the BrightSign Network servers for content updates.
...
ContentDownloadsStartTime Nullable<TimeSpan>: The time each day (according to the reported time zone) when the device should begin downloading content from the BrightSign Network persistent storage. A Null value indicates that the device can download content at any time during the day.
...
ContentDownloadsEndTime Nullable<TimeSpan>: The time each day (according to the reported time zone) when the device should finish downloading content from the BrightSign Network persistent storage. A Null value indicates that the device can download content at any time during the day. See
...
TimeSpan for more information about this data type.
...
HealthReportingPeriod DeviceConnectionsPeriod
...
: A DeviceConnectionsPeriod enumeration representing the interval between health-report events, when the device checks in with the server to report its status.
...
HealthReportingStartTime Nullable<TimeSpan>: The time each day (according to the reported time zone) when the device should begin sending health status updates to the BrightSign Network servers. A Null value indicates that the device can send reports at any time during the day. See
...
TimeSpan for more information about this data type.
...
HealthReportingEndTime Nullable<TimeSpan>: The time each day (according to the reported time zone) when the device should stop sending health status updates to the BrightSign network servers. A Null value indicates that the device can send reports at any time during the day.
...
See TimeSpan for more information about this data type.
...
LastContentCheckTime DateTime
...
: A timestamp indicating when the device last checked in with the BrightSign Network servers for content updates. See DateTime
...
for more information about this data type.
...
LastSyncSpecProcessedTime DateTime
...
: A timestamp indicating when the player finished processing the last retrieved sync spec. See DateTime for more information about this data type.
LastContentDownloadStartTime DateTime: A timestamp indicating when the device last began downloading content from the BrightSign Network servers. See
...
...
for more information about this data type.
...
LastContentDownloadEndTime DateTime
...
: A timestamp indicating when the device last completed downloading content from the BrightSign Network servers. See DateTime
...
for more information about this data type.
...
LastHeartbeatTime DateTime
...
: A timestamp indicating when the device last reported its health status to the BrightSign Network servers. See
...
...
for more information about this data type.
...
LastErrorTime DateTime
...
: A timestamp indicating the most recent time that the device reported a current error. See
...
...
for more information about this data type.
...
Uptime TimeSpan
...
: The length of time that the player has been running. See TimeSpan for more information about this data type.
...
HealthStatus DeviceHealthStatus
...
: Returns either "Normal", "Warning", "Error", or "Unknown"
...
NetworkSettings DeviceNetworkSettings
...
: See Device Network Settings Entity
...
RemoteSnapshotSettings
...
RemoteSnapshotSettings:
...
Enabled bool
...
: A flag specifying whether the remote snapshot feature is enabled or disabled on the device.
...
CaptureInterval TimeSpan
...
: The amount of time to elapse between each screenshot. This value can be between 00:01:00 and 24:00:00.
...
ScreenShotsCountLimit ushort
...
: The maximum number of remote snapshot images allowed on player storage. Once this number is reached, the player will begin deleting Remote Snapshot images, beginning with the oldest first. This value can range from 1 to 100.
...
ImageQuality byte
...
: The quality of remote snapshot images on the player. This value can range from 1 to 100.
...
ScreenOrientation
...
ScreenOrientation: A ScreenOrientation enumeration indicating whether the remote snapshot images are landscape or portrait oriented. There are two portrait modes, so the return values would be either landscape, portrait bottom left, or portrait bottom right.
...
LogsSettings DeviceLogsSettings
...
: See Device Logs Settings Entity
...
DiagnosticWebServerSettings
...
DiagnosticWebServerSettings: See DiagnosticWebServer Settings Entity
...
LocalWebServerSettings
...
LocalWebServerSettings: See LocalWebServer Settings Entity
...
DeviceLocation
...
DeviceLocation: See Device Location Entity
...
Beacons DeviceBeacon[]
...
: See Device Beacon Entity
...
Tags Dictionary<string, string>
...
: An object where the tag keys are object properties and the tag values are the values of these properties. See the example below but note that the value is not necessarily "Country", "City", and "Number", but can be any object property value:
string::[Device].<Country>: "Ukraine"
string::[Device].<City>: "Odesa"
number::[Device].<Number>: "1"
...
Permissions List<Permission>
...
: The device permissions entity. See the Permission Entity