Versions Compared

Key

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

...

This structure represents all of the unique identifying fields associated with a Useruser. 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 Useruser, but each User user need not be a resource.

Users can be identified by UserDisplayName, UserReferenceSystemId (Employee Id) or UserUid. When specifying a PwsUserRef as an input to a web service, you may specify one or all three fields the  UserDisplayName, UserReferenceSystemId (Employee Id) and/or UserUid. However, if you do specify all three, they must refer to the same User user or the User user reference will not be considered valid. When a PwsUserRef is returned in the response to a web service, the UserDisplayName, UserReferenceSystemId (Employee Id) and/or UserUid will be populated, and guaranteed to refer to a single Useruser.

Format


Panel
titlePwsUserRef
  • PwsUserRef
    • UserDisplayName: String (90)
    • UserId: Int32
    • UserReferenceSystemId: String (20)
    • UserUid: Int64

Elements


Element

Data Type

Required?

Default

Description

Sample Data

UserDisplayName

String The User Display Name (90)

On Insert: Yes

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


The user display name is a unique identifier for a User.user

Jack Spratt

UserId

Int32

On Insert: No

On Update: No


The User user Id is a unique identifier for a Useruser. For internal use only.


UserReferenceSystemId

String The User Reference System ID / Employee ID(20)

On Insert: Yes

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


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

E123

UserUid

Int64

On Insert: Yes

The User On Update: Yes (if the UserDisplayName or UserReferenceSystemId is not supplied)


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

1152921504607112369

Usage Example(s)

...