PUT centers/{centerId}/prospects/{prospectId}

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

NameDescriptionTypeAdditional information
centerId

globally unique identifier

Required
prospectId

globally unique identifier

Required

Body Parameters

PearsonEnglish.LearningServices.Wse.Models.Prospects.ProspectTrialParameters
NameDescriptionTypeAdditional information
Enabled

boolean

None.
StartDate

date

None.
EndDate

date

None.
CenterId

globally unique identifier

None.
UnitNumber

integer

None.
OnboardingEnabled

boolean

None.

Request Formats

application/json, text/json

Sample: 
{
  "Enabled": true,
  "StartDate": "2024-10-05T09:27:53.5737898+00:00",
  "EndDate": "2024-10-05T09:27:53.5737898+00:00",
  "CenterId": "bf572eb1-dbf1-4cbc-8c5f-e817363c4b35",
  "UnitNumber": 1,
  "OnboardingEnabled": true
}

Response Information

Resource Description

System.Web.Http.IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.