Auflistung von Organisationen

GET /organisationen

Die Schnittstelle /organisationen bezieht sich auf die Auflistung von Organisationen.

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

Filter	Typ	Beschreibung
`kennung`	String	Möglichkeit, die Ergebnisliste der Anfrage nach `kennung` zu filtern. Der Schulconnex-Server überprüft, ob der Wert des Filterparameters ohne Beachtung von Groß- und Kleinschreibung im Filter-Attribut beinhaltet ist (contains).
`name`	String	Möglichkeit, die Ergebnisliste der Anfrage nach dem Attribut `organisation.name` zu filtern. Der Schulconnex-Server überprüft, ob der Wert des Filterparameters ohne Beachtung von Groß- und Kleinschreibung im Filter-Attribut beinhaltet ist (contains).
`typ`	String (Code)	Möglichkeit, die Ergebnisliste der Anfrage nach dem Attribut `organisation.typ` 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 (Organisationstyp) zugrunde.

Dieser Schnittstellenendpunkt gibt die Organisationen zurück, die vom Anfrager ausgelesen werden dürfen.

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

Siehe auch Datenmodell Organisation.

Auflistung von Organisationen

/organisationen

Request

Responses

Auflistung von Organisationen

/organisationen

Request​

Responses​

Request

Responses