Zum Hauptinhalt springen
Version: Version 1.8 Veröffentlichungskandidat 1

Modifiziert den Personendatensatz der angegebenen ID

PATCH 
/personen/:id

Dieser Schnittstellenendpunkt modifiziert den Personendatensatz der angegebenen ID.

Die Modifikation eines Personendatensatzes per ID muss mit HTTP-PATCH auf die API /personen/{personendatensatz.person.id} erfolgen. Die Anfrage-Nutzdaten (Request Payload) beinhalten ein JSON-Objekt des Datentyps Personendatensatz.

Siehe auch die einzelnen Datenmodelle zu Personendatensatz und Person.

Es ist erforderlich, dass das Attribut personendatensatz.person.revision des zugrunde liegenden Personendatensatzes mitgeschickt wird. Der Schulconnex-Service überprüft anhand des mitgeschickten Werts des Attributs personendatensatz.person.revision, ob der Datensatz der Person in der Zwischenzeit keine Änderung erfahren hat. Der Wert des Attributs kann von einem Quellsystem oder Dienst nicht verändert werden; dieser wird mit der Erstellung (Create) des Datensatzes Person und jeder erfolgreichen Änderung (Update) vom Schulconnex-Server neu generiert.

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

AttributIn den Anfrage-Nutzdaten erforderlich?Bemerkung
idneinID der Person. Wird vom Schulconnex-Server vergeben und ist eindeutig. Dieses Attribut ist unveränderbar (immutable).
mandantneinID des Mandanten, dem die Person zugeordnet ist. Wird vom Schulconnex Server vergeben und ist eindeutig. Dieser Wert ist eine Referenz auf einen Mandanten.
revisionJaRevision des Datensatzes. Wird vom Schulconnex-Server mit der Erstellung des Datensatzes sowie Aktualisierung generiert. Dieser Wert kann nicht von Quellsystemen oder Diensten gesetzt werden. Bei einem Update eines Datensatzes muss der letzte Revisionswert für diesen Datensatz mitgegeben werden, damit erkannt werden kann, ob der Datensatz inzwischen anderweitig modifiziert wurde.

Dieser Endpunkt stellt eine HTTP-PATCH Operation bereit, bei der ausschließlich die zu modifizierenden Attribute in der Anfrage-Nutzlast mitgeschickt werden müssem. Werte von Attributen, welche nicht in der Anfrage-Nutzlast mitgeschickt werden, bleiben unverändert.

Um einen Wert zu löschen, muss der Wert des Attributs auf null gesetzt werden, beispielsweise {"geburtsort": null}. Dabei dürfen allerdings keine notwendigen Attribute wie vertrauensstufe gelöscht werden.

Request​

Responses​

OK