Start- und Enddaten einer Sitzung über die Learn365-API abrufen

Einführung

In diesem Artikel beschreiben wir, wie Sie mithilfe von Learn365-API-Endpunkten die Start- und Enddaten einer Kurssitzung abrufen können. Je nachdem, ob Sie die ID des relevanten Kurses oder der Sitzung haben, gibt es mehrere Möglichkeiten, dies zu tun.

Daten über eine Kurs-ID abrufen

Um die Learn365-API zu verwenden, sollten Sie sich mit dem entsprechenden API-Schlüssel authentifizieren. Details finden Sie in diesem Artikel.

Um die Start- und Enddaten einer Sitzung in einem bestimmten Kurs abzurufen, gehen Sie wie folgt vor:

1. Navigieren Sie in https://api.365.systems, navigieren Sie zum Courses-Abschnitt und erweitern Sie ihn.

2. Wählen Sie den Endpunkt GET/odata/v2/Courses aus, der den Kurs anhand seiner ID zurückgibt, und wählen Sie Try it out.

3. Der geöffnete Abschnitt Parameters enthält die auszufüllenden Felder für Abfrageparameter:

• Geben Sie im erforderlichen Feld Id die ID des Kurses ein, für den Sie die Start- und Enddaten der Sitzung abrufen möchten.
• Geben Sie in $expand, CourseSessions ein. Die Daten zu den Kurssitzungen werden in der Antwort enthalten sein. 

4. Wählen Sie Execute aus, um die Anfrage auszuführen.

5. Überprüfen Sie im Block Responses die Ergebnisse:

• Die Zahl 2xx (beispielsweise „200“) unter Code zeigt an, dass die Anfrage korrekt funktioniert hat. 
• Mit der Option Download können Sie die Ergebnisse im JSON-Format auf Ihrem Gerät speichern.
• Die Antwort enthält nur Daten zu dem Kurs, dessen ID in Parameters angegeben wurde, sowie zu seinen Sitzungen und Sitzungsgruppen, einschließlich der Start- und Enddaten der Sitzungen:
  • Die Start- und Enddaten für eigenständige Sitzungen sowie Sitzungen in einer Sitzungsgruppe sind neben den entsprechenden Parametern angegeben. 

• Bei Sitzungsgruppen (IsGroup hat den Wert true ) zeigen die Parameter StartDate und EndDate immer 1753-01-01T00:00:00Z bzw. 9999-12-31T23:59:59.997Z an. Sitzungsgruppen haben keine Start- und Enddaten; nur Sitzungen (eigenständig oder innerhalb einer Sitzungsgruppe) haben die angegebenen Daten. 

Daten mithilfe einer Sitzungs-ID abrufen

Zum Verwenden der Learn365-API sollten Sie mit dem relevanten API-Schlüssel autorisiert sein. Details finden Sie in diesem Artikel.

Der Vorteil dieses Ansatzes zum Abrufen der Start- und Enddaten einer Sitzung über eine Sitzungs-ID besteht darin, dass er nur die notwendigen Informationen zur jeweiligen Sitzung bereitstellt.

Um die Start- und Enddaten einer bestimmten Kurssitzung abzurufen, gehen Sie wie folgt vor:

1. Navigieren Sie in https:/api.365.systems, zum Abschnitt CourseSessions und erweitern Sie ihn.

2. Wählen Sie den Endpunkt GET/odata/v2/CourseSessions({Id}), der Daten zu Kurssitzungen oder Sitzungsgruppen anhand ihrer ID zurückgibt, und wählen Sie Try it out aus.

3. Der geöffnete Abschnitt Parameters enthält die auszufüllenden Felder für die Abfrageparameter. Geben Sie im erforderlichen Feld Id die ID der Sitzung ein, deren Start- und Enddaten Sie abrufen möchten.

4. Wählen Sie Execute aus, um die Anfrage auszuführen.

5. Überprüfen Sie im Block Responses die Ergebnisse:

• Die Zahl 2xx (beispielsweise „200“) unter Code zeigt an, dass die Anfrage korrekt funktioniert hat. 
• Sie können die Option Download verwenden, um die Ergebnisse im JSON-Format auf Ihrem Gerät zu speichern.
• Die zurückgegebenen Daten beziehen sich auf diese spezifische Sitzung, einschließlich ihrer Start- und Enddaten.

Daten ohne Kurs- oder Sitzungs-ID abrufen

Um die Learn365-API zu verwenden, müssen Sie mit dem entsprechenden API-Schlüssel autorisiert sein. Details finden Sie in diesem Artikel.

Um die Start- und Enddaten einer Sitzung abzurufen, zu der Sie keine Kurs- oder Sitzungs-ID haben, gehen Sie wie folgt vor:

1. Navigieren Sie in https://api.365.systems, zum Abschnitt Courses und erweitern Sie ihn.

2. Wählen Sie den GET-Endpunkt /odata/v2/Courses aus, der die Liste der Kurse zurückgibt, und wählen Sie anschließend Try it out.

3. Der geöffnete Abschnitt Parameters enthält verschiedene Abfrageoptionen-Parameter, die angegeben werden können, um die Daten in der Antwort zu steuern.

4. Select Execute, um die Anfrage auszuführen.

5. Überprüfen Sie im Block Responses die Ergebnisse:

• Die Zahl 2xx (beispielsweise „200“) unter Code zeigt an, dass die Anfrage korrekt funktioniert hat. 
• Mit der Option Download können Sie die Ergebnisse im JSON-Format auf Ihrem Gerät speichern.
• Der Response body enthält die Liste der Kurse und deren Daten, einschließlich Daten zu ihren Sitzungen und Sitzungsgruppen. Die Start- und Enddaten der Sitzungen werden unter CourseSessions jeweils neben den Parametern StartDate und EndDate angezeigt.