Zum Hauptinhalt springen

Erstellen einer Beziehung.

POST 
/personenkontexte/:id/beziehungen

Die Schnittstelle /personenkontexte/{personenkontext.id}/beziehungen erlaubt das Erstellen 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 erstellt eine Beziehung aus einem Personenkontext per ID personenkontext.id.

Ein CREATE zum Erstellen von Beziehungen aus einem Personenkontext muss mit HTTP-POST auf die API /personenkontext/{personenkontext.id}/beziehungen erfolgen. Die Anfrage-Nutzdaten (Request Payload) beinhalten ein JSON-Objekt des Datentyps Beziehungen.

Siehe auch Datenmodell Beziehung.

Bestehen zwischen zwei Personenkontexten mehrere Beziehungen (ist beispielsweise eine Person sowohl erziehungsberechtigt als auch betreuend für eine andere Person), so ist für jede Einzelbeziehung ein eigenes Beziehungsobjekt zu erstellen.

Die folgende Tabelle listet die Attribute einer Beziehung auf, welche von einem Quellsystem oder Dienst nicht verändert werden können.

AttributIn den Anfrage-Nutzdaten erforderlich?Bemerkung
idneinID der Beziehung. Wird vom Schulconnex-Server vergeben und ist eindeutig. Dieses Attribut ist unveränderbar (immutable).
revisionneinRevision der Beziehung. Wird vom Schulconnex-Server mit der Erstellung des Datensatzes sowie Aktualisierung generiert. Dieser Wert kann nicht von Quellsystemen oder Diensten gesetzt werden.

Bei einer erfolgreichen Anforderung zum Erstellen einer Beziehung zu einem Personenkontext wird diese Anforderung mit einer Repräsentation der Beziehung in den Antwort-Nutzdaten und dem HTTP-Statuscode 201 quittiert.

Request​

Path Parameters

    id stringrequired

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

Body

required

    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

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.

Loading...