Zum Hauptinhalt springen

Aktualisiert den Personenkontext der angegebenen ID.

PUT 
/personenkontexte/:id

Dieser Schnittstellenendpunkt aktualisiert den Personenkontext zur angegebenen {personendatensatz.personenkontexte.id}.

Ein UPDATE zum Aktualisieren eines Personenkontexts per ID muss mit HTTP-PUT auf die API /v1/personenkontexte/{personendatensatz.personenkontext.id} erfolgen. Die Anfrage-Nutzdaten (Request Payload) beinhalten ein JSON-Objekt des Datentyps Personenkontext. Das Datenmodell „Personenkontext“ ist in 5.5 beschrieben.

Es ist erforderlich, dass zur Aktualisierungsanfrage im bearbeiteten Personenkontext das Attribut „personenkontext.revision” des zugrunde liegenden Personenkontexts mitgeschickt wird. Der Schulconnex-Server überprüft anhand des mitgeschickten Werts des Attributs „personenkontext.revision”, ob der Datensatz des Personenkontexts 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 Personenkontext und jeder erfolgreichen Änderung (Update) vom Schulconnex-Server neu generiert.

Die folgende Tabelle listet die Attribute eines Personenkontexts auf, 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).
mandantneinID des Mandanten, dem die Person 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).
rolleneinRolle der Person innerhalb der Organisation. Referenz auf einen Code der Codeliste (Rolle). Dieses Attribut ist unveränderbar (immutable).
sichtfreigabeneingibt an, ob dieser Personenkontext nur aufgrund einer Freigabe durch eine andere Organisation sichtbar ist. Sollte der Wert von Sichtfreigabe Ja sein, so führt ein Update auf diesen Personenkontext zu einer Fehlermeldung, da eine Sichtfreigabe nur das Lesen des Personenkontexts erlaubt.
revisionja (Wert des für die Änderung zugrunde liegenden PersonenkontextRevision des Personenkontexts. Wird vom Schulconnex-Server mit der Erstellung des Datensatzes sowie der Aktualisierung generiert. Dieser Wert kann nicht von Quellsystemen oder Diensten gesetzt werden.

Bis auf die Revisionsnummer können diese nicht veränderbaren Attribute im Request ausgelassen werden. Sind die Attribute im Request dennoch vorhanden, werden sie validiert und führen gegebenenfalls zu einer Fehlermeldung.

Anmerkung: Bei dieser Aktualisierungsanfrage handelt es sich um eine HTTP-PUT-Operation, bei der die Anfrage-Nutzlast mit den gegebenen Attributen der Aktualisierung zugrunde gelegt wird (mitgeschickte Attribute werden aktualisiert, nicht mitgeschickte Attribute werden gelöscht); es ist keine HTTP-PATCH-Operation, bei der lediglich die zu aktualisierenden Attribute in der Anfrage Nutzlast mitgeschickt werden.

Bei einer erfolgreichen Anforderung zum Aktualisieren eines Personenkontexts wird diese Anforderung mit einer Repräsentation des Personenkontexts in den Antwort-Nutzdaten und dem HTTP-Statuscode 200 quittiert.

Die Antwort-Nutzdaten umfassen standardmäßig für das Attribut personendatensatz.personenkontext.organisation mit dem Datentyp Organisation alle nicht optionalen Attribute – nur die ID personendatensatz.personenkontext.organisation.id.

Delete mittels Löschzeitpunkt​

Soll ein Personenkontext gelöscht werden, welcher bereits an Dienste weitergeleitet worden ist, so kann dieser nicht mehr direkt mit einer Delete-Operation gelöscht werden. Es muss dann mit einer Update-Operation ein Löschzeitpunkt gesetzt werden, welcher es diesen erlaubt von Diensten lokal gespeicherte Daten fristgerecht zu löschen.

Request​

Path Parameters

    id stringrequired

    Der Pfad-Parameter bezieht sich auf die ID des Personenkontexts.

Body

required

    id string

    ID des Personenkontexts.

    mandant string

    ID des Mandanten, dem der Personenkontext zugeordnet ist.

    organisation

    object

    id string

    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)

    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 Personenkontext.

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...