Zum Hauptinhalt springen

Auflistung von Personenkontexten

GET 
/personenkontexte

Die Schnittstelle /personenkontexte bezieht sich auf das Anfordern und die Auflistung von Personenkontexten in Bezug zu der eigenen Organisation.

Die Schnittstelle /personenkontexte 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 auf:

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).
rolleString (Code)Möglichkeit, die Ergebnisliste der Anfrage nach dem Attribut personenkontext.rolle zu filtern. Der Schulconnex-Server überprüft, ob der Wert des Filterparameters mit dem Wert des Filter-Attributs übereinstimmt (equals). Dem Filterparameter liegt eine Codeliste Rolle zugrunde.
personenstatusString (Code)Möglichkeit, die Ergebnisliste der Anfrage nach dem Attribut „personenkontext.personenstatus” zu filtern. Der Schulconnex-Server überprüft, ob der Wert des Filterparameters mit dem Wert des Filter-Attributs übereinstimmt (equals). Dem Filterparameter liegt die Codeliste Personenstatus zugrunde.
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.

Dieser Schnittstellenendpunkt gibt alle Personenkontexte zurück, auf die der Quellsystemanbieter zugreifen kann.

Ein READ muss mit einer HTTP-GET Anfrage erfolgen. Die Antwort-Nutzdaten (Response Payload) beinhalten ein Array von JSON-Objekten vom Datentyp Personendatensatz mit dem jeweiligen Personenkontext und der zugeordneten Person, sofern Einträge (ggf. passend zu den optionalen Filtern) existieren.

Siehe auch Datenmodell Personendatensatz, Datenmodell Person und Datenmodell Personenkontext.

Die Antwort-Nutzdaten umfassen standardmäßig für das Attribut personendatensatz.person mit dem Datentyp Person nur die ID über das Attribut personenkontext.person.id.

Die Antwort-Nutzdaten umfassen standardmäßig für das Attribut personendatensatz.personenkontext.organisation mit dem Datentyp Organisation alle nicht optionalen Attribute – also nur deren ID personenkontext.organisation.id.

Request​

Responses​

OK