Create a class enrollment

  • Updated on Jul 16, 2024
  • 1 minute(s) read
Prev Next
Get
/CreateClassEnrollment

Allows you to create a class enrollment.

Security
API Key
Header parameter nameapi_key
Query parameters
externalId
string

The exernal ID of the class enrollment, usually a unique identifier from the calling system

classId
integer (int32) Required

The Id of the related class

userId
integer (int32) Required

The Id of the related user

enrollmentStatusId
stringRequired

Indicates the status of the class enrollment

  • 0 = Request
  • 10 = Cancel
  • 20 = Waitlist
  • 30 = Approve
  • 40 = Deny
  • 50 = Audit
  • 60 = Enroll
completionStatusId
stringRequired

Indicates the completion status of the class enrollment

  • 0 = Unknown
  • 10 = Attending
  • 20 = Complete
  • 30 = Incomplete
  • 40 = NoShow
  • 50 = Failed
lateCancel
boolean

Indicates if the class enrollment was cancelled outside the late cancellation window

retake
boolean

Indicates if the class enrollment is a retake

LocationTypeId
integer (int32)

Indicates the location type that the student is assigned to attend the class

  • 0 = To Be Determined
  • 10 = Classroom
  • 20 = Remote Classroom
  • 30 = Virtual
ClassroomId
integer (int32)

The ID of the classroom (if any) in which the student is assigned to attend the class

HoursSpent
integer (int32)

The hours spent by the student in the class enrollment

Grade
integer (int32)

The grade the student received for the class enrollment

Responses
200

OK Response

object
status
integer (int32)

Indicates the status of the API request.

  • 0 = Success
  • 10 = Error
  • 20 = Not found
  • 30 = Invalid integration key
Example10
error
string | null

Error details. This will only have a value if an error was encountered. The status property will also be set to Error (10).

ClassEnrollmentId
integer (int32)

The ID of the created class enrollment.

Example45632