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​

Responses​

OK