Zum Hauptinhalt springen

Auflistung von Gruppenzugehörigkeiten zur Gruppe.

GET 
/gruppen/:id/gruppenzugehoerigkeiten

Dieser Schnittstellenendpunkt gibt die Gruppenzugehörigkeiten zur angegebenen gruppe.id zurück.

Ein READ zum Abfragen der Gruppenzugehörigkeiten per gruppe.id muss mit HTTP-GET auf die API /gruppen/{gruppe.id}/gruppenzugehoerigkeiten erfolgen. Die Antwort-Nutzdaten (Response Payload) beinhalten ein JSON-Objekt mit einem Array des Datentyps Gruppenzugehörigkeit.

Siehe auch Datenmodell Gruppenzugehörigkeit.

Die Schnittstelle /gruppen/{gruppe.id}/gruppenzugehoerigkeiten ermöglicht das Verwenden von Filterparametern zur Präzisierung der Anfrage bei HTTP-GET.

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 den Filterparametern ?referrer=123&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.

Eine mehrfache Nutzung des gleichen Filters in einer Anfrage darf nicht erfolgen. Entsprechen keine Werte den angegebenen Filtern, so wird als Resultat eine leere Liste geliefert.

Folgende Tabelle listet die zur Verfügung stehenden Filter:

FilterTypBeschreibung
referrerStringMöglichkeit, die Ergebnisliste der Anfrage nach dem Fremdschlüssel referrer zu filtern .
rollenString (Code)Möglichkeit, die Ergebnisliste der Anfrage nach dem Attribut gruppenzugehoerigkeit.rollen zu filtern. Mehrere Rollen können durch Kommas separiert werden.

Request​

Path Parameters

    id stringrequired

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

Query Parameters

    referrer string
    rollen string

Responses​

OK

Schema

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