Zum Hauptinhalt springen

Auflistung aller Gruppenzugehörigkeiten.

GET 
/gruppenzugehoerigkeiten

Dieser Schnittstellenendpunkt gibt alle Gruppenzugehörigkeiten zurück, auf die der Quellsystemanbieter zugreifen kann.

Ein READ muss mit einer HTTP-GET Anfrage erfolgen. Die Antwort-Nutzdaten (Response Payload) beinhalten ein Array von JSON-Objekten vom Datentyp Gruppendatensatz mit den jeweiligen Gruppenzugehörigkeiten und der zugeordneten Gruppe, sofern Einträge existieren.

Siehe auch Datenmodell Gruppendatensatz, Datenmodell Gruppe und Datenmodell Gruppenzugehörigkeit.

Die Antwort-Nutzdaten umfassen standardmäßig für das Attribut gruppe die Gruppen-ID über das Attribut gruppe.id.

Durch das Setzen von Filterparametern (query-parameter) wird mit der HTTP-GET-Anfrage eine Filteroperation mitgeschickt, welche die Ergebnismenge der Antwort-Nutzdaten (Response Payload) beeinflusst, beispielsweise mit dem Filterparameter ?rollen=Lehr.

Bei Filtern vom Typ „String” überprüft der Schulconnex-Server, ob der Wert des Filterparameters ohne Beachtung von Groß- und Kleinschreibung im Filter-Attribut beinhaltet ist (contains). Bei Filtern vom Typ „String (Code)” überprüft der Schulconnex-Server, ob der Wert des Filterparameters ohne Beachtung von Groß- und Kleinschreibung gleich dem Filter-Attribut ist (equals). Werden mehrere Filter angegeben, so müssen sie als mit „und“ verknüpft angesehen werden. Entsprechen keine Werte den angegebenen Filtern, so wird als Resultat eine leere Liste geliefert.

FilterTypBeschreibung
referrerStringMöglichkeit, die Ergebnisliste der Anfrage nach dem Fremdschlüssel referrer zu filtern.
mandantStringMöglichkeit, die Ergebnisliste der Anfrage nach dem Attribut mandant zu filtern. Der Schulconnex-Server überprüft, ob der Wert des Filterparameters unabhängig von Groß- und Kleinschreibung im Filter-Attribut beinhaltet ist (contains).
rollenString (Code)Möglichkeit, die Ergebnisliste der Anfrage nach dem Attribut gruppenzugehoerigkeit.rollen zu filtern.

Request​

Query Parameters

    referrer string
    mandant string
    rollen string

Responses​

OK

Schema

  • Array [

    • gruppe

    object

    required

    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.

    gruppenzugehoerigkeiten

    object[]

  • Array [

    • id stringrequired

    ID der Gruppenzugehörigkeit.

    mandant stringrequired

    ID des Mandanten, dem die Gruppenzugehörigkeit zugeordnet ist.

    referrer string

    ID der Gruppenzugehörigkeit im Quellsystem.

    ktid stringrequired

    ID des Personenkontexts, welcher der Gruppe zugeordnet ist.

    rollen components-code-Gruppenrolle (string)[]required

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

    von date

    Beginn der Gruppenzugehörigkeit. Dieser Zeitpunkt kann auch in der Zukunft liegen.

    bis date

    Ende der Gruppenzugehörigkeit.

    revision stringrequired

    Revision der Gruppenzugehörigkeit.

  • ]

  • ]

Loading...