Zum Hauptinhalt springen

Auflistung von Beziehungen.

GET 
/personenkontexte/:id/beziehungen

Die Schnittstelle /personenkontexte/{personenkontext.id}/beziehungen erlaubt das Lesen von zu einem Personenkontext gehörenden Beziehungen.

Beziehungen sind immer von der Form „hat_als“. Besteht zum Beispiel aus einem Personenkontext von Person A eine Beziehung vom Typ SchB zu einem Personenkontext (ktid) von Person B, so bedeutet dieses, dass Person A die Person B als Schulbegleiter (oder Schulbegleiterin) hat.

Im schulischen Gebrauch bedeutet das meistens, dass Beziehungen den Kontexten von Schülern und Schülerinnen zugeordnet sind. Schüler und Schülerinnen haben Betreuer oder Betreuerinnen, Tutoren oder Tutorinnen oder Erziehungsberechtigte. Der Personenkontext von beispielsweise Erziehungsberechtigten enthält keine Beziehungs-Relation.

Dieser Schnittstellenendpunkt gibt die Beziehungen zur angegebenen personenkontext.id zurück.

Ein READ zum Abfragen der Beziehung per personenkontext.id muss mit HTTP-GET auf die API /personenkontexte/{personenkontext.id}/beziehungen erfolgen. Die Antwort-Nutzdaten (Response Payload) beinhalten ein JSON-Objekt mit einem Array des Datentyps Beziehung.

Siehe auch Datenmodell Beziehung.

Die Schnittstelle /personenkontexte/{personenkontext.id}/beziehungen 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:

FilterTypBeschreibung
hat_als_beziehungenString (Boolean)listet alle Beziehungen auf, welche der, durch die Personenkontext-ID gegebenen, Personenkontext hat. Die Beziehungen werden unter hat_als_beziehungen aufgelistet. Der Defaultwert ist Ja, es werden also ohne Filterangabe alle Beziehungen angegeben, welche ein Personenkontext hat.
ist_von_beziehungenString (Boolean)listet alle Beziehungen auf, welche von anderen Personenkontexten zu dem, durch die Personenkontext-ID gegebenen, Personenkontext bestehen. Die Beziehungen werden unter ist_von_beziehungen aufgelistet. Der Defaultwert ist Nein, es werden also ohne Filterangabe keine Beziehungen angegeben, welche zu dem gegebenen Personenkontext bestehen.

Request​

Path Parameters

    id stringrequired

    Der Pfad-Parameter bezieht sich auf die ID des eigenen Personenkontexts.

Query Parameters

    hat_als_beziehungen string

    Possible values: [Ja, Nein]

    ist_von_beziehungen string

    Possible values: [Ja, Nein]

Responses​

OK

Schema

    hat_als_beziehungen

    object[]

  • Array [

    • id stringrequired

    ID der Beziehung.

    mandant stringrequired

    ID des Mandanten.

    ktid stringrequired

    ID des Personenkontexts, zu dem eine Beziehung besteht.

    beziehung components-code-Beziehungen (string)required

    Possible values: [SchB, SorgBer]

    Beziehungen ist eine Liste von Beziehungen, welche zwischen zwei Personen innerhalb von Personenkontexten bestehen können:

    • SorgBer Sorgeberechtigter oder Sorgeberechtigte
    • SchB Schulbegleiter oder Schulbegleiterin
    revision stringrequired

    Revision der Beziehung.

  • ]

    • ist_von_beziehungen

    object[]

  • Array [

    • id stringrequired

    ID der Beziehung.

    mandant stringrequired

    ID des Mandanten.

    ktid stringrequired

    ID des Personenkontexts, zu dem eine Beziehung besteht.

    beziehung components-code-Beziehungen (string)required

    Possible values: [SchB, SorgBer]

    Beziehungen ist eine Liste von Beziehungen, welche zwischen zwei Personen innerhalb von Personenkontexten bestehen können:

    • SorgBer Sorgeberechtigter oder Sorgeberechtigte
    • SchB Schulbegleiter oder Schulbegleiterin
    revision stringrequired

    Revision der Beziehung.

  • ]

Loading...