...
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 | ||
|---|---|---|
| ||
|
...
| 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 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. | ||
| 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 | The maximum number of clients to be returned. This value is disregarded if a client is specified in ClientIdentity. | 100 | |
| QueryString | String (255) | No | 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 |
...
| Panel | ||
|---|---|---|
| ||
|
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 informaton | 2018-01-17T19:52:55.4411759Z |
| Clients | PwsClientSummary[] | The client summary record(s) retrieved by the service |
...