Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 16 Next »

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 to be useful in a listing of users.

Format


PwsUserSummary
  • 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)

On Insert: Yes

On Update: Yes (if UserReferenceSystemId and UserUid is not supplied)

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)

On Insert: No

On Update: Yes (if UserDisplayName and UserUid is not supplied)

The user reference system Id / employee Id  is a unique identifier for a user

Partner - 01

UserUid

Int64

On Insert: No

On Update: Yes (if UserDisplayName and UserReferenceSystemId is not supplied)

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

Usage Example(s)


Example 01 
                   <b:Manager>
                     <b:UserDisplayName>Betty Smith</b:UserDisplayName>
                     <b:UserId i:nil="true"/>
                     <b:UserReferenceSystemId>Partner - 01</b:UserReferenceSystemId>
                     <b:UserUid>1152921504607011056</b:UserUid>
                     <b:EmailAddress>betty@revcorp.bb</b:EmailAddress>
                     <b:FirstName>Betty</b:FirstName>
                     <b:LastName>Smith</b:LastName>
                     <b:MiddleName i:nil="true"/>
                  </b:Manager>
  • No labels