Zum Hauptinhalt springen

Aktualisiert die Gruppe der angegebenen ID.

PUT 
/gruppen/:id

Dieser Schnittstellenendpunkt aktualisiert die Gruppe zur angegebenen gruppen.id.

Ein UPDATE zum Aktualisieren einer Gruppe per ID muss mit HTTP-PUT auf die API /gruppen/{gruppen.id} erfolgen. Die Anfrage-Nutzdaten (Request Payload) beinhalten ein JSON-Objekt des Datentyps Gruppe.

Siehe auch die einzelnen Datenmodelle zu Gruppe.

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

Die folgende Tabelle listet die Attribute einer Gruppe auf, welche von einem Quellsystem oder Dienst nicht verändert werden können.

AttributBemerkung
idID der Gruppe. Wird vom Schulconnex-Server vergeben und ist eindeutig. Dieses Attribut ist unveränderbar (immutable).
mandantMandanten-ID der Gruppe. Wird vom Schulconnex-Server vergeben und ist eindeutig. Dieses Attribut ist unveränderbar (immutable).
orgidOrganisations-ID der Gruppe. Wird automatisch vergeben und ist eindeutig. Dieses Attribut ist unveränderbar (immutable).
revisionRevision der Gruppe. Wird vom Schulconnex-Server mit der Erstellung des Datensatzes sowie Aktualisierung generiert. Dieser Wert kann nicht von Quellsystemen oder Diensten gesetzt werden.

Die Attribute id, mandant und orgid können im Request ausgelassen werden. Sind ein oder mehrere Attribute im Request dennoch vorhanden, wird es oder 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 einer Gruppe wird diese Anforderung mit einer Repräsentation der Gruppe in den Antwort-Nutzdaten und dem HTTP-Statuscode 200 quittiert.

Request​

Path Parameters

    id stringrequired

    Der Pfad-Parameter bezieht sich auf die ID der Gruppe.

Body

required

    id string

    ID der Gruppe.

    mandant string

    ID des Mandanten.

    orgid string

    ID der Organisation.

    revision stringrequired

    Revision der Gruppe.

    referrer string

    ID der Gruppe im Quellsystem.

    bezeichnung stringrequired

    Bezeichnung der Gruppe.

    thema string

    Thema der Gruppe in Kurzform.

    beschreibung string

    Possible values: <= 1024 characters

    Zusätzliche optionale Beschreibung der Gruppe.

    typ components-code-Gruppentyp (string)required

    Possible values: [Klasse, Kurs, Sonstig]

    Wie folgt:

    • Klasse Schulklasse
    • Kurs Kurs/Unterricht
    • Sonstig Sonstige Gruppe
    bereich components-code-Gruppenbereich (string)

    Possible values: [Pflicht, Wahl, Wahlpflicht]

    Diese Codeliste ist spezifisch für das Bundesland Niedersachsen:

    • Pflicht Pflichtunterricht
    • Wahl Wahlunterricht
    • Wahlpflicht Wahlpflichtunterricht
    optionen components-code-Gruppenoption (string)[]

    Possible values: [``]

    differenzierung components-code-Gruppendifferenzierung (string)

    Possible values: [G, E, Z, gA, eA]

    Diese Codeliste ist spezifisch für das Bundesland Niedersachsen:

    • G G-Kurs
    • E E-Kurs
    • Z Z-Kurs
    • gA grundlegendes Anforderungsniveau
    • eA erhöhtes Anforderungsniveau
    bildungsziele components-code-Bildungsziel (string)[]

    Possible values: [GS, HS, RS, GY-SEK-I, GY-SEK-II]

    jahrgangsstufen components-code-Jahrgangsstufe (string)[]

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

    faecher

    object[]

  • Array [

    • oneOf

    kennung components-code-Fächerkanon (string)

    Possible values: [BI, CH, CI, DE, DS, EK, EN, FR, GR, NL, IT, SN, KU, LA, RS, GE, PO, PW, RE, RI, RK, SP, SU, TE, TG, WE, WN, WS, DA, MA, HW, MU, PA, PH, IF, AW, GL, PWI, PTE, PGUS, NAT]

    Diese Codeliste ist spezifisch für das Bundesland Niedersachsen:

    • BI Biologie
    • CH Chemie
    • CI Chinesisch
    • DE Deutsch
    • DS Darstellendes Spiel
    • EK Erdkunde
    • EN Englisch
    • FR Französisch
    • GR Griechisch
    • NL Niederländisch
    • IT Italienisch
    • SN Spanisch
    • KU Kunst
    • LA Latein
    • RS Russisch
    • GE Geschichte
    • PO Politik
    • PW Politik/Wirtschaft
    • RE Evangelische Religion
    • RI Islamische Religion
    • RK Katholische Religion
    • SP Sport
    • SU Sachunterricht
    • TE Technik
    • TG Textiles Gestalten
    • WE Gestaltendes Werken
    • WN Werte und Normen
    • WS Wirtschaft
    • DA Deutsch als Zweitsprache
    • MA Mathematik
    • HW Hauswirtschaft
    • MU Musik
    • PA Pädagogik
    • PH Physik
    • IF Informatik
    • AW Arbeit-Wirtschaft-Technik
    • GL Gesellschaftslehre
    • PWI Profil Wirtschaft
    • PTE Profil Technik
    • PGUS Profil Gesundheit und Soziales
    • NAT Naturwissenschaften

  • ]

    • referenzgruppen

    object[]

  • Array [

    • grupid stringrequired

    ID der Referenzgruppe.

    rollen components-code-Gruppenrolle (string)[]

    Possible values: [Lern, Lehr, KlLeit, Foerd, VLehr, SchB, GMit, GLeit]

  • ]

    • laufzeit

    object

    oneOf

    von date

    Anfang des Gültigkeitszeitraums der Gruppe. Dieser Zeitpunkt kann auch in der Zukunft liegen.

    bis date

    Ende des Gültigkeitszeitraums der Gruppe.

Responses​

OK

Schema

    id stringrequired

    ID der Gruppe.

    mandant stringrequired

    ID des Mandanten.

    orgid string

    ID der Organisation.

    revision stringrequired

    Revision der Gruppe.

    referrer string

    ID der Gruppe im Quellsystem.

    bezeichnung stringrequired

    Bezeichnung der Gruppe.

    thema string

    Thema der Gruppe in Kurzform.

    beschreibung string

    Possible values: <= 1024 characters

    Zusätzliche optionale Beschreibung der Gruppe.

    typ components-code-Gruppentyp (string)required

    Possible values: [Klasse, Kurs, Sonstig]

    Wie folgt:

    • Klasse Schulklasse
    • Kurs Kurs/Unterricht
    • Sonstig Sonstige Gruppe
    bereich components-code-Gruppenbereich (string)

    Possible values: [Pflicht, Wahl, Wahlpflicht]

    Diese Codeliste ist spezifisch für das Bundesland Niedersachsen:

    • Pflicht Pflichtunterricht
    • Wahl Wahlunterricht
    • Wahlpflicht Wahlpflichtunterricht
    optionen components-code-Gruppenoption (string)[]

    Possible values: [``]

    differenzierung components-code-Gruppendifferenzierung (string)

    Possible values: [G, E, Z, gA, eA]

    Diese Codeliste ist spezifisch für das Bundesland Niedersachsen:

    • G G-Kurs
    • E E-Kurs
    • Z Z-Kurs
    • gA grundlegendes Anforderungsniveau
    • eA erhöhtes Anforderungsniveau
    bildungsziele components-code-Bildungsziel (string)[]

    Possible values: [GS, HS, RS, GY-SEK-I, GY-SEK-II]

    jahrgangsstufen components-code-Jahrgangsstufe (string)[]

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

    faecher

    object[]

  • Array [

    • oneOf

    kennung components-code-Fächerkanon (string)

    Possible values: [BI, CH, CI, DE, DS, EK, EN, FR, GR, NL, IT, SN, KU, LA, RS, GE, PO, PW, RE, RI, RK, SP, SU, TE, TG, WE, WN, WS, DA, MA, HW, MU, PA, PH, IF, AW, GL, PWI, PTE, PGUS, NAT]

    Diese Codeliste ist spezifisch für das Bundesland Niedersachsen:

    • BI Biologie
    • CH Chemie
    • CI Chinesisch
    • DE Deutsch
    • DS Darstellendes Spiel
    • EK Erdkunde
    • EN Englisch
    • FR Französisch
    • GR Griechisch
    • NL Niederländisch
    • IT Italienisch
    • SN Spanisch
    • KU Kunst
    • LA Latein
    • RS Russisch
    • GE Geschichte
    • PO Politik
    • PW Politik/Wirtschaft
    • RE Evangelische Religion
    • RI Islamische Religion
    • RK Katholische Religion
    • SP Sport
    • SU Sachunterricht
    • TE Technik
    • TG Textiles Gestalten
    • WE Gestaltendes Werken
    • WN Werte und Normen
    • WS Wirtschaft
    • DA Deutsch als Zweitsprache
    • MA Mathematik
    • HW Hauswirtschaft
    • MU Musik
    • PA Pädagogik
    • PH Physik
    • IF Informatik
    • AW Arbeit-Wirtschaft-Technik
    • GL Gesellschaftslehre
    • PWI Profil Wirtschaft
    • PTE Profil Technik
    • PGUS Profil Gesundheit und Soziales
    • NAT Naturwissenschaften

  • ]

    • referenzgruppen

    object[]

  • Array [

    • grupid stringrequired

    ID der Referenzgruppe.

    rollen components-code-Gruppenrolle (string)[]

    Possible values: [Lern, Lehr, KlLeit, Foerd, VLehr, SchB, GMit, GLeit]

  • ]

    • laufzeit

    object

    oneOf

    von date

    Anfang des Gültigkeitszeitraums der Gruppe. Dieser Zeitpunkt kann auch in der Zukunft liegen.

    bis date

    Ende des Gültigkeitszeitraums der Gruppe.

Loading...