Zum Hauptinhalt springen

Organisation zur angeforderten ID.

GET 
/organisationen/:id

Die Schnittstelle /organisationen/{organisation.id} bezieht sich auf das Anfordern einer Organisation per ID.

Dieser Schnittstellenendpunkt gibt die Organisation zur angegebenen organisation.id zurück.

Ein READ zum Abfragen einer Organisation per ID muss mit HTTP-GET auf die API /organisationen/{organisation.id}erfolgen. Die Antwort-Nutzdaten (Response Payload) beinhalten ein JSON-Objekt des Datentyps Organisation.

Siehe auch Datenmodell Organisation.

Request​

Path Parameters

    id stringrequired

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

Responses​

OK

Schema

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