Aktualisiert die Gruppenzugehörigkeit der angegebenen ID.

PUT /gruppenzugehoerigkeiten/:id

Dieser Schnittstellenendpunkt aktualisiert die Gruppenzugehörigkeit zur angegebenen gruppenzugehoerigkeit.id.

Ein UPDATE zum Aktualisieren einer Gruppenzugehörigkeit per ID muss mit HTTP-PUT auf die API /gruppenzugehoerigkeiten/{gruppenzugehoerigkeit.id} erfolgen. Die Anfrage-Nutzdaten (Request Payload) beinhalten ein JSON-Objekt des Datentyps Gruppenzugehörigkeit.

Siehe auch die einzelnen Datenmodelle zu Gruppenzugehörigkeit.

Es ist erforderlich, dass zur Aktualisierungsanfrage in der bearbeiteten Gruppenzugehörigkeit das Attribut revision der zugrunde liegenden Gruppenzugehörigkeit mitgeschickt wird. Der Schulconnex-Server überprüft anhand des mitgeschickten Werts des Attributs revision, ob der Datensatz der Gruppenzugehörigkeit in der Zwischenzeit keine Änderung erfahren hat. Der Wert des Attributs kann von einem Quellsystem oder Dienst nicht verändert werden; dieser wird mit der Erstellung (Create) des Datensatzes Gruppenzugehörigkeit und jeder erfolgreichen Änderung (Update) vom Schulconnex-Server neu generiert.

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

Attribut	Bemerkung
`id`	ID der Gruppenzugehörigkeit. Wird vom Schulconnex-Server vergeben und ist eindeutig. Dieses Attribut ist unveränderbar (immutable).
`revision`	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.

Die ID kann im Request ausgelassen werden. Ist das Attribut im Request dennoch vorhanden, wird es validiert und führt gegebenenfalls zu einer Fehlermeldung.

Anmerkung: Bei dieser Aktualisierungsanfrage handelt es sich um eine HTTP-PUT-Operation, bei der die Anfrage-Nutzlast mit den gegebenen Attributen der Aktualisierung zugrunde gelegt wird (mitgeschickte Attribute werden aktualisiert, nicht mitgeschickte Attribute werden gelöscht); es ist keine HTTP-PATCH-Operation, bei der lediglich die zu aktualisierenden Attribute in der Anfrage-Nutzlast mitgeschickt werden.

Bei einer erfolgreichen Anforderung zum Aktualisieren einer Gruppenzugehörigkeit wird diese Anforderung mit einer Repräsentation der Gruppenzugehörigkeit in den Antwort-Nutzdaten und dem HTTP-Statuscode 200 quittiert.

Request

Path Parameters

id stringrequired

Der Pfad-Parameter bezieht sich auf die ID der Gruppenzugehörigkeit.

application/json

Body

required

id string

ID der Gruppenzugehörigkeit.

mandant string

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

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.

revision stringrequired

Revision der Gruppenzugehörigkeit.

Responses

application/json

Schema
Example (from schema)

Schema