Account data model
Name | Type | Description | Always available |
---|---|---|---|
accessPointUID | Integer | The unique access point identifier within the SDP. Can be used to request the full access point details from the SDP using the Access Point service. An access point provides details on the location the device resides in and how it should connect to the platform. | Yes |
accountNumber | String (max 20 chars) | The account number. Usually provided by the service provider. | Yes |
accountProfileUID | Integer | The unique account profile identifier within the SDP. This profile is used to specify the maximum number of allowed devices, device activations, and concurrent OTT streams. Available from SMSDomain-1.3 and above. | No |
address1 | String (max 150 chars) | First line of address. | No |
address2 | String (max 150 chars) | Second line of address. | No |
city | String | Address city name. | No |
country | String (max 50 chars) | Address country. | No |
county | String (max 100 chars) | Address county. | No |
creditLimit | Double | The maximum spend per globally-specified credit interval, for example, a calendar month. If empty, the account will be able to make unlimited purchases. | No |
creditSpent | Double | The credit spent so far in the current time period. | No |
creditSpentRS | String | Not relevant to clients. Used by billing jobs. Available from SMSDomain-1.3 and above. | No |
firstName | String | Account holder first name. | No |
lastname | String (max 100 chars) | Account holder last name. | No |
locality | String (max 100 chars) | Address locality, that is, area name. | No |
maxMPDeviceAllowed | Integer | The number of open devices associated with the account cannot exceed this value, if set. | No |
maxUserAllowed | Integer | The number of users associated with the account cannot exceed this value, if set. | No |
npvrProfile | String (max 32 chars) | The network PVR profile used for this account. Available from SMSDomain-1.3 and above. | No |
password | String (max 20 chars) | Not typically used. | No |
postcode | String (max 10 chars) | Postcode or zipcode. | No |
ppvStatus | Boolean | Boolean to indicate whether the account has access to PPV services. This field was known as | No |
rolloutProfileUID | Long | The identifier of the rollout profile that should be used for this account. A rollout profile indicates what software versions should be rolled out to an account's open devices. Available from SMSDomain-1.3 and above. | Yes |
status | String | The account status. One of:
Only accounts that are active or restricted will be able to sign on to the system, therefore the status is largely irrelevant to a client UI application. For details see: Account and STB Status. | Yes |
title | String | Account holder title. | No |
UID | Integer | Unique account identifier within the SDP. Can be used to query other APIs in the SDP, but not against any other modules or systems. | Yes |