Zum Hauptinhalt springen

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.

Folgende Tabelle listet die zur Verfügung stehenden Filter auf:

FilterTypBeschreibung
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.

Über weitere Filter ist es möglich, sich zusätzliche Informationen zu Beziehungen von Organisationen untereinande ausgeben zu lassen.

FilterTypBeschreibung
hat_als_organisationsbeziehungenString (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_organisationsbeziehungenString (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.

Responses​

OK

Schema

  • Array [

    • kennung string

    Die optionale Kennung (Identifikations-ID) einer Organisation.

    name string

    Offizieller Name einer Organisation.

    anschrift

    object

    postleitzahl string

    Postleitzahl.

    ort string

    Amtlicher Gemeindename.

    ortsteil string

    Teil eines Orts, falls genauere Untergliederung gewünscht.

    typ components-code-Organisationstyp (string)

    Possible values: [Schule, Anbieter, Sonstige]

    Wie folgt:

    • Schule
    • Anbieter
    • Sonstige sonstige Organisationen / Einrichtungen

  • ]

Loading...