...
This web service retrieves a list of client summary records (PwsClientSummary), based on specified search criteria. You can specify which client or clients to retrieve either by specifying a set of search criteria, or by specifying a specific client (PwsClientRef). The web service returns a list of clients (PwsClientSummary).
Request Format
| Panel |
|---|
| title | PwsGetClientList Request |
|---|
|
|
Request Elements
| Element | Data Type | Required? | Default | Description | Sample Data |
|---|
| RequestId | Int32 | No |
| Click here for more information | 1 |
| SessionTicket | String (50) | Yes |
| Click here for more information | AavFwbZgVb9V4tr3R7BbzQ== |
| ClientIdentity | PwsClientRef | No |
| For this service, the caller may specify |
up to 1 client identity| a client identity to retrieve a specific client summary. If a client identity is not specified all clients fitting the other specified criteria will be returned |
. Click here for more information| . |
|
| IncludeInactiveFlag | Boolean | No | false |
Valid values for this field include "true" or "false". | If set to 'true', inactive clients will be included in the response. This flag is disregarded if a client is specified in ClientIdentity. | true/false |
| MaxRowsToReturn | Int32 | No |
infinite |
| The maximum number of clients to be returned. This value is disregarded if a client is specified in ClientIdentity. | 100 |
| QueryString | String ( |
50Find all clients matching specified string in client name or client number
| A search string to narrow down the results. A client will be included in the results if the search string matches the client number or client name, or if it is a child to a client that is matched based upon the criteria. This value is disregarded if a client is specified in ClientIdentity. | Parent |
| LastUpdatedSinceTimestamp | DateTime | No |
| Only clients that have been updated on or after the specified date/time will be retrieved. This value is disregarded if a client is specified in ClientIdentity. | 2018-01-01 |
Request Usage Example(s)
| Code Block |
|---|
| language | xml |
|---|
| title | Example 01 - Client is not specified |
|---|
| collapse | true |
|---|
|
<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:PwsGetClientList>
<pws:serviceRequest>
<req:RequestId>1</req:RequestId>
<req:SessionTicket>AavFwbZgVb9V4tr3R7BbzQ==</req:SessionTicket>
<req:IncludeInactiveFlag>false</req:IncludeInactiveFlag>
<req:MaxRowsToReturn>100</req:MaxRowsToReturn>
<req:QueryString>Parent</req:QueryString>
<req:LastUpdatedSinceTimestamp>2018-01-01</req:LastUpdatedSinceTimestamp>
</pws:serviceRequest>
</pws:PwsGetClientList>
</soapenv:Body>
</soapenv:Envelope> |
...
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 | StringRequestStatus | Click here for more information | Ok |
| ServerTimestampUtc | DateTime | Click here for more informaton | 2018-01-17T19:52:55.4411759Z |
| Clients | PwsClientSummary[] | The client summary record(s) retrieved by the service | ParentClientIdentity | PwsClientRef | The identity of this client's parent, if any. Circular relationships are not permitted (a client cannot be it's own parent, nor can a client's parent refer back to the client as it's parent, and so forth.). |
|
Response Usage Example(s)
...
- For all errors and warnings please refer to the Complete List of Errors and Warnings
| ErrorNumber | ErrorCodeErrorNumber | ErrorText |
|---|
| 104 | RowCountExceeded | Row count limit exceeded |
| 10100 | MaxRowsToReturnOutOfRange | Invalid value specified for MaxRowsToReturn |
| 50045 | ViewPermissionDenied | Permission denied |
| 57629 | ClientNotFound | Specified client not found |
| 57633 | UnexpectedErrorRetrievingClientList | Unexpected error retrieving client list |