Kern-API
Die HTTP-Schnittstelle, über die timbra im Verbund liest und schreibt.
timbra ist eine Desktop-Anwendung. Auf Endgeräten liegen keine Zugangsdaten zur Datenbank; timbra spricht im Verbund deshalb nur mit der Kern-API.
Die Kern-API ist kein eigener Dienst. Sie ist Teil des Go-Moduls von canon und läuft in score und roster mit, sobald eines davon betrieben wird. Ohne score und roster arbeitet timbra allein.
Anmeldung
timbra meldet sich über dieselbe Anmeldung an wie score und roster (OpenID Connect) und schickt
das Token mit. Jede Anfrage läuft in der Datenbank als timbra_app, im Kontext der angemeldeten
Person. Lesen dürfen Stundenplanung, Schulleitung und Schuladministration.
Was timbra liest
- die Schule mit ihrer Hoheitsverteilung,
- Schuljahre mit Zeiträumen,
- Klassen mit Anzahl der Schüler, ohne Namen,
- Lehrkräfte mit Kürzel,
- Fächer, Kurse mit Klassen und Lehraufträgen, Stundentafel,
- Kursbelegungen mit pseudonymen Kennungen.
Was timbra schreibt
- Fächer, Kurse, Lehraufträge und Stundentafel, wenn timbra an der Schule die Hoheit
unterrichthat, - Räume, Zeitraster, Kursplanung, Freigaben und Vertretungen im Schema
timbra.
Ein Plan wird nur unter einer Planungssperre freigegeben, damit sich die Grundlage während der Freigabe nicht ändert.
Pfade
| Bereich | Pfade |
|---|---|
| Kern | /v1/kern/einrichtungen/…: Schuljahre, Klassen, Lehrkräfte, Fächer, Kurse, Stundentafel, Belegungen |
| timbra | /v1/timbra/einrichtungen/…: Räume, Zeitraster, Kursplanung, Sperre, Freigaben, Vertretungen |
Der Vertrag liegt als OpenAPI-Beschreibung in canon. timbra baut seinen Anschluss selbst gegen diesen Vertrag; ein eigenes Client-Paket gibt es nicht.