Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

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

ElementData TypeRequired?DefaultDescription
Common InputCommon Inputyes

PwsClientRefPwsClientRef [1]no

IncludeInactiveFlagBooleannofalseValid values for this field include "true" or "false". If set to true, inactive clients will be included in the response.
MaxRowsToReturnInt32noinfiniteMaximum number of clients to be returned
QueryStringStringno
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>
  • No labels