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

Authorization

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

  • Authenticated territory has access to center which matches identifier given in "centerId" uri parameter.

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-12-20T13:50:53.1650427+00:00",
  "EndDate": "2024-12-20T13:50:53.1650427+00:00",
  "CenterId": "bda0d02f-557f-415a-874d-f4a07ee779fa",
  "UnitNumber": 1,
  "OnboardingEnabled": true
}

Response Information

Resource Description

System.Web.Http.IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.