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 10 Next »

Overview


This structure represents all of the unique identifying fields associated with a user. Users represent people who need to log into Projector for any reason,  whether it be the Management Portal or Projector Web. Each resource within Projector is also a user, but each user need not be a resource.

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)

Element


Element

Data Type

Required?

Default

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

Jack Spratt

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

E123

UserUid

Int64

On Insert: No

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


The user Uid is a unique and immutable identifier for a user

1152921504607112369

EmailAddress

String (100)

On Insert: Yes

On Update: No


The user email address is a unique identifier for a user

jack@revcorp.bb

FirstName

String (20)

On Insert: Yes

On Update: No


The user's first name

Jack

LastName

String (20)

On Insert: Yes

On Update: No


The user's last name

Spratt

MiddleName

String (20)

On Insert: Yes

On Update: No


The user's middle name

E

Usage Example(s)


Example 01 
                     <UserDisplayName>Jack Spratt</UserDisplayName>
                     <UserId i:nil="true"/>
                     <UserReferenceSystemId>E123</UserReferenceSystemId>
                     <UserUid>1152921504607112369</UserUid>
                     <EmailAddress>jack@revcorp.bb</EmailAddress>
                     <FirstName>Jack</FirstName>
                     <LastName>Spratt</LastName>
                     <MiddleName i:nil="true"/>
  • No labels