UCS@school Kelvin REST API Update auf Version 1.7.0

Mit der App UCS@school Kelvin REST API können Sie User und Klassenobjekte von UCS@school komfortabel über eine REST Schnittstelle anlegen, löschen oder ändern. Im Gegensatz zu der Importfunktion und manuellen Eingriffen über das Webinterface ist sie weniger fehleranfällig und kann automatisiert angesprochen werden.

Wichtige Änderungen in Version 1.7.0:

• Schulklassen und Arbeitsgruppen können jetzt ohne Freigabe (Share) erstellt werden. Eine Gruppen-Freigabe war bisher eine Voraussetzung für das Erzeugen einer Klasse oder Arbeitsgruppe. Durch die Mitgliedschaft in einer Gruppe mit Freigabe, können Schüler*innen und Lehrkräfte Daten teilen, die für die entsprechende Gruppe von Interesse sind, wie zum Beispiel Arbeitsblätter. Da dies in der Praxis allerdings nicht immer Hand in Hand geht, ist die Freigabe nun bei der Erzeugung optional und dadurch auch datensparsamer.
• Wer vor der Anlage einer Schule prüfen möchte, ob es diese schon gibt, kann dies mit dem neuen HEAD-Endpunkt für Schulen nun unkomplizierter herausfinden.

• Das Erstellen bzw. Modifizieren von Benutzern mit Arbeitsgruppen wird nun ebenfalls von der API unterstützt. Anders als bei Schulklassen werden die Gruppen nicht implizit erstellt und müssen separat angelegt werden.

• Wir haben außerdem den Update-Vorgang angepasst, sodass projektspezifische Konfigurationswerte (UCR-Variablen), die im Docker Container der App gesetzt wurden, auch bei einem Update beständig bleiben.
• In Anfragen gegen die API kann eine Korrelations-ID mitgegeben werden, die dann auch im Verarbeitungsprozess an andere APIs von UCS weitergegeben wird. Auf diese Weise lassen sich Anfragen einfacher in Log-Dateien nachverfolgen und Problemfälle leichter lokalisieren. Wie Sie das mit dem Python Client machen können, finden Sie hier (https://kelvin-rest-api-client.readthedocs.io/en/latest/usage-correlation.html) beschrieben.

Wichtiger Hinweis: Falls die von Ihnen genutzte API über den UCS@school Kelvin REST API Python Client angesprochen wird, sollten Sie sicherstellen, dass alle Python Clients mindestens auf die Version 1.7.0 aktualisiert werden, bevor Sie ihre App updaten. Damit gewährleisten Sie, dass alle Abfragen verarbeitet werden können. Die Versions-Historie finden Sie hier: https://kelvin-rest-api-client.readthedocs.io/en/latest/history.html.

In der Dokumentation des UCS@school Kelvin REST API finden Sie eine Auflistung von Breaking Changes, die Sie beachten müssen.

Sie haben eine Anregung oder möchten uns Feedback zu unserer Dokumentation geben? Klicken sie in der Dokumentation auf die Sprechblase neben den Überschriften. So sehen wir direkt, auf welchen Abschnitt Sie sich beziehen.

Bitte lesen Sie aufmerksam das Changelog, bevor Sie die App updaten.