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.ProspectParametersName | Description | Type | Additional information |
---|---|---|---|
FirstName | string |
None. |
|
LastName | string |
None. |
|
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": "d56e32b7-c44d-4748-88ab-e1a57de2d542", "CenterId": "b7acca06-8ab4-46a5-9d16-160c66f45ed7", "ShowPlacementResultFlag": true, "PhoneNumber": "sample string 6", "IsB2bProspect": true, "Trial": { "Enabled": true, "StartDate": "2024-10-05T09:22:52.2500002+00:00", "EndDate": "2024-10-05T09:22:52.2500002+00:00", "CenterId": "dbbb5f82-9bd0-4aee-ba6d-df8716ed6dc7", "UnitNumber": 1, "OnboardingEnabled": true }, "PlacementTestEntryPoint": 0 }
Response Information
Resource Description
System.Web.Http.IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.