You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 13
Next »
Overview
This web service retrieves a list of client summary records (PwsResourceSummary), based on specified search criteria. You can specify which client or clients to retrieved either by specifying a set of search criteria, or by specifying a specific client to retrieve (PwsResourceRef).
- PwsGetResourceList
- serviceRequest: PwsGetResourceListRq
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 | 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 |
QueryString | 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 | PwsResourceRef | No |
| The unique keys used to identify a resource to be retrieved |
|
Request Usage Example(s)
<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>
<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>
- PwsGetResourceListResponse
- PwsGetResourceListResult: PwsGetResourceListRs
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 |
Resources | PwsResourceSummary | The resource summary records that were fetched by the service |
|
Response Usage Example(s)
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<PwsGetResourceListResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
<PwsGetResourceListResult 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-01-29T19:19:48.2062214Z</ServerTimestampUtc>
<a:Resources xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:PwsResourceSummary>
<b:ResourceDisplayName>Abby Baxter</b:ResourceDisplayName>
<b:ResourceId i:nil="true"/>
<b:ResourceReferenceSystemId>OPA02</b:ResourceReferenceSystemId>
<b:ResourceUid>1152921504607069416</b:ResourceUid>
<b:EmailAddress>abby@revcorp.bb</b:EmailAddress>
<b:FirstName>Abby</b:FirstName>
<b:LastName>Baxter</b:LastName>
<b:MiddleName i:nil="true"/>
<b:InactiveFlag>false</b:InactiveFlag>
</b:PwsResourceSummary>
<b:PwsResourceSummary>
<b:ResourceDisplayName>Maya Hamilton</b:ResourceDisplayName>
<b:ResourceId i:nil="true"/>
<b:ResourceReferenceSystemId>MC01</b:ResourceReferenceSystemId>
<b:ResourceUid>1152921504607076880</b:ResourceUid>
<b:EmailAddress>maya@revcorp.bb</b:EmailAddress>
<b:FirstName>Maya</b:FirstName>
<b:LastName>Hamilton</b:LastName>
<b:MiddleName i:nil="true"/>
<b:InactiveFlag>false</b:InactiveFlag>
</b:PwsResourceSummary>
<b:PwsResourceSummary>
<b:ResourceDisplayName>Amie Heston</b:ResourceDisplayName>
<b:ResourceId i:nil="true"/>
<b:ResourceReferenceSystemId>CN (USA) - 02</b:ResourceReferenceSystemId>
<b:ResourceUid>1152921504607074058</b:ResourceUid>
<b:EmailAddress>amie@revcorp.bb</b:EmailAddress>
<b:FirstName>Amie</b:FirstName>
<b:LastName>Heston</b:LastName>
<b:MiddleName i:nil="true"/>
<b:InactiveFlag>false</b:InactiveFlag>
</b:PwsResourceSummary>
<b:PwsResourceSummary>
<b:ResourceDisplayName>Anita Lawson</b:ResourceDisplayName>
<b:ResourceId i:nil="true"/>
<b:ResourceReferenceSystemId>CS (CAN) - 01</b:ResourceReferenceSystemId>
<b:ResourceUid>1152921504607027242</b:ResourceUid>
<b:EmailAddress>anita@revcorp.bb</b:EmailAddress>
<b:FirstName>Anita</b:FirstName>
<b:LastName>Lawson</b:LastName>
<b:MiddleName i:nil="true"/>
<b:InactiveFlag>false</b:InactiveFlag>
</b:PwsResourceSummary>
<b:PwsResourceSummary>
<b:ResourceDisplayName>Anton Kintyre</b:ResourceDisplayName>
<b:ResourceId i:nil="true"/>
<b:ResourceReferenceSystemId>IT (USA) - 19</b:ResourceReferenceSystemId>
<b:ResourceUid>1152921504607074823</b:ResourceUid>
<b:EmailAddress>anton@revcorp.bb</b:EmailAddress>
<b:FirstName>Anton</b:FirstName>
<b:LastName>Kintyre</b:LastName>
<b:MiddleName i:nil="true"/>
<b:InactiveFlag>false</b:InactiveFlag>
</b:PwsResourceSummary>
</a:Resources>
</PwsGetResourceListResult>
</PwsGetResourceListResponse>
</s:Body>
</s:Envelope>
PwsGetResourceList - Common Errors and Warnings
ErrorNumber | ErrorCode | ErrorText |
|---|
| 10125 | ResourceNotFoundInExternalSystem | Resource matching '{ResourceIdentifier}' not found in external system |
| 57545 | ResourceNotFound | The specified resource does not exist. |