Auflistung von Organisationsbeziehungen.

GET /organisationen/:id/organisationsbeziehungen

Die Schnittstelle /organisationen/{id}/organisationsbeziehungen erlaubt das Lesen von zu einer Organisation gehörenden Organisationsbeziehungen.

Organisationsbeziehungen sind immer von der Form hat_als. Besteht von einer Organisation A eine Organisationsbeziehung vom Typ SchBeh zu einer Organisation B, so bedeutet dieses, das Organisation A die Organisation B als Schulbehörde hat.

Bestehen zwischen zwei Organisationen mehrere Beziehungen (ist beispielsweise eine Organisation sowohl Schulbehörde als auch Schulträger einer anderen Organisation), so hat jede Beziehung ein eigenes Organisationsbeziehungsobjekt.

Dieser Schnittstellenendpunkt gibt die Organisationsbeziehungen zur angegebenen Organisations-ID zurück.

Ein READ zum Abfragen der Organisationsbeziehungen per Organisations-ID muss mit HTTP-GET auf die API /organisationen/{id}/organisationsbeziehungen erfolgen. Die Antwort-Nutzdaten (Response Payload) beinhalten ein JSON-Objekt mit einem Array des Datentyps Organisationsbeziehungen.

Siehe auch Datenmodell Organisationsbeziehung.

Die Schnittstelle /organisationen/{id}/organisationsbeziehungen ermöglicht das Verwenden von Filterparametern zur Präzisierung der Anfrage bei HTTP-GET. 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
`hat_als_organisationsbeziehungen`	String (Boolean)	Listet alle Organisationsbeziehungen auf, welche die durch die Organsations-ID gegebene Organisation hat. Die Organisationsbeziehungen werden unter `hat_als_organisationsbeziehungen` aufgelistet. Der Defaultwert ist `Ja`, es werden also ohne Filterangabe alle Organisationsbeziehungen angegeben, welche eine Organisation hat.
`ist_von_organisationsbeziehungen`	String (Boolean)	Listet alle Organisationsbeziehungen auf, welche von anderen Organisationen zu dem, durch die Organisations-ID gegebenen, Organisation bestehen. Die Organisationsbeziehungen werden unter `ist_von_organisationsbeziehungen` aufgelistet. Der Defaultwert ist `Nein`, es werden also ohne Filterangabe keine Organisationsbeziehungen angegeben, welche aus der gegebenen Organisation heraus bestehen.

Request

Path Parameters

id stringrequired

Der Pfad-Parameter bezieht sich auf die ID der Organisation.

Query Parameters

hat_als_organisationsbeziehungen string

Possible values: [Ja, Nein]

ist_von_organisationsbeziehungen string

Possible values: [Ja, Nein]

Responses

application/json

Schema
Example (from schema)

Schema

hat_als_organisationsbeziehungen

object[]

Array [

orgid string

ID der Organisation.

organisationsbeziehung string

Beziehung aus Codeliste Organisationsbeziehungen.

]

ist_von_organisationsbeziehungen