Lernmodule über die Learn365-API abschließen

Einführung

In diesem Artikel wird beschrieben, wie Sie die Learn365-APIs verwenden können, um den Fortschrittsstatus eines Lernmoduls von Nicht gestartet oder In Bearbeitung zu Abgeschlossen zu ändern.

Voraussetzungen

1. Gehen Sie zu https://api.365.systems/ und autorisieren Sie sich mit dem relevanten API-Schlüssel. Weitere Informationen zum Autorisierungsprozess finden Sie in diesem Artikel.

2. Für eine Anfrage zum Ändern des Abschlussstatus eines Lernmoduls müssen Sie die Registrierungs-ID des entsprechenden Benutzers, die ID des betreffenden Lernmoduls sowie die IDs der zugehörigen Lernobjekte abrufen.

So rufen Sie diese Daten ab:

• Suchen Sie den Abschnitt Courses, erweitern Sie ihn, suchen Sie die GET-Methode /odata/v2/Courses mit der Beschreibung Returns the list of Courses und wählen Sie Try it out aus.
   
• Geben Sie im Feld $expand Enrollments, LearningModules ein, damit die Antwort Daten zu Benutzerregistrierungen und Lernmodulen innerhalb von Kursen enthält.
  
  Sie können die Antwort mithilfe des Felds $filter weiter eingrenzen, wenn Sie die ID oder den Titel des Kurses haben, der das Lernmodul enthält. In diesem Fall können Sie im Feld $filter Title eq 'course title' oder Title eq 'course ID' eingeben, wobei course title und course ID durch die relevanten Daten ersetzt werden.
   
• Select Execute, um die Anfrage auszuführen. 

3. Gehen Sie zum Block Responses, um die Ergebnisse einzusehen.

• 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 alle Kurse des Tenants, die Lernmodule enthalten (einschließlich ihrer IDs), sowie Daten zu Benutzern, die in den Kursen eingeschrieben sind (einschließlich ihrer Registrierungs-ID). Suchen Sie mit Strg+F nach dem entsprechenden Lernmodul oder dem entsprechenden Benutzer.

4. Rufen Sie die ID des entsprechenden Lernmoduls neben dem Parameter Id unter LearningModules ab.

5. Rufen Sie die Registrierungs-ID des Benutzers neben dem Parameter Id unter Enrollments ab.

6. Sobald Sie die ID des Lernmoduls haben, können Sie die IDs der Lernobjekte im Lernmodul abrufen. Führen Sie zu diesem Zweck die folgenden Schritte durch:

• Suchen Sie den Abschnitt LearningModules , erweitern Sie ihn, suchen Sie die GET-Methode /odata/v2/LearningModules{Id} mit der Beschreibung Returns the Learning Module by Id und wählen Sie Try it out.
   
• Geben Sie im Feld key: Id die ID des betreffenden Lernmoduls ein.
   
• Geben Sie im Feld $expand Configuration ein, damit die Antwort die Lernobjekte des Lernmoduls enthält.

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

8. Gehen Sie zum Block Responses , um die Ergebnisse zu kontrollieren.

• Die Zahl 2xx (zum Beispiel 200) unter Code zeigt, dass die Anfrage korrekt ausgeführt wurde. Sie können die Daten aus der Antwort über Download im .JSON-Format auf Ihren Computer herunterladen.
• Im Feld Response body sehen Sie alle Lernobjekte im Lernmodul, einschließlich ihrer IDs.

Ein Lernmodul per API abschließen

Sobald die erforderlichen Daten erfasst sind, können Sie eine Anfrage ausführen, um den Status des relevanten Lernmoduls für den betreffenden Benutzer auf „abgeschlossen“ zu setzen.

1. Suchen Sie den Abschnitt LearningModuleAttempts , erweitern Sie ihn, suchen Sie die POST-Methode /odata/v2/LearningModuleAttempts mit der Beschreibung Creates Learning Module Attempt und wählen Sie Try it out.

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

• Id ist ein optionaler Parameter. Ersetzen Sie guid durch die ID des Versuchs. 
• LearningModuleId ist ein erforderlicher Parameter. Ersetzen Sie guid durch die ID des Lernmoduls.
• EnrollmentId, ein erforderlicher Parameter. Ersetzen Sie guid durch die Registrierungs-ID des Benutzers.
• PercentOfCompleting, ein optionaler Parameter. Ersetzen Sie integer durch eine ganze Zahl. Wenn nicht festgelegt, berechnet das System diesen Wert automatisch anhand der für die erforderlichen Parameter bereitgestellten Daten.
• IsCompleted,in diesem Fall ein optionaler Parameter. Ersetzen Sie boolean durch true, um das Lernmodul als abgeschlossen zu markieren. Wenn nicht festgelegt, berechnet das System diesen Wert automatisch anhand der für die erforderlichen Parameter bereitgestellten Daten.
• IsCompletedCorrectly, in diesem Fall ein optionaler Parameter. Ersetzen Sie boolean durch true, um das Lernmodul als erfolgreich abgeschlossen zu markieren. Wenn nicht festgelegt, berechnet das System diesen Wert automatisch anhand der für die erforderlichen Parameter bereitgestellten Daten.
• PassingTimeTicks, ein optionaler Parameter. Ersetzen Sie integer durch eine ganze Zahl.
• Status, ein optionaler Parameter. Ersetzen Sie integer durch die entsprechende Zahl, um den Fortschrittsstatus des Lernmoduls festzulegen: 0 (nicht gestartet), 1 (in Bearbeitung), 2 (fehlgeschlagen) oder 3 (abgeschlossen). Wenn nicht festgelegt, berechnet das System diesen Wert automatisch anhand der für die erforderlichen Parameter bereitgestellten Daten.
• State,ein erforderlicher Parameter, der dem Status des Versuchs des Benutzers bei den Elementen des Lernmoduls entspricht.
  Ersetzen Sie string durch {\"Element-ID\":Elementstatus}, wobei für Element-ID und Elementstatus die entsprechenden Daten eingegeben werden.
  Die ID der Versuche wurde im Abschnitt Voraussetzungen ermittelt.
  Der Status des Versuchs kann einer der folgenden sein: 0 (Element ist nicht gestartet), 1 (Element ist bestanden und daher abgeschlossen) und 2 (Element ist fehlgeschlagen).
  
  Wenn es mehrere Lernobjekte im Lernmodul gibt, sieht der Wert so aus: "State": "{\"Element-ID\":Elementstatus, \"Element-ID\":Elementstatus, \"Element-ID\":Elementstatus}", wobei \"Element-ID\":Elementstatus für jedes Lernobjekt des Lernmoduls eingetragen wird.

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 kontrollieren.

• Die Zahl 2xx (zum Beispiel 201) unter Code zeigt an, dass die Anfrage korrekt ausgeführt wurde. Sie können die Daten der Antwort über Download im .JSON-Format auf Ihren Computer herunterladen.

• Im Feld Response body sehen Sie Daten zum Abschluss eines Lernmoduls. Sie können den Abschluss des Lernmoduls für den Benutzer im Learn365 Admin Center überprüfen. Weitere Informationen darüber, wie Sie den Fortschritt des Benutzers im Lernmodul und bei dessen Elementen nachverfolgen, finden Sie in diesem Artikel.