Overview

This web service retrieves a list of user summary records (PwsResourceSummary), based on specified search criteria. You can specify which users to retrieve either by specifying a set of search criteria, or by specifying a specific user to retrieve (PwsUserRef).

Request Format

PwsGetUserList Request

PwsGetUserList
- serviceRequest: PwsGetUserListRq
  - RequestId: Int32
  - SessionTicket: String
  - IncludeInactiveFlag: Boolean
  - LastUpdatedSinceTimestamp: DateTime
  - MaxRowsToReturn: Int32
  - QueryString: String
  - UserIdentity: PwsUserRef

Request Elements

Element	Data Type	Required?	Default	Description	Sample Data
RequestId	Int32	No		Click here for more information.	1
SessionTicket	String	Yes		Click here for more information.	AaoSuE89vJzjNFnsXZNioA==
IncludeInactiveFlag	Boolean	Yes	false	If set to 'true', inactive users will be included in the results. Otherwise, only active users will be returned. This flag is disregarded if a user is specified in UserIdentity.	true
LastUpdatedSinceTimestamp	DateTime	No		If set, only users that have been updated since this date will be returned. This value is disregarded if a user is specified in UserIdentity.	2018-10-20
MaxRowsToReturn	Int32	No		The maximum number of users to be retrieved. This value is disregarded if a user is specified in UserIdentity.	5
QueryString	String	No		A search string to narrow down the results. A user will be included in the results if the search string matches the user display name or user reference system id / employee id as well as the other specified criteria. This value is disregarded if a user is specified in UserIdentity.
UserIdentity	PwsUserRef	No		If specified, this identifies a specific user to be retrieved. All other criteria is disregarded if a user is explicitly requested.

Request Usage Example(s)

Example 01 - without UserIdentity

<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:PwsGetUserList>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AaoSuE89vJzjNFnsXZNioA==</req:SessionTicket>
            <req:IncludeInactiveFlag>true</req:IncludeInactiveFlag>
            <req:LastUpdatedSinceTimestamp>2018-10-20</req:LastUpdatedSinceTimestamp>
            <req:MaxRowsToReturn>5</req:MaxRowsToReturn>
         </pws:serviceRequest>
      </pws:PwsGetUserList>
   </soapenv:Body>
</soapenv:Envelope>

Example 02 - with user identity

<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:PwsGetUserList>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AaoSuE89vJzjNFnsXZNioA==</req:SessionTicket>
            <req:IncludeInactiveFlag>true</req:IncludeInactiveFlag>
            <req:UserIdentity>
               <com:UserReferenceSystemId>IT Manager</com:UserReferenceSystemId>
            </req:UserIdentity>
         </pws:serviceRequest>
      </pws:PwsGetUserList>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsGetUserList Response

PwsGetUserListResponse
- PwsGetUserListResult: PwsGetUserListRs
  - Messages: PwsMessage[]
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - Users: PwsUserSummaryElement[]

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-01-29T19:19:48.2062214Z
Users	PwsUserSummaryElement	The user summary records that were fetched by the service.

Response Usage Example(s)

Example 01

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetUserListResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetUserListResult xmlns:a="http://projectorpsa.com/DataContracts/Responses/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Messages xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
            <ResponseId xmlns="http://projectorpsa.com/CommonServices/">1</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-10-25T16:04:32.9905027Z</ServerTimestampUtc>
            <a:Users xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsUserSummaryElement>
                  <b:InactiveFlag>false</b:InactiveFlag>
                  <b:PasswordTicketFlag>false</b:PasswordTicketFlag>
                  <b:UserSummary>
                     <b:UserDisplayName>IT Manager</b:UserDisplayName>
                     <b:UserId i:nil="true"/>
                     <b:UserReferenceSystemId>IT Manager</b:UserReferenceSystemId>
                     <b:UserUid>1152921504607134339</b:UserUid>
                     <b:EmailAddress>it_manager@revcorp.bb</b:EmailAddress>
                     <b:FirstName>IT</b:FirstName>
                     <b:LastName>Manager</b:LastName>
                     <b:MiddleName i:nil="true"/>
                     <b:ClientIdentity i:nil="true"/>
                     <b:PrimaryUserTypeCostCenter>
                        <b:CostCenterIdentity>
                           <b:CostCenterId i:nil="true"/>
                           <b:CostCenterName>IT Team (USA)</b:CostCenterName>
                           <b:CostCenterNumber>IT Team (USA)</b:CostCenterNumber>
                           <b:CostCenterUid>1152921504606867365</b:CostCenterUid>
                        </b:CostCenterIdentity>
                        <b:UserTypeIdentity>
                           <b:UserTypeId i:nil="true"/>
                           <b:UserTypeName>IT Manager</b:UserTypeName>
                           <b:UserTypeUid>1152921504606867304</b:UserTypeUid>
                        </b:UserTypeIdentity>
                     </b:PrimaryUserTypeCostCenter>
                  </b:UserSummary>
               </b:PwsUserSummaryElement>
            </a:Users>
         </PwsGetUserListResult>
      </PwsGetUserListResponse>
   </s:Body>
</s:Envelope>

PwsGetUserList - Common Errors and Warnings

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

ErrorNumber	ErrorCode	ErrorText
50024	EntityNotFound	Entity PwsUserRef was not found.
50045	ViewPermissionDenied	You do not have permission to view this item.
57813	PermissionLimitedToClientUsers	User permission is limited to client users.