Skip to end of metadata
Go to start of metadata
You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 42
Next »
Overview
This web service retrieves a list of client summary records (PwsClientSummary), based on specified search criteria (PwsClientRef).
- PwsGetClientListRq
- RequestId: Int32
- SessionTicket: String
- ClientIdentity: PwsClientRef [1]
- IncludeInactiveFlag: Boolean
- MaxRowsToReturn: Int32
- QueryString: String
- LastUpdatedSinceTimestamp: DateTime
Request Elements
| Element | Data Type | Required? | Default | Description |
|---|
| RequestId | Int32 | No |
|
|
| SessionTicket | String | Yes |
|
|
| PwsClientRef | PwsClientRef [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 |
| 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 |
| LastUpdatedSinceTimestamp | DateTime | No |
| Only clients that have been updated on or after the specified date/time will be retrieved |
Request Usage Example(s)
<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>
<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
Response Usage Example(s)
<PwsGetClientListResponse>
<PwsGetClientListResult>
<Messages i:nil="true"/>
<ResponseId>1</ResponseId>
<Status>Ok</Status>
<ServerTimestampUtc>2017-12-27T18:23:22.3881313Z</ServerTimestampUtc>
<Clients>
<PwsClientSummary>
<ClientId i:nil="true"/>
<ClientNumber>Air Acme<ClientNumber>
<ClientUid>1152921504606949187<ClientUid>
<ClientName>Air Canada<ClientName>
<InactiveFlag>false<InactiveFlag>
<ParentClientIdentity>
<ClientId i:nil="true"/>
<ClientNumber>Constellation Acme<ClientNumber>
<ClientUid>1152921504606956489<ClientUid>
</ParentClientIdentity>
</PwsClientSummary>
<PwsClientSummary>
<ClientId i:nil="true"/>
<ClientNumber>River<ClientNumber>
<ClientUid>1152921504606971723<ClientUid>
<ClientName>River<ClientName>
<InactiveFlag>false<InactiveFlag>
<ParentClientIdentity i:nil="true"/>
</PwsClientSummary>
<PwsClientSummary>
<ClientId i:nil="true"/>
<ClientNumber>FR123<ClientNumber>
<ClientUid>1152921504606973698<ClientUid>
<ClientName>Fruits and Chocolates<ClientName>
<InactiveFlag>false<InactiveFlag>
<ParentClientIdentity i:nil="true"/>
</PwsClientSummary>
<PwsClientSummary>
<ClientId i:nil="true"/>
<ClientNumber>RI123<ClientNumber>
<ClientUid>1152921504606949188<ClientUid>
<ClientName>Realty Inc.<ClientName>
<InactiveFlag>false<InactiveFlag>
<ParentClientIdentity i:nil="true"/>
</PwsClientSummary>
<PwsClientSummary>
<ClientId i:nil="true"/>
<ClientNumber>D545<ClientNumber>
<ClientUid>1152921504606968450<ClientUid>
<ClientName>Dogs Dogs Dogs<ClientName>
<InactiveFlag>false<InactiveFlag>
<ParentClientIdentity i:nil="true"/>
</PwsClientSummary>
<PwsClientSummary>
<ClientId i:nil="true"/>
<ClientNumber>C000109<ClientNumber>
<ClientUid>1152921504606971245<ClientUid>
<ClientName>Sound Shack<ClientName>
<InactiveFlag>false<InactiveFlag>
<ParentClientIdentity i:nil="true"/>
</PwsClientSummary>
<PwsClientSummary>
<ClientId i:nil="true"/>
<ClientNumber>C000110<ClientNumber>
<ClientUid>1152921504606973604<ClientUid>
<ClientName>Platinum Service<ClientName>
<InactiveFlag>false<InactiveFlag>
<ParentClientIdentity i:nil="true"/>
</PwsClientSummary>
<PwsClientSummary>
<ClientId i:nil="true"/>
<ClientNumber>C000112<ClientNumber>
<ClientUid>1152921504606980895<ClientUid>
<ClientName>Temperate Destinations<ClientName>
<InactiveFlag>false<InactiveFlag>
<ParentClientIdentity i:nil="true"/>
</PwsClientSummary>
<PwsClientSummary>
<ClientId i:nil="true"/>
<ClientNumber>C000113<ClientNumber>
<ClientUid>1152921504606987273<ClientUid>
<ClientName>R17-B14<ClientName>
<InactiveFlag>false<InactiveFlag>
<ParentClientIdentity i:nil="true"/>
</PwsClientSummary>
<PwsClientSummary>
<ClientId i:nil="true"/>
<ClientNumber>C000114<ClientNumber>
<ClientUid>1152921504606987286<ClientUid>
<ClientName>R17-B17<ClientName>
<InactiveFlag>false<InactiveFlag>
<ParentClientIdentity i:nil="true"/>
</PwsClientSummary>
<PwsClientSummary>
<ClientId i:nil="true"/>
<ClientNumber>C000115<ClientNumber>
<ClientUid>1152921504606989357<ClientUid>
<ClientName>S-Miles Corporation<ClientName>
<InactiveFlag>false<InactiveFlag>
<ParentClientIdentity i:nil="true"/>
</PwsClientSummary>
<PwsClientSummary>
<ClientId i:nil="true"/>
<ClientNumber>C000116<ClientNumber>
<ClientUid>1152921504606989620<ClientUid>
<ClientName>Cat World<ClientName>
<InactiveFlag>false<InactiveFlag>
<ParentClientIdentity i:nil="true"/>
</PwsClientSummary>
<PwsClientSummary>
<ClientId i:nil="true"/>
<ClientNumber>C000118<ClientNumber>
<ClientUid>1152921504606989807<ClientUid>
<ClientName>Acme 100<ClientName>
<InactiveFlag>false<InactiveFlag>
<ParentClientIdentity i:nil="true"/>
</PwsClientSummary>
<PwsClientSummary>
<ClientId i:nil="true"/>
<ClientNumber>C000119<ClientNumber>
<ClientUid>1152921504606989815<ClientUid>
<ClientName>Hedgehog Gardening<ClientName>
<InactiveFlag>false<InactiveFlag>
<ParentClientIdentity i:nil="true"/>
</PwsClientSummary>
<PwsClientSummary>
<ClientId i:nil="true"/>
<ClientNumber>C001000<ClientNumber>
<ClientUid>1152921504606989813<ClientUid>
<ClientName>Acme 1000-01<ClientName>
<InactiveFlag>false<InactiveFlag>
<ParentClientIdentity>
<ClientId i:nil="true"/>
<ClientNumber>C000118<ClientNumber>
<ClientUid>1152921504606989807<ClientUid>
</ParentClientIdentity>
</PwsClientSummary>
<PwsClientSummary>
<ClientId i:nil="true"/>
<ClientNumber>C001001<ClientNumber>
<ClientUid>1152921504606989814<ClientUid>
<ClientName>Acme 1000-02<ClientName>
<InactiveFlag>false<InactiveFlag>
<ParentClientIdentity i:nil="true"/>
</PwsClientSummary>
<PwsClientSummary>
<ClientId i:nil="true"/>
<ClientNumber>CL0009<ClientNumber>
<ClientUid>1152921504606984049<ClientUid>
<ClientName>Target<ClientName>
<InactiveFlag>false<InactiveFlag>
<ParentClientIdentity i:nil="true"/>
</PwsClientSummary>
<PwsClientSummary>
<ClientId i:nil="true"/>
<ClientNumber>CL0010<ClientNumber>
<ClientUid>1152921504606984050<ClientUid>
<ClientName>W6 Airlines<ClientName>
<InactiveFlag>false<InactiveFlag>
<ParentClientIdentity i:nil="true"/>
</PwsClientSummary>
<PwsClientSummary>
<ClientId i:nil="true"/>
<ClientNumber>Projector PSA<ClientNumber>
<ClientUid>1152921504606961482<ClientUid>
<ClientName>Projector PSA<ClientName>
<InactiveFlag>false<InactiveFlag>
<ParentClientIdentity i:nil="true"/>
</PwsClientSummary>
<PwsClientSummary>
<ClientId i:nil="true"/>
<ClientNumber>revcorp-bb<ClientNumber>
<ClientUid>1152921504606944619<ClientUid>
<ClientName>revcorp-bb<ClientName>
<InactiveFlag>false<InactiveFlag>
<ParentClientIdentity i:nil="true"/>
</PwsClientSummary>
<PwsClientSummary>
<ClientId i:nil="true"/>
<ClientNumber>C736718<ClientNumber>
<ClientUid>1152921504606967386<ClientUid>
<ClientName>Concrete Research and Development<ClientName>
<InactiveFlag>false<InactiveFlag>
<ParentClientIdentity i:nil="true"/>
</PwsClientSummary>
<PwsClientSummary>
<ClientId i:nil="true"/>
<ClientNumber>12938028212<ClientNumber>
<ClientUid>1152921504606960351<ClientUid>
<ClientName>Constellations Inc.<ClientName>
<InactiveFlag>false<InactiveFlag>
<ParentClientIdentity i:nil="true"/>
</PwsClientSummary>
<PwsClientSummary>
<ClientId i:nil="true"/>
<ClientNumber>12938028213<ClientNumber>
<ClientUid>1152921504606966758<ClientUid>
<ClientName>Orion Inc.<ClientName>
<InactiveFlag>false<InactiveFlag>
<ParentClientIdentity>
<ClientId i:nil="true"/>
<ClientNumber>12938028212<ClientNumber>
<ClientUid>1152921504606960351<ClientUid>
</ParentClientIdentity>
</PwsClientSummary>
<PwsClientSummary>
<ClientId i:nil="true"/>
<ClientNumber>12938028214<ClientNumber>
<ClientUid>1152921504606966759<ClientUid>
<ClientName>Milky Way Inc.<ClientName>
<InactiveFlag>false<InactiveFlag>
<ParentClientIdentity>
<ClientId i:nil="true"/>
<ClientNumber>12938028212<ClientNumber>
<ClientUid>1152921504606960351<ClientUid>
</ParentClientIdentity>
</PwsClientSummary>
</Clients>
</PwsGetClientListResult>
</PwsGetClientListResponse>
<PwsGetClientListResponse>
<PwsGetClientListResult>
<Messages>
<PwsMessage>
<AdditionalErrorText i:nil="true"/>
<ErrorCode i:nil="true"/>
<ErrorNumber i:nil="true"/>
<ErrorText i:nil="true"/>
<Type i:nil="true"/>
<ReferenceId1 i:nil="true"/>
<ReferenceId2 i:nil="true"/>
</PwsMessage>
</Messages>
<ResponseId>1</ResponseId>
<Status>Ok</Status>
<ServerTimestampUtc>2017-12-27T18:23:22.3881313Z</ServerTimestampUtc>
<Clients>
<PwsClientSummary>
<ClientId i:nil="true"/>
<ClientNumber>Projector PSA</ClientNumber>
<ClientUid>1152921504606961482</ClientUid>
<ClientName>Projector PSA</ClientName>
<InactiveFlag>false</InactiveFlag>
<ParentClientIdentity i:nil="true"/>
</PwsClientSummary>
</Clients>
</PwsGetClientListResult>
</PwsGetClientListResponse>
PwsGetClientList - Common Errors and Warnings
| ErrorCode | ErrorNumber | ErrorText |
|---|
| 104 | RowCountExceeded | Row count limit exceeded |
| 10100 | MaxRowsToReturnOutOfRange | Invalid value specified for MaxRowsToReturn |
| 50045 | ViewPermissionDenied | Permission denied |
| 57629 | ClientNotFound | Specified client not found |
| 57633 | UnexpectedErrorRetrievingClientList | Unexpected error retrieving client list |