Zum Hauptinhalt springen

Personendatensätze des Quellsystemanbieters

GET 
/personen

Mittels dieses Endpunkts werden alle Personendatensätze zurückgegeben, auf die der Quellsystemanbieter zugreifen darf.

Ein READ muss mit einer HTTP-GET Anfrage erfolgen. Die Schnittstelle /personen ermöglicht das Verwenden von Filterparametern zur Präzisierung der Anfrage bei HTTP-GET. Werden mehrere Filter angegeben, so sind sie als mit „und“ verknüpft anzusehen. Die mehrfache Nutzung des gleichen Filters in einer Anfrage darf nicht erfolgen. Entsprechen keine Werte den angegebenen Filtern, so wird als Resultat eine leere Liste geliefert.

Folgende Tabelle listet die zur Verfügung stehenden Filter:

FilterTypBeschreibung
referrerStringMöglichkeit, die Ergebnisliste der Anfrage nach dem Fremdschlüssel referrer zu filtern. Der Schulconnex-Server überprüft, ob der Wert des Filterparameters ohne Beachtung von Groß- und Kleinschreibung im Filter-Attribut beinhaltet ist (contains).
mandantStringMöglichkeit, die Ergebnisliste der Anfrage nach dem Attribut mandant zu filtern. Der Schulconnex-Server überprüft, ob der Wert des Filterparameters unabhängig von Groß- und Kleinschreibung im Filter-Attribut beinhaltet ist (contains).
familiennameStringMöglichkeit, die Ergebnisliste der Anfrage nach dem Attribut person.name.familienname zu filtern. Der Schulconnex-Server überprüft, ob der Wert des Filter-parameters ohne Beachtung von Groß- und Kleinschreibung im Filter-Attribut beinhaltet ist (contains).
vornameStringMöglichkeit, die Ergebnisliste der Anfrage nach dem Attribut person.name.vorname zu filtern. Der Schulconnex-Server überprüft, ob der Wert des Filter-parameters ohne Beachtung von Groß- und Kleinschreibung im Filter-Attribut beinhaltet ist (contains).
sichtfreigabeStringErlaubt es Personen, abhängig davon aufzulisten, ob diese von einer anderen Organisation zum Lesen freigegeben wurden. Die möglichen Optionen sind sichtfreigabe=ja, um nur die durch externe Organisationen freigegebenen Personen beziehungsweise Personenkontexte aufzulisten und sichtfreigabe=nein, um nur eigene Personen beziehungsweise Personenkontexte aufzulisten. Wird nicht nach Sichtfreigabe gefiltert, so werden alle lesbaren Personen, beziehungsweise Personenkontexte geliefert.

Die Antwort-Nutzdaten (Response Payload) beinhalten ein Array von JSON-Objekten vom Datentyp „Personendatensatz“, sofern Einträge (ggf. passend zu den optionalen Filtern) existieren. Siehe auch die einzelnen Datenmodelle zu Personendatensatz und Person.

Die Ergebnisliste beinhaltet ausschließlich Datensätze vom Datentyp „Person“ beziehungsweise erweitert über das Attribut personendatensatz.personenkontexte Personenkontexte, welche der eigenen Organisation zugeordnet werden können. Der Schulconnex-Server übernimmt diese Information aus dem access_token.

Request​

Responses​

OK