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

PwsUserSummaryDetail

PwsUserSummaryDetail
- UserDisplayName: String (30)
- UserId: Int32
- UserReferenceSystemId: String (20)
- UserUid: Int64
- EmailAddress: String (100)
- FirstName: String (20)
- LastName: String (20)
- MiddleName: String (20)
- ClientIdentity: PwsClientRef
- PrimaryUserTypeCostCenter: PwsUserTypeCostCenter

Elements

Element	Data Type	Required	Description	Sample Data
UserDisplayName	String (30)	On Insert: Yes On Update: One of UserDisplayName, UserReferenceSystemId, UserUid or EmailAddress is required	The user's display name.	IT Manager
UserId	Int32	No	The user Id is a unique identifier for a user. For internal use only.
UserReferenceSystemId	String (20)	On Insert: No On Update: See UserDisplayName	The user reference system id / employee id is a unique identifier for a user.	IT Manager
UserUid	Int64	On Insert: No On Update: See UserDisplayName	A unique and immutable identifier for a user.	1152921504607134339
EmailAddress	String (100)	On Insert: Yes On Update: No	The user's email address.	it_manager@revcorp.bb
FirstName	String (20)	On Insert: Yes On Update: No	The user's first name.	IT
LastName	String (20)	On Insert: Yes On Update: No	The user's last name.	Manager
MiddleName	String (20)	On Insert: No On Update: No	The user's middle name.
ClientIdentity	PwsClientRef	On Insert: No On Update: No	If the user is a client, this identifies the client that the user is associated with.
PrimaryUserTypeCostCenter	PwsUserTypeCostCenter	On Insert: Yes On Update: No	The user's primary user type.

Usage Example(s)

Example 01

                  <b:UserSummary>
                     <b:UserDisplayName>IT Manager</b:UserDisplayName>
                     <b:UserId i:nil="true"/>
                     <b:UserReferenceSystemId>IT Manager</b:UserReferenceSystemId>
                     <b:UserUid>1152921504607134339</b:UserUid>
                     <b:EmailAddress>it_manager@revcorp.bb</b:EmailAddress>
                     <b:FirstName>IT</b:FirstName>
                     <b:LastName>Manager</b:LastName>
                     <b:MiddleName i:nil="true"/>
                     <b:ClientIdentity i:nil="true"/>
                     <b:PrimaryUserTypeCostCenter>
                        <b:CostCenterIdentity>
                           <b:CostCenterId i:nil="true"/>
                           <b:CostCenterName>IT Team (USA)</b:CostCenterName>
                           <b:CostCenterNumber>IT Team (USA)</b:CostCenterNumber>
                           <b:CostCenterUid>1152921504606867365</b:CostCenterUid>
                        </b:CostCenterIdentity>
                        <b:UserTypeIdentity>
                           <b:UserTypeId i:nil="true"/>
                           <b:UserTypeName>IT Manager</b:UserTypeName>
                           <b:UserTypeUid>1152921504606867304</b:UserTypeUid>
                        </b:UserTypeIdentity>
                     </b:PrimaryUserTypeCostCenter>
                  </b:UserSummary>

API Documentation

PwsUserSummaryDetail

Analytics

Overview

Format

Elements

Usage Example(s)

Related content