Zum Hauptinhalt springen

Löscht die Gruppe zur angeforderten ID.

DELETE 
/gruppen/:id

Dieser Schnittstellenendpunkt löscht die Gruppe zur angegebenen gruppe.id.

Ein DELETE zum Löschen einer Gruppe per gruppe.id muss mit HTTP-DELETE auf die API /gruppen/{gruppe.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 für eine Löschanfrage einer 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.

Wichtig: Das Löschen einer Gruppe löscht auch gleichzeitig alle zu der Gruppe gehörenden Gruppenzugehörigkeiten.

Request​

Path Parameters

    id stringrequired

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

Body

required

    revision stringrequired

    Revision der zugrunde liegenden Gruppe. Dieses Feld ist ein Pflichtfeld.

Responses​

No Content

Bei einer erfolgreichen Ausführung der Löschanfrage wird es keine Antwort-Nutzdaten (Response Payload) geben.

Loading...