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
PwsGetTitleList Request
- PwsGetTitleList
- serviceRequest: PwsGetTitleListRq
- RequestId: Int32
- SessionTicket: String
- IncludeInactiveFlag: Boolean
- MaxRowsToReturn: Int32
- QueryString: String
- TitleIdentity: PwsTitleRef
- serviceRequest: PwsGetTitleListRq
Request Elements
Element | Data Type | Required? | Default | Description | Sample Data |
---|---|---|---|---|---|
RequestId | Int32 | Click here for more information. | |||
SessionTicket | String | Click here for more information. | |||
IncludeInactiveFlag | Boolean | ||||
MaxRowsToReturn | Int32 | ||||
QueryString | String | ||||
TitleIdentity |
Request Usage Example(s)
Response Format
PwsGetTitleList Response
- PwsGetTitleListResponse
- PwsGetTitleListResult: PwsGetTitleListRs
- Messages: PwsMessage[]
- ResponseId: Int32
- Status: RequestStatus
- ServerTimestampUtc: DateTime
- Titles: PwsTitleSummary
- PwsGetTitleListResult: PwsGetTitleListRs
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. |
|
Titles |
|
|
Response Usage Example(s)
PwsGetClientList - Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
ErrorNumber | ErrorCode | ErrorText |
---|---|---|