Einleitung

Der Anwendungsserver kommuniziert ausschliesslich im JSON-Format. Das heisst, das in sämtlichen POST- und PUT-Anfragen ein Body mit Mime Type application/json erwartet wird.

Sämtliche Antworten mit Body enthalten ebenfalls ein JSON-Objekt. Eine Antwort enthält immer das Attribut response, welches die eigentlichen Daten enthält.

{
  "response": ...
}

Grund dafür ist, dass manche JSON-Implementierungen Probleme mit Listen als Root-Objekt haben und dass die Antworten manchmal Listen sind. Ausserdem kann so das API um Meta-Informationen erweitert werden.

Allgemeine JSON-Objekte

Diese JSON-Objekte werden im API verwendet, haben aber keinen eigenen Endpoint.

binary (binäre Daten)
grade (Stufe)

Initialisierung

config (Konfiguration anfordern)
profile (Profil anfordern)

vorkonfigurierte Daten

curriculum (Lehrgang)
gender (Geschlecht)
payrolltype (Anstellungsart)
pooltype (Pooltyp)
subjectcategory (Fachgebiet)
subjecttype (Fachtyp)
thesistype (Abschlussarbeitsart)

Stammdaten

division (Organisationseinheit)
schoolclass (Klasse)
schoolyear (Schuljahr)
subject (Fach)
teacher (Lehrperson)

Transaktionsdaten

course (Kurs)