Versions Compared

Version Old Version 3 New Version 4
Changes made by

Bettina Borces

Bettina Borces

Saved on

Key

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

...

Panel
titlePwsGetClientListRq
  • 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)

Code Block
languagexml
titleExample 01 - Client Id is not specified
      <PwsGetClientList>
         <serviceRequest>
            <RequestId>1</RequestId>
            <SessionTicket>AcjOqKSXoUYG3qLkrxKQYw==</SessionTicket>
            <!--ClientIdentity>
               <ClientId>?</ClientId>
               <ClientNumber>?</ClientNumber>
               <ClientUid>?</ClientUid>
            </ClientIdentity-->
            <req:IncludeInactiveFlag>true</IncludeInactiveFlag>
            <!--req:MaxRowsToReturn>?</MaxRowsToReturn-->
            <!--req:QueryString>?</QueryString-->
            <!--req:LastUpdatedSinceTimestamp>?</LastUpdatedSinceTimestamp-->
         </serviceRequest>
      </PwsGetClientList>