Erstellen eines Personenkontexts zu einem bestimmten Personendatensatz

POST /personen/:id/personenkontexte

Dieser Schnittstellenendpunkt erstellt einen Personenkontext zur angegebenen Person per ID personendatensatz.person.id.

Ein CREATE zum Erstellen von Personenkontexten zu einem Personendatensatz muss mit HTTP-POST auf die API /personen/{personendatensatz.person.id}/personenkontexte erfolgen. Die Anfrage-Nutzdaten (Request Payload) beinhalten ein JSON-Objekt des Datentyps Personenkontext.

Siehe auch Datenmodell Personenkontext.

Beim Erstellen eines Personenkontexts ist der Default-Status des Attributes personenstatus der Wert Aktiv.

Beim Erstellen eines Personenkontexts zu einem Personendatensatz wird immer die eigene Organisation per ID referenziert; die Organisation und deren ID organisation.id wird vom Schulconnex-Server aus dem access_token übernommen.

Die folgende Tabelle listet die Attribute eines Personenkontext (personendatensatz.personenkontexte), welche von einem Quellsystem oder Dienst nicht verändert werden können.

Attribut	In den Anfrage-Nutzdaten erforderlich?	Bemerkung
`id`	nein	ID des Personenkontexts. Wird vom Schulconnex-Server vergeben und ist eindeutig. Dieses Attribut ist unveränderbar (immutable).
`referrer`	nein	ID des Personenkontexts im Quellsystem. Wird vom Quellsystem vergeben und ist eindeutig.
`mandant`	nein	ID des Mandanten, dem die Personen zugeordnet ist. Wird vom Schulconnex-Server vergeben und ist eindeutig. Dieser Wert ist eine Referenz auf einen Mandanten.
`organisation`	nein
`organisation.id`	nein	ID der Organisation. Wird vom Schulconnex-Server vergeben und ist eindeutig. Dieses Attribut ist unveränderbar (immutable).
`revision`	nein	Revision des Personenkontexts. Wird vom Schulconnex-Server mit der Erstellung des Datensatzes sowie Aktualisierung generiert. Dieser Wert kann nicht von Quellsystemen oder Diensten gesetzt werden.

Bei einer erfolgreichen Anforderung zum Erstellen eines Personenkontexts zu einem Personendatensatz wird diese Anforderung mit einer Repräsentation des Personenkontexts in den Antwort-Nutzdaten und dem HTTP-Statuscode 201 quittiert.

Die Organisation wurde beim Erstellen eines Personenkontexts vom Schulconnex-Server aus dem access_token übernommen und per personenkontext.organisation.id referenziert. Die Antwort-Nutzdaten umfassen standardmäßig für das Attribut personenkontext.organisation mit dem Datentyp Organisation alle nicht optionalen Attribute – nur die ID personenkontext.organisation.id.

Erstellen eines Personenkontexts zu einem bestimmten Personendatensatz

/personen/:id/personenkontexte

Request​

Responses​

Request

Responses