Overview

This web service retrieves a list of user records (PwsUserElement), based upon a list of unique resource identifiers (PwsUserRef).

Request Format

PwsGetUser Request

PwsGetUser
- serviceRequest: PwsGetUserRq
  - RequestId: Int32
  - SessionTicket: String
  - UserIdentities: PwsUserRef[1..100]

Request Elements

Element	Data Type	Required?	Description	Sample Data
RequestId	Int32	No	Click here for more information
SessionTicket	String	Yes	Click here for more information	AaoSuE89vJzjNFnsXZNioA==
UserIdentities	PwsUserRef[1..100]	Yes	One or more (up to 100) user identities to be retrieved

Request Usage Example(s)

Example 01

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsGetUser>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AaoSuE89vJzjNFnsXZNioA==</req:SessionTicket>
            <req:UserIdentities>
               <com:PwsUserRef>
                  <com:UserReferenceSystemId>IT Manager</com:UserReferenceSystemId>
               </com:PwsUserRef>
            </req:UserIdentities>
         </pws:serviceRequest>
      </pws:PwsGetUser>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsGetUser Response

PwsGetUserResponse
- PwsGetUserResult: PwsGetUserRs
  - Messages: PwsMessage[]
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - Users: PwsUserElement[1..100]

Response Elements

Element	Data Type	Description	Sample Data
Messages	PwsMessage[]	The web service response status and message. Click here for more information
ResponseId	Int32	Click here for more information	1
Status	RequestStatus	Click here for more information	Ok
ServerTimestampUtc	DateTime	Click here for more information	2018-10-25T14:25:22.9619849Z
Users	PwsUserElement[1..100]	The details of the users that were fetched

Response Usage Example(s)

PwsGetUser - Common Errors and Warnings

For all errors and warnings please refer to the Complete List of Errors and Warnings

ErrorNumber	ErrorCode	ErrorText
105	AtLeastOneItemNotFound	At least one requested item was not found. The remaining items, if any, were returned.
50045	ViewPermissionDenied	You do not have permission to view this item.
57813	PermissionLimitedToClientUsers	User permission is limited to client users.