In diesem Artikel wird beschrieben, wie Sie mithilfe eines Learn365-API-Endpunkts in Learn365 die ID der aktiven Registrierungen eines Benutzers abrufen können.
Um die ID der aktiven Registrierungen des Benutzers abzurufen, führen Sie die folgenden Schritte aus:
Zum Verwenden der Learn365-API müssen Sie mit dem entsprechenden API-Schlüssel auf https://api.365.systems autorisiert sein. Details finden Sie in diesem Artikel.
1. Navigieren Sie auf https:/api.365.systems zum Abschnitt Registrierungen.
2. Wählen Sie den Endpunkt GET/odata/v2/Enrollments (der die Liste der aktiven Registrierungen des aktuellen Benutzers zurückgibt) und wählen Sie Try it out aus.
3. Der geöffnete Abschnitt Parameters enthält die Felder für Abfrageparameter, die Sie ausfüllen können, wenn Sie die Antwortdaten eingrenzen möchten.
- Wenn Sie Daten zu den aktiven Registrierungen aller Benutzer im Tenant abrufen möchten, lassen Sie die Felder leer und fahren Sie mit dem nächsten Schritt fort.
- Um das Array AllCourseSessions in die Antwort aufzunehmen (dieses Array enthält die IDs und Titel jeder Sitzung der Registrierung), geben Sie AllCourseSessions in das Feld $expand ein.
- Wenn Sie die Antwortdaten eingrenzen möchten, geben Sie Abfrageparameter an und tragen Sie diese in die Abfragefelder ein. Die zurückgegebenen Antwortdaten enthalten dann nur die gefilterten Daten.
BEISPIEL
So rufen Sie aktive Registrierungen in einem bestimmten Kurs ab:
- Geben Sie im Feld $filter CourseId eq ID ein, wobei ID die ID des relevanten Kurses ist. Informationen zum Abrufen einer Kurs-ID finden Sie in diesem Artikel. In diesem Fall enthält die Antwort nur die aktiven Registrierungen aller Lernenden für diesen Kurs.
- Wenn Sie die aktive Registrierungs-ID eines bestimmten Lernenden in diesem Kurs abrufen möchten, rufen Sie die Benutzer-ID ab und verwenden Sie sie, um die zurückgegebenen Daten im Response block weiter zu filtern.
3. Wählen Sie Execute, um die Anfrage auszuführen.
4. Gehen Sie zum Block Responses , um die Ergebnisse zu überprüfen.
- Die Zahl 2xx (zum Beispiel 200) unter Code zeigt an, dass die Anfrage korrekt verarbeitet wurde.
- Wenn im Block Parameters keine Abfrageparameter festgelegt wurden, um die Antwort einzugrenzen, können Sie Daten zu allen aktiven Registrierungen aller Benutzer im Tenant sehen, einschließlich der Registrierungs-ID.
- Der Wert neben dem Parameter Id zeigt die eindeutige Registrierungs-ID für jeden Benutzer in jedem Kurs an.
- Wenn im Block Parameters Abfrageparameter festgelegt wurden, sehen Sie nur die relevanten angeforderten Daten.
- Um die Antwort einzuschränken, verwenden Sie Strg+F und die gesuchten Daten.
- Sie können die Option Herunterladen verwenden, um die Ergebnisse zu speichern. im JSON-Format auf Ihr Gerät.
Kommentare
Zu diesem Beitrag können keine Kommentare hinterlassen werden.