Versions Compared

Key

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

...

Panel
titlePwsGetClientList Request
  • PwsGetClientListRq
    • RequestId: Int32
    • SessionTicket: String (50)
    • ClientIdentity: PwsClientRef
    • IncludeInactiveFlag: Boolean
    • MaxRowsToReturn: Int32
    • QueryString: String (50)
    • LastUpdatedSinceTimestamp: DateTime


Request Elements


ElementData TypeRequired?DefaultDescriptionSample Data
RequestIdInt32No
Click here for more information
1
SessionTicketString (50)Yes
Click here for more information
AavFwbZgVb9V4tr3R7BbzQ==
ClientIdentityPwsClientRefNo
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. Click here for more information.
IncludeInactiveFlagBooleanNofalseValid values for this field include "true" or "false". If set to true, inactive clients will be included in the response
true/false
MaxRowsToReturnInt32NoinfiniteThe maximum number of clients to be returned
100
QueryStringString (50)No
Find all clients matching specified string in client name or client number

The clients that are returned will contain the value in this field
Parent
LastUpdatedSinceTimestampDateTimeNo
Only clients that have been updated on or after the specified date/time will be retrieved
2018-01-01

Request Usage Example(s)


Code Block
languagexml
titleExample 01 - Client is not specified
collapsetrue
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsGetClientList>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AavFwbZgVb9V4tr3R7BbzQ==</req:SessionTicket>
            <req:IncludeInactiveFlag>false</req:IncludeInactiveFlag>
            <req:MaxRowsToReturn>100</req:MaxRowsToReturn>
            <req:QueryString>Parent</req:QueryString>
            <req:LastUpdatedSinceTimestamp>2018-01-01</req:LastUpdatedSinceTimestamp>
         </pws:serviceRequest>
      </pws:PwsGetClientList>
   </soapenv:Body>
</soapenv:Envelope>

...