Zum Hauptinhalt springen

Löscht die Gruppenzugehörigkeit zur angeforderten ID.

DELETE 
/gruppenzugehoerigkeiten/:id

Dieser Schnittstellenendpunkt löscht die Gruppenzugehörigkeit zur angegebenen gruppenzugehoerigkeit.id.

Ein DELETE zum Löschen einer Gruppe per gruppe.id muss mit HTTP-DELETE auf die API /gruppenzugehoerigkeit/{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 für eine Löschanfrage einer 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 des Personenkontext in der Zwischenzeit keine Änderung erfahren hat.

Bei einer erfolgreichen Ausführung der Löschanfrage wird es keine Antwort-Nutzdaten (Response Payload) geben. Eine erfolgreiche Löschanforderung einer Gruppenzugehörigkeit per ID wird mit dem HTTP-Statuscode 204 quittiert.

Request​

Path Parameters

    id stringrequired

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

Body

required

    revision stringrequired

    Revision der zugrunde liegenden Gruppenzugehörigkeit. 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...