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.
| Attribut | In den Anfrage-Nutzdaten erforderlich? | Bemerkung |
|---|---|---|
id | nein | ID der Person. Wird vom Schulconnex-Server vergeben und ist eindeutig. Dieses Attribut ist unveränderbar (immutable). |
mandant | nein | ID des Mandanten, dem die Person zugeordnet ist. Wird vom Schulconnex Server vergeben und ist eindeutig. Dieser Wert ist eine Referenz auf einen Mandanten. |
revision | Ja | Revision 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
Path Parameters
Der Pfad-Parameter bezieht sich auf die vom Quellsystem vergebene ID der Person.
- application/json
Body
required
- m männlich
- w weiblich
- d divers
- x keine Angabe
- de deutsch
- de-XX deutsch, Anrede du, einfache Sprache
- en-GB englisch (Vereinigtes Königreich)
- Kein - kein - Der Schlüsselbesitzer ist nicht vertrauenswürdig.
- Unbe - unbekannt - Der Schlüsselbesitzer ist unbekannt.
- Teil - vertraut - Dem Schlüsselbesitzer wird vertraut.
- Voll - verifiziert - Der Schlüsselbesitzer ist eindeutig und formal identifiziert.
- Ja
true - Nein
false
ID der Person. Wird vom Schulconnex-Server vergeben und ist eindeutig. Dieses Attribut ist unveränderbar (immutable).
ID des Mandanten, dem die Personen zugeordnet ist. Wird vom Schulconnex-Server vergeben und ist eindeutig.
Revision der Person. Wird vom Schulconnex-Server mit der Erstellung des Datensatzes sowie Aktualisierung generiert. Dieser Wert kann nicht von Quellsystemen oder Diensten gesetzt werden.
Identifikations-ID einer Person. Wird vom Quellsystem vergeben und muss im Quellsystem eindeutig sein (z. B. eine einheitliche Personalnummer).
ID der Stammorganisation. Personen können einer Organisation angehören, jedoch zeitweise an einer anderen Organisation tätig sein. Der häufigste Anwendungsfall ist die Abordnung eines Lehrenden an eine andere Dienststelle. Die Stammorganisation ist unabhängig vom Personenkontext.
name
object
required
Familienname(n) der Person. Mehrere Familiennamen werden durch Leerzeichen separiert.
Mehrere Vornamen werden durch Leerzeichen separiert.
Possible values: <= 8 characters
Initial oder Initialen des Familiennamens, maximal acht Zeichen.
Possible values: <= 8 characters
Initial oder Initialen des Vornamens, maximal acht Zeichen.
Possible values: <= 32 characters
Bei mehreren Vornamen wird der täglich im Gebrauch genutzte Vorname geführt, maximal 32 Zeichen.
Possible values: <= 128 characters
Titel der Person (bspw. ein akademischer Grad, Dienst- und Amtsbezeichnungen oder militärische Ränge), maximal 128 Zeichen.
Possible values: <= 64 characters
Liste (Array) von Namenszusätzen bei der Anrede. Jeder einzelne Namenszusatz hat eine Maximallänge von 64 Zeichen, die Maximallänge für alle Namenszusätze liegt bei 512 Zeichen.
Possible values: <= 64 characters
Liste (Array) von Namenssuffixen. Jeder einzelne Namenssuffix hat eine Maximallänge von 64 Zeichen, die Maximallänge für alle Namenssuffixe liegt bei 1024 Zeichen.
Possible values: Value must match regular expression ^[0-9]+$
Index des Buchstabens des Nachnamens, nach dem sortiert werden soll. Der Index ist Null-basiert, d. h. ein Wert von „4“ zeigt an, dass die ersten vier Buchstaben ignoriert und ab dem fünften Buchstaben des Nachnamens sortiert werden soll. Ist kein Sortierindex angegeben, so ist der Nachname entsprechend dem ersten Buchstaben in Listen einzusortieren, äquivalent zum Sortierindex „0“.
geburt
object
Geburtsdatum einer Person.
Geburtsort einer Person, bestehend aus Ortsname und Land, beispielsweise „Eindhoven, Niederlande“. Wird kein Land angegeben, so wird als Land „Deutschland“ angenommen, d.h. der Geburtsort „Erfurt“ ist wie „Erfurt, Deutschland“ zu behandeln.
Possible values: [m, w, d, x]
Geschlecht:
Basierend auf RFC 5646. Mögliche Beispiele:
Possible values: [Kein, Unbe, Teil, Voll]
Wie folgt:
Possible values: [Ja, Nein]
Die Codeliste „Boolean“ regelt das Mapping der deutschen Wörter „ja“ und „nein“ auf die englischen Begriffe „true“ und „false“:
Responses
- 200
- 304
- 400
- 401
- 403
- 404
- 405
- 409
OK
- application/json
- Schema
- Example (from schema)
Schema
- m männlich
- w weiblich
- d divers
- x keine Angabe
- de deutsch
- de-XX deutsch, Anrede du, einfache Sprache
- en-GB englisch (Vereinigtes Königreich)
- Kein - kein - Der Schlüsselbesitzer ist nicht vertrauenswürdig.
- Unbe - unbekannt - Der Schlüsselbesitzer ist unbekannt.
- Teil - vertraut - Dem Schlüsselbesitzer wird vertraut.
- Voll - verifiziert - Der Schlüsselbesitzer ist eindeutig und formal identifiziert.
- Ja
true - Nein
false
ID der Person. Wird vom Schulconnex-Server vergeben und ist eindeutig. Dieses Attribut ist unveränderbar (immutable).
ID des Mandanten, dem die Personen zugeordnet ist. Wird vom Schulconnex-Server vergeben und ist eindeutig.
Revision der Person. Wird vom Schulconnex-Server mit der Erstellung des Datensatzes sowie Aktualisierung generiert. Dieser Wert kann nicht von Quellsystemen oder Diensten gesetzt werden.
Identifikations-ID einer Person. Wird vom Quellsystem vergeben und muss im Quellsystem eindeutig sein (z. B. eine einheitliche Personalnummer).
ID der Stammorganisation. Personen können einer Organisation angehören, jedoch zeitweise an einer anderen Organisation tätig sein. Der häufigste Anwendungsfall ist die Abordnung eines Lehrenden an eine andere Dienststelle. Die Stammorganisation ist unabhängig vom Personenkontext.
name
object
required
Familienname(n) der Person. Mehrere Familiennamen werden durch Leerzeichen separiert.
Mehrere Vornamen werden durch Leerzeichen separiert.
Possible values: <= 8 characters
Initial oder Initialen des Familiennamens, maximal acht Zeichen.
Possible values: <= 8 characters
Initial oder Initialen des Vornamens, maximal acht Zeichen.
Possible values: <= 32 characters
Bei mehreren Vornamen wird der täglich im Gebrauch genutzte Vorname geführt, maximal 32 Zeichen.
Possible values: <= 128 characters
Titel der Person (bspw. ein akademischer Grad, Dienst- und Amtsbezeichnungen oder militärische Ränge), maximal 128 Zeichen.
Possible values: <= 64 characters
Liste (Array) von Namenszusätzen bei der Anrede. Jeder einzelne Namenszusatz hat eine Maximallänge von 64 Zeichen, die Maximallänge für alle Namenszusätze liegt bei 512 Zeichen.
Possible values: <= 64 characters
Liste (Array) von Namenssuffixen. Jeder einzelne Namenssuffix hat eine Maximallänge von 64 Zeichen, die Maximallänge für alle Namenssuffixe liegt bei 1024 Zeichen.
Possible values: Value must match regular expression ^[0-9]+$
Index des Buchstabens des Nachnamens, nach dem sortiert werden soll. Der Index ist Null-basiert, d. h. ein Wert von „4“ zeigt an, dass die ersten vier Buchstaben ignoriert und ab dem fünften Buchstaben des Nachnamens sortiert werden soll. Ist kein Sortierindex angegeben, so ist der Nachname entsprechend dem ersten Buchstaben in Listen einzusortieren, äquivalent zum Sortierindex „0“.
geburt
object
Geburtsdatum einer Person.
Geburtsort einer Person, bestehend aus Ortsname und Land, beispielsweise „Eindhoven, Niederlande“. Wird kein Land angegeben, so wird als Land „Deutschland“ angenommen, d.h. der Geburtsort „Erfurt“ ist wie „Erfurt, Deutschland“ zu behandeln.
Possible values: [m, w, d, x]
Geschlecht:
Basierend auf RFC 5646. Mögliche Beispiele:
Possible values: [Kein, Unbe, Teil, Voll]
Wie folgt:
Possible values: [Ja, Nein]
Die Codeliste „Boolean“ regelt das Mapping der deutschen Wörter „ja“ und „nein“ auf die englischen Begriffe „true“ und „false“:
{
"id": "a6e1a860-8d44-4b2b-aef7-aa2c8bf5beb5",
"mandant": "58f45270-8e54-40c6-a212-980307fc19be",
"revision": "1",
"referrer": "125",
"stammorganisation": "ad4a5d27-631d-49a3-bc0a-cc28614f8443",
"name": {
"familienname": "von Musterfrau",
"vorname": "Natalie",
"initialenfamilienname": "M",
"initialenvorname": "N",
"rufname": "string",
"titel": "string",
"anrede": [
"string"
],
"namenssuffix": [
"string"
],
"sortierindex": "4"
},
"geburt": {
"datum": "2005-05-01",
"geburtsort": "Berlin, Deutschland"
},
"geschlecht": "m",
"lokalisierung": "de",
"vertrauensstufe": "Kein",
"auskunftssperre": "Ja"
}
Not Modified
Bad Request
Siehe Fehlerbehandlung
Unauthorized
Siehe Fehlerbehandlung
Forbidden
Siehe Fehlerbehandlung
Not found
Siehe Fehlerbehandlung
Method not allowed
Siehe Fehlerbehandlung
Conflict
Siehe Fehlerbehandlung