Erstellen einer Sichtfreigabe.

POST /personenkontexte/:id/sichtfreigaben

Mittels dieser Schnittstelle wird eine neue Sichtfreigabe für einen Personenkontext erstellt.

Der Anmeldeserver ermöglicht es, dass Personenkontexte von einer Organisation für eine andere Organisation zur Einsicht freigegeben werden. Dabei kann die andere Organisation auf diese freigegebenen Daten nur lesend zugreifen. Das Erstellen oder Ändern der Daten durch die andere Organisation ist nicht zulässig oder möglich.

Sichtfreigaben können nur für Personenkontexte erteilt werden. Dabei ist über die API immer nur die Sichtfreigabe einzelner Personenkontexte möglich. Es besteht nicht die Möglichkeit, über die API alle Personenkontexte einer Organisation pauschal einer anderen Organisation bereit zu stellen.

Wird ein Personenkontext für eine andere Organisation freigegeben, so hat die andere Organisation auch automatisch Lese-Zugriff auf die im Datenmodell Person beschriebenen Attribute der zu dem Personenkontext gehörenden Person, jedoch nicht auf andere, nicht freigegebene Personenkontexte dieser Person oder auf Gruppenzugehörigkeiten.

Ein Personenkontext kann für mehr als eine andere Organisation freigegeben werden. Dazu sind mehrere Sichtfreigaben zu erstellen.

Bei einer erfolgreichen Anforderung zum Erstellen einer Sichtfreigaben zu einem Personenkontext wird diese Anforderung mit einer Repräsentation der Sichtfreigaben in den Antwort-Nutzdaten und dem HTTP-Statuscode 201 quittiert.

Request

Path Parameters

id stringrequired

Der Pfad-Parameter bezieht sich auf die ID des eigenen Personenkontexts.

application/json

Body

required

von daterequired

Beginn der Sichtfreigabeperiode.

bis daterequired

Ende der Sichtfreigabeperiode.

Responses

application/json

Schema
Example (from schema)

Schema

id stringrequired

ID der Sichtfreigabe.

orgid stringrequired

ID der Organisation für welche die Sichtfreigabe erteilt wurde.

revision stringrequired

Revision der Beziehung.