Zum Hauptinhalt springen

Beziehung zur angeforderten ID.

GET 
/beziehungen/:id

Dieser Schnittstellenendpunkt gibt die Beziehung zur angegebenen beziehung.id zurück.

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

Siehe auch Datenmodell Beziehung.

Zusätzlich zu den Informationen aus dem Datenmodell wird ein Attribut ist_von_ktid mitgeliefert, welches angibt, welchen Personenkontext die Beziehung referenziert.

Beziehungen können nicht direkt geändert werden. Sollte sich die Beziehung ändern, wenn beispielsweise eine andere Person das Sorgerecht bekommt oder sich die Rolle in einer Beziehung ändert, so ist die alte Beziehung zu löschen und eine neue Beziehung zu erstellen.

Request​

Path Parameters

    id stringrequired

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

Responses​

OK

Schema

    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_ktid stringrequired

    ID des Personenkontexts, aus dem heraus die Beziehung besteht.

Loading...