...
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
Int32 | No | Click here for more information information. | 1 | ||
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 resources 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 | |
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 cost center user is specified in UserIdentity. | |||
UserIdentity | No | The unique keys used to identify a resource 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)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<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> |
...
Element | Data Type | Description | Sample Data |
|---|---|---|---|
Messages | The web service response status and message. Click here for more information. | ||
Int32 | Click here for more information. | 1 | |
Status | Click here for more information. | Ok | |
DateTime | Click here for more information. | 2018-01-29T19:19:48.2062214Z | |
Users | The user summary records that were fetched by the service. |
Response Usage Example(s)
...