Version: Version 1.8 Veröffentlichungskandidat 1

Modifiziert die Gruppe der angegebenen ID

PATCH /gruppen/:id

Dieser Schnittstellenendpunkt modifiziert die Gruppe zur angegebenen gruppen.id durch eine PATCH-Operation.

Die Modifikation einer Gruppe per ID muss mit HTTP-PATCH auf die API /gruppen/{gruppen.id} erfolgen. Die Anfrage-Nutzdaten (Request Payload) beinhalten ein JSON-Objekt des Datentyps Gruppe.

Siehe auch die einzelnen Datenmodelle zu Gruppe.

Es ist erforderlich, dass das Attribut gruppe.revision der zugrunde liegenden Gruppe mitgeschickt wird. Der Schulconnex-Server überprüft anhand des mitgeschickten Werts des Attributs gruppe.revision, ob der Datensatz der Gruppe 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 Gruppe und jeder erfolgreichen Änderung (Update) vom Schulconnex-Server neu generiert.

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

Attribut	Bemerkung
`id`	ID der Gruppe. Wird vom Schulconnex-Server vergeben und ist eindeutig. Dieses Attribut ist unveränderbar (immutable).
`mandant`	Mandanten-ID der Gruppe. Wird vom Schulconnex-Server vergeben und ist eindeutig. Dieses Attribut ist unveränderbar (immutable).
`orgid`	Organisations-ID der Gruppe. Wird automatisch vergeben und ist eindeutig. Dieses Attribut ist unveränderbar (immutable).
`revision`	Revision der Gruppe. Wird vom Schulconnex-Server mit der Erstellung des Datensatzes sowie sowie bei der Aktualisierung generiert. Dieser Wert kann nicht von Quellsystemen oder Diensten gesetzt werden.

Die Attribute id, mandant und orgid können im Request ausgelassen werden. Sind ein oder mehrere Attribute im Request dennoch vorhanden, wird es oder werden sie validiert und führen gegebenenfalls zu einer Fehlermeldung.

Dieser Endpunkt stellt eine HTTP-PATCH Operation bereit, bei der ausschließlich die zu modifizierenden Attribute in der Anfrage-Nutzlast mitgeschickt werden müssen. Werte von Attributen, welche nicht in der Anfrage-Nutzlast mitgeschickt werden, bleiben unverändert.

Um einen Wert zu löschen, muss der Wert des Attributs auf null gesetzt werden, beispielsweise {"beschreibung": null}. Dabei dürfen allerdings keine notwendigen Attribute wie bezeichnung gelöscht werden.

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

Modifiziert die Gruppe der angegebenen ID

/gruppen/:id

Request​

Responses​

Request

Responses