POST classes/{classId}/book?carryOver={carryOver}

Authorization

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

  • Authenticated user is a staff member and is assigned to the same center as a user who matches a student who is assigned to class book specified in body of request.
  • Authenticated user who is either StaffMember

Request Information

URI Parameters

NameDescriptionTypeAdditional information
classId

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"
}