Zum Hauptinhalt springen

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:

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

Request​

Query Parameters

    kennung string
    name string
    typ string

Responses​

OK

Schema

  • Array [

    • id stringrequired

    ID der Organisation.

    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
    namensergaenzung string

    Ergänzender Name einer Organisation.

    kuerzel string

    Possible values: <= 64 characters

    Kurzname einer Organisation.

    traegerschaft components-code-Trägerschaft (string)

    Possible values: [01, 02, 03, 04, 05, 06]

    Wie folgt:

    • 01 Bund
    • 02 Land
    • 03 Kommune
    • 04 Privat
    • 05 Kirchlich
    • 06 Sonstige

  • ]

Loading...