Import external course record and a certificate for it via API

Introduction

External course records and certificates can be imported into LMS365 using the Import External Training option in the LMS365 Admin Center or via LMS365 API endpoints. This article describes how to import external course records and an associated certificate via API in three steps: import external course records, add a user's progress for these course records, and then add an associated certificate.

 

Import an external course record

To import an external training record via API, follow these steps:

1. Go to https://api.365.systems/ and make sure you are authorized with the relevant API key.

2. In the ExternalTrainings section, find the POST method /externalTrainings/importCourse with the Import course description and select Try it out.

3. Complete the fields, paying attention to the required parameters:

  • CourseCatalogId, a required parameter. Enter the ID of the catalog into which you want to import the external course record. Replace guid next to CourseCatalogId with the catalog ID.
  • Title, a required parameter. Enter title of you course if you want to create a record for a course that isn't already present in LMS365, or the ID of an existing LMS365 course. Replace string next to the title.
  • Categories, an optional parameter. Specify the categories you want to assign to the imported external course record. To specify Categories, you need to enter a key-value pair in {} for each category, where the key is the ID of the category and the value is the name of the category. Fir information on how to get the ID of a category and its name, see steps 1-2 of this article.
  • CourseType, an optional parameter. Set the type of the imported external course record. Available types are e-learning (number 1) and instructor-led training (number 3).

 

EXAMPLE

{
"CourseCatalogId": "1cc13181-ede9-4756-b13e-f60f8e1fdbfa",
"Title": "Master Of Projects",
"Categories":
[{"Id": "c0a6b190-b7ba-429e-af0e-043c5f1f3c21", "Name": "Imported"},
{"Id": "c60f50d2-bc4d-48e5-b3f8-1bef1c56d134", "Name": "Performance Management"}],
"CourseType": "1"
}

 

4. When ready, select Execute to run the request.

 

LMS365_API

 

5. Go to the Responses block to check the results.

  • Number 2xx (for example, 200) under Code shows that the request worked correctly. You can Download the data from the response to your computer in .JSON format.
  • In the Response body field, you can see the external course record that's been created in the tenant. At this stage, there is no progress associated with the imported external course record.
    From the response, you need to copy the ID of the imported external course because it's required to add users' progress and award them with a certificate.

 

LMS365_API

 

Add user's progress for the imported external course record

1. To add users' progress for the recently imported external course record, find the POST method /externalTrainings/importProgress with the Import progress description and select Try it out.

2. Complete the fields, paying attention to the required parameters:

  • CourseId, a required parameter. Enter the ID of the recently imported external course (see step 5 above) for which you want to add users' progress. Replace guid next to CourseId with the relevant course ID.
  • UserId, a required parameter. Enter the ID of the user for whom you want to add progress. Replace string next to the UserId.
  • CompletionDate, a required parameter. Specify the completion date for the user. By default, the CompletionDate field prepopulated with the current date and time.
  • Ceu, an optional parameter. Specify the number of CEUs you want to grant to the user.

 

EXAMPLE

{
"CourseId": "0d35358f-8cd0-456c-ac83-7f1f831f6a09",
"UserId": "0a8b66cc-c591-4d04-b1cb-16a04fd94113",
"CompletionDate": "2023-02-24T05:51:02Z",
"Ceu": "15"
}

 

3. When ready, select Execute to run the request.

 

LMS365_API

 

4. Go to the Responses block to check the results.

  • Number 2xx (for example, 200) under Code shows that the request worked correctly. You can Download the data from the response to your computer in .JSON format.
  • In the Response body field, you can see that completion progress and CEUs (if any) have been added for the selected user for the imported external course records. You can check the result in the LMS365 Admin Center as well as via Users > select the relevant user > View Learner's Transcript > Courses tab.
    Copy the value next to the Id parameter. This is the enrollment ID of the user for this imported external course record and is required later in the process to award the user with a certificate.

 

LMS365_API

 

Add a certificate associated with the imported external course record

1. In the ExternalTrainings section, find the POST method /externalTrainings/importCourse with the Import certificate description and then select Try it out.

2. Complete the fields, paying attention to the required parameters:

 


EXAMPLE

{
"EnrollmentId": "ae92dacf-ddbe-4838-a3ea-0c37277a0e4f",
"ExpiryDate": "2025-04-19T07:36:58Z",
"TemplateId": "139505da-e8f0-4ee7-a50e-9235601e8ce4"
}

 

Request_to_import_certificate_for_imported_course

 

3. When ready, select Execute to run the request.

4. Go to the Responses block to check the results:

  • Number 2xx (for example, 200) under Code shows that the request worked correctly. You can Download the data from the response to your computer in .JSON format.
  • In the Response body field, you can see that a certificate with a set template (if any) has been awarded to the selected user for the imported external course record. You can check the result in the LMS365 Admin Center as well as via Users > select the relevant user > View Learner's Transcript > Certificates tab.

 

Import_certificate_for_imported_course_response

 

Was this article helpful?
3 out of 11 found this helpful

Comments

Article is closed for comments.