POST centers/{centerId}/prospects

Authorization

Access to this endpoint is granted if all following conditions are true:

Authenticated user belongs to center which matches identifier given in "centerId" uri parameter.
Authenticated user who is either StaffMember

Request Information

URI Parameters

Name	Description	Type	Additional information
centerId		globally unique identifier	Required

Body Parameters

PearsonEnglish.LearningServices.Wse.Models.Prospects.ProspectParameters

Name	Type	Additional information
FirstName	string	None.
LastName	string	None.
Email	string	None.
Password	string	None.
CompanyId	globally unique identifier	None.
CenterId	globally unique identifier	None.
ShowPlacementResultFlag	boolean	None.
PhoneNumber	string	None.
IsB2bProspect	boolean	None.
Trial	PearsonEnglish.LearningServices.Wse.Models.Prospects.ProspectTrialParameters	None.
PlacementTestEntryPoint	PearsonEnglish.LearningServices.Core.Models.Enums.PlacementTestEntryPoint	None.

Request Formats

application/json, text/json

Sample:

{
  "FirstName": "sample string 1",
  "LastName": "sample string 2",
  "Email": "sample string 3",
  "Password": "sample string 4",
  "CompanyId": "9c389610-e19e-4edc-ba25-c4f6f1351bcb",
  "CenterId": "828e0d78-fd3c-41f7-a2ca-4b23e80fd7ee",
  "ShowPlacementResultFlag": true,
  "PhoneNumber": "sample string 6",
  "IsB2bProspect": true,
  "Trial": {
    "Enabled": true,
    "StartDate": "2024-10-05T09:20:34.0529166+00:00",
    "EndDate": "2024-10-05T09:20:34.0529166+00:00",
    "CenterId": "9a6f0538-6377-44df-9f45-1383fe3c101d",
    "UnitNumber": 1,
    "OnboardingEnabled": true
  },
  "PlacementTestEntryPoint": 0
}

Response Information

Resource Description

System.Web.Http.IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.