2020/10 to 2022/06 (DOCS-1182)

Overview

You must migrate to the 2022/06 bsn.cloud APIs if you want to use any of the Series 5 players (except the AU335, which is supported in bsn.cloud 2020/10 APIs). In previous versions, these players will show up as "unknown" and new video walls, 8K images and other Series 5 related features are not supported. See https://www.brightsign.biz/brightsign-players/series-5/ for more information about Series 5 players.

Series 5 Changes

The 2022/06 API supports BrightSign Series 5 players with the following changes:

• The Player Models Enumeration (2022/06) has been extended by the "XC2055", "XC4055", "LS425", "LS445", "HS125", "HS145", "HD225", "HD1025", "XD235", "XD1035", "XT245", "XT1145", and "XT2145" elements.
• The Player Family Enumeration (2022/06) has been extended by the "Raptor" and "Cobra" elements.
• The VideoMode Enumeration (2022/06)(DOCS-1182) has been extended by the "7680x4320x60p", "7680x4320x59.94p", "7680x4320x50p", "7680x4320x30p", "7680x4320x29.97p", "7680x4320x25p", "7680x4320x24p", "7680x4320x23.976p", "3072x2048x30p", "1536x2048x30p" elements.
• The Regular Groups Entity (2022/06) has been extended by the [string] XCX55Firmware and [string] XTX45_XDX35_HDX25_LS4X5_HS1X5Firmware properties.

Business Operations Appliance Changes

Business operations are accessed in BrightAuthor:connected through:

• The Admin > Permissions page, where customers create custom roles and defines player permissions
• The Entity Property panels (Content, Player Group, Presentation) where a customer defines object permissions for specific instances

In previous API versions, the business operations listed also included non-applicable operations. We addressed this usability bug by providing new information in the OperationAppliance property which has the listed values shown below. Please update your clients and display in the places where you define permissions or collections of entities, please display only the Business

These entities have changed:

• Business Operations Entity (2022/06)  was extended by the [OperationAppliance] Appliance property.
• The OperationAppliance enumeration was defined. It may have one or more unique { "Instance", "Collection", "Unknown" } values. The "Instance" value indicates that the given business operation applies to specific entity instances. The "Collection" value indicates that the given business operation applies to collections of entities, in an entire network and associated folders, and may be shown on the "Permissions" page and the Folder Properties panel.

HTTP Conditional Request Support

We also aligned and improved the versioning of our entities and implemented missing conditional requests, which are handled according to rfc 7201.

Network Settings Structure Fixes

• Network Entity (2022/06) was extended by the [DateTime] LastModifiedDate property
• Network Settings Entity (2022/06);
  • The [bool] AutomaticSubscriptionsManagementEnabled property has been added to the structure.
  • The [bool] AutomaticTaggedPlaylistApprovementEnabled property has been renamed to AutomaticTaggedPlaylistApprovalEnabled.
• Network Subscription Entity (2022/06):
  • The [DateTime] LastModifiedDate property is no longer nullable.
  • The GET ~/2022/06/REST/Self/Networks/{networkId}/Subscription/ and GET ~/2022/06/REST/Self/Networks/{networkId}/Subscription/methods set the Last-Modified HTTP response header to the [DateTime] LastModifiedDate property value of the returned entity.
  • The PUT ~/2022/06/REST/Self/Networks/{networkId}/Subscription/ and PUT ~/2022/06/REST/Self/Networks/{networkId}/Subscription/methods accept the optional If-Unmodified-Since HTTP Request Header and evaluate condition against the target entity.
• Player Subscription Entity (2022/06) was extended by the [DateTime]LastModifiedDate property.