Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 22 Next »

All device entities are structured as follows:

entity:

  • [int] Id:  A unique identifier for the device instance
  • [string] Serial:  The device serial number 
  • [string] Name: The device name

  • [bool]  ConcatUnitNameAndSerial:  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.

  • [string] Description: A customer-defined description of the device. The description does not need to be unique within the scope of the account.

  • [DeviceSubscription] CurrentSubscription: See Device Subscription Entity
  • [GroupInfo] TargetGroup: 

    • [int] Id: The unique identifier for the group instance to which the device belongs.
    • [string] Name: The name of the group instance to which the device belongs
  • [TaggedGroupInfo[]] TaggedGroups:
    • [int] Id: The unique identifier for the tagged group
    • [string] Name: The name of the tagged group
  • [BrightWallInfo] TargetBrightWall: 

    • [int?] Id: A unique identifier for the BrightWall

    • [string] Name: The BrightWall name

  • [Nullable<byte>] TargetBrightWallScreenNumber: 
  • [GroupInfo] ReportedGroup:
    • [int] Id: .The unique identifier for the reported group
    • [string] Name: The name of the reported group
  • [BrightWallInfo] ReportedBrightWall: 
    • [int] Id: The identifier and primary key of the BrightWall instance.

    • [string] Name: The user-defined name of the BrightWall instance. This alternate key must be unique in the scope of the BSN account.

  • [Nullable<byte>] ReportedBrightWallScreenNumber: 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.
  • [PresentationInfo] Presentation: See the Presentation Info Entity
  • [DeviceModel] Model: The device model name and suffix
  • [DeviceFamily] Family: The model family of the device ("Sebring", "Pagani", etc.)
  • [DateTime] LastModifiedDate: A UTC timestamp indicating when the player instance was last modified. See DateTime for more information about this data type.

  • [DeviceAutorun] Autorun:
    • [string] Version: The current presentation autorun version assigned to the group

    • [bool] IsCustom: Whether the autorun is a standard BrightAuthor file (false) or a custom-built file (true)

    • [DeviceFirmware[]]MinFirmwares: 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.

      • [string] version: The firmware version number

      • [string[]]supportedModels: An array of string values indicating which model numbers (e.g. "XDx233") apply for the minimum-firmware requirement

    • [bool] IsRevoked: Whether or not the current presentation autorun version is supported/in service

  • [string] FirmwareVersion: The version of firmware that the device was using the last time it synced with the server.
  • [string] CardSize: 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”)).
  • [string] CardFreeSize: 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”)).
  • [string] TargetTimeZone: The string name of the time zone that the device should use
  • [string] ReportedTimeZone: The string name of the time zone that the device reported using the last time it synced with the server.
  • [string] ScreenColor: The background color of the screen 
  • [DeviceConnectionsPeriod] ContentCheckPeriod: Represents the time interval between synchronization events, when the device checks with the BrightSign Network servers for content updates.

  • [Nullable<TimeSpan>] ContentDownloadsStartTime: 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. 

  • [Nullable<TimeSpan>] ContentDownloadsEndTime: 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.

  • [DeviceConnectionsPeriod] HealthReportingPeriod: A DeviceConnectionsPeriod enumeration representing the interval between health-report events, when the device checks in with the server to report its status.

  • [Nullable<TimeSpan>] HealthReportingStartTime: 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.

  • [Nullable<TimeSpan>] HealthReportingEndTime: 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.

  • [DateTime] LastContentCheckTime: 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.

  • [DateTime] LastSyncSpecProcessedTime: A timestamp indicating when the player finished processing the last retrieved sync spec. See DateTime for more information about this data type.

  • [DateTime] LastContentDownloadStartTime: A timestamp indicating when the device last began downloading content from the BrightSign Network servers. See DateTime for more information about this data type.

  • [DateTime] LastContentDownloadEndTime: A timestamp indicating when the device last completed downloading content from the BrightSign Network servers. See DateTime for more information about this data type.

  • [DateTime] LastHeartbeatTime: A timestamp indicating when the device last reported its health status to the BrightSign Network servers. See DateTime for more information about this data type.

  • [DateTime] LastErrorTime: A timestamp indicating the most recent time that the device reported a current error. See DateTime for more information about this data type.

  • [TimeSpan] Uptime: The length of time that the player has been running. See TimeSpan for more information about this data type.

  • [DeviceHealthStatus] HealthStatus: Returns either "Normal", "Warning", "Error", or "Unknown"

  • [DeviceNetworkSettings] NetworkSettings: See Device Network Settings Entity

  • [RemoteSnapshotSettings] RemoteSnapshotSettings:

    • [bool] Enabled: A flag specifying whether the remote snapshot feature is enabled or disabled on the device.

    • [TimeSpan] CaptureInterval: The amount of time to elapse between each screenshot. This value can be between 00:01:00 and 24:00:00.

    • [ushort] ScreenShotsCountLimit: 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.

    • [byte] ImageQuality: 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.

  • [DeviceLogsSettings] LogsSettings: See Device Logs Settings Entity

  • [DiagnosticWebServerSettings] DiagnosticWebServerSettings: See DiagnosticWebServer Settings Entity

  • [LocalWebServerSettings] LocalWebServerSettings: See LocalWebServer Settings Entity

  • [DeviceLocation] DeviceLocation: See Device Location Entity

  • [DeviceBeacon[]]Beacons: See Device Beacon Entity

  • [Dictionary<string, string>] Tags: 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"
  • [List<Permission>] Permissions: The device permissions entity. See the Permission Entity





  • No labels