GET openapi/students/{userIdentifier}/contracts/future/next?synchronizeUserData={synchronizeUserData}

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
userIdentifier

PearsonEnglish.LearningServices.Business.Helpers.UserIdentifier

Required

synchronizeUserData

boolean

Default value is True

Body Parameters

None.

Response Information

Resource Description

PearsonEnglish.LearningServices.Wse.Models.NextFutureRegistrationModel
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

ContractId

string

None.

EndDate

date

None.

StartDate

date

None.

ContractStatusLabel

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "e30a387f-123c-49e2-b340-cc0b9e1a096d",
  "ContractId": "sample string 2",
  "EndDate": "2024-10-05T09:27:08.3383163+00:00",
  "StartDate": "2024-10-05T09:27:08.3383163+00:00",
  "ContractStatusLabel": "sample string 5"
}