Retrieve class enrollment information by id
- 16 Jul 2024
- 1 Minute to read
- Print
Retrieve class enrollment information by id
- Updated on 16 Jul 2024
- 1 Minute to read
- Print
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/GetClassEnrollment/{id}
Allows you to get basic information about a class enrollment.
Security
API Key
Header parameter nameapi_key
Path parameters
id
stringRequired
The ID of the class enrollment to retrieve
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).
Results
Array of object (ClassEnrollment)
See ClassEnrollment
object
Id
integer (int32)
The class enrollment's unique identifier
Example10
ExternalId
string | null
The class enrollment's external ID, usually a unique identifier from the calling system
ExampleE3G5YZFREFEQ9371
UserId
integer (int32)
The Id of the related user
Example897615
ClassId
integer (int32)
The Id of the related class
Example4421
EnrollmentStatusId
integer (int32)
Indicates the status of the class enrollment
- 0 = Request
- 10 = Cancel
- 20 = Waitlist
- 30 = Approve
- 40 = Deny
- 50 = Audit
- 60 = Enroll
Example60
CompletionStatusId
integer (int32)
Indicates the completion status of the class enrollment
- 0 = Unknown
- 10 = Attending
- 20 = Complete
- 30 = Incomplete
- 40 = NoShow
- 50 = Failed
Example0
LateCancel
boolean
Indicates if the class enrollment was cancelled outside the late cancellation window.
ExampleFalse
Retake
boolean
Indicates if the class enrollment is a retake.
ExampleFalse
LocationTypeId
integer (int32) | null
Indicates the location type that the student is assigned to attend the class
- 0 = To Be Determined
- 10 = Classroom
- 20 = Remote Classroom
- 30 = Virtual
Example0
ClassroomId
integer (int32) | null
The ID of the classroom (if any) in which the student is assigned to attend the class.
Example3456
HoursSpent
integer (int32) | null
The hours spent by the student in the class enrollment.
Example20
Grade
integer (int32) | null
The grade the student received for the class enrollment.
Example10
CustomFields
Array of object
Custom Fields that have values for the user
Example[ { "Name": "Unique Text", "TextValue": "AXY12345", "CustomFieldId": 5089 }, { "Name": "Unique Number", "TextValue": "44", "CustomFieldId": 5090 }, { "Name": "Dropdown-01", "TextValue": "Second Choice", "CustomFieldId": 5087 } ]
object
Name
string
The name that is given to this custom field
TextValue
string
The text value for this field can be updated using the /UpdateClassEnrollmentCustomFieldValue API endpoint.
CustomFieldId
integer (int32)
The Custom Field's system generated unique id.
Was this article helpful?