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.

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 or the 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 user.

Format

PwsUserRef

PwsUserRef
- UserDisplayName: String (90)
- UserId: Int32
- UserReferenceSystemId: String (20)
- UserUid: Int64

Elements

Element	Data Type	Required?	Description	Sample Data
UserDisplayName	String (90)	One of UserDisplayName, UserReferenceSystemId or UserUid is required	The user display name is a unique identifier for a user	Betty Smith
UserId	Int32	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

Usage Example(s)

Example 01

                             <b:LastUpdatedByUserIdentity>
                                 <b:UserDisplayName>Betty Smith</b:UserDisplayName>
                                 <b:UserId i:nil="true"/>
                                 <b:UserReferenceSystemId>Partner - 01</b:UserReferenceSystemId>
                                 <b:UserUid>1152921504607011056</b:UserUid>
                              </b:LastUpdatedByUserIdentity>