GET api/Prospect
Authorization
Access to this endpoint is public.
Request Information
URI Parameters
None.
Body Parameters
PearsonEnglish.LearningServices.Data.Models.Prospects.ProspectFilterParametersName | 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": "b126658a-60a3-4e1b-9548-2b5046bba350", "SortInfo": { "SortBy": "sample string 1", "Direction": 0 }, "PaginationInfo": { "Count": 1, "Offset": 2 }, "SearchPhrase": "sample string 2", "CompanyId": "cd1513d1-9f1d-45d5-b913-c1a2e998e90f", "IsPlacementTestCompleted": true, "RegisteredFrom": "2024-10-05T09:28:09.1099468+00:00", "RegisteredUntil": "2024-10-05T09:28:09.1099468+00:00" }
Response Information
Resource Description
PagedCollectionOfPearsonEnglish.LearningServices.Wse.Models.Prospects.ProspectListItemName | 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.