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 27 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.

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?

Default

Description

Sample Data

UserDisplayName

String (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

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

E123

UserUid

Int64

On Insert: Yes

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


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

1152921504607112369

Usage Example(s)


Example 01 
                     <UserDisplayName>Jack Spratt</UserDisplayName>
                     <UserId i:nil="true"/>
                     <UserReferenceSystemId>E123</UserReferenceSystemId>
                     <UserUid>1152921504607112369</UserUid>



  • No labels