Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

All regular groups entities are structured as follows:

entity:

  • [int] Id:  A unique identifier for the Group instance. This value is generated by the server when the group is created
  • [string] Name:  The group name
  • [DateTime] CreationDate:  Indicates when the group was created on BSN.cloud.
  • [DateTime] LastModifiedDate: Indicates when the group was last modified on BSN.cloud.
  • [DeviceAutorunInfo] Autorun:
  • [string] HDX23Firmware: The minimum version of device firmware required to play presentations on the HD223/HD1023
  • [int] HDX23FirmwareId: A unique identifier for the HD223/HD1023 minimum firmware version
  • [string] LSX23Firmware: The minimum version of device firmware required to play presentations on the LS423
  • [int] LSX23FirmwareId: A unique identifier for the LS423 minimum firmware version
  • [string] HSX23Firmware: The minimum version of device firmware required to play presentations on the HS123
  • [int] HSX23FirmwareId:  A unique identifier for the HS123 minimum firmware version
  • [string] HOX23Firmware: The minimum version of device firmware required to play presentations on the HO523
  • [int] HOX23FirmwareId: A unique identifier for the HO523 minimum firmware version
  • [string] XDX33Firmware: The minimum version of device firmware required to play presentations on the XD233/XD1033
  • [int] XDX33FirmwareId:  A unique identifier for the XD233/XD1033 minimum firmware version
  • [string] XTX43Firmware: The minimum version of device firmware required to play presentations on the XT242/XT1042/XT1142

  • [int] XTX43FirmwareId: A unique identifier for the XT242/XT1042/XT1142 minimum firmware version

  • [string] XDX34_XTX44Firmware: A unique identifier for the XD234/XD1034 minimum firmware version

  • [int] XDX34_XTX44FirmwareId: A unique identifier for the XD234/XD1034 minimum firmware version

  • [string] HDX4_HSX4_LSX4Firmware

  • [int] HDX4_HSX4_LSX4FirmwareId

  • [string] AUX5Firmware:  The minimum version of device firmware required to play presentations on the AU335

  • [int] AUX5FirmwareId:  A unique identifier for the AU335 minimum firmware version

  • [string] FKX42Firmware: The minimum version of device firmware required to play presentations on the AU320/HD220/HD1020/LS322/LS422

  • [int] FKX42FirmwareId: A unique identifier for the HD222/HD1022 minimum firmware version

  • [bool] EnableSerialDebugging:  A flag specifying whether serial debugging should be enabled for all players assigned to the Group instance
  • [bool] EnableSystemLogDebugging: A flag specifying whether system log debugging should be enabled for players assigned to the Group instance
  • [bool] EnableStorageSpaceLimit: A flag specifying whether player storage devices will be divided into different segments. This allows the user to allot maximum sizes to different segments to ensure that a certain type of data does not take up too much space on the storage device. The "limit" values below will only apply to the player storage if this value is true.
  • [StorageSpaceLimitUnit] StorageSpaceLimitUnits: A value specifying whether the following "limit" values are measured in percentages ("Percentage") or megabytes ("Megabyte")
  • [ushort] PublishedDataSizeLimit: The maximum size allotted to all presentation and content files that are written to the storage device during the publish process. This includes audio, video, images, text, and HTML content files.
  • [ushort] DynamicDataSizeLimit: The maximum size of all dynamic content, including Dynamic Playlists and MRSS feeds. When this segment runs out of space, dynamic content files will be deleted to create space, starting with the oldest files first.
  • [ushort] HtmlDataSizeLimit: The maximum size of the HTML application cache

  • [ushort] HtmlLocalStorageSizeLimit: The maximum size of all JavaScript variables and data

  • [ushort] WebDatabaseSizeLimit: The maximum amount of storage allocated to the IndexedDB web database application

  • [ushort] DevicesCount: The number of players assigned to the Group instance

  • [Dictionary<DeviceHealthStatus, uint>] DevicesHealthStatus:
  • [DeviceInfo[]] Devices: Supported representations include:
    • [int] Id: The device id
    • [string] Serial:  The device serial number
  • [ScheduledPresentation[]] Schedule: Supported representations include:
    • [int] Id: A unique identifier for the ScheduledPresentation instance
    • [int] PresentationId: The identifier for the scheduled presentation
    • [string] PresentationName: The name of the scheduled presentation
    • [bool] IsRecurrent: A flag indicating whether the scheduled playback recurs every week
    • [DateTime?] EventDate: A UTC timestamp specifying the date when a non-recurrent presentation should begin playing. This value is null for recurring presentations.
    • [TimeSpan]  StartTime: The time of day when playback begins.
    • [TimeSpan] Duration: The duration of the playback window. 
    • [DateTime?] RecurrenceStartDate: A timestamp indicating when recurring playback begins. If this value is null, then recurring playback begins immediately when scheduled.
    • [DateTime?] RecurrenceEndDate: A timestamp indicating when recurring playback ends. If this value is null, then recurring playback will not end.
    • [DayOfWeek] DaysOfWeek:The days of the week during which the recurring schedule is active. The days are specified as a string list (for example, "Monday, Wednesday, Friday").  
    • [DateTime] CreationDate: A timestamp indicating when the ScheduledPresentation instance was created on BSN. 
    • [DateTime] LastModifiedDate: A timestamp indicating when the ScheduledPresentation instance was last modified on BSN. 
    • [DateTime?] ExpirationDate: A timestamp indicating when the scheduled presentation instance will expire. If this value is null, then the instance will never expire.
    • [bool] InterruptScheduling:
  • [List<Permission>] Permissions: A list of the permissions rules assigned to the group