Overview

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

Request Format

PwsGetClientListRq

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

Request Elements

Element	Data Type	Required?	Default	Description
Common Input	Common Input	yes
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
- Common Output
- Clients: PwsClientSummary [0..infinity]
- ParentClientIdentity: /wiki/spaces/QA/pages/11796518

Response Elements

Element	Data Type	Description
Common Output	Common Output
Clients	PwsClientSummary	Unique key fields associated with the client(s) returned by the request plus the client status (i.e. active or inactive)
ParentClientIdentity	PwsClientRef	The parent client associated with the client(s) - if any