Skip to content

Educauser Process Layer

Übersicht

Der Educauser Process Layer wurde für den Kanton Appenzell im Rahmen des NASA Projekts entwickelt und ermöglicht die Weiterverarbeitung von Schuldaten durch EducaX und AiAddress (Drittsysteme der Firma BKO Soft)

Context Diagram

Für eine detaillierte Übersicht siehe Architektur Für technische Details zur Systemarchitektur siehe C4 Modell

Konfiguration & Troubleshooting

Voraussetzungen für den Betrieb (KPF-Felder, Klassen-/Teilklassenpläne, Schuljahrperioden, Gebiete/SGID) sowie Troubleshooting bei fehlenden Daten sind auf einer eigenen Seite beschrieben:

API

Der Prozesslayer besteht aus 3 Controllern:

Für Entwicklerinformationen siehe EntwicklerInformationen Für Fehlerbehandlung siehe Fehlerbehandlung Für Testinformationen siehe Testing und Testprotokoll

AiAddress-Controller

Controller für die Integration mit AiAddress. Ein Tool der BKO Soft.

Ressource Beschreibung
GET /aiaddress/persons Liefert Personendaten
GET /aiaddress/addresses Liefert Addressen der Personen
GET /aiaddress/contacts Liefert Kontaktinformationen der Personen

Export-Controller

Controller für den Export von Schuldaten. Umfasst Schuleinheiten, Schuljahre, Schulklassen, Schulpersonal, Schüler und deren gesetzlichen Vertreter

Ressource Beschreibung
GET /export/personen Angehörige und Entitäten der Schulen bereit Details
GET /export/pks Informationen über die Zugehörigkeit einer Person zu einer Klasse Details
GET /export/plz Ortschaftsverzeichnis Details
GET /export/schulklassen Informationen über die Schulklassen, Teilklassen und die Schulstufe Details
GET /export/schuljahre Informationen über Schuljahr und Schuljahrperiode Details

Vollständige Feld-Herkunft (welche exportierte Eigenschaft aus welcher CMI-TypDefinition/Property stammt) pro Endpunkt: siehe API-Endpunkte & Feld-Mapping.

Integration-Controller

Controller für die Integration mit anderen Systemen.

Ressource Beschreibung
GET /integration/persons Liste aller Personen aus dem System
GET /integration/lernendedossiers Liste aller Lernendedossiers aus dem integrierten System
GET /export/integration/schulklassendossiers Liste aller Schulklassendossiers aus dem integrierten System

Weitere Dokumentation