Personenkontexte zur angeforderten ID

GET /personen/:id/personenkontexte

Dieser Schnittstellenendpunkt gibt die Personenkontexte zur angeforderten Person per ID personendatensatz.person.id zurück.

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

Siehe auch Datenmodell Personenkontext.

Die Anfrage erfordert keine Nutzdaten (Request Payload).

Die Schnittstelle ermöglicht das Verwenden von Filterparametern zur Präzisierung der Anfrage bei HTTP-GET. Werden mehrere Filter angegeben, so müssen sie als mit „und“ verknüpft angesehen werden. 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:

Filter	Typ	Beschreibung
`referrer`	String	Mö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).
`rolle`	String (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 die Codeliste Rolle zugrunde.
`personenstatus`	String (Code)	Möglichkeit, die Ergebnisliste der Anfrage nach dem Attribut „personenkontext.personenstatus” zu filtern. Der Schulconnex-Server überprüft, ob der Wert des Filter-parameters mit dem Wert des Filter-Attributs übereinstimmt (equals). Dem Filterparameter liegt eine Codeliste Personenstatus zugrunde.
`sichtfreigabe`	String	erlaubt 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 Organisation wurde beim Erstellen eines Personenkontexts vom Schulconnex-Server aus dem access_token übernommen und per personenkontext.organisation.id referenziert. Die Antwort-Nutzdaten umfassen standardmäßig für das Attribut personenkontext.organisation mit dem Datentyp Organisation alle nicht optionalen Attribute – nur die ID personenkontext.organisation.id.

Personenkontexte zur angeforderten ID

/personen/:id/personenkontexte

Request​

Responses​

Request

Responses