Creating an e-learning record
After learners have been enrolled in an e-learning course, the final step is to assign a grade to each learner by creating a learning record.
This endpoint requires a request body that includes "learnerId", "grade", and "completed" for a successful call. E-learning courses only consider grades that reflect a successful performance, therefore "grade" will only accept a value of "PASSED". The "completed" field marks the date of course completion in ISO8601 format. It must occur after the enrollment date.
The field "notes" is not required but can be included to record additional comments regarding the learner's performance.
Request Body Example and Schema
- Example
{
"learnerId": "string",
"grade": "PASSED",
"completed": "2023-10-24T12:42:41.090Z",
"notes": "string"
}
Getting a list of enrolled learners in an e-learning course
By calling this endpoint we can confirm which learners have been enrolled in the course and retrieve useful information about them such as the "enrollmentId", and information about the learner such as their "id", "firstname", "lastname", "contact" information, as well as "employer" information.
Responses Example
- Example
[
{
"id": "string",
"learner": {
"id": "string",
"firstname": "string",
"lastname": "string",
"email": "string",
"phone": "string"
},
"employer": {
"id": "string",
"name": "string"
},
"enrolledAt": "2023-11-02T12:34:34.890Z"
}
]
Verfying learning records for an e-learning course
Check the learning records for an e-learning course by calling this endpoint. The response will return an array of learning records with information including the "learningRecordId", "result" as well as information about the "learner"
Responses Example
- Example
[
{
"id": "string",
"result": "PASSED",
"notes": "string",
"learner": {
"id": "string",
"firstname": "string",
"lastname": "string",
"email": "string",
"phone": "string"
}
}
]