...
| Panel | ||
|---|---|---|
| ||
|
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. | AcjOqKSXoUYG3qLkrxKQYw== | |
| ClientIdentity | PwsClientRef | 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. | true/false |
| MaxRowsToReturn | Int32 | No | infinite | Maximum number of clients to be returned. | 100 |
| QueryString | String (50) | No | Find all clients matching specified string in client name or client number. | Acme | |
| LastUpdatedSinceTimestamp | DateTime | No | Only clients that have been updated on or after the specified date/time will be retrieved. | 2017-12-27 |
Request Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<PwsGetClientList>
<serviceRequest>
<RequestId>1</RequestId>
<SessionTicket>AcjOqKSXoUYG3qLkrxKQYw==</SessionTicket>
<IncludeInactiveFlag>true</IncludeInactiveFlag>
<MaxRowsToReturn>100</MaxRowsToReturn>
</serviceRequest>
</PwsGetClientList> |
...
| Element | Data Type | Description | Sample Data |
|---|---|---|---|
| Messages | PwsMessageThe web service response status and Message. | Click here for more information | |
| ResponseId | Int32 | Click here for more information. | 2 |
| Status | String | Click here for more infomration. | Ok |
| ServerTimestampUtc | DateTime | Click here for more informaton | 2017-12-27T18:23:22.3881313Z |
| Clients | PwsClientSummary | Client Summary Record(s) retrieved by the service. |
Response Usage Example(s)
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<PwsGetClientListResponse>
<PwsGetClientListResult>
<Messages>
<PwsMessage>
<AdditionalErrorText i:nil="true"/>
<ErrorCode <Messages i:nil="true"/>
<ErrorNumber i:nil="true"/>
<ErrorText i:nil="true"/>
<Type i:nil="true"/>
<ReferenceId1 i:nil="true"/>
<ReferenceId2 i:nil="true"/>
</PwsMessage>
</Messages>
<ResponseId>2</ResponseId>
<Status>Ok</Status>
<ServerTimestampUtc>2017-12-27T18:23:22.3881313Z</ServerTimestampUtc>
<Clients>
<PwsClientSummary>
<ClientId i:nil="true"/>
<ClientNumber>Projector PSA</ClientNumber>
<ClientUid>1152921504606961482</ClientUid>
<ClientName>Projector PSA</ClientName>
<InactiveFlag>false</InactiveFlag>
<ParentClientIdentity i:nil="true"/>
</PwsClientSummary>
</Clients>
</PwsGetClientListResult>
</PwsGetClientListResponse>
|
...