Erstellen einer Gruppenzugehörigkeit.

POST /gruppen/:id/gruppenzugehoerigkeiten

Dieser Schnittstellenendpunkt erstellt eine Gruppenzugehörigkeit zur angegebenen Gruppe per ID gruppe.id.

Ein CREATE zum Erstellen von Gruppenzugehörigkeiten zu einer Gruppe muss mit HTTP-POST auf die API /gruppen/{gruppe.id}/gruppenzugehoerigkeiten erfolgen. Die Anfrage-Nutzdaten (Request Payload) beinhalten ein JSON-Objekt des Datentyps Gruppenzugehörigkeiten.

Siehe auch Datenmodell Gruppenzugehörigkeit.

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

Attribut	In den Anfrage-Nutzdaten erforderlich?	Bemerkung
`id`	nein	ID der Gruppenzugehörigkeit. Wird vom Schulconnex-Server vergeben und ist eindeutig. Dieses Attribut ist unveränderbar (immutable).
`revision`	nein	Revision der Gruppenzugehörigkeit. 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 Gruppenzugehörigkeit zu einer Gruppe wird diese Anforderung mit einer Repräsentation der Gruppenzugehörigkeit in den Antwort-Nutzdaten und dem HTTP-Statuscode 201 quittiert.

Request

Path Parameters

id stringrequired

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

application/json

Body

required

referrer string

ID der Gruppenzugehörigkeit im Quellsystem.

ktid stringrequired

ID des Personenkontexts, welcher der Gruppe zugeordnet ist.

rollen components-code-Gruppenrolle (string)[]required

Possible values: [Lern, Lehr, KlLeit, Foerd, VLehr, SchB, GMit, GLeit]

von date

Beginn der Gruppenzugehörigkeit. Dieser Zeitpunkt kann auch in der Zukunft liegen.

bis date

Ende der Gruppenzugehörigkeit.

Responses

application/json

Schema
Example (from schema)

Schema

id stringrequired

ID der Gruppenzugehörigkeit.

mandant stringrequired

ID des Mandanten, dem die Gruppenzugehörigkeit zugeordnet ist.