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 5 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: 
  • [GroupInfo] Group: 

    • [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

  • [byte?] TargetBrightWallScreenNumber: 
  • [GroupInfo] ReportedGroup:
    • [int] Id: .
    • [string] Name:
  • [BrightWallInfo] ReportedBrightWall: 
    • [int] Id

    • [int] BrightWallGroupId

    • [string] Name

    • [DateTime] CreationDate

    • [DeviceHealthStatus?] DevicesHealthStatus

    • [BrightWallScreen[]] Screens

    • [List<Permission>] Permissions

  • [byte?] ReportedBrightWallScreenNumber:


  • [string] Model: The model name and suffix
  • [DeviceFamily] Family: The model family of the device ("Sebring", "Pagani", etc.)
  • [DateTime] RegistrationDate: A UTC timestamp indicating when the player instance was registered. See DateTime for more information about this data type.
  • [DateTime] LastModifiedDate: A UTC timestamp indicating when the player instance was last modified. See DateTime for more information about this data type.

  • [PlayerSettings] Settings:  Returns the Device Settings Entities

  • [PlayerFullStatus] Status: Returns the Player Full Status Entity

  • [PlayerSubscription] Subscription: Returns the Device Subscription 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"
  • [Permission[]]Permissions: The device permissions entity. See the Permission Entity.






  • No labels