Package de.svws_nrw.api.server
Klasse APIGostKlausuren
java.lang.Object
de.svws_nrw.api.server.APIGostKlausuren
@Path("/db/{schema}/gost/klausuren")
@Produces("application/json")
@Consumes("application/json")
public class APIGostKlausuren
extends Object
Die Klasse spezifiziert die OpenAPI-Schnittstelle für den Zugriff auf die
grundlegenden Gost-Klausurdaten aus der SVWS-Datenbank. Ein Zugriff erfolgt
über den Pfad https://{Hostname}/db/{schema}/gost/klausuren/...
-
Konstruktorübersicht
-
Methodenübersicht
Modifizierer und TypMethodeBeschreibungjakarta.ws.rs.core.Response
blockenGostKursklausuren
(String schema, GostKlausurterminblockungDaten blockungDaten, jakarta.servlet.http.HttpServletRequest request) Startet den Kursklausur-Blockungsalgorithmus für die übergebenenGostKlausurterminblockungDaten
.jakarta.ws.rs.core.Response
blockenGostSchuelerklausurtermine
(String schema, GostNachschreibterminblockungKonfiguration config, jakarta.servlet.http.HttpServletRequest request) Startet den Nachschreiber-Blockungsalgorithmus für die übergebeneGostNachschreibterminblockungKonfiguration
.jakarta.ws.rs.core.Response
copyGostKlausurenVorgaben
(String schema, int abiturjahr, int halbjahr, int quartal, jakarta.servlet.http.HttpServletRequest request) Kopiert dieGostKlausurvorgabe
-Vorlagen in einen konkreten Abiturjahrgang und gibt sie zurück.jakarta.ws.rs.core.Response
createGostKlausurenDefaultVorgaben
(String schema, int halbjahr, int quartal, jakarta.servlet.http.HttpServletRequest request) Legt die Default-GostKlausurvorgabe
n im Vorlagen-Jahrgang an und gibt sie zurück.jakarta.ws.rs.core.Response
createGostKlausurenKlausurtermin
(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request) Erstellt einen neuenGostKlausurtermin
.jakarta.ws.rs.core.Response
createGostKlausurenKursklausurenJahrgangHalbjahrQuartal
(String schema, int abiturjahr, int halbjahr, int quartal, jakarta.servlet.http.HttpServletRequest request) Erzeugt dieGostKursklausur
en eines Abiturjahrgangs in einem bestimmten GostHalbjahr und Quartal der Gymnasialen Oberstufe.jakarta.ws.rs.core.Response
createGostKlausurenRaum
(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request) Legt einen neuenGostKlausurraum
an.jakarta.ws.rs.core.Response
createGostKlausurenSchuelerklausuren
(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request) Erstellt mehrere neueGostSchuelerklausur
en inklusive der zugehörigenGostSchuelerklausurTermin
e.jakarta.ws.rs.core.Response
createGostKlausurenSchuelerklausurtermin
(String schema, long id, jakarta.servlet.http.HttpServletRequest request) Legt einen neuenGostSchuelerklausurTermin
an.jakarta.ws.rs.core.Response
createGostKlausurenVorgabe
(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request) Erstellt eine neueGostKlausurvorgabe
und gibt sie zurück.jakarta.ws.rs.core.Response
deleteGostKlausurenKlausurtermine
(String schema, List<Long> terminIds, jakarta.servlet.http.HttpServletRequest request) Löscht mehrereGostKlausurtermin
e.jakarta.ws.rs.core.Response
deleteGostKlausurenRaum
(String schema, long id, jakarta.servlet.http.HttpServletRequest request) Löscht einenGostKlausurraum
.jakarta.ws.rs.core.Response
deleteGostKlausurenSchuelerklausuren
(String schema, List<Long> terminIds, jakarta.servlet.http.HttpServletRequest request) Löscht mehrereGostSchuelerklausur
en inkluive der zugehörigenGostSchuelerklausurTermin
e.jakarta.ws.rs.core.Response
deleteGostKlausurenSchuelerklausurtermin
(String schema, long id, jakarta.servlet.http.HttpServletRequest request) Löscht einenGostSchuelerklausurTermin
.jakarta.ws.rs.core.Response
deleteGostKlausurenVorgabe
(String schema, long id, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Löschen einerGostKlausurvorgabe
.jakarta.ws.rs.core.Response
getGostKlausurenCollectionAlldata
(String schema, List<GostKlausurenCollectionHjData> hjData, jakarta.servlet.http.HttpServletRequest request) Liefert alle zur Klausurplanung gehörenden Daten in einemGostKlausurenCollectionAllData
-Objekt.jakarta.ws.rs.core.Response
getGostKlausurenCollectionAlldataGZip
(String schema, List<GostKlausurenCollectionHjData> hjData, jakarta.servlet.http.HttpServletRequest request) Liefert alle zur Klausurplanung gehörenden Daten in einem komprimiertenGostKlausurenCollectionAllData
-Objekt.jakarta.ws.rs.core.Response
getGostKlausurenCollectionAllIssues
(String schema, int abiturjahr, int halbjahr, jakarta.servlet.http.HttpServletRequest request) Liefert alle zur Klausurplanung gehörenden Fehler und Probleme in einemGostKlausurenCollectionHjData
-Objekt.jakarta.ws.rs.core.Response
getGostKlausurenCollectionAllIssuesGZip
(String schema, int abiturjahr, int halbjahr, jakarta.servlet.http.HttpServletRequest request) Liefert alle zur Klausurplanung gehörenden Fehler und Probleme in einem komprimiertenGostKlausurenCollectionHjData
-Objekt.jakarta.ws.rs.core.Response
getGostKlausurenCollectionBySchuelerid
(String schema, long sId, int abiturjahr, int halbjahr, jakarta.servlet.http.HttpServletRequest request) Fragt die Klausurdaten eines Schülers ab.jakarta.ws.rs.core.Response
getGostKlausurenVorgabenJahrgang
(String schema, int abiturjahr, jakarta.servlet.http.HttpServletRequest request) Liefert dieGostKlausurvorgabe
n eines Abiturjahrgangs der gymnasialen Oberstufe.jakarta.ws.rs.core.Response
loescheGostSchuelerklausurenAusRaum
(String schema, List<GostKlausurraumRich> raumSchuelerZuteilung, jakarta.servlet.http.HttpServletRequest request) Löscht die Raumzuweisungen für alle in denGostKlausurraumRich
-Objekten übergebeneGostSchuelerklausurTermin
-IDs.jakarta.ws.rs.core.Response
patchGostKlausurenKlausurtermin
(String schema, long id, long abschnittid, InputStream is, jakarta.servlet.http.HttpServletRequest request) Patcht einenGostKlausurtermin
und liefert die dadurch geänderten Raumdaten alsGostKlausurenCollectionSkrsKrsData
-Objekt zurück.jakarta.ws.rs.core.Response
patchGostKlausurenKursklausur
(String schema, long id, int abiturjahr, int halbjahr, InputStream is, jakarta.servlet.http.HttpServletRequest request) Patcht eineGostKursklausur
und gibt die daraufhin geänderten Daten innerhalb desGostKlausurenCollectionSkrsKrsData
-Objekts zurück.jakarta.ws.rs.core.Response
patchGostKlausurenRaum
(String schema, long id, InputStream is, jakarta.servlet.http.HttpServletRequest request) Patcht die Daten einesGostKlausurraum
s.jakarta.ws.rs.core.Response
patchGostKlausurenSchuelerklausur
(String schema, long id, InputStream is, jakarta.servlet.http.HttpServletRequest request) Patcht die Daten einerGostSchuelerklausur
.jakarta.ws.rs.core.Response
patchGostKlausurenSchuelerklausurtermin
(String schema, long id, InputStream is, jakarta.servlet.http.HttpServletRequest request) Patcht einenGostSchuelerklausurTermin
.jakarta.ws.rs.core.Response
patchGostKlausurenVorgabe
(String schema, long id, InputStream is, jakarta.servlet.http.HttpServletRequest request) Patcht die Daten einerGostKlausurvorgabe
.jakarta.ws.rs.core.Response
setzeGostSchuelerklausurenZuRaum
(String schema, int abiturjahr, int halbjahr, List<GostKlausurraumRich> raumSchuelerZuteilung, jakarta.servlet.http.HttpServletRequest request) Weist die in denGostKlausurraumRich
-Objekten übergebenen IDs derGostSchuelerklausurTermin
e dem jeweiligenGostKlausurraum
zu.jakarta.ws.rs.core.Response
updateGostKlausuren
(String schema, GostKlausurenUpdate update, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Erstellen einer neuen Klausurraumstunde.
-
Konstruktordetails
-
APIGostKlausuren
public APIGostKlausuren()Leerer Standardkonstruktor.
-
-
Methodendetails
-
getGostKlausurenVorgabenJahrgang
@GET @Path("/vorgaben/abiturjahrgang/{abiturjahr : -?\\d+}") public jakarta.ws.rs.core.Response getGostKlausurenVorgabenJahrgang(@PathParam("schema") String schema, @PathParam("abiturjahr") int abiturjahr, @Context jakarta.servlet.http.HttpServletRequest request) Liefert dieGostKlausurvorgabe
n eines Abiturjahrgangs der gymnasialen Oberstufe.- Parameter:
schema
- das Datenbankschema, auf welchem die Abfrage ausgeführt werden sollabiturjahr
- das Jahr, in welchem der Jahrgang Abitur machen wirdrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die Liste der
GostKlausurvorgabe
n
-
createGostKlausurenVorgabe
@POST @Path("/vorgaben/new") public jakarta.ws.rs.core.Response createGostKlausurenVorgabe(@PathParam("schema") String schema, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request) Erstellt eine neueGostKlausurvorgabe
und gibt sie zurück.- Parameter:
schema
- das Datenbankschema, in welchem dieGostKlausurvorgabe
erstellt wirdis
- JSON-Objekt mit den Datenrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die HTTP-Antwort mit der neuen
GostKlausurvorgabe
-
patchGostKlausurenVorgabe
@PATCH @Path("/vorgaben/{id : \\d+}") public jakarta.ws.rs.core.Response patchGostKlausurenVorgabe(@PathParam("schema") String schema, @PathParam("id") long id, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request) Patcht die Daten einerGostKlausurvorgabe
.- Parameter:
schema
- das Datenbankschema, auf welchem der Patch ausgeführt werden sollid
- die ID derGostKlausurvorgabe
is
- JSON-Objekt mit den Datenrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die HTTP-Antwort
-
deleteGostKlausurenVorgabe
@DELETE @Path("/vorgaben/delete/{id : \\d+}") public jakarta.ws.rs.core.Response deleteGostKlausurenVorgabe(@PathParam("schema") String schema, @PathParam("id") long id, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Löschen einerGostKlausurvorgabe
.- Parameter:
schema
- das Datenbankschema, in welchem dieGostKlausurvorgabe
gelöscht wirdid
- die ID der zu löschenden Klausurvorgaberequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die HTTP-Antwort
-
copyGostKlausurenVorgaben
@GET @Path("/vorgaben/copyVorlagen/abiturjahrgang/{abiturjahr : -?\\d+}/halbjahr/{halbjahr : -?\\d+}/quartal/{quartal : -?\\d+}") public jakarta.ws.rs.core.Response copyGostKlausurenVorgaben(@PathParam("schema") String schema, @PathParam("abiturjahr") int abiturjahr, @PathParam("halbjahr") int halbjahr, @PathParam("quartal") int quartal, @Context jakarta.servlet.http.HttpServletRequest request) Kopiert dieGostKlausurvorgabe
-Vorlagen in einen konkreten Abiturjahrgang und gibt sie zurück.- Parameter:
schema
- das Datenbankschema, in welchem dieGostKlausurvorgabe
n erstellt werdenabiturjahr
- das Abiturjahr, für das dieGostKlausurvorgabe
n kopiert werden sollenhalbjahr
- das GostHalbjahr, für das dieGostKlausurvorgabe
n kopiert werden sollenquartal
- das Quartal, 0 für das gesamte GostHalbjahrrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die Liste der neuen
GostKlausurvorgabe
n im angegebenen Abiturjahrgang, GostHalbjahr und Quartal
-
createGostKlausurenDefaultVorgaben
@GET @Path("/vorgaben/createDefault/halbjahr/{halbjahr : -?\\d+}/quartal/{quartal : -?\\d+}") public jakarta.ws.rs.core.Response createGostKlausurenDefaultVorgaben(@PathParam("schema") String schema, @PathParam("halbjahr") int halbjahr, @PathParam("quartal") int quartal, @Context jakarta.servlet.http.HttpServletRequest request) Legt die Default-GostKlausurvorgabe
n im Vorlagen-Jahrgang an und gibt sie zurück.- Parameter:
schema
- das Datenbankschema, in welchem dieGostKlausurvorgabe
n erstellt werdenhalbjahr
- das GostHalbjahr, für das dieGostKlausurvorgabe
n erstellt werden sollenquartal
- das Quartal, 0 für das gesamte GostHalbjahrrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die Liste der neuen
GostKlausurvorgabe
n im Vorlagen-Jahrgang, GostHalbjahr und Quartal
-
patchGostKlausurenKursklausur
@POST @Path("/kursklausuren/{id : \\d+}/abiturjahrgang/{abiturjahr : -?\\d+}/halbjahr/{halbjahr : -?\\d+}") public jakarta.ws.rs.core.Response patchGostKlausurenKursklausur(@PathParam("schema") String schema, @PathParam("id") long id, @PathParam("abiturjahr") int abiturjahr, @PathParam("halbjahr") int halbjahr, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request) Patcht eineGostKursklausur
und gibt die daraufhin geänderten Daten innerhalb desGostKlausurenCollectionSkrsKrsData
-Objekts zurück.- Parameter:
schema
- das Datenbankschema, auf welches der Patch ausgeführt werden sollid
- die ID der Kursklausurabiturjahr
- das Abiturjahr der Kursklausurhalbjahr
- das GostHalbjahr der Kursklausuris
- JSON-Objekt mit den Datenrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die geänderten Raumdaten als
GostKlausurenCollectionSkrsKrsData
-Objekt
-
createGostKlausurenKursklausurenJahrgangHalbjahrQuartal
@GET @Path("/kursklausuren/create/abiturjahrgang/{abiturjahr : -?\\d+}/halbjahr/{halbjahr : \\d+}/quartal/{quartal : \\d+}") public jakarta.ws.rs.core.Response createGostKlausurenKursklausurenJahrgangHalbjahrQuartal(@PathParam("schema") String schema, @PathParam("abiturjahr") int abiturjahr, @PathParam("halbjahr") int halbjahr, @PathParam("quartal") int quartal, @Context jakarta.servlet.http.HttpServletRequest request) Erzeugt dieGostKursklausur
en eines Abiturjahrgangs in einem bestimmten GostHalbjahr und Quartal der Gymnasialen Oberstufe. Schülerklausuren und Haupttermin-Schülerklausurtermine werden ebenfalls erzeugt.- Parameter:
schema
- das Datenbankschema, auf welches die Abfrage ausgeführt werden sollabiturjahr
- das Jahr, in welchem der Jahrgang Abitur machen wirdhalbjahr
- das Gost-Halbjahr, für das die Klausuren erzeugt werden sollenquartal
- das Quartal, für das die Klausuren erzeugt werden sollen, falls 0 angegeben wird, für das gesamte GostHalbjahrrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- das
GostKlausurenCollectionData
-Objekt mit den erzeugten Daten
-
patchGostKlausurenSchuelerklausur
@PATCH @Path("/schuelerklausuren/{id : \\d+}") public jakarta.ws.rs.core.Response patchGostKlausurenSchuelerklausur(@PathParam("schema") String schema, @PathParam("id") long id, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request) Patcht die Daten einerGostSchuelerklausur
.- Parameter:
schema
- das Datenbankschema, auf welches der Patch ausgeführt werden sollid
- die ID derGostSchuelerklausur
is
- JSON-Objekt mit den Datenrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- das Ergebnis der Patch-Operation
-
getGostKlausurenCollectionAlldata
@POST @Path("/collection/alldata") public jakarta.ws.rs.core.Response getGostKlausurenCollectionAlldata(@PathParam("schema") String schema, List<GostKlausurenCollectionHjData> hjData, @Context jakarta.servlet.http.HttpServletRequest request) Liefert alle zur Klausurplanung gehörenden Daten in einemGostKlausurenCollectionAllData
-Objekt.- Parameter:
schema
- das Datenbankschema, auf welches die Abfrage ausgeführt werden sollhjData
- die Liste derGostKlausurenCollectionHjData
-Objekte, für die Klausurdaten geladen werden sollenrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- das
GostKlausurenCollectionAllData
-Objekt mit den Daten zur Klausurplanung
-
getGostKlausurenCollectionAlldataGZip
@POST @Produces("application/octet-stream") @Path("/collection/alldata/gzip") public jakarta.ws.rs.core.Response getGostKlausurenCollectionAlldataGZip(@PathParam("schema") String schema, List<GostKlausurenCollectionHjData> hjData, @Context jakarta.servlet.http.HttpServletRequest request) Liefert alle zur Klausurplanung gehörenden Daten in einem komprimiertenGostKlausurenCollectionAllData
-Objekt.- Parameter:
schema
- das Datenbankschema, auf welches die Abfrage ausgeführt werden sollhjData
- die Liste derGostKlausurenCollectionHjData
-Objekte, für die Klausurdaten geladen werden sollenrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- das komprimierte
GostKlausurenCollectionAllData
-Objekt mit den Daten zur Klausurplanung
-
getGostKlausurenCollectionAllIssues
@GET @Path("/collection/issues/abiturjahrgang/{abiturjahr : -?\\d+}/halbjahr/{halbjahr : \\d+}") public jakarta.ws.rs.core.Response getGostKlausurenCollectionAllIssues(@PathParam("schema") String schema, @PathParam("abiturjahr") int abiturjahr, @PathParam("halbjahr") int halbjahr, @Context jakarta.servlet.http.HttpServletRequest request) Liefert alle zur Klausurplanung gehörenden Fehler und Probleme in einemGostKlausurenCollectionHjData
-Objekt.- Parameter:
schema
- das Datenbankschema, auf welches die Abfrage ausgeführt werden sollabiturjahr
- das Jahr, in welchem der Jahrgang Abitur machen wirdhalbjahr
- das gesuchte Gost-Halbjahrrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- das
GostKlausurenCollectionHjData
-Objekt mit den Fehlern und Problemen zur Klausurplanung
-
getGostKlausurenCollectionAllIssuesGZip
@GET @Produces("application/octet-stream") @Path("/collection/issues/abiturjahrgang/{abiturjahr : -?\\d+}/halbjahr/{halbjahr : \\d+}/gzip") public jakarta.ws.rs.core.Response getGostKlausurenCollectionAllIssuesGZip(@PathParam("schema") String schema, @PathParam("abiturjahr") int abiturjahr, @PathParam("halbjahr") int halbjahr, @Context jakarta.servlet.http.HttpServletRequest request) Liefert alle zur Klausurplanung gehörenden Fehler und Probleme in einem komprimiertenGostKlausurenCollectionHjData
-Objekt.- Parameter:
schema
- das Datenbankschema, auf welches die Abfrage ausgeführt werden sollabiturjahr
- das Jahr, in welchem der Jahrgang Abitur machen wirdhalbjahr
- das gesuchte Gost-Halbjahrrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- das komprimierte
GostKlausurenCollectionHjData
-Objekt mit den Fehlern und Problemen zur Klausurplanung
-
createGostKlausurenKlausurtermin
@POST @Path("/termine/new") public jakarta.ws.rs.core.Response createGostKlausurenKlausurtermin(@PathParam("schema") String schema, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request) Erstellt einen neuenGostKlausurtermin
.- Parameter:
schema
- das Datenbankschema, in welchem derGostKlausurtermin
erstellt wirdis
- JSON-Objekt mit den Datenrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- der neue
GostKlausurtermin
-
createGostKlausurenSchuelerklausuren
@POST @Path("/schuelerklausuren/new") public jakarta.ws.rs.core.Response createGostKlausurenSchuelerklausuren(@PathParam("schema") String schema, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request) Erstellt mehrere neueGostSchuelerklausur
en inklusive der zugehörigenGostSchuelerklausurTermin
e.- Parameter:
schema
- das Datenbankschema, in welchem derGostSchuelerklausur
en erstellt werdenis
- JSON-Objekt mit den Datenrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- das
GostKlausurenCollectionData
-Objekt mit den neuenGostSchuelerklausur
en inklusive der zugehörigenGostSchuelerklausurTermin
e
-
deleteGostKlausurenKlausurtermine
@DELETE @Path("/termine/delete") public jakarta.ws.rs.core.Response deleteGostKlausurenKlausurtermine(@PathParam("schema") String schema, List<Long> terminIds, @Context jakarta.servlet.http.HttpServletRequest request) Löscht mehrereGostKlausurtermin
e.- Parameter:
schema
- das Datenbankschema, in welchem dieGostKlausurtermin
e gelöscht werdenterminIds
- die IDs der zu löschendenGostKlausurtermin
erequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die HTTP-Antwort mit dem Status und ggf. den gelöschten Klausurterminen
-
deleteGostKlausurenSchuelerklausuren
@DELETE @Path("/schuelerklausuren/delete") public jakarta.ws.rs.core.Response deleteGostKlausurenSchuelerklausuren(@PathParam("schema") String schema, List<Long> terminIds, @Context jakarta.servlet.http.HttpServletRequest request) Löscht mehrereGostSchuelerklausur
en inkluive der zugehörigenGostSchuelerklausurTermin
e.- Parameter:
schema
- das Datenbankschema, in welchem dieGostSchuelerklausur
en gelöscht werdenterminIds
- die IDs der zu löschendenGostSchuelerklausur
enrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die HTTP-Antwort mit dem Status und ggf. den gelöschten Schuelerklausuren
-
patchGostKlausurenKlausurtermin
@POST @Path("/termine/{id : \\d+}/abschnitt/{abschnittid : -?\\d+}") public jakarta.ws.rs.core.Response patchGostKlausurenKlausurtermin(@PathParam("schema") String schema, @PathParam("id") long id, @PathParam("abschnittid") long abschnittid, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request) Patcht einenGostKlausurtermin
und liefert die dadurch geänderten Raumdaten alsGostKlausurenCollectionSkrsKrsData
-Objekt zurück.- Parameter:
schema
- das Datenbankschema, auf welchem der Patch ausgeführt werden sollid
- die ID desGostKlausurtermin
sabschnittid
- die ID des Schuljahresabschnittsis
- JSON-Objekt mit den Datenrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die durch den Patch geänderten Raumdaten als
GostKlausurenCollectionSkrsKrsData
-Objekt
-
createGostKlausurenRaum
@POST @Path("/raeume/new") public jakarta.ws.rs.core.Response createGostKlausurenRaum(@PathParam("schema") String schema, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request) Legt einen neuenGostKlausurraum
an.- Parameter:
schema
- das Datenbankschema, in welchem derGostKlausurraum
angelegt wirdis
- JSON-Objekt mit den Datenrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- der neue
GostKlausurraum
-
patchGostKlausurenRaum
@PATCH @Path("/raeume/{id : \\d+}") public jakarta.ws.rs.core.Response patchGostKlausurenRaum(@PathParam("schema") String schema, @PathParam("id") long id, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request) Patcht die Daten einesGostKlausurraum
s.- Parameter:
schema
- das Datenbankschema, auf welches der Patch ausgeführt werden sollid
- die ID desGostKlausurraum
sis
- JSON-Objekt mit den Datenrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- das Ergebnis der Patch-Operation
-
deleteGostKlausurenRaum
@DELETE @Path("/raeume/delete/{id : \\d+}") public jakarta.ws.rs.core.Response deleteGostKlausurenRaum(@PathParam("schema") String schema, @PathParam("id") long id, @Context jakarta.servlet.http.HttpServletRequest request) Löscht einenGostKlausurraum
.- Parameter:
schema
- das Datenbankschema, in welchem der GostKlausurraum gelöscht wirdid
- die ID des zu löschendenGostKlausurraum
srequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die HTTP-Antwort mit dem Status und ggf. dem gelöschten Klausurraum
-
setzeGostSchuelerklausurenZuRaum
@POST @Path("/schuelerklausuren/zuraum/abiturjahrgang/{abiturjahr : -?\\d+}/halbjahr/{halbjahr : -?\\d+}") public jakarta.ws.rs.core.Response setzeGostSchuelerklausurenZuRaum(@PathParam("schema") String schema, @PathParam("abiturjahr") int abiturjahr, @PathParam("halbjahr") int halbjahr, List<GostKlausurraumRich> raumSchuelerZuteilung, @Context jakarta.servlet.http.HttpServletRequest request) Weist die in denGostKlausurraumRich
-Objekten übergebenen IDs derGostSchuelerklausurTermin
e dem jeweiligenGostKlausurraum
zu.- Parameter:
schema
- das Datenbankschemaabiturjahr
- das Abiturjahr des Jahrgangshalbjahr
- das GostHalbjahrraumSchuelerZuteilung
- die Liste vonGostKlausurraumRich
-Objekten, die die IDs der zuzuteilendenGostSchuelerklausurTermin
en enthaltenrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- das
GostKlausurenCollectionSkrsKrsData
-Objekt mit den aktualisierten Raumdaten
-
loescheGostSchuelerklausurenAusRaum
@POST @Path("/schuelerklausuren/ausraum") public jakarta.ws.rs.core.Response loescheGostSchuelerklausurenAusRaum(@PathParam("schema") String schema, List<GostKlausurraumRich> raumSchuelerZuteilung, @Context jakarta.servlet.http.HttpServletRequest request) Löscht die Raumzuweisungen für alle in denGostKlausurraumRich
-Objekten übergebeneGostSchuelerklausurTermin
-IDs.- Parameter:
schema
- das DatenbankschemaraumSchuelerZuteilung
- die Ids der GostSchuelerklausurenrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die HTTP-Antwort
-
blockenGostKursklausuren
@POST @Path("/kursklausuren/blocken") public jakarta.ws.rs.core.Response blockenGostKursklausuren(@PathParam("schema") String schema, GostKlausurterminblockungDaten blockungDaten, @Context jakarta.servlet.http.HttpServletRequest request) Startet den Kursklausur-Blockungsalgorithmus für die übergebenenGostKlausurterminblockungDaten
.- Parameter:
schema
- das Datenbankschema, auf dem die Klausurblockung gestartet wirdblockungDaten
- dasGostKlausurterminblockungDaten
-Objektrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die HTTP-Antwort mit dem Status und dem
GostKlausurenCollectionData
-Objekt, das die fertige Klausurblockung enthält
-
blockenGostSchuelerklausurtermine
@POST @Path("/schuelerklausuren/termine/blocken") public jakarta.ws.rs.core.Response blockenGostSchuelerklausurtermine(@PathParam("schema") String schema, GostNachschreibterminblockungKonfiguration config, @Context jakarta.servlet.http.HttpServletRequest request) Startet den Nachschreiber-Blockungsalgorithmus für die übergebeneGostNachschreibterminblockungKonfiguration
.- Parameter:
schema
- das Datenbankschema, auf dem die Klausurblockung gestartet wirdconfig
- dasGostNachschreibterminblockungKonfiguration
-Objektrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die HTTP-Antwort mit dem Status und dem
GostKlausurenCollectionData
-Objekt, das die fertige Nachschreibblockung enthält
-
getGostKlausurenCollectionBySchuelerid
@GET @Path("/schueler/{sid : -?\\d+}/abiturjahrgang/{abiturjahr : -?\\d+}/schuljahr/{halbjahr : \\d+}") public jakarta.ws.rs.core.Response getGostKlausurenCollectionBySchuelerid(@PathParam("schema") String schema, @PathParam("sid") long sId, @PathParam("abiturjahr") int abiturjahr, @PathParam("halbjahr") int halbjahr, @Context jakarta.servlet.http.HttpServletRequest request) Fragt die Klausurdaten eines Schülers ab.- Parameter:
schema
- das Datenbankschema, auf welches die Abfrage ausgeführt werden sollsId
- die Id des Schülersabiturjahr
- das Jahr, in welchem der Jahrgang des Schülers Abitur machen wirdhalbjahr
- das Gost-Halbjahrrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- das
GostKlausurenCollectionData
-Objekt mit den Klausurdaten des Schülers
-
createGostKlausurenSchuelerklausurtermin
@GET @Path("/schuelerklausuren/termine/new/{id : \\d+}") public jakarta.ws.rs.core.Response createGostKlausurenSchuelerklausurtermin(@PathParam("schema") String schema, @PathParam("id") long id, @Context jakarta.servlet.http.HttpServletRequest request) Legt einen neuenGostSchuelerklausurTermin
an. Dies ist meist ein Nachschreibtermin.- Parameter:
schema
- das Datenbankschema, in welchem derGostSchuelerklausurTermin
erstellt wirdid
- die ID derGostSchuelerklausur
, zu der ein neuerGostSchuelerklausurTermin
generiert werden soll.request
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die HTTP-Antwort mit dem neuen
GostSchuelerklausurTermin
-
deleteGostKlausurenSchuelerklausurtermin
@DELETE @Path("/schuelerklausuren/termine/delete/{id : \\d+}") public jakarta.ws.rs.core.Response deleteGostKlausurenSchuelerklausurtermin(@PathParam("schema") String schema, @PathParam("id") long id, @Context jakarta.servlet.http.HttpServletRequest request) Löscht einenGostSchuelerklausurTermin
.- Parameter:
schema
- das Datenbankschema, in welchem derGostSchuelerklausurTermin
gelöscht wirdid
- die ID des zu löschendenGostSchuelerklausurTermin
s.request
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die HTTP-Antwort mit dem Status und ggf. dem gelöschten Schuelerklausurtermin
-
patchGostKlausurenSchuelerklausurtermin
@PATCH @Path("/schuelerklausuren/termine/{id : \\d+}") public jakarta.ws.rs.core.Response patchGostKlausurenSchuelerklausurtermin(@PathParam("schema") String schema, @PathParam("id") long id, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request) Patcht einenGostSchuelerklausurTermin
.- Parameter:
schema
- das Datenbankschema, auf welches der Patch ausgeführt werden sollid
- die ID desGostSchuelerklausurTermin
sis
- JSON-Objekt mit den Datenrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- das Ergebnis der Patch-Operation
-
updateGostKlausuren
@POST @Path("/update") public jakarta.ws.rs.core.Response updateGostKlausuren(@PathParam("schema") String schema, GostKlausurenUpdate update, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Erstellen einer neuen Klausurraumstunde.- Parameter:
schema
- das Datenbankschemaupdate
- das GostNachschreibterminblockungKonfiguration-Objektrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die HTTP-Antwort
-