Zum Hauptinhalt springen

Aktualisiert den Personendatensatz der angegebenen ID

PUT 
/personen/:id

Dieser Schnittstellenendpunkt aktualisiert den Personendatensatz der angegebenen ID.

Ein UPDATE zum Aktualisieren eines Personendatensatzes per ID muss mit HTTP-PUT 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 zur Aktualisierungsanfrage im bearbeiteten Personendatensatz 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.

Request​

Responses​

OK