In the Learn365 API, it’s possible to update the registration (enrollment) information displayed in a learner's transcript.
To update registration information, you'll need the enrollment ID. You can find this via the API by following the steps in this article.
To update registration information via API:
1. Go to https://api.365.systems/ and make sure you are authorized with the relevant API key.
2. In the Enrollments section, select the PATCH /odata/v2/Enrollments({Id}) endpoint and select Try it out in the top right-hand corner.
3. In the required Id field, enter the enrollment ID.
4. In the Enrollment object, which is a request body:
- Delete the entire row for properties you don't want to update.
- To change the registration date, start date, completion date, or due date, enter the new date in the correct format, like 2024-01-15T15:00:00.00Z.
- To change the course passing status, enter 0 for Completed, 1 for Not Started, or 2 for In Progress.
- To change the number of CEUs, in the CEU field, enter the relevant number. If the course is Not Started or In Progress, CEUs are awarded after the course is completed. If the course is Completed, CEUs are awarded instantly.
- In the CourseDuration field, enter the course duration in minutes.
The request body might look like this.
{
"RegistrationDate": "2024-01-15T15:00:00.00Z",
"StartDate": "2024-02-15T15:00:00.00Z",
"CompletionDate": "2024-03-15T15:00:00.00Z",
"CoursePassingStatus": 0,
"CEU": "20",
"CourseDuration": 60,
"DueDate": "2024-04-15T15:00:00.00Z"
}
5. Select Execute to run the request.
6. Go to the Responses block to check the results:
- 204 code with an empty body means the successful response.
- In case of an error, the response body contains the error object with the code and message keys explaining the issue.
You can track the updated enrollment information in View Learner's Transcript and View Learner's Progress in the Learn365 Admin Center, as well as in the downloaded progress reports.
Comments
Article is closed for comments.