Zum Hauptinhalt springen

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.

AttributIn den Anfrage-Nutzdaten erforderlich?Bemerkung
idneinID des Personenkontexts. Wird vom Schulconnex-Server vergeben und ist eindeutig. Dieses Attribut ist unveränderbar (immutable).
referrerneinID des Personenkontexts im Quellsystem. Wird vom Quellsystem vergeben und ist eindeutig.
mandantneinID des Mandanten, dem die Personen zugeordnet ist. Wird vom Schulconnex-Server vergeben und ist eindeutig. Dieser Wert ist eine Referenz auf einen Mandanten.
organisationnein
organisation.idneinID der Organisation. Wird vom Schulconnex-Server vergeben und ist eindeutig. Dieses Attribut ist unveränderbar (immutable).
revisionneinRevision 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.

Request​

Path Parameters

    id stringrequired

    Der Pfad-Parameter bezieht sich auf die vom Quellsystem vergebene ID der Person.

Body

required

    referrer string

    ID des Personenkontexts im Quellsystem.

    rolle components-code-Rolle (string)required

    Possible values: [Lern, Lehr, SorgBer, Extern, OrgAdmin, Leit, SysAdmin, SchB, NLehr]

    Wie folgt:

    • Lern Lernende/-r
    • Lehr Lehrende/-r
    • SorgBer Sorgeberechtigte/-r
    • Extern externe Person
    • OrgAdmin Organisationsadministrator
    • Leit Organisationsleitung
    • SysAdmin Systemadministrator
    • Schulbegleiter/-in
    • Nicht-lehrendes Personal

    erreichbarkeiten

    object[]

  • Array [

    • typ components-code-Erreichbarkeitstyp (string)required

    Possible values: [E-Mail]

    Wie folgt:

    • E-Mail E-Mail-Adressen müssen RFC 5322 (Internet Message Format) erfüllen
    kennung emailrequired

    Konkrete Angabe der zum Erreichen der Person oder Organisation notwendigen Information.

  • ]

    • personenstatus components-code-Personenstatus (string)

    Possible values: [Aktiv]

    Wie folgt:

    • Aktiv aktiv
    jahrgangsstufe components-code-Jahrgangsstufe (string)

    Possible values: [01, 02, 03, 04, 05, 06, 07, 08, 09, 10, 11, 12, 13]

    Wie folgt:

    • 01 Jahrgangsstufe 1
    • 02 Jahrgangsstufe 2
    • 03 Jahrgangsstufe 3
    • 04 Jahrgangsstufe 4
    • 05 Jahrgangsstufe 5
    • 06 Jahrgangsstufe 6
    • 07 Jahrgangsstufe 7
    • 08 Jahrgangsstufe 8
    • 09 Jahrgangsstufe 9
    • 10 Jahrgangsstufe 10
    • 11 Jahrgangsstufe 11
    • 12 Jahrgangsstufe 12
    • 13 Jahrgangsstufe 13
    sichtfreigabe components-code-Boolean (string)

    Possible values: [Ja, Nein]

    Die Codeliste „Boolean“ regelt das Mapping der deutschen Wörter „ja“ und „nein“ auf die englischen Begriffe „true“ und „false“:

    • Ja true
    • Nein false

    loeschung

    object

    zeitpunkt date-time

    Datum und Uhrzeit der Löschung des Personenkontexts.

Responses​

OK

Schema

    id stringrequired

    ID des Personenkontexts.

    mandant stringrequired

    ID des Mandanten, dem der Personenkontext zugeordnet ist.

    organisation

    object

    Organisation.

    id stringrequired

    ID der Organisation.

    referrer string

    ID des Personenkontexts im Quellsystem.

    erreichbarkeiten

    object[]

  • Array [

    • typ components-code-Erreichbarkeitstyp (string)required

    Possible values: [E-Mail]

    Wie folgt:

    • E-Mail E-Mail-Adressen müssen RFC 5322 (Internet Message Format) erfüllen
    kennung emailrequired

    Konkrete Angabe der zum Erreichen der Person oder Organisation notwendigen Information.

  • ]

    • personenstatus components-code-Personenstatus (string)

    Possible values: [Aktiv]

    Wie folgt:

    • Aktiv aktiv
    jahrgangsstufe components-code-Jahrgangsstufe (string)

    Possible values: [01, 02, 03, 04, 05, 06, 07, 08, 09, 10, 11, 12, 13]

    Wie folgt:

    • 01 Jahrgangsstufe 1
    • 02 Jahrgangsstufe 2
    • 03 Jahrgangsstufe 3
    • 04 Jahrgangsstufe 4
    • 05 Jahrgangsstufe 5
    • 06 Jahrgangsstufe 6
    • 07 Jahrgangsstufe 7
    • 08 Jahrgangsstufe 8
    • 09 Jahrgangsstufe 9
    • 10 Jahrgangsstufe 10
    • 11 Jahrgangsstufe 11
    • 12 Jahrgangsstufe 12
    • 13 Jahrgangsstufe 13
    rolle components-code-Rolle (string)required

    Possible values: [Lern, Lehr, SorgBer, Extern, OrgAdmin, Leit, SysAdmin, SchB, NLehr]

    Wie folgt:

    • Lern Lernende/-r
    • Lehr Lehrende/-r
    • SorgBer Sorgeberechtigte/-r
    • Extern externe Person
    • OrgAdmin Organisationsadministrator
    • Leit Organisationsleitung
    • SysAdmin Systemadministrator
    • Schulbegleiter/-in
    • Nicht-lehrendes Personal
    sichtfreigabe components-code-Boolean (string)

    Possible values: [Ja, Nein]

    Die Codeliste „Boolean“ regelt das Mapping der deutschen Wörter „ja“ und „nein“ auf die englischen Begriffe „true“ und „false“:

    • Ja true
    • Nein false

    loeschung

    object

    zeitpunkt date-time

    Datum und Uhrzeit der Löschung des Personenkontexts.

    revision stringrequired

    Revision des Personenkontexts.

Loading...