...
| Element | Data Type | Required? | Default | Description |
|---|---|---|---|---|
| RequestId | Int32 | No | Click here for more information. | |
| SessionTicket | String | Yes | Click here for more information. | |
| ClientIdentity | PwsClientRef [1] | No | For this service, the caller may specify up to 1 client identity. If a client identity is not specified all clients fitting the 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. |
| 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. | |
| LastUpdatedSinceTimestamp | DateTime | No | Only clients that have been updated on or after the specified date/time will be retrieved. |
Request Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<PwsGetClientList>
<serviceRequest>
<RequestId>1</RequestId>
<SessionTicket>AcjOqKSXoUYG3qLkrxKQYw==</SessionTicket>
<ClientIdentity>
<!--ClientId>?</ClientId-->
<!--ClientNumber>?</ClientNumber-->
<!--ClientUid>?</ClientUid-->
</ClientIdentity>
<IncludeInactiveFlag>true</IncludeInactiveFlag>
<!--MaxRowsToReturn>?</MaxRowsToReturn-->
<!--QueryString>?</QueryString-->
<!--LastUpdatedSinceTimestamp>?</LastUpdatedSinceTimestamp-->
</serviceRequest>
</PwsGetClientList> |
...
| Element | Data Type | Description |
|---|---|---|
| Messages | PwsMessage | The web service response status and Message. |
| ResponseId | Int32 | Click here for more information. |
| Status | String | Click here for more infomration. |
| ServerTimestampUtc | DateTime | Click here for more informaton. |
| Clients | PwsClientSummary | Client Summary Record(s) retrieved by the service. |
Response Usage Example(s)
...