Overview
This web service retrieves a list of client summary records (PwsClientSummary), based on specified search criteria (PwsClientRef).
| Panel |
|---|
|
- PwsGetClientListRq
- Common Input
- PwsClientRef
- IncludeInactiveFlag: Boolean
- MaxRowsToReturn: Int32
- QueryString: String
- LastUpdatedSinceTimestamp: dateTime
|
Request Elements
| Element | Data Type | Required? | Default | Description |
|---|
| Common Input | Common Input | yes |
|
|
| PwsClientRef | PwsClientRef [1] | no |
|
|
| 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. |
| MaxRowsToReturn | Int32 | no | infinite | Maximum number of clients to be returned |
| QueryString | String | no |
| Find all clients matching specified string in client name or client number |
Usage Example(s)
| Code Block |
|---|
| language | xml |
|---|
| title | Example 01 - Client is not specified |
|---|
| collapse | true |
|---|
|
<PwsGetClientList>
<serviceRequest>
<RequestId>1</RequestId>
<SessionTicket>AcjOqKSXoUYG3qLkrxKQYw==</SessionTicket>
<ClientIdentity>
<!--ClientId>?</ClientId-->
<!--ClientNumber>?</ClientNumber-->
<!--ClientUid>?</ClientUid-->
</ClientIdentity>
<IncludeInactiveFlag>true</IncludeInactiveFlag>
<!--req:MaxRowsToReturn>?</MaxRowsToReturn-->
<!--req:QueryString>?</QueryString-->
<!--req:LastUpdatedSinceTimestamp>?</LastUpdatedSinceTimestamp-->
</serviceRequest>
</PwsGetClientList> |
| Code Block |
|---|
| language | xml |
|---|
| title | Example 02 - Client is specified |
|---|
| collapse | true |
|---|
|
|