Zum Hauptinhalt springen

Löscht die Person zur angeforderten ID.

DELETE 
/personen/:id

Dieser Schnittstellenendpunkt löscht die Person zur angeforderten ID.

Ein DELETE zum Löschen einer Person per ID muss mit HTTP-DELETE auf die API /personen/{personendatensatz.person.id} erfolgen. Bevor eine Person gelöscht werden kann, müssen sämtliche Personenkontexte der Person vorher gelöscht werden.

Siehe auch die einzelnen Datenmodelle zu Personendatensatz und Person.

Es ist erforderlich, dass für eine Löschanfrage einer Person das Attribut personendatensatz.person.revision des zugrunde liegenden Personendatensatzes mitgeschickt wird. Der Schulconnex-Server überprüft anhand des mitgeschickten Werts des Attributs personendatensatz.person.revision, ob der Datensatz der Person in der Zwischenzeit keine Änderung erfahren hat.

Request​

Path Parameters

    id stringrequired

    Der Pfad-Parameter bezieht sich auf die vom Quellsystem vergebene ID der Person.

Body

required

    revision stringrequired

    Revision der Person des zugrunde liegenden Personendatensatzes. 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...