Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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
titlePwsGetClientList Request

...

ElementData TypeRequired?DefaultDescriptionSample Data
RequestIdInt32No
Click here for more information
1
SessionTicketString (50)Yes
Click here for more information
AavFwbZgVb9V4tr3R7BbzQ==
ClientIdentityPwsClientRefNo
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.
IncludeInactiveFlagBooleanNofalseValid 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
MaxRowsToReturnInt32No
The maximum number of clients to be returned. This flag value is disregarded if a client is specifiedin ClientIdentity.
100
QueryStringString (50255)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
LastUpdatedSinceTimestampDateTimeNo
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)

...

Panel
titlePwsClientRs


Response Elements


ElementData TypeDescriptionSample Data
MessagesPwsMessage[]

The web service response status and message. Click here for more information


ResponseIdInt32Click here for more information
1
StatusStringRequestStatusClick here for more information
Ok
ServerTimestampUtcDateTimeClick here for more informaton
2018-01-17T19:52:55.4411759Z
ClientsPwsClientSummary[]The client summary record(s) retrieved by the service. Click here for more information.ParentClientIdentityPwsClientRefThe 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)

...

ErrorNumberErrorCodeErrorText
104RowCountExceeded104Row count limit exceeded
10100MaxRowsToReturnOutOfRange10100Invalid value specified for MaxRowsToReturn
50045ViewPermissionDenied50045Permission denied
57629ClientNotFound57629Specified client not found
57633UnexpectedErrorRetrievingClientList57633Unexpected error retrieving client list