GET api/Prospect
Authorization
Access to this endpoint is public.
Request Information
URI Parameters
None.
Body Parameters
PearsonEnglish.LearningServices.Data.Models.Prospects.ProspectFilterParameters| Name | Description | Type | Additional information |
|---|---|---|---|
| CenterId | globally unique identifier |
None. |
|
| SortInfo | SortInfoOfPearsonEnglish.LearningServices.Data.Models.Prospects.Prospect |
None. |
|
| PaginationInfo | PearsonEnglish.LearningServices.Core.Models.PaginationInfo |
None. |
|
| SearchPhrase | string |
None. |
|
| CompanyId | globally unique identifier |
None. |
|
| IsPlacementTestCompleted | boolean |
None. |
|
| RegisteredFrom | date |
None. |
|
| RegisteredUntil | date |
None. |
Request Formats
application/json, text/json
Sample:
{
"CenterId": "89930a21-056c-4d94-80fc-70d699325388",
"SortInfo": {
"SortBy": "sample string 1",
"Direction": 0
},
"PaginationInfo": {
"Count": 1,
"Offset": 2
},
"SearchPhrase": "sample string 2",
"CompanyId": "3ceb758a-02ea-4b98-b000-be3187d6140a",
"IsPlacementTestCompleted": true,
"RegisteredFrom": "2025-04-04T05:55:51.0348111+00:00",
"RegisteredUntil": "2025-04-04T05:55:51.0348111+00:00"
}
Response Information
Resource Description
PagedCollectionOfPearsonEnglish.LearningServices.Wse.Models.Prospects.ProspectListItem| Name | Description | Type | Additional information |
|---|---|---|---|
| TotalItemCount | integer |
None. |
|
| Elements | Collection of PearsonEnglish.LearningServices.Wse.Models.Prospects.ProspectListItem |
None. |
Response Formats
application/json, text/json
Sample:
Sample not available.