Retrieve Class Enrollment

API Documentation

Retrieve Class Enrollment

The Get ClassEnrollment API retrieves class enrollment information for the ID provided as parameter.

Endpoint:

Get /
/api/v1/ClassEnrollment/{classEnrolmentID}

Request Parameters

Id Int (Required)

The Id of the classEnrollment to retrieve.

Response

Id Int(Not Nullable)

The Id of the ClassEnrollment.

ExternalId String(Nullable)

The class enrollment’s external ID, usually a unique identifier from the calling system

UserId Int(Not Nullable)

The Id of the related user

ClassId Int(Not Nullable)

The Id of the related class

EnrollmentStatusId Int(Not Nullable)

Indicates the status of the class enrollment

0 = Request

10 = Cancel

20 = Waitlist

30 = Approve

40 = Deny

50 = Audit

60 = Enroll

CompletionStatusId Int(Not Nullable)

Indicates the completion status of the class enrollment

0 = Unknown

10 = Attending

20 = Complete

30 = Incomplete

40 = NoShow

50 = Failed

LateCancel Boolean(Not Nullable)

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

Retake Boolean(Not Nullable)

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

LocationTypeId Int(Not Nullable)

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 Int(Nullable)

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

HoursSpend Int(Nullable)

The hours spent by the student in the class enrollment 

Grade Int(Nullable)

The grade the student received for the class enrollment

SurveyCompleted Boolean(Not Nullable)

Whether the user survey has been completed

CompanyId Int(Not Nullable)

The Id of the user’s company (set only if the user belongs to a company)

Address String(Not Nullable)

Address of the user

Email String(Not Nullable)

The user’s primary e-mail address

Name String(Not Nullable)

Name of the Course.

End DateTime(Not Nullable)

End date of the class enrollment

Start DateTime(Not Nullable)

End date of the class enrollment

TrainingFormats String(Not Nullable)

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

ClassName String(Not Nullable)

Name of the class

DeliveryType String(Not Nullable)

Type of delivery for the class (e.g., physical, virtual)

InvoiceID Int(Not Nullable)

InvoiceID of the payment type for the classenrollment.

				
					{
  "success": true,
  "message": "Record retrieved successfully.",
  "data": {
    "Id": 45632,
    "ExternalId": "E3G5YZFREFEQ9371",
    "ClassId": 4421,
    "UserId": "897615",
    "EnrollmentStatusId": 60,
    "CompletionStatusId": 0,
    "LateCancel": false,
    "Retake": false,
    "LocationTypeId": 0,
    "ClassroomId": null,
    "HoursSpent": 20,
    "Grade": null,
    "SurveyCompleted": false,
    "CompanyId": 76554,
    "Address": "pune",
    "PrimaryEmail": "test123@gmail.com",
    "Name": "Java",
    "End": "2009-12-14",
    "LastModifiedById": 76,
    "TrainingFormats": "Instructor-Led",
    "ClassName": "soft skill",
    "DeliveryType": "",
    "InvoiceID": 86252,
    "Start": "2009-12-14"
  }
}