...
| 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 identitya 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 specifiedin ClientIdentity. | true/false |
| MaxRowsToReturn | Int32 | No | The maximum number of clients to be returned. This flag value is disregarded if a client is specifiedin ClientIdentity. | 100 | |
| QueryString | String (50) | No | The clients that are returned will contain the value in this field. This flag 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 flag value is disregarded if a client is specifiedin ClientIdentity. | 2018-01-01 |
Request Usage Example(s)
...
| 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 | String | Click here for more information | Ok | |||
| ServerTimestampUtc | DateTime | Click here for more informaton | 2018-01-17T19:52:55.4411759Z | |||
| Clients | PwsClientSummary [0..infinity] | The client summary record(s) retrieved by the service. Click here for more information. | 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.). Click here for more information. |
Response Usage Example(s)
...