Create Class

API Documentation

Create Class

The CreateClass API creates a class in the LMS, corresponding to the Course Id provided.

Endpoint:

Post /
/api/v1/Class

Request Parameters

CourseId Int (Required)

The class’s course identifier.

MinStudents Int (Required)

The minimum the number of students enrolled.

MaxStudents Int (Required)

The maximum the number of students enrolled.

DeliveryTypeId Int (Required)

The class’s delivery identifier

1 = Physical

SessionTimes Array of ClassSession (Required)

See ClassSession

Name String (Required)

The class’s name

ConfirmationStatusId Int (Optional)

Gives the class’s ConfirmationStatusId

0 = Scheduled

1 = GuaranteedToRun

2 = Cancelled

3 = Rescheduled

4 = Tentative

5 = Requested

6 = Denied

7 = Completed

PrimaryInstructorId Int (Optional)

The class’s primaryInstructor identifier

EnableEnrollmentNotifications Boolean (Required)

Distinguishes if enrollment notifications are enabled

ClassSessions DateTime (Required)

Start time of the class.
EndTime of the class.

				
					{
  "CourseId": 57415,
  "Name": "Test course for center wise course testing 05Dec",
  "MinStudents": 1,
  "MaxStudents": 16,
  "DeliveryTypeId": 1,
  "ConfirmationStatusId": 1,
  "PrimaryInstructorId": 543,
  "EnableEnrollmentNotifications": false,
  "SessionTimes": [
    {
      "Start": "2023-02-09 11:01:01",
      "End": "2023-02-09 13:01:01"
    },
    {
      "Start": "2023-02-10 11:01:01",
      "End": "2023-02-10 13:01:01"
    },
    {
      "Start": "2023-02-11 11:01:01",
      "End": "2023-02-11 11:01:01"
    }
  ]
}

Response

(Nullable)
				
					{
  "success": true,
  "message": "Record created successfully.",
  "data": 213122
}