Update registration details via API

Introduction

The LMS365 (Learn365) API enables you to update the registration information displayed in a learner's transcript.

This article describes how to update registration information via API.

 

Update registration details

Required role: Catalog admin or course admin

To be able to use the LMS365 (Learn365) API, you should be authorized with the relevant API key on https:/api.365.systems.

1. In https:/api.365.systems, expand the Enrollments section.

2. Select the PATCH /odata/v2/Enrollments({Id}) endpoint and Try it out.

 

Patch an enrollment, try it out

 

3. In the required key: Id field, paste the enrollment ID. For information about how to get the enrollment ID via the API, see this article.

4. In the Enrollment field, update the data of the relevant properties.

 

NOTE   

If the code of the last property you want to update has a comma at the end of it, remove it otherwise the update won't execute.

 

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.

To change the course passing status, specify:

  • 0 for Completed.
  • 1 for Not Started.
  • 2 for In Progress.

To change the number of CEUs, 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.

 

Patch enrollments request

7. Select Execute to run the request.

8. Go to the Responses block to see the results.

  • Code 2xx (for example, 200) shows that the request worked correctly.
  • You can Download the data from the response to your device .JSON format.

 

Patch enrollment response

You can track the updated enrollment information in View Learner's Transcript and View Learner's Progress in the LMS365 (Learn365) Admin Center, as well as in the downloaded progress reports.

 

NOTE   

If the requested updates fail to execute or an improper response is returned, try clearing the cache, deleting cookies in the browser, and reloading the page, then executing the method again.

 

Was this article helpful?
0 out of 0 found this helpful

Comments

Article is closed for comments.