Zum Hauptinhalt springen
Version: Version 1.7 Veröffentlichungskandidat 1

Organisationen auflisten

GET 
/organisationen-info

Die Schnittstelle /organisationen-info ermöglicht die Auflistung von Organisationen durch Dienste. Der Zugriff erfordert die Client Credentials eines Dienstes.

Dieser Schnittstellenendpunkt gibt die Organisationen zurück, die vom Dienst 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.

Die Schnittstelle /v1/organisationen-info 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. Entsprechen keine Werte den angegebenen Filtern, so wird als Resultat eine leere Liste geliefert. Die mehrfache Nutzung des gleichen Filters in einer Anfrage darf nicht erfolgen.

FilterTypParameterBeschreibung
vollstaendigStringbeziehungenMöglichkeit, die Beziehungen, welche eine Organisation hat, aufzulisten. Es werden nur die hat_als Beziehungen ausgegeben. Der Default ist keine Ausgabe von Beziehungen.
idStringMöglichkeit, die Ergebnisliste der Anfrage nach der „id” einer Organisation zu filtern. Der Schulconnex-Server überprüft, ob der Wert des Filterparameters ohne Beachtung von Groß- und Kleinschreibung im Filter-Attribut beinhaltet ist (contains).
kennungString (Code)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).
nameStringMö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).
typString (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 die Codeliste Organisationstyp zugrunde.

Die Möglichkeit, die Organisationsbeziehungen über die Filter hat_als_organisationsbeziehungen oder ist_von_organisationsbeziehungen ausgeben zu lassen, ist deprechiated und wird nicht weiter unterstützt.

Request​

Responses​

OK