UserBean
From
(Difference between revisions)
m (Fix size of mobileNumber field) |
|||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 9: | Line 9: | ||
!Name | !Name | ||
!Type | !Type | ||
| + | !Size | ||
| + | !Required | ||
!Description | !Description | ||
|---- bgcolor=#EDEDFF | |---- bgcolor=#EDEDFF | ||
|deleted | |deleted | ||
|boolean | |boolean | ||
| − | |An indication of the deleted state of the record. True indicates the user has been deleted and can no longer be used to logon or work on EService. | + | |1 |
| + | |No | ||
| + | |An indication of the deleted state of the record. True indicates the user has been deleted and can no longer be used to logon or work on EService/Timecard. | ||
|---- bgcolor=#EDEDFF | |---- bgcolor=#EDEDFF | ||
|description | |description | ||
|String | |String | ||
| + | |50 | ||
| + | |No | ||
|A short description of the user. | |A short description of the user. | ||
|---- bgcolor=#EDEDFF | |---- bgcolor=#EDEDFF | ||
|emailAddress | |emailAddress | ||
|String | |String | ||
| + | |64 | ||
| + | |No | ||
|The email address of the user. | |The email address of the user. | ||
|---- bgcolor=#EDEDFF | |---- bgcolor=#EDEDFF | ||
|faxNumber | |faxNumber | ||
|String | |String | ||
| + | |30 | ||
| + | |No | ||
|The user's fax number. | |The user's fax number. | ||
|---- bgcolor=#EDEDFF | |---- bgcolor=#EDEDFF | ||
|loginID | |loginID | ||
|String | |String | ||
| − | |The logon id (logon name) used to log onto the EService system. | + | |30 |
| + | |Yes | ||
| + | |The logon id (logon name) used to log onto the EService/Timecard system. | ||
|---- bgcolor=#EDEDFF | |---- bgcolor=#EDEDFF | ||
|mobileNumber | |mobileNumber | ||
|String | |String | ||
| + | |50 | ||
| + | |No | ||
|The mobile phone number of the user. | |The mobile phone number of the user. | ||
|---- bgcolor=#EDEDFF | |---- bgcolor=#EDEDFF | ||
|name | |name | ||
|String | |String | ||
| + | |50 | ||
| + | |Yes | ||
|The name of the user. | |The name of the user. | ||
|---- bgcolor=#EDEDFF | |---- bgcolor=#EDEDFF | ||
|pagerNumber | |pagerNumber | ||
|String | |String | ||
| + | |30 | ||
| + | |No | ||
|The pager number of the user. | |The pager number of the user. | ||
|---- bgcolor=#EDEDFF | |---- bgcolor=#EDEDFF | ||
|phoneNumber | |phoneNumber | ||
|String | |String | ||
| + | |30 | ||
| + | |No | ||
|The standard phone number for the user. | |The standard phone number for the user. | ||
|---- bgcolor=#EDEDFF | |---- bgcolor=#EDEDFF | ||
|primaryKey | |primaryKey | ||
|String | |String | ||
| − | |The EService assigned primary key for the user. | + | |9 |
| + | |Yes | ||
| + | |The EService/Timecard assigned primary key for the user. | ||
|---- bgcolor=#EDEDFF | |---- bgcolor=#EDEDFF | ||
|securityAnswer | |securityAnswer | ||
|String | |String | ||
| + | |32 | ||
| + | |No | ||
|The user's answer to their special security verification question. | |The user's answer to their special security verification question. | ||
|---- bgcolor=#EDEDFF | |---- bgcolor=#EDEDFF | ||
|securityQuestion | |securityQuestion | ||
|String | |String | ||
| + | |128 | ||
| + | |No | ||
|The user's special security verification question. | |The user's special security verification question. | ||
|---- bgcolor=#EDEDFF | |---- bgcolor=#EDEDFF | ||
|synchronisation | |synchronisation | ||
|[[SynchronisationBean]] array | |[[SynchronisationBean]] array | ||
| + | |N/A | ||
| + | |No | ||
|An array of [[SynchronisationBean]] objects, showing all current sync flags and custom data associated with the user record. | |An array of [[SynchronisationBean]] objects, showing all current sync flags and custom data associated with the user record. | ||
|---- bgcolor=#EDEDFF | |---- bgcolor=#EDEDFF | ||
|timezone | |timezone | ||
|String | |String | ||
| + | |50 | ||
| + | |No | ||
|The local timezone of the user. | |The local timezone of the user. | ||
|---- bgcolor=#EDEDFF | |---- bgcolor=#EDEDFF | ||
|updateIndex | |updateIndex | ||
|int | |int | ||
| + | |10 | ||
| + | |Yes | ||
|The time derived int value of the user record, used for concurrency checks. | |The time derived int value of the user record, used for concurrency checks. | ||
|---- bgcolor=#EDEDFF | |---- bgcolor=#EDEDFF | ||
|userType | |userType | ||
|String | |String | ||
| + | |9 | ||
| + | |Yes | ||
|One of the user types specified for this organisation during initial setup. | |One of the user types specified for this organisation during initial setup. | ||
|} | |} | ||
Latest revision as of 23:16, 8 May 2020
[edit] Description
This class represents all the details related to users of the EService system.
[edit] Fields
The data fields of this object.
| Name | Type | Size | Required | Description |
|---|---|---|---|---|
| deleted | boolean | 1 | No | An indication of the deleted state of the record. True indicates the user has been deleted and can no longer be used to logon or work on EService/Timecard. |
| description | String | 50 | No | A short description of the user. |
| emailAddress | String | 64 | No | The email address of the user. |
| faxNumber | String | 30 | No | The user's fax number. |
| loginID | String | 30 | Yes | The logon id (logon name) used to log onto the EService/Timecard system. |
| mobileNumber | String | 50 | No | The mobile phone number of the user. |
| name | String | 50 | Yes | The name of the user. |
| pagerNumber | String | 30 | No | The pager number of the user. |
| phoneNumber | String | 30 | No | The standard phone number for the user. |
| primaryKey | String | 9 | Yes | The EService/Timecard assigned primary key for the user. |
| securityAnswer | String | 32 | No | The user's answer to their special security verification question. |
| securityQuestion | String | 128 | No | The user's special security verification question. |
| synchronisation | SynchronisationBean array | N/A | No | An array of SynchronisationBean objects, showing all current sync flags and custom data associated with the user record. |
| timezone | String | 50 | No | The local timezone of the user. |
| updateIndex | int | 10 | Yes | The time derived int value of the user record, used for concurrency checks. |
| userType | String | 9 | Yes | One of the user types specified for this organisation during initial setup. |
