Versions Compared

Key

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

...

Panel
titlePwsGetClientListRq
  • PwsGetClientListRq
    • PwsClientRef
    • IncludeInactiveFlag: Boolean
    • MaxRowsToReturn: Int32
    • QueryString: String
    • LastUpdatedSinceTimestamp: dateTimeDateTime

...

ElementData TypeRequired?DefaultDescription
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
LastUpdatedSinceTimestampDateTimeno
Only clients that have been updated on or after the specified date/time will be retrieved

Request Usage Example(s)


Code Block
languagexml
titleExample 01 - Client is not specified
collapsetrue
      <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>

...