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


Panel
titlePwsUserRef
  • PwsUserRef
    • UserDisplayName: String
    • UserId: Int32
    • UserReferenceSystemId: String
    • UserUid: Int64

Elements


Element

Data Type

Required?

Default

Description

Sample Data

UserDisplayName

String

 

 



User Display Name

Jack Spratt

UserId

Int32

 

 



A unique identifier for a User


UserReferenceSystemId

String

 

 



User Reference System ID / Employee ID 

E123

UserUid

Int64

 

 



A unique and immutable Id for a User

1152921504607112369

Usage Example(s)


Code Block
languagexml
titleExample 01
collapsetrue
                     <UserDisplayName>Jack Spratt</UserDisplayName>
                     <UserId i:nil="true"/>
                     <UserReferenceSystemId>E123</UserReferenceSystemId>
                     <UserUid>1152921504607112369</UserUid>

...