Overview
This structure includes basic information about a user. The information represented in this structure is not comprehensive and only includes certain key attributes of a user deemed to be useful in a listing of users.
Format
- PwsUserSummary
- UserDisplayName: String (90)
- UserId: Int32
- UserReferenceSystemId: String (20)
- UserUid: Int64
- EmailAddress: String (100)
- FirstName: String (20)
- LastName: String (20)
- MiddleName: String (20)
Elements
Element | Data Type | Required? | Description | Sample Data |
---|---|---|---|---|
UserDisplayName | String (90) | One of UserDisplayName, UiserReferenceSystemId or UserUid is required | The user display name is a unique identifier for a user | Betty Smith |
UserId | Int32 | On Insert: No On Update: No | The user Id is a unique identifier for a user. For internal use only. | |
UserReferenceSystemId | String (20) | See UserDisplayName | The user reference system Id / employee Id is a unique identifier for a user | Partner - 01 |
UserUid | Int64 | See UserDisplayName | A unique and immutable identifier for a user | 1152921504607011056 |
EmailAddress | String (100) | On Insert: Yes On Update: No | The user email address is a unique identifier for a user | betty@revcorp.bb |
FirstName | String (20) | On Insert: Yes On Update: No | The user's first name | Betty |
LastName | String (20) | On Insert: Yes On Update: No | The user's last name | Smith |
MiddleName | String (20) | On Insert: Yes On Update: No | The user's middle name | E |