...
This web service retrieves a list of client resource summary records (PwsResourceSummary), based on specified search criteria. You can specify which client or clients resources to retrieved retrieve either by specifying a set of search criteria, or by specifying a specific client resource to retrieve (PwsResourceRef).
...
| Panel | ||
|---|---|---|
| ||
|
Request Elements
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
Int32 | No | Click here for more information | 1 | ||
String | Yes | Click here for more information | AVC/x56/KIpgZvF71H4TwA== | ||
IncludeInactiveFlag | Boolean | Yes | false | If set to 'true', inactive resources will be included in the results. Otherwise, only active resources will be returned. This flag is disregarded if a resource is specified in ResourceIdentity | false |
MaxRowsToReturn | Int32 | No | The maximum number of resources to be retrieved. This value is disregarded if a resource is specified in ResourceIdentity | 5 | |
String (255) | No | A search string to narrow down the results. A resource will be included in the results if the search string matches the resource display name or resource reference system id / employee id as well as the other specified criteria. This value is disregarded if a cost center is specified in ResourceIdentity. | |||
ResourceIdentity | No | The unique keys used to identify a resource to be retrieved | |||
| LastUpdatedSinceTimestamp | String | No | The timestamp from when the resource is last updated. |
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:PwsGetResourceList>
<pws:serviceRequest>
<req:RequestId>1</req:RequestId>
<req:SessionTicket>AVC/x56/KIpgZvF71H4TwA==</req:SessionTicket>
<req:IncludeInactiveFlag>false</req:IncludeInactiveFlag>
<req:MaxRowsToReturn>5</req:MaxRowsToReturn>
</pws:serviceRequest>
</pws:PwsGetResourceList>
</soapenv:Body>
</soapenv:Envelope> |
| 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:PwsGetResourceList>
<pws:serviceRequest>
<req:RequestId>1</req:RequestId>
<req:SessionTicket>AVC/x56/KIpgZvF71H4TwA==</req:SessionTicket>
<req:IncludeInactiveFlag>false</req:IncludeInactiveFlag>
<!--req:MaxRowsToReturn>5</req:MaxRowsToReturn-->
<!--req:QueryString>?</req:QueryString-->
<req:ResourceIdentity>
<com:ResourceReferenceSystemId>IT (USA) - 01</com:ResourceReferenceSystemId>
</req:ResourceIdentity>
</pws:serviceRequest>
</pws:PwsGetResourceList>
</soapenv:Body>
</soapenv:Envelope> |
...
| Panel | ||
|---|---|---|
| ||
|
Response Elements
Element | Data Type | Description | Sample Data |
|---|---|---|---|
Messages | The web service response status and message. Click here for more information. | ||
ResponseId | Int32 | Click here for more information. | 1 |
Status | Click here for more information. | Ok | |
ServerTimestampUtc | DateTime | Click here for more information. | 2018-01-29T19:19:48.2062214Z |
Resources | The resource summary records that were fetched by the service |
...