Externe Kursunterlagen und ein zugehöriges Zertifikat per API importieren

Einführung

Externe Kursunterlagen und Zertifikate können in Learn365 importiert werden, wobei wahlweise die Option Externe Schulungsdaten importieren im Learn365 Admin Center oder Endpunkte in der Learn365-API verwendet werden können. Dieser Artikel beschreibt, wie man externe Kursunterlagen und ein zugehöriges Zertifikat per API importiert. Dabei sind drei Schritte durchzuführen: Importieren der externen Kursunterlagen, Hinzufügen des Fortschritts eines Benutzers für diese Kursunterlagen und abschließendes Hinzufügen eines zugehörigen Zertifikats.

 

Externe Kursunterlagen importieren

Gehen Sie wie folgt vor, um externe Schulungsunterlagen per API zu importieren:

1. Gehen Sie zu https://api.365.systems/, und vergewissern Sie sich, dass Sie mit dem entsprechenden API-Schlüssel autorisiert sind.

2. Suchen Sie im Abschnitt ExternalTrainings nach der POST-Methode /externalTrainings/importCourse mit der Beschreibung Import course und wählen Sie dann Try it out aus.

3. Füllen Sie die Felder aus und beachten Sie dabei die Pflichtparameter:

• CourseCatalogId ist ein Pflichtparameter. Geben Sie die ID des Katalogs ein, in den Sie die externen Kursunterlagen importieren möchten. Ersetzen Sie guid neben CourseCatalogId durch die Katalog-ID.
• Title ist ein Pflichtparameter. Hier geben Sie den Titel Ihres Kurses ein, wenn Sie einen Datensatz für einen Kurs erstellen möchten, der noch nicht in Learn365 vorhanden ist, oder aber die ID eines bestehenden Learn365-Kurses. Ersetzen Sie dazu string neben dem Titel.
  
• Categories ist ein optionaler Parameter. Hier geben Sie die Kategorien an, die Sie den importierten externen Kursunterlagen zuweisen möchten. Zum Angeben von Categories müssen Sie für jede Kategorie ein Schlüssel-Wert-Paar in {} eingeben, wobei der Schlüssel die Kategorie-ID und der Wert der Kategoriename ist. Informationen zum Abrufen der ID und des Namens einer Kategorie entnehmen Sie den Schritten 1 und 2 dieses Artikels.
• CourseType ist ein optionaler Parameter. Hiermit legen Sie den Typ der importierten externen Kursunterlagen fest. Zulässige Typen sind E-Learning (1) und veranstaltungsbasierte Schulung (3).

 

 

4. Wenn Sie bereit sind, wählen Sie Execute aus, um die Anfrage auszuführen.

 

 

5. Gehen Sie zum Block Response, um die Ergebnisse zu kontrollieren:

• Die Zahl 2xx (beispielsweise „200“) unter Code zeigt an, dass die Anfrage korrekt funktioniert hat. Über Download können Sie die Daten aus der Antwort im JSON-Format auf Ihren Computer herunterladen.
• Im Feld Response Body wird der externe Kursdatensatz angezeigt, der im Mandanten erstellt wurde. In diesem Stadium ist mit dem importierten externen Kursdatensatz noch kein Fortschritt verbunden.
  Kopieren Sie aus der Antwort die ID des importierten externen Kurses, denn diese benötigen Sie, um Angaben zum Fortschritt von Benutzern hinzuzufügen und Zertifikate zu verleihen.

 

 

Fortschritt von Benutzern für einen importierten externen Kursdatensatz hinzufügen

1. Zum Hinzufügen eines Benutzerfortschritts für kürzlich importierte externe Kursunterlagen suchen Sie die POST-Methode /externalTrainings/importProgress mit der Beschreibung Import progress und wählen Try it out aus.

2. Füllen Sie die Felder aus und beachten Sie dabei die Pflichtparameter:

• CourseId ist ein Pflichtparameter. Geben Sie die ID des kürzlich importierten externen Kurses (siehe Schritt 5 oben) ein, für den Sie den Fortschritt von Benutzern hinzufügen möchten. Ersetzen Sie guid neben CourseId durch die entsprechende Kurs-ID.
• UserId ist ein Pflichtparameter. Geben Sie die ID des Benutzers ein, für den Sie einen Fortschritt hinzufügen möchten. Ersetzen Sie dazu string neben UserID.
• CompletionDate ist ein Pflichtparameter. Hier geben Sie das Abschlussdatum des Benutzers an. Standardmäßig wird in das Feld CompletionDate der aktuelle Zeitpunkt (als Datum und Uhrzeit) eingetragen.
• Ceu ist ein optionaler Parameter. Hier geben Sie die Anzahl der WBEs an, die Sie dem Benutzer gewähren möchten.

 

 

3. Wenn Sie bereit sind, wählen Sie Execute aus, um die Anfrage auszuführen.

 

 

4. Gehen Sie zum Block Response, um die Ergebnisse zu kontrollieren:

• Die Zahl 2xx (beispielsweise „200“) unter Code zeigt an, dass die Anfrage korrekt funktioniert hat. Über Download können Sie die Daten aus der Antwort im JSON-Format auf Ihren Computer herunterladen.
• Im Feld Response body sehen Sie, dass der Abschlussfortschritt (sowie ggf. WBEs) zu den importierten externen Kursunterlagen für den ausgewählten Benutzer hinzugefügt wurden. Sie können das Ergebnis im Learn365 Admin Center sowie über Benutzer > betreffenden Benutzer auswählen > Sitzungshistorie des Lernenden ansehen > Registerkarte Kurse einsehen.
  Kopieren Sie den Wert neben dem Id-Parameter. Dies ist die Registrierungs-ID des Benutzers für diesen importierten externen Kursdatensatz. Sie wird im weiteren Verlauf benötigt, um dem Benutzer ein Zertifikat zu verleihen.

 

 

Mit den importierten externen Kursunterlagen verknüpftes Zertifikat hinzufügen

1. Suchen Sie im Abschnitt ExternalTrainings nach der POST-Methode /externalTrainings/importCourse mit der Beschreibung Import certificate und wählen Sie dann Try it out aus.

2. Füllen Sie die Felder aus und beachten Sie dabei die Pflichtparameter:

• EnrollmentId ist ein Pflichtparameter. Ersetzen Sie guid durch die Registrierungs-ID des betreffenden Benutzers (siehe Schritt 4 im Abschnitt zum Importieren der externen Kursunterlagen).
  
• ExpiryDate ist ein optionaler Parameter. Hier geben Sie das Ablaufdatum des Zertifikats an. Standardmäßig wird in das Feld ExpiryDate der aktuelle Zeitpunkt (als Datum und Uhrzeit) eingetragen.
• TemplateId ist ein optionaler Parameter. Hier geben Sie die ID der Learn365-Vorlage an, die für das Zertifikat verwendet werden soll.

 

 

 

3. Wenn Sie bereit sind, wählen Sie Execute aus, um die Anfrage auszuführen.

4. Gehen Sie zum Block Response, um die Ergebnisse zu kontrollieren:

• Die Zahl 2xx (beispielsweise „200“) unter Code zeigt an, dass die Anfrage korrekt funktioniert hat. Über Download können Sie die Daten aus der Antwort im JSON-Format auf Ihren Computer herunterladen.
• Im Feld Response body sehen Sie, dass dem ausgewählten Benutzer für die importierten externen Kursunterlagen ein Zertifikat (ggf. unter Verwendung der ausgewählten Vorlage) verliehen wurde. Sie können das Ergebnis im Learn365 Admin Center sowie über Benutzer > betreffenden Benutzer auswählen > Registerkarte Sitzungshistorie des Lernenden ansehen > Zertifikate einsehen.