...
| Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
| RequestId | Int32 | No | Click here for more information | 1 | |
| SessionTicket | String (50) | Yes | Click here for more information | AcjOqKSXoUYG3qLkrxKQYwAavFwbZgVb9V4tr3R7BbzQ== | |
| ClientIdentity | PwsClientRef | 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 | ||
| IncludeInactiveFlag | Boolean | No | false | Valid values for this field include "true" or "false". If set to true, inactive clients will be included in the response | true/false |
| MaxRowsToReturn | Int32 | No | infinite | The maximum number of clients to be returned | 100 |
| QueryString | String (50) | No | Find all clients matching specified string in client name or client number | AcmeParent | |
| LastUpdatedSinceTimestamp | DateTime | No | Only clients that have been updated on or after the specified date/time will be retrieved | 20172018-1201-2701 |
Request Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<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:ClientIdentity>
<com:ClientNumber>C000121</com:ClientNumber>IncludeInactiveFlag>false</req:IncludeInactiveFlag>
<<req:MaxRowsToReturn>100</req:ClientIdentity>MaxRowsToReturn>
<req:IncludeInactiveFlag>false<QueryString>Parent</req:IncludeInactiveFlag>QueryString>
<req:MaxRowsToReturn>100<LastUpdatedSinceTimestamp>2018-01-01</req:MaxRowsToReturn>LastUpdatedSinceTimestamp>
</pws:serviceRequest>
</pws:PwsGetClientList>
</soapenv:Body>
</soapenv:Envelope> |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<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:ClientIdentity>
<com:ClientNumber>C000121</com:ClientNumber>
</req:ClientIdentity>
<req:IncludeInactiveFlag>false</req:IncludeInactiveFlag>
<req:MaxRowsToReturn>100</req:MaxRowsToReturn>
<!--req:QueryString>?</req:QueryString-->
<!--req:LastUpdatedSinceTimestamp>?</req:LastUpdatedSinceTimestamp-->
</pws:serviceRequest>
</pws:PwsGetClientList>
</soapenv:Body>
</soapenv:Envelope> |
...