Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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 resourceincludes 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


Panel
titlePwsUserSummary
  • 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?

Default

Description

Description
Sample Data

UserDisplayName

String

UserId

Int32

UserReferenceSystemId

String

UserUid

Int64

EmailAddress

String

FirstName

String

LastName

String

MiddleName

String

jack@revcorp

Element

Data Type

Description

Default (on insert/update)

Sample Data

UserDisplayNameStringUser Display NameJack SprattUserIdInt32User IDUserReferenceSystemIDStringUser Reference System ID / Employee IDE123UserUidInt64User Unique Internal ID. For internal use only.
1152921504607112369
EmailAddressStringUser Email Address

(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's email address.

betty@revcorp.bb

FirstName

String (20)

On Insert: Yes

On Update: No

The user's first name.

Jack
Betty

LastName

String (20)

On Insert: Yes

On Update: No

The user's last name.

Spratt
Smith

MiddleName

String (20)

On Insert: Yes

On Update: No

The user's middle name.

E

Usage Example(s)


Code Block
languagexml
titleExample 01
collapsetrue
                     <UserDisplayName>Jack Spratt</<b:Manager>
                     <b:UserDisplayName>Betty Smith</b:UserDisplayName>
                     <UserId<b:UserId i:nil="true"/>
                     <UserReferenceSystemId>E123</<b:UserReferenceSystemId>Partner - 01</b:UserReferenceSystemId>
                     <UserUid>1152921504607112369<<b:UserUid>1152921504607011056</b:UserUid>
                     <EmailAddress>jack@revcorp<b:EmailAddress>betty@revcorp.bb</b:EmailAddress>
                     <FirstName>Jack<<b:FirstName>Betty</b:FirstName>
                     <LastName>Spratt<<b:LastName>Smith</b:LastName>
                     <MiddleName<b:MiddleName i:nil="true"/>
                  </b:Manager>