POST openapi/classes/{refClassId}/book?carryOver={carryOver}

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
refClassId

string

Required

carryOver

boolean

Default value is False

Body Parameters

PearsonEnglish.LearningServices.Wse.Models.ClassBookParameters
NameDescriptionTypeAdditional information
ClassId

string

None.

ClassType

PearsonEnglish.LearningServices.Core.Models.Enums.ClassTypes

None.

UnitLevel

integer

None.

Categories

Collection of string

None.

StudentId

globally unique identifier

None.

Index

string

None.

Override

boolean

None.

BookingUserName

string

None.

Source

PearsonEnglish.LearningServices.Core.Models.Enums.ApiCallerSource

None.

IsMLTPEnabledPilotCenter

boolean

None.

IsCrossCenterGroupClass

boolean

None.

BookedMode

PearsonEnglish.LearningServices.Core.Models.Enums.BookModes

None.

ClassToBeBooked

PearsonEnglish.LearningServices.Data.DataModels.Class

None.

CurrentAndFutureRegistrations

Collection of PearsonEnglish.LearningServices.Data.DataModels.Registration

None.

Request Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

Response Information

Resource Description

PearsonEnglish.LearningServices.Wse.Models.ApiProxyResponse
NameDescriptionTypeAdditional information
Code

integer

None.

Message

string

None.

Fields

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Code": 1,
  "Message": "sample string 2",
  "Fields": "sample string 3"
}