Externen Kursdatensatz und ein zugehöriges Zertifikat über die Learn365-API importieren

Einführung

Externe Kursdatensätze und Zertifikate können in Learn365 mithilfe der Option Import External Training im Learn365 Admin Center oder über Learn365-API-Endpunkte importiert werden. 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 Try it out aus.

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

• CourseCatalogId, ein Pflichtparameter. Geben Sie die ID des Katalogs ein, in den Sie den externen Kursdatensatz importieren möchten. Ersetzen Sie guid neben CourseCatalogId durch die Katalog-ID.
• Title, 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 die ID eines bestehenden Learn365-Kurses. Ersetzen Sie string neben dem Titel. 
• Categories, 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, 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 Responses, 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 Tenant 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 ihnen ein Zertifikat zu verleihen.

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

1. Um den Fortschritt von Benutzern für den kürzlich importierten externen Kursdatensatz hinzuzufügen, 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 achten Sie dabei auf die erforderlichen Parameter:

• CourseId ist ein erforderlicher Parameter. 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 erforderlicher Parameter. Geben Sie die ID des Benutzers ein, für den Sie Fortschritt hinzufügen möchten. Ersetzen Sie string neben UserId.
• CompletionDate ist ein erforderlicher Parameter. Hier geben Sie das Abschlussdatum des Benutzers an. Standardmäßig ist das Feld CompletionDate mit dem aktuellen Datum und der aktuellen Uhrzeit vorausgefüllt.
• Wbe, 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 Responses, um die Ergebnisse zu prüfen.

• 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 Abschlussfortschritt und WBEs (falls vorhanden) für die ausgewählten Benutzer in den importierten externen Kursdatensätzen hinzugefügt wurden. Sie können das Ergebnis im Learn365 Admin Center sowie über Users > relevanten Benutzer auswählen > Registerkarte View Learner's Transcript > Courses einsehen.
  Kopieren Sie den Wert neben dem Id Parameter. Dies ist die Registrierungs-ID des Benutzers für diesen importierten externen Kursdatensatz und wird später im Prozess 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 description und wählen Sie dann Try it out aus.

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

• EnrollmentId ist ein erforderlicher Parameter. Ersetzen Sie guid durch die Registrierungs-ID des betreffenden Benutzers (siehe Schritt 4 im Abschnitt zum Importieren des externen Kursdatensatzes). 
• ExpiryDate ist ein optionaler Parameter. Hier geben Sie das Ablaufdatum des Zertifikats an. Standardmäßig wird das Feld ExpiryDate mit dem aktuellen Datum und der aktuellen Uhrzeit vorausgefüllt.
• TemplateId ist ein optionaler Parameter. 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 Responses, um die Ergebnisse zu überprüfen:

• 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 den importierten externen Kursdatensatz ein Zertifikat (ggf. unter Verwendung der ausgewählten Vorlage) verliehen wurde. Sie können das Ergebnis im Learn365 Admin Center sowie über Users > den betreffenden Benutzer auswählen > View Learner's Transcript > Certificates tab.