Overview
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).
Request Format
PwsGetCompanyList Request
- PwsGetCompanyList
- serviceRequest: PwsGetCompanyListRq
- RequestId: Int32
- SessionTicket: String
- CompanyIdentity: PwsCompanyRef
- MaxRowsToReturn: Int32
- QueryString: String
- serviceRequest: PwsGetCompanyListRq
Request Elements
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
RequestId | Int32 |
|
| Click here for more information. |
|
SessionTicket | String |
|
| Click here for more information. |
|
CompanyIdentity |
|
|
|
| |
MaxRowsToReturn | Int32 |
|
|
|
|
QueryString | String |
|
|
|
|
Request Usage Example(s)
Response Format
PwsGetCompanyList Response
- PwsGetCompanyListResponse
- PwsGetCompanyListResult: PwsGetCompanyListRs
- Messages: PwsMessage
- ResponseId: Int32
- Status: RequestStatus
- ServerTimestampUtc: DateTime
- Companies: PwsCompanySummary
- PwsGetCompanyListResult: PwsGetCompanyListRs
Response Elements
Element | Data Type | Description | Sample Data |
|---|---|---|---|
Messages |
|
| |
ResponseId | Int32 | Click here for more information. |
|
Status | RequestStatus | Click here for more information. |
|
ServerTimestampUtc | DateTime | Click here for more information. |
|
Companies |
|
|
Response Usage Example(s)
Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
| ErrorNumber | ErrorCode | ErrorText |
|---|---|---|