GET api/Prospect

Authorization

Access to this endpoint is public.

Request Information

URI Parameters

None.

Body Parameters

PearsonEnglish.LearningServices.Data.Models.Prospects.ProspectFilterParameters

Name	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": "14216886-60a9-46e2-b0a6-81559c37cf5b",
  "SortInfo": {
    "SortBy": "sample string 1",
    "Direction": 0
  },
  "PaginationInfo": {
    "Count": 1,
    "Offset": 2
  },
  "SearchPhrase": "sample string 2",
  "CompanyId": "e6d6372e-f548-4276-8349-317bb7d8aaee",
  "IsPlacementTestCompleted": true,
  "RegisteredFrom": "2024-10-05T09:23:46.8993329+00:00",
  "RegisteredUntil": "2024-10-05T09:23:46.8993329+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.