Versions Compared

Key

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

...

Panel
titlePwsGetClientListRq
  • PwsGetClientListRq
    • RequestId: Int32
    • SessionTicket: String
    • ClientIdentity: PwsClientRef [1]
    • IncludeInactiveFlag: Boolean
    • MaxRowsToReturn: Int32
    • QueryString: String
    • LastUpdatedSinceTimestamp: DateTime

...

ElementData TypeRequired?DefaultDescription
RequestIdInt32No
RequestId
SessionTicketStringYes
SessionTicket
PwsClientRefPwsClientRef [1]No
For this service, the caller may specify up to 1 client identity. If a client identity is not specified all clients fitting the criteria will be returned
IncludeInactiveFlagBooleanNo"false"Valid 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

...

Panel
titlePwsClientRs


Response Elements


ElementData TypeDescription
MessagesPwsMessage
ResponseIdInt32ResponseId
StatusStringStatus
ServerTimestamptUtcDateTimeServerTimestampUtc
ClientsPwsClientSummaryClient Summary Record(s) retrieved by the service

...