Zum Hauptinhalt springen

Aktualisiert die Gruppe der angegebenen ID

PUT 
/gruppen/:id

Dieser Schnittstellenendpunkt aktualisiert die Gruppe zur angegebenen gruppen.id.

Ein UPDATE zum Aktualisieren einer Gruppe per ID muss mit HTTP-PUT 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 zur Aktualisierungsanfrage in der bearbeiteten Gruppe 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.

AttributBemerkung
idID der Gruppe. Wird vom Schulconnex-Server vergeben und ist eindeutig. Dieses Attribut ist unveränderbar (immutable).
mandantMandanten-ID der Gruppe. Wird vom Schulconnex-Server vergeben und ist eindeutig. Dieses Attribut ist unveränderbar (immutable).
orgidOrganisations-ID der Gruppe. Wird automatisch vergeben und ist eindeutig. Dieses Attribut ist unveränderbar (immutable).
revisionRevision der Gruppe. Wird vom Schulconnex-Server mit der Erstellung des Datensatzes sowie 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.

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 Gruppe wird diese Anforderung mit einer Repräsentation der Gruppe in den Antwort-Nutzdaten und dem HTTP-Statuscode 200 quittiert.

Request​

Responses​

OK