Set Top Box data model
This data structure provides the fields that classify a Set Top Box device.
Note that a Set Top Box is an instance of a Device, and that the Set Top Box data model extends the Device data model.
| Name | Type | Description | Always available |
|---|---|---|---|
banned | Boolean | If true, then this device is banned from using the system due to improper operation. Other devices in the account might be OK, and the account may otherwise be in perfectly good standing. | Yes |
caSN | String (max 256 chars) | The Conditional Access Serial Number of the device CA chipset. Can be changed by a firmware change, but this isn't common, so can be used as a device identifier for signon. | No |
drmInstanceName | String (max 320 chars) | Indicates which DRM the STB uses. Available from SMSDomain-1.3 and above. | No |
drmDeviceID | String (max 50 chars) | DRM device ID. Available from SMSDomain-1.3 and above. | No |
externalGroupUID | String | External group identifier. | No |
ipAddress | String (max 20 chars) | The current IP address of the STB, if known and available. | No |
macAddress | String (max 20 chars) | The MAC address of the STB. | No |
network | String (max 256 chars) | A network identifier. | No |
nUID | String (max 256 chars) | Uniquely identifies the device within a NAGRA STB deployment. Cannot be changed as it is hardwired in the hardware. | No |
port | Integer | The port used for IP communication with the STB if needed. | No |
provisionId | String | An optional ID that may be used during provisioning. | No |
provisionPwd | String (max 10 chars) | An optional password that may be used to authenticate the Set Top Box during provisioning. | No |
serialNumber | String (max 100 chars) | STB serial number. | No |
smartcardID | String (max 100 chars) | The smartcard number. If the device is cardbased – it requires a physical smartcard – then this value is hardcoded on the smartcard itself. For a cardless device, this value is generated by the SDP, and paired to the device during provisioning. Can be used to retrieve the full smartcard data from the Smartcard service. | No |
smartcardType | String (max 11 chars) | The smartcard type. One of:
| No |
status | String | Device status. One of:
If the device is cancelled, inactive, or suspended, then an end-user application should not be able to use it to query the API. For details see Account and STB Status. | Yes |
version | String | The version of the software currently running on the device. | No |