Zum Hauptinhalt springen

Freigaben für Personenkontexte löschen

DELETE 
/sichtfreigaben/:id

Die Schnittstelle /sichtfreigaben/{sichtfreigabe.id} erlaubt es, Sichtfreigaben von Personenkontexten für andere Organisationen wieder zu löschen. Der Pfad-Parameter sichtfreigabe.id bezieht sich auf die ID der Freigabe.

Eine solche Löschung ist eher ein Ausnahmefall.

Im Normalfall wird eine Sichtfreigabe über das in ihr enthaltene Enddatum terminiert.

Ein DELETE muss mit einer HTTP-DELETE Anfrage erfolgen. Die Anfrage-Nutzdaten (Request Payload) beinhalten die Revisionsnummer.

Siehe auch das Datenmodell zu Sichtfreigabe.

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

Request​

Path Parameters

    id stringrequired

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

Body

required

    revision stringrequired

    Revision der zugrunde liegenden Sichtfreigabe. 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...