User
Object that represent the User data information.
Members
| Field | Data Type | Description |
|---|---|---|
| BirthDate | long | |
| CustomFields | Array of UserCustomField | |
| DefaultAudioId | int | |
| DefaultSubtitleId | int | |
| String | ||
| EWallet | double | |
| FirstAccess | bool | |
| FirstName | String | |
| Gender | Gender | |
| ID | int | |
| InstanceId | int | |
| LastName | String | |
| MinimumAgeRating | int | |
| MobileNumber | String | |
| PinStatus | Array of UserPinStatus | |
| PlatformId | int | |
| ServiceType | ServiceIdType | |
| SocialNetworksStatus | Array of UserSocialNetworkStatus | |
| Status | UserStatus | |
| TimeStamp | long | |
| Type | UserType | |
| UniqueId | String | |
| VideoServiceInfo | UserVideoServiceInfo | |
| CreditCardStatus | New in 4.0! This field has meaning for NOTEF users in instances with SIA payment method. It indicates if user has completed registration with a valid credit card. It is stored at GVP_USERS.CREDIT_CARD_STATUS. Possible values are: 0: n/a. Meaning that this field does not apply to this user. Possible reasons: instance parameter SIA_ENABLED = false (this instance is not connected to SIA payment gateway), TEF user, ... | |
| CreditCardStatus | New in 4.0! This field has meaning for NOTEF users in instances with SIA payment method. It indicates if user has completed registration with a valid credit card. It is stored at GVP_USERS.CREDIT_CARD_STATUS. Possible values are: 0: n/a. Meaning that this field does not apply to this user. Possible reasons: instance parameter SIA_ENABLED = false (this instance is not connected to SIA payment gateway), TEF user, ... | |
| IanaTimezone | string | New in 4.2! |
| UserGroups | Array of Int32 | New in 4.3! Messaging group ids (comma separated) the user belongs to. |
| AuraId | string | New in 7.1! Aura ID for the user. |
Example
{
- "ID": 29395,
- "FirstName": "vivoplay06@gmail.com",
- "LastName": "",
- "Email": "vivoplay06@gmail.com",
- "PinStatus": [
- UserPinStatus Object
- ],
- "SocialNetworkStatus": [
- UserSocialNetworkStatus Object
- ],
- "CustomFields": [
- UserCustomField object
- ],
- "Status": 1,
- "EWallet": 0,
- "Type": UserType object,
- "MinimumAgeRating": 18,
- "Gender": Gender object,
- "MobileNumber": "",
- "BirthDate": 0,
- "TimeStamp": 1609459620,
- "DefaultSubtitleId": 0,
- "DefaultAudioId": 14,
- "PlatformId": 12,
- "UniqueId": "vivoplay06",
- "InstanceId": 25,
- "ServiceType": ServiceIdType object,
- "VideoServiceInfo": {
- UserVideoServiceInfo Object
- },
- "FirstAccess": false,
- "DefaultCreditLimit": -1,
- "CurrentCreditLimit": 600,
- "CreditCardStatus": 0
}
Known issues
None
Version history
| API Version Number | Change description | Changes author |
|---|---|---|
| 1.0 | Initial data type implementation | Harley Cabral |
| 4.0 | Added new field to the User object
|
Cristina Peña |
| 4.3 | Added new fields to the User object
|
Cristina Peña |
! 7.1 | Added new field to the User object
- AuraId
| Cristina Peña |- valign="top" |}