Overview
This web service retrieves a list of client summary records (PwsClientSummary), based on specified search criteria (PwsClientRef).
| Panel |
|---|
|
- PwsGetClientListRq
- PwsClientRef
- IncludeInactiveFlag: Boolean
- MaxRowsToReturn: Int32
- QueryString: String
- LastUpdatedSinceTimestamp: dateTime
|
Request Elements
| Element | Data Type | Required? | Default | Description |
|---|
| PwsClientRef | PwsClientRef [1] | no |
|
|
| 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. |
| MaxRowsToReturn | Int32 | no | infinite | Maximum number of clients to be returned |
| QueryString | String | no |
| Find all clients matching specified string in client name or client number |
Usage Example(s)
| Code Block |
|---|
| language | xml |
|---|
| title | Example 01 - Client is not specified |
|---|
| collapse | true |
|---|
|
<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> |
| Code Block |
|---|
| language | xml |
|---|
| title | Example 02 - Client is specified |
|---|
| collapse | true |
|---|
|
<PwsGetClientList>
<serviceRequest>
<RequestId>1</RequestId>
<SessionTicket>AcjOqKSXoUYG3qLkrxKQYw==</SessionTicket>
<ClientIdentity>
<!--ClientId>?</ClientId-->
<ClientNumber>Projector PSA</ClientNumber>
<!--ClientUid>?</ClientUid-->
</ClientIdentity>
<IncludeInactiveFlag>true</IncludeInactiveFlag>
<!--MaxRowsToReturn>?</MaxRowsToReturn-->
<!--QueryString>?</QueryString-->
<!--LastUpdatedSinceTimestamp>?</LastUpdatedSinceTimestamp-->
</serviceRequest>
</PwsGetClientList> |
Response Elements
| Element | Data Type | Description |
|---|
| Clients | PwsClientSummary | Client Summary Record(s) retrieved by the service |
Usage Examples
| Code Block |
|---|
| language | xml |
|---|
| title | Example 01 - Client is not specified |
|---|
| collapse | true |
|---|
|
<a:Clients xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:PwsClientSummary>
<b:ClientId i:nil="true"/>
<b:ClientNumber>Air Acme</b:ClientNumber>
<b:ClientUid>1152921504606949187</b:ClientUid>
<b:ClientName>Air Canada</b:ClientName>
<b:InactiveFlag>false</b:InactiveFlag>
<b:ParentClientIdentity>
<b:ClientId i:nil="true"/>
<b:ClientNumber>Constellation Acme</b:ClientNumber>
<b:ClientUid>1152921504606956489</b:ClientUid>
</b:ParentClientIdentity>
</b:PwsClientSummary>
<b:PwsClientSummary>
<b:ClientId i:nil="true"/>
<b:ClientNumber>River</b:ClientNumber>
<b:ClientUid>1152921504606971723</b:ClientUid>
<b:ClientName>River</b:ClientName>
<b:InactiveFlag>false</b:InactiveFlag>
<b:ParentClientIdentity i:nil="true"/>
</b:PwsClientSummary>
<b:PwsClientSummary>
<b:ClientId i:nil="true"/>
<b:ClientNumber>FR123</b:ClientNumber>
<b:ClientUid>1152921504606973698</b:ClientUid>
<b:ClientName>Fruits and Chocolates</b:ClientName>
<b:InactiveFlag>false</b:InactiveFlag>
<b:ParentClientIdentity i:nil="true"/>
</b:PwsClientSummary>
<b:PwsClientSummary>
<b:ClientId i:nil="true"/>
<b:ClientNumber>RI123</b:ClientNumber>
<b:ClientUid>1152921504606949188</b:ClientUid>
<b:ClientName>Realty Inc.</b:ClientName>
<b:InactiveFlag>false</b:InactiveFlag>
<b:ParentClientIdentity i:nil="true"/>
</b:PwsClientSummary>
<b:PwsClientSummary>
<b:ClientId i:nil="true"/>
<b:ClientNumber>D545</b:ClientNumber>
<b:ClientUid>1152921504606968450</b:ClientUid>
<b:ClientName>Dogs Dogs Dogs</b:ClientName>
<b:InactiveFlag>false</b:InactiveFlag>
<b:ParentClientIdentity i:nil="true"/>
</b:PwsClientSummary>
<b:PwsClientSummary>
<b:ClientId i:nil="true"/>
<b:ClientNumber>C000109</b:ClientNumber>
<b:ClientUid>1152921504606971245</b:ClientUid>
<b:ClientName>Sound Shack</b:ClientName>
<b:InactiveFlag>false</b:InactiveFlag>
<b:ParentClientIdentity i:nil="true"/>
</b:PwsClientSummary>
<b:PwsClientSummary>
<b:ClientId i:nil="true"/>
<b:ClientNumber>C000110</b:ClientNumber>
<b:ClientUid>1152921504606973604</b:ClientUid>
<b:ClientName>Platinum Service</b:ClientName>
<b:InactiveFlag>false</b:InactiveFlag>
<b:ParentClientIdentity i:nil="true"/>
</b:PwsClientSummary>
<b:PwsClientSummary>
<b:ClientId i:nil="true"/>
<b:ClientNumber>C000112</b:ClientNumber>
<b:ClientUid>1152921504606980895</b:ClientUid>
<b:ClientName>Temperate Destinations</b:ClientName>
<b:InactiveFlag>false</b:InactiveFlag>
<b:ParentClientIdentity i:nil="true"/>
</b:PwsClientSummary>
<b:PwsClientSummary>
<b:ClientId i:nil="true"/>
<b:ClientNumber>C000113</b:ClientNumber>
<b:ClientUid>1152921504606987273</b:ClientUid>
<b:ClientName>R17-B14</b:ClientName>
<b:InactiveFlag>false</b:InactiveFlag>
<b:ParentClientIdentity i:nil="true"/>
</b:PwsClientSummary>
<b:PwsClientSummary>
<b:ClientId i:nil="true"/>
<b:ClientNumber>C000114</b:ClientNumber>
<b:ClientUid>1152921504606987286</b:ClientUid>
<b:ClientName>R17-B17</b:ClientName>
<b:InactiveFlag>false</b:InactiveFlag>
<b:ParentClientIdentity i:nil="true"/>
</b:PwsClientSummary>
<b:PwsClientSummary>
<b:ClientId i:nil="true"/>
<b:ClientNumber>C000115</b:ClientNumber>
<b:ClientUid>1152921504606989357</b:ClientUid>
<b:ClientName>S-Miles Corporation</b:ClientName>
<b:InactiveFlag>false</b:InactiveFlag>
<b:ParentClientIdentity i:nil="true"/>
</b:PwsClientSummary>
<b:PwsClientSummary>
<b:ClientId i:nil="true"/>
<b:ClientNumber>C000116</b:ClientNumber>
<b:ClientUid>1152921504606989620</b:ClientUid>
<b:ClientName>Cat World</b:ClientName>
<b:InactiveFlag>false</b:InactiveFlag>
<b:ParentClientIdentity i:nil="true"/>
</b:PwsClientSummary>
<b:PwsClientSummary>
<b:ClientId i:nil="true"/>
<b:ClientNumber>C000118</b:ClientNumber>
<b:ClientUid>1152921504606989807</b:ClientUid>
<b:ClientName>Acme 100</b:ClientName>
<b:InactiveFlag>false</b:InactiveFlag>
<b:ParentClientIdentity i:nil="true"/>
</b:PwsClientSummary>
<b:PwsClientSummary>
<b:ClientId i:nil="true"/>
<b:ClientNumber>C000119</b:ClientNumber>
<b:ClientUid>1152921504606989815</b:ClientUid>
<b:ClientName>Hedgehog Gardening</b:ClientName>
<b:InactiveFlag>false</b:InactiveFlag>
<b:ParentClientIdentity i:nil="true"/>
</b:PwsClientSummary>
<b:PwsClientSummary>
<b:ClientId i:nil="true"/>
<b:ClientNumber>C001000</b:ClientNumber>
<b:ClientUid>1152921504606989813</b:ClientUid>
<b:ClientName>Acme 1000-01</b:ClientName>
<b:InactiveFlag>false</b:InactiveFlag>
<b:ParentClientIdentity>
<b:ClientId i:nil="true"/>
<b:ClientNumber>C000118</b:ClientNumber>
<b:ClientUid>1152921504606989807</b:ClientUid>
</b:ParentClientIdentity>
</b:PwsClientSummary>
<b:PwsClientSummary>
<b:ClientId i:nil="true"/>
<b:ClientNumber>C001001</b:ClientNumber>
<b:ClientUid>1152921504606989814</b:ClientUid>
<b:ClientName>Acme 1000-02</b:ClientName>
<b:InactiveFlag>false</b:InactiveFlag>
<b:ParentClientIdentity i:nil="true"/>
</b:PwsClientSummary>
<b:PwsClientSummary>
<b:ClientId i:nil="true"/>
<b:ClientNumber>CL0009</b:ClientNumber>
<b:ClientUid>1152921504606984049</b:ClientUid>
<b:ClientName>Target</b:ClientName>
<b:InactiveFlag>false</b:InactiveFlag>
<b:ParentClientIdentity i:nil="true"/>
</b:PwsClientSummary>
<b:PwsClientSummary>
<b:ClientId i:nil="true"/>
<b:ClientNumber>CL0010</b:ClientNumber>
<b:ClientUid>1152921504606984050</b:ClientUid>
<b:ClientName>W6 Airlines</b:ClientName>
<b:InactiveFlag>false</b:InactiveFlag>
<b:ParentClientIdentity i:nil="true"/>
</b:PwsClientSummary>
<b:PwsClientSummary>
<b:ClientId i:nil="true"/>
<b:ClientNumber>Projector PSA</b:ClientNumber>
<b:ClientUid>1152921504606961482</b:ClientUid>
<b:ClientName>Projector PSA</b:ClientName>
<b:InactiveFlag>false</b:InactiveFlag>
<b:ParentClientIdentity i:nil="true"/>
</b:PwsClientSummary>
<b:PwsClientSummary>
<b:ClientId i:nil="true"/>
<b:ClientNumber>revcorp-bb</b:ClientNumber>
<b:ClientUid>1152921504606944619</b:ClientUid>
<b:ClientName>revcorp-bb</b:ClientName>
<b:InactiveFlag>false</b:InactiveFlag>
<b:ParentClientIdentity i:nil="true"/>
</b:PwsClientSummary>
<b:PwsClientSummary>
<b:ClientId i:nil="true"/>
<b:ClientNumber>C736718</b:ClientNumber>
<b:ClientUid>1152921504606967386</b:ClientUid>
<b:ClientName>Concrete Research and Development</b:ClientName>
<b:InactiveFlag>false</b:InactiveFlag>
<b:ParentClientIdentity i:nil="true"/>
</b:PwsClientSummary>
<b:PwsClientSummary>
<b:ClientId i:nil="true"/>
<b:ClientNumber>12938028212</b:ClientNumber>
<b:ClientUid>1152921504606960351</b:ClientUid>
<b:ClientName>Constellations Inc.</b:ClientName>
<b:InactiveFlag>false</b:InactiveFlag>
<b:ParentClientIdentity i:nil="true"/>
</b:PwsClientSummary>
<b:PwsClientSummary>
<b:ClientId i:nil="true"/>
<b:ClientNumber>12938028213</b:ClientNumber>
<b:ClientUid>1152921504606966758</b:ClientUid>
<b:ClientName>Orion Inc.</b:ClientName>
<b:InactiveFlag>false</b:InactiveFlag>
<b:ParentClientIdentity>
<b:ClientId i:nil="true"/>
<b:ClientNumber>12938028212</b:ClientNumber>
<b:ClientUid>1152921504606960351</b:ClientUid>
</b:ParentClientIdentity>
</b:PwsClientSummary>
<b:PwsClientSummary>
<b:ClientId i:nil="true"/>
<b:ClientNumber>12938028214</b:ClientNumber>
<b:ClientUid>1152921504606966759</b:ClientUid>
<b:ClientName>Milky Way Inc.</b:ClientName>
<b:InactiveFlag>false</b:InactiveFlag>
<b:ParentClientIdentity>
<b:ClientId i:nil="true"/>
<b:ClientNumber>12938028212</b:ClientNumber>
<b:ClientUid>1152921504606960351</b:ClientUid>
</b:ParentClientIdentity>
</b:PwsClientSummary>
</a:Clients> |