Overview

This web service retrieves a list of client summary records (PwsClientSummary), based on specified search criteria (PwsClientRef).

Request Format

PwsGetClientListRq

PwsGetClientListRq
- PwsClientRef
- IncludeInactiveFlag: Boolean
- MaxRowsToReturn: Int32
- QueryString: String
- LastUpdatedSinceTimestamp: dateTime

This request also includes the Common Input Elements

Request Elements

Element	Data Type	Required?	Default	Description
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)

Example 01 - Client is not specified

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

Example 02 - Client is specified

      <PwsGetClientList>
         <serviceRequest>
            <RequestId>1</RequestId>
            <SessionTicket>AcjOqKSXoUYG3qLkrxKQYw==</SessionTicket>
            <ClientIdentity>
               <!--ClientId>?</ClientId-->
               <ClientNumber>Projector PSA</ClientNumber>
               <!--ClientUid>?</ClientUid-->
            </ClientIdentity>
            <IncludeInactiveFlag>true</IncludeInactiveFlag>
            <!--MaxRowsToReturn>?</MaxRowsToReturn-->
            <!--QueryString>?</QueryString-->
            <!--LastUpdatedSinceTimestamp>?</LastUpdatedSinceTimestamp-->
         </serviceRequest>
      </PwsGetClientList>

Response Format

PwsClientRs

PwsGetClientListRs
- Clients: PwsClientSummary [0..infinity]
- ParentClientIdentity: /wiki/spaces/QA/pages/11796518

This response also includes the Common Output Elements

Response Elements

Element	Data Type	Description
Common Output	Common Output Elements
Clients	PwsClientSummary	Client Summary Record(s) retrieved by the service