Retrieve Class

API Documentation

Retrieve Class

The GetClass API retrieves class information for the class ID.

Endpoint:

Get /
/api/v1/Class

Request Parameters

Id Int (Optional)

The Id of the class.

Response

Id Int(Not Nullable)

The class’s unique identifier

Name String(Not Nullable)

The class’s name

Course Name String(Not Nullable)

The class’s course name

Description String(Nullable)

The class’s Description

HtmlDescription String(Nullable)

The class’s HTML Description

Enabled Boolean(Not Nullable)

Gives the class’s status

ConfirmationStatusId Int(Not Nullable)

Gives the class’s ConfirmationStatusId

0 = Scheduled

1 = GuaranteedToRun

2 = Cancelled

3 = Rescheduled

4 = Tentative

5 = Requested

6 = Denied

7 = Completed

CourseId Int(Not Nullable)

The class’s course identifier

organizationId Int(Not Nullable)

The class’s organization identifier

CompanyId Int(Nullable)

The class’s company identifier

DeliveryTypeId Int(Not Nullable)

The class’s delivery identifier

1 = Physical

PrimaryInstructorId Int(Nullable)

The class’s primaryInstructor identifier

Start DateTime (Not Nullable)

When the class starts

End DateTime (Not Nullable)

When the class ends

MinStudents Int(Not Nullable)

The minimum the number of students enrolled

MaxStudents Int(Not Nullable)

The the maximum number of students enrolled

EnableEnrollmentNotifications Boolean(Not Nullable)

Distinguishes if enrollment notifications are enabled

TimeZoneId String(Not Nullable)

The class timezone, or the timezone of the organization the class belongs to

SessionTimes Array of ClassSession (Not Nullable)

See ClassSession

ShortName String(Nullable)

Title of the course

CoursewareProvider String(Nullable)

Courseware vendor provider

CreatedById (Not Nullable)

Id of the user who created

LastModifiedById Int(Not Nullable)

ID of the user who last modified the record

TrainingFormats String(Not Nullable)

Formats in which training is provided (e.g., InstructorLed)

Number Of Sessions Int(Not Nullable)

Count of session times

Enrolled String(Not Nullable)

Number of enrolled students to the class

RemainingSeats Int(Not Nullable)

Need to calculate Count of remaining seats

WaitListCount Int(Not Nullable)

Wait list count

				
					{
  "Name": "Test course for center wise course testing 05Dec",
 "CourseId": 57415,
  "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"
    }
  ]
}

Objects

CustomfieldResult

PropertyTypeNullableNote
NameStringNot Nullable

Name of the field.

TextValueStringNot Nullable

Text Value of the field

ClassSession

PropertyTypeNullableNote
StartDateTimeNot Nullable

When the class starts.

EndDateTimeNot Nullable

When the class ends.