...
This web service retrieves a list of client summary records (PwsClientSummary), based on specified search criteria. You can specify which client or clients to retrieve either by specifying a set of search criteria, or by specifying a specific client (PwsClientRef). The web service returns a list of clients (PwsClientSummary).
Request Format
| Panel |
|---|
| title | PwsGetClientList Request |
|---|
|
|
...
| 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. | AavFwbZgVb9V4tr3R7BbzQ== |
| ClientIdentity | PwsClientRef | No |
| For this service, the caller may specify up to 1 client identitya client identity to retrieve a specific client summary. If a client identity is not specified all clients fitting the other specified criteria will be returned. |
|
| IncludeInactiveFlag | Boolean | No | falseValid | values for this field include "true" or "false". If set to 'true', inactive clients will be included in the response. This flag is disregarded if a client is specified in ClientIdentity. | true/false |
| MaxRowsToReturn | Int32 | No | infinite |
| Maximum The maximum number of clients to be returned. This value is disregarded if a client is specified in ClientIdentity. | 100 |
| QueryString | String (255) | No | Find all clients matching specified string in client name or client number. |
| A search string to narrow down the results. A client will be included in the results if the search string matches the client number or client name, or if it is a child to a client that is matched based upon the criteria. This value is disregarded if a client is specified in ClientIdentity. | Parent |
| LastUpdatedSinceTimestamp | DateTime | No |
| Only clients that have been updated on or after the specified date/time will be retrieved. This value is disregarded if a client is specified in ClientIdentity. | 2018-01-01 |
Request Usage Example(s)
| Code Block |
|---|
| language | xml |
|---|
| title | Example 01 - Client is not specified |
|---|
| collapse | true |
|---|
|
<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>
<PwsGetClientList> <pws:PwsGetClientList>
<serviceRequest><pws:serviceRequest>
<RequestId>1<<req:RequestId>1</req:RequestId>
<SessionTicket>AcjOqKSXoUYG3qLkrxKQYw<req:SessionTicket>AavFwbZgVb9V4tr3R7BbzQ==</req:SessionTicket>
<IncludeInactiveFlag>true<<req:IncludeInactiveFlag>false</req:IncludeInactiveFlag>
<MaxRowsToReturn>100<<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> |
| Code Block |
|---|
| language | xml |
|---|
| title | Example 02 - Client is specified |
|---|
| collapse | true |
|---|
|
<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>
<PwsGetClientList> <pws:PwsGetClientList>
<serviceRequest><pws:serviceRequest>
<RequestId>2<<req:RequestId>1</req:RequestId>
<SessionTicket>AcjOqKSXoUYG3qLkrxKQYw<req:SessionTicket>AavFwbZgVb9V4tr3R7BbzQ==</req:SessionTicket>
<ClientIdentity><req:ClientIdentity>
<ClientNumber>Projector PSA</<com:ClientNumber>C000121</com:ClientNumber>
</req:ClientIdentity>
<IncludeInactiveFlag>true<<req:IncludeInactiveFlag>false</req:IncludeInactiveFlag>
</pws:serviceRequest>
</pws:PwsGetClientList>
</soapenv:Body>
</soapenv:Envelope> |
Response Format
Response Elements
| Element | Data Type | Description | Sample Data |
|---|
| Messages | PwsMessage[] | The web service response status and Messagemessage. Click here for more information |
|
| ResponseId | Int32 | Click here for more information. | 1 |
| Status | StringRequestStatus | Click here for more infomration.information | Ok |
| ServerTimestampUtc | DateTime | Click here for more informaton | 2018-01-17T19:52:55.4411759Z |
| Clients | PwsClientSummaryClient Summary Record[] | The client summary record(s) retrieved by the service. |
|
Response Usage Example(s)
...
| Code Block |
|---|
| language | xml |
|---|
| title | Example 01 |
|---|
| collapse | true |
|---|
|
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<PwsGetClientListResponse><s:Body>
<PwsGetClientListResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
<PwsGetClientListResult> <PwsGetClientListResult xmlns:a="http://projectorpsa.com/DataContracts/Responses/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Messages> <Messages xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
<PwsMessage> <ResponseId xmlns="http://projectorpsa.com/CommonServices/">1</ResponseId>
<AdditionalErrorText<Status i:nilxmlns="true"/>http://projectorpsa.com/CommonServices/">Ok</Status>
<ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-01-17T19:52:55.4411759Z</ServerTimestampUtc>
<ErrorCode i:nil="true"/ <a:Clients xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:PwsClientSummary>
<ErrorNumber <b:ClientId i:nil="true"/>
<b:ClientNumber>C000121</b:ClientNumber>
<ErrorText i:nil="true"/> <b:ClientUid>1152921504606998462</b:ClientUid>
<Type i:nil="true"/><b:ClientName>Parent Inc.</b:ClientName>
<ReferenceId1 i:nil="true"/><b:InactiveFlag>false</b:InactiveFlag>
<ReferenceId2<b:ParentClientIdentity i:nil="true"/>
</PwsMessage>b:PwsClientSummary>
</Messages><b:PwsClientSummary>
<ResponseId>2</ResponseId> <b:ClientId i:nil="true"/>
<Status>Ok</Status> <ServerTimestampUtc>2017-12-27T18:23:22.3881313Z</ServerTimestampUtc><b:ClientNumber>C000123</b:ClientNumber>
<b:ClientUid>1152921504606998464</b:ClientUid>
<Clients> <PwsClientSummary>
<b:ClientName>Child Inc.</b:ClientName>
<ClientId i:nil="true"/><b:InactiveFlag>false</b:InactiveFlag>
<b:ParentClientIdentity>
<ClientNumber>Projector PSA</ClientNumber> <ClientUid>1152921504606961482</ClientUid><b:ClientId i:nil="true"/>
<ClientName>Projector PSA</ClientName><b:ClientNumber>C000121</b:ClientNumber>
<InactiveFlag>false</InactiveFlag><b:ClientUid>1152921504606998462</b:ClientUid>
<ParentClientIdentity i:nil="true"/></b:ParentClientIdentity>
</b:PwsClientSummary>
</a:Clients>
</PwsGetClientListResult>
</PwsGetClientListResponse>
</s:Body>
</s:Envelope>
|
PwsGetClientList - Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
| ErrorNumber | ErrorCodeErrorNumber | 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 |