Zum Hauptinhalt springen

Erstellen eines Personendatensatzes

POST 
/personen

Mittels dieser Schnittstelle wird ein neuer Datensatz „Person“ erstellt.

Ein CREATE zum Erstellen von Personendatensätzen muss mit HTTP-POST auf die API /personen erfolgen. Die Anfrage-Nutzdaten (Request Payload) beinhalten ein JSON-Objekt des Datentyps Personendatensatz. Siehe auch die einzelnen Datenmodelle zu Personendatensatz und Person.

Die folgende Tabelle listet die Attribute einer Person (personendatensatz.person), welche von einem Quellsystem oder Dienst nicht gesetzt 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.
revisionneinRevision der Person. Wird vom Schulconnex-Server mit der Erstellung des Datensatzes sowie Aktualisierung generiert. Dieser Wert kann nicht von Quellsystemen oder Diensten gesetzt werden.

In Anbetracht der Attribute, die von einem Quellsystem oder Dienst bei der Erstellung einer Person nicht gesetzt oder verändert werden können, ergibt sich folgende JSON-Struktur der Anfrage-Nutzdaten (Request Payload):

{
  "referrer": <String>, // ID der Person im Quellsystem.
  "name": {
    "familienname": <String>,
    //Familienname der Person. Dieses Feld ist ein Pflichtfeld.
    "vorname": <String>,
    // Vorname der Person. Dieses Feld ist ein Pflichtfeld.
    "initialenfamilienname": <String>,
    //Initial oder Initialen des Familiennames der Person. D
    "initialenvorname ": <String>,
    // Initial oder Initialen des Vornamens der Person.
    "rufname": <String>, // Rufname der Person.
    "titel": <String>, // Titel der Person.
    "anrede": [
      <String> // Liste von Anreden der Person.
    ],
    "namenssuffix": [
      <String> // Liste von Namenssuffixe der Person.
    ],
    "sortierindex": <String> // sortierindex des Nachnamens
  },
  "geburt": {
    "datum": <Datum>, // Geburtsdatum der Person.
    "geburtsort": <String> // Geburtsort der Person.
  },
  "geschlecht": <Code>,
  // Geschlecht der Person. Siehe Code-Liste „Geschlecht“.
  "lokalisierung": <String>, // Zm Beispiel "de", String basierend auf RFC 5646.
  "vertrauensstufe": <Code>,
  // Vertrauensstufe. Siehe Code-Liste „Vertrauensstufe“.
  "auskunftssperre": <Code>
  // Auskunftssperre. Siehe Code-Liste „Boolean“.
  // Dieses Feld ist ein Pflichtfeld.
 }

Bei einer erfolgreichen Anforderung zum Erstellen eines Personendatensatzes wird diese Anforderung mit einer Repräsentation des Personendatensatzes in den Antwort-Nutzdaten und dem HTTP Status Code 201 quittiert.

Request​

Responses​

OK