Package de.svws_nrw.api.server

Klasse APIGesamtschule

java.lang.Object

de.svws_nrw.api.server.APIGesamtschule

@Path("/db/{schema}/gesamtschule")
@Produces("application/json")
@Consumes("application/json")
public class APIGesamtschule
extends Object

Die Klasse spezifiziert die OpenAPI-Schnittstelle für den Zugriff auf Schülerdaten aus der SVWS-Datenbank in Bezug auf die SekI-Daten der Gesamtschule. Ein Zugriff erfolgt über den Pfad https://{Hostname}/db/{schema}/schueler/ge/...

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
APIGesamtschule()	Leerer Standardkonstruktor.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
jakarta.ws.rs.core.Response	getGesamtschuleSchuelerPrognoseLeistungsdaten(String schema, long id, jakarta.servlet.http.HttpServletRequest request)	Die OpenAPI-Methode für die Abfrage der Leistungsdaten aus dem aktuellen Abschnitt zu der ID eines Schüler im angegebenen Schema, um die Prognose zu berechnen.
jakarta.ws.rs.core.Response	getGesamtschuleSchuelerPrognosLeistungsdatenFuerAbschnitt(String schema, long id, long abschnittID, jakarta.servlet.http.HttpServletRequest request)	Die OpenAPI-Methode für die Abfrage der Leistungsdaten aus dem angegebenen Abschnitt zu der ID eines Schüler im angegebenen Schema, um die Prognose zu berechnen.

Von Klasse geerbte Methoden java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Konstruktordetails

APIGesamtschule

public APIGesamtschule()

Leerer Standardkonstruktor.

Methodendetails

getGesamtschuleSchuelerPrognoseLeistungsdaten

@GET
@Path("/schueler/{id : \\d+}/prognose_leistungsdaten")
public jakarta.ws.rs.core.Response getGesamtschuleSchuelerPrognoseLeistungsdaten(@PathParam("schema")
 String schema,
 @PathParam("id")
 long id,
 @Context
 jakarta.servlet.http.HttpServletRequest request)

Die OpenAPI-Methode für die Abfrage der Leistungsdaten aus dem aktuellen Abschnitt zu der ID eines Schüler im angegebenen Schema, um die Prognose zu berechnen.

Parameter:

schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll

id - die ID des Schüler, für den die Leistungsdaten ausgelesen werden sollen

request - die Informationen zur HTTP-Anfrage

Gibt zurück:

die Liste der Fächer mit ID des Datenbankschemas

getGesamtschuleSchuelerPrognosLeistungsdatenFuerAbschnitt

@GET
@Path("/schueler/{id : \\d+}/prognose_leistungsdaten/abschnitt/{abschnittID : \\d+}")
public jakarta.ws.rs.core.Response getGesamtschuleSchuelerPrognosLeistungsdatenFuerAbschnitt(@PathParam("schema")
 String schema,
 @PathParam("id")
 long id,
 @PathParam("abschnittID")
 long abschnittID,
 @Context
 jakarta.servlet.http.HttpServletRequest request)

Die OpenAPI-Methode für die Abfrage der Leistungsdaten aus dem angegebenen Abschnitt zu der ID eines Schüler im angegebenen Schema, um die Prognose zu berechnen.

Parameter:

schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll

id - die ID des Schüler, für den die Leistungsdaten ausgelesen werden sollen

abschnittID - der Schuljahresabschnitt, für den die Leistungsdaten ausgelesen werden sollen

request - die Informationen zur HTTP-Anfrage

Gibt zurück:

die Liste der Fächer mit ID des Datenbankschemas