Package de.svws_nrw.api.server

Klasse APISchueler

java.lang.Object
de.svws_nrw.api.server.APISchueler
@Path("/db/{schema}/schueler") @Produces("application/json") @Consumes("application/json") public class APISchueler extends Object
Die Klasse spezifiziert die OpenAPI-Schnittstelle für den Zugriff auf die grundlegenden Schülerdaten aus der SVWS-Datenbank. Ein Zugriff erfolgt über den Pfad https://{Hostname}/db/{schema}/schueler/...

  • Konstruktorübersicht

    Konstruktoren
    Konstruktor
    Beschreibung
    APISchueler()
    Leerer Standardkonstruktor.

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    jakarta.ws.rs.core.Response
    addKAoAdaten(String schema, long idSchueler, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Erzeugt einen SchuelerKAoADaten-Eintrag und gibt diesen zurück
    jakarta.ws.rs.core.Response
    addSchuelerLeistungsdaten(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Hinzufügen von Leistungsdaten.
    jakarta.ws.rs.core.Response
    addSchuelerLeistungsdatenMultiple(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Hinzufügen mehrerer Leistungsdaten.
    jakarta.ws.rs.core.Response
    addSchuelerSprachbelegung(String schema, long id, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Erzeugt einen Sprachbelegung für den Schüler mit der angebenen ID.
    jakarta.ws.rs.core.Response
    addSchuelerSprachpruefung(String schema, long id, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Erzeugt einen Sprachprüfung für den Schüler mit der angebenen ID.
    jakarta.ws.rs.core.Response
    addVermerk(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Erzeugt einen Schpler-Vermerk und gibt diesen zurück
    jakarta.ws.rs.core.Response
    deleteKAoAdaten(String schema, long idSchueler, long schuelerKAoAID, jakarta.servlet.http.HttpServletRequest request)
    Löscht ein SchuelerKAoADaten-Eintrag anhand dessen Id
    jakarta.ws.rs.core.Response
    deleteSchueler(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Entfernen mehrerer Schüler.
    jakarta.ws.rs.core.Response
    deleteSchuelerLeistungsdaten(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Entfernen von Leistungsdaten.
    jakarta.ws.rs.core.Response
    deleteSchuelerLeistungsdatenMultiple(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Entfernen mehrerer Leistungsdaten.
    jakarta.ws.rs.core.Response
    deleteSchuelerSprachbelegung(String schema, long id, @NotNull String sprache, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Entfernen der Sprachbelegung eines Schülers.
    jakarta.ws.rs.core.Response
    deleteSchuelerSprachpruefung(String schema, long id, @NotNull String sprache, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Entfernen der Sprachprüfung eines Schülers.
    jakarta.ws.rs.core.Response
    deleteSchuelerVermerk(String schema, long schuelerID, long idVermerk, jakarta.servlet.http.HttpServletRequest request)
    Löscht ein SchülerVermerk-Eintrag anhand dessen Id
    jakarta.ws.rs.core.Response
    getKAoAdaten(String schema, long idSchueler, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der KAOADaten eines Schülers.
    jakarta.ws.rs.core.Response
    getKatalogHerkuenfte(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Katalogs der Herkünfte von Schülern.
    jakarta.ws.rs.core.Response
    getKatalogHerkunftsarten(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Katalogs der Herkunftsarten bei Schülern.
    jakarta.ws.rs.core.Response
    getKatalogUebergangsempfehlung(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Katalogs der Übergangsempfehlungen der Grundschule für die Sekundarstufe I.
    jakarta.ws.rs.core.Response
    getSchuelerAktuell(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Liste aller Schüler.
    jakarta.ws.rs.core.Response
    getSchuelerAuswahllisteFuerAbschnitt(String schema, long abschnitt, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Informationen zur Verwaltung einer Schüler-Auswahlliste mit Filterfunktionen in Bezug auf einen Schuljahresabschnitt (GZip-komprimiert).
    jakarta.ws.rs.core.Response
    getSchuelerBetriebe(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Liste aller Betriebe.
    jakarta.ws.rs.core.Response
    getSchuelerBetriebsstammdaten(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Liste aller Betriebsstammdaten eines Schülers.
    jakarta.ws.rs.core.Response
    getSchuelerErzieher(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Liste aller Erzieher.
    jakarta.ws.rs.core.Response
    getSchuelerFahrschuelerarten(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Kataloges für die Fahrschülerarten.
    jakarta.ws.rs.core.Response
    getSchuelerFuerAbschnitt(String schema, long abschnitt, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Liste aller Schüler.
    jakarta.ws.rs.core.Response
    getSchuelerLeistungsdatenByID(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Leistungsdaten eines Schülers.
    jakarta.ws.rs.core.Response
    getSchuelerLernabschnittsdaten(String schema, long id, long abschnitt, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Lernabschnittsdaten eines Schülers.
    jakarta.ws.rs.core.Response
    getSchuelerLernabschnittsdatenByID(String schema, long abschnitt, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Lernabschnittsdaten eines Schülers.
    jakarta.ws.rs.core.Response
    getSchuelerLernabschnittsliste(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Liste von Lernabschnitten eines Schülers.
    jakarta.ws.rs.core.Response
    getSchuelerSchulbesuch(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Schulbesuchsdaten eines Schülers.
    jakarta.ws.rs.core.Response
    getSchuelerSprachbelegung(String schema, long id, @NotNull String sprache, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Sprachbelegung eines Schülers in einer Sprache.
    jakarta.ws.rs.core.Response
    getSchuelerSprachbelegungen(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Sprachbelegungen eines Schülers.
    jakarta.ws.rs.core.Response
    getSchuelerSprachpruefung(String schema, long id, @NotNull String sprache, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Sprachprüfung eines Schülers in einer Sprache.
    jakarta.ws.rs.core.Response
    getSchuelerSprachpruefungen(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Sprachprüfungen eines Schülers.
    jakarta.ws.rs.core.Response
    getSchuelerStammdaten(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Stammdaten eines Schülers.
    jakarta.ws.rs.core.Response
    getVermerkdaten(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Vermerke eines Schülers.
    jakarta.ws.rs.core.Response
    getVermerkdatenByVermerkArt(String schema, long vermerkArt, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Vermerke eines Schülers.
    jakarta.ws.rs.core.Response
    patchKAoADaten(String schema, long idSchueler, long schuelerKAoAId, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Ändert einen SchuelerKAoADaten-Eintrag anhand seiner ID
    jakarta.ws.rs.core.Response
    patchSchuelerLeistungsdaten(String schema, long id, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Patchen von Schülerleistungsdaten.
    jakarta.ws.rs.core.Response
    patchSchuelerLernabschnittsdaten(String schema, long abschnitt, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Patchen von Schülerlernabschnittsdaten.
    jakarta.ws.rs.core.Response
    patchSchuelerLernabschnittsdatenBemerkungen(String schema, long abschnitt, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Patchen von Bemerkungen in Schülerlernabschnittsdaten.
    jakarta.ws.rs.core.Response
    patchSchuelerSchulbesuch(String schema, long id, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Patchen der Stammdaten eines Schülers.
    jakarta.ws.rs.core.Response
    patchSchuelerSprachbelegung(String schema, long id, @NotNull String sprache, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Patchen der Sprachbelegung eines Schülers in einer Sprache.
    jakarta.ws.rs.core.Response
    patchSchuelerSprachpruefung(String schema, long id, @NotNull String sprache, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Patchen der Sprachprüfung eines Schülers in einer Sprache.
    jakarta.ws.rs.core.Response
    patchSchuelerStammdaten(String schema, long id, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Patchen der Stammdaten eines Schülers.
    jakarta.ws.rs.core.Response
    patchSchuelerVermerke(String schema, long vid, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Patchen der Vermerke eines Schülers.

    Von Klasse geerbte Methoden java.lang.Object

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

  • Konstruktordetails

    • APISchueler

      public APISchueler()
      Leerer Standardkonstruktor.

  • Methodendetails

    • getSchuelerAktuell

      @GET @Path("/aktuell") public jakarta.ws.rs.core.Response getSchuelerAktuell(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage der Liste aller Schüler.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Liste mit den einzelnen Schülern

    • getSchuelerFuerAbschnitt

      @GET @Path("/abschnitt/{abschnitt : \\d+}") public jakarta.ws.rs.core.Response getSchuelerFuerAbschnitt(@PathParam("schema") String schema, @PathParam("abschnitt") long abschnitt, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage der Liste aller Schüler.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      abschnitt - die ID des Schuljahresabschnitts dessen Schüler zurückgegeben werden sollen
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Liste mit den einzelnen Schülern

    • getSchuelerAuswahllisteFuerAbschnitt

      @GET @Produces("application/octet-stream") @Path("/abschnitt/{abschnitt : \\d+}/auswahlliste") public jakarta.ws.rs.core.Response getSchuelerAuswahllisteFuerAbschnitt(@PathParam("schema") String schema, @PathParam("abschnitt") long abschnitt, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage der Informationen zur Verwaltung einer Schüler-Auswahlliste mit Filterfunktionen in Bezug auf einen Schuljahresabschnitt (GZip-komprimiert).
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      abschnitt - die ID des Schuljahresabschnitts
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die GZip-komprimierten Daten zur Schüler-Auswahlliste

    • getSchuelerStammdaten

      @GET @Path("/{id : \\d+}/stammdaten") public jakarta.ws.rs.core.Response getSchuelerStammdaten(@PathParam("schema") String schema, @PathParam("id") long id, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage der Stammdaten eines Schülers.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      id - die Datenbank-ID zur Identifikation des Schülers
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Stammdaten des Schülers

    • patchSchuelerStammdaten

      @PATCH @Path("/{id : \\d+}/stammdaten") public jakarta.ws.rs.core.Response patchSchuelerStammdaten(@PathParam("schema") String schema, @PathParam("id") long id, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Patchen der Stammdaten eines Schülers.
      Parameter:
      schema - das Datenbankschema, auf welches der Patch ausgeführt werden soll
      id - die Datenbank-ID zur Identifikation des Schülers
      is - der InputStream, mit dem JSON-Patch-Objekt nach RFC 7386
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      das Ergebnis der Patch-Operation

    • deleteSchueler

      @DELETE @Path("/delete/multiple") public jakarta.ws.rs.core.Response deleteSchueler(@PathParam("schema") String schema, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Entfernen mehrerer Schüler.
      Parameter:
      schema - das Datenbankschema
      is - der InputStream, mit der Liste von zu löschenden IDs
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die HTTP-Antwort mit dem Status der Lösch-Operationen

    • getSchuelerSchulbesuch

      @GET @Path("/{id : \\d+}/schulbesuch") public jakarta.ws.rs.core.Response getSchuelerSchulbesuch(@PathParam("schema") String schema, @PathParam("id") long id, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage der Schulbesuchsdaten eines Schülers.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      id - die Datenbank-ID zur Identifikation des Schülers
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Schulbesuchsdaten des Schülers

    • patchSchuelerSchulbesuch

      @PATCH @Path("/{id : \\d+}/schulbesuch") public jakarta.ws.rs.core.Response patchSchuelerSchulbesuch(@PathParam("schema") String schema, @PathParam("id") long id, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Patchen der Stammdaten eines Schülers.
      Parameter:
      schema - das Datenbankschema, auf welches der Patch ausgeführt werden soll
      id - die Datenbank-ID zur Identifikation des Schülers
      is - der InputStream, mit dem JSON-Patch-Objekt nach RFC 7386
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      das Ergebnis der Patch-Operation

    • getSchuelerLernabschnittsliste

      @GET @Path("/{id : \\d+}/lernabschnitte") public jakarta.ws.rs.core.Response getSchuelerLernabschnittsliste(@PathParam("schema") String schema, @PathParam("id") long id, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage der Liste von Lernabschnitten eines Schülers.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      id - die Datenbank-ID zur Identifikation des Schülers
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Lernabschnittsdaten des Schülers

    • getSchuelerLernabschnittsdaten

      @GET @Path("/{id : \\d+}/abschnitt/{abschnitt : \\d+}/lernabschnittsdaten") public jakarta.ws.rs.core.Response getSchuelerLernabschnittsdaten(@PathParam("schema") String schema, @PathParam("id") long id, @PathParam("abschnitt") long abschnitt, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage der Lernabschnittsdaten eines Schülers.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      id - die Datenbank-ID zur Identifikation des Schülers
      abschnitt - der Schuljahresabschnitt des auszulesenden Lernabschnitts
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Lernabschnittsdaten des Schülers

    • getSchuelerLernabschnittsdatenByID

      @GET @Path("/lernabschnittsdaten/{abschnitt : \\d+}") public jakarta.ws.rs.core.Response getSchuelerLernabschnittsdatenByID(@PathParam("schema") String schema, @PathParam("abschnitt") long abschnitt, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage der Lernabschnittsdaten eines Schülers.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      abschnitt - die ID des Schülerlernabschnitts
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Lernabschnittsdaten des Schülers

    • patchSchuelerLernabschnittsdaten

      @PATCH @Path("/lernabschnittsdaten/{abschnitt : \\d+}") public jakarta.ws.rs.core.Response patchSchuelerLernabschnittsdaten(@PathParam("schema") String schema, @PathParam("abschnitt") long abschnitt, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Patchen von Schülerlernabschnittsdaten.
      Parameter:
      schema - das Datenbankschema, auf welches der Patch ausgeführt werden soll
      abschnitt - die ID des Schülerlernabschnitts
      is - der InputStream, mit dem JSON-Patch-Objekt nach RFC 7386
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      das Ergebnis der Patch-Operation

    • patchSchuelerLernabschnittsdatenBemerkungen

      @PATCH @Path("/lernabschnittsdaten/{abschnitt : \\d+}/bemerkungen") public jakarta.ws.rs.core.Response patchSchuelerLernabschnittsdatenBemerkungen(@PathParam("schema") String schema, @PathParam("abschnitt") long abschnitt, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Patchen von Bemerkungen in Schülerlernabschnittsdaten.
      Parameter:
      schema - das Datenbankschema, auf welches der Patch ausgeführt werden soll
      abschnitt - die ID des Schülerlernabschnitts
      is - der InputStream, mit dem JSON-Patch-Objekt nach RFC 7386
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      das Ergebnis der Patch-Operation

    • getSchuelerLeistungsdatenByID

      @GET @Path("/leistungsdaten/{id : \\d+}") public jakarta.ws.rs.core.Response getSchuelerLeistungsdatenByID(@PathParam("schema") String schema, @PathParam("id") long id, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage der Leistungsdaten eines Schülers.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      id - die Datenbank-ID der Schülerleistungsdaten
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Leistungsdaten des Schülers

    • patchSchuelerLeistungsdaten

      @PATCH @Path("/leistungsdaten/{id : \\d+}") public jakarta.ws.rs.core.Response patchSchuelerLeistungsdaten(@PathParam("schema") String schema, @PathParam("id") long id, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Patchen von Schülerleistungsdaten.
      Parameter:
      schema - das Datenbankschema, auf welches der Patch ausgeführt werden soll
      id - die Datenbank-ID zur Identifikation der Schülerleistungsdaten
      is - der InputStream, mit dem JSON-Patch-Objekt nach RFC 7386
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      das Ergebnis der Patch-Operation

    • addSchuelerLeistungsdaten

      @POST @Path("/leistungsdaten/create") public jakarta.ws.rs.core.Response addSchuelerLeistungsdaten(@PathParam("schema") String schema, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Hinzufügen von Leistungsdaten.
      Parameter:
      schema - das Datenbankschema
      is - der Input-Stream mit den Daten der Leistungsdaten
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die HTTP-Antwort mit den neuen Leistungsdaten

    • addSchuelerLeistungsdatenMultiple

      @POST @Path("/leistungsdaten/create/multiple") public jakarta.ws.rs.core.Response addSchuelerLeistungsdatenMultiple(@PathParam("schema") String schema, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Hinzufügen mehrerer Leistungsdaten.
      Parameter:
      schema - das Datenbankschema
      is - der Input-Stream mit den Daten der Räume
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die HTTP-Antwort mit der Liste der neuen Leistungsdaten

    • deleteSchuelerLeistungsdaten

      @DELETE @Path("/leistungsdaten/{id : \\d+}") public jakarta.ws.rs.core.Response deleteSchuelerLeistungsdaten(@PathParam("schema") String schema, @PathParam("id") long id, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Entfernen von Leistungsdaten.
      Parameter:
      schema - das Datenbankschema
      id - die ID der Leistungsdaten
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die HTTP-Antwort mit dem Status und ggf. den gelöschten Leistungsdaten

    • deleteSchuelerLeistungsdatenMultiple

      @DELETE @Path("/leistungsdaten/delete/multiple") public jakarta.ws.rs.core.Response deleteSchuelerLeistungsdatenMultiple(@PathParam("schema") String schema, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Entfernen mehrerer Leistungsdaten.
      Parameter:
      schema - das Datenbankschema
      is - die IDs der Leistungsdaten
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die HTTP-Antwort mit dem Status und ggf. den gelöschten Leistungsdaten

    • getSchuelerFahrschuelerarten

      @GET @Path("fahrschuelerarten") public jakarta.ws.rs.core.Response getSchuelerFahrschuelerarten(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage des Kataloges für die Fahrschülerarten.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Liste mit dem Katalog der Fahrschülerarten

    • getSchuelerErzieher

      @GET @Path("/{id : \\d+}/erzieher") public jakarta.ws.rs.core.Response getSchuelerErzieher(@PathParam("schema") String schema, @PathParam("id") long id, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage der Liste aller Erzieher.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      id - die ID des Schülers, dessen Erzieher zurückegeben werden.
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Liste mit den einzelnen Erziehern

    • getSchuelerBetriebe

      @GET @Path("/{id : \\d+}/betriebe") public jakarta.ws.rs.core.Response getSchuelerBetriebe(@PathParam("schema") String schema, @PathParam("id") long id, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage der Liste aller Betriebe.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      id - die ID des Schülers, dessen Betriebe zurückegeben werden.
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Liste mit den einzelnen Betrieben

    • getSchuelerBetriebsstammdaten

      @GET @Path("/{id : \\d+}/betriebsstammdaten") public jakarta.ws.rs.core.Response getSchuelerBetriebsstammdaten(@PathParam("schema") String schema, @PathParam("id") long id, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage der Liste aller Betriebsstammdaten eines Schülers.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      id - die ID des Schülers
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Liste der Betriebsstammdaten eines Schülers

    • getKatalogUebergangsempfehlung

      @GET @Path("/allgemein/uebergangsempfehlung") public jakarta.ws.rs.core.Response getKatalogUebergangsempfehlung(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage des Katalogs der Übergangsempfehlungen der Grundschule für die Sekundarstufe I.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Liste mit dem Katalog der Übergangsempfehlungen der Grundschule für die Sekundarstufe I.

    • getKatalogHerkuenfte

      @GET @Path("/allgemein/herkuenfte") public jakarta.ws.rs.core.Response getKatalogHerkuenfte(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage des Katalogs der Herkünfte von Schülern.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Liste mit dem Katalog der Herkünfte von Schülern.

    • getKatalogHerkunftsarten

      @GET @Path("/allgemein/herkunftsarten") public jakarta.ws.rs.core.Response getKatalogHerkunftsarten(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage des Katalogs der Herkunftsarten bei Schülern.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Liste mit dem Katalog der Herkunftsarten bei Schülern.

    • getVermerkdaten

      @GET @Path("/{id : \\d+}/vermerke") public jakarta.ws.rs.core.Response getVermerkdaten(@PathParam("schema") String schema, @PathParam("id") long id, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage der Vermerke eines Schülers.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      id - die Datenbank-ID zur Identifikation des Schülers
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Vermerkdaten des Schülers

    • getVermerkdatenByVermerkArt

      @GET @Path("/vermerke/vermerkart/{vermerkArt : \\d+}") public jakarta.ws.rs.core.Response getVermerkdatenByVermerkArt(@PathParam("schema") String schema, @PathParam("vermerkArt") long vermerkArt, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage der Vermerke eines Schülers.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      vermerkArt - die Datenbank-ID zur Identifikation des Vermerart
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Vermerkdaten des Schülers

    • patchSchuelerVermerke

      @PATCH @Path("/vermerke/{vid : \\d+}") public jakarta.ws.rs.core.Response patchSchuelerVermerke(@PathParam("schema") String schema, @PathParam("vid") long vid, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Patchen der Vermerke eines Schülers.
      Parameter:
      schema - das Datenbankschema, auf welches der Patch ausgeführt werden soll
      vid - die ID des Vermerkes welcher gepatches wird
      is - der InputStream, mit dem JSON-Patch-Objekt nach RFC 7386
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      das Ergebnis der Patch-Operation

    • addVermerk

      @POST @Path("/vermerke") public jakarta.ws.rs.core.Response addVermerk(@PathParam("schema") String schema, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Erzeugt einen Schpler-Vermerk und gibt diesen zurück
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      is - der InputStream, mit dem JSON-Patch-Objekt nach RFC 7386
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      HTTP_201 und der angelegte Schueler-Vermerk, wenn erfolgreich.
      HTTP_400, wenn Fehler bei der Validierung auftreten HTTP_403 bei fehlender Berechtigung,
      HTTP_404, wenn der Eintrag nicht gefunden wurde

    • deleteSchuelerVermerk

      @DELETE @Path("/{id : \\d+}/vermerke/{idVermerk : \\d+}") public jakarta.ws.rs.core.Response deleteSchuelerVermerk(@PathParam("schema") String schema, @PathParam("id") long schuelerID, @PathParam("idVermerk") long idVermerk, @Context jakarta.servlet.http.HttpServletRequest request)
      Löscht ein SchülerVermerk-Eintrag anhand dessen Id
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      schuelerID - die Schueler-ID
      idVermerk - die Datenbank-ID des Schüler-Vermerks
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      HTTP_204, wenn erfolgreich.
      HTTP_403 bei fehlender Berechtigung,
      HTTP_404, wenn der Eintrag nicht gefunden wurde

    • getKAoAdaten

      @GET @Path("/{id : \\d+}/kaoa") public jakarta.ws.rs.core.Response getKAoAdaten(@PathParam("schema") String schema, @PathParam("id") long idSchueler, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage der KAOADaten eines Schülers.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      idSchueler - die Datenbank-ID zur Identifikation des Schülers
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die KAOADaten des Schülers

    • addKAoAdaten

      @POST @Path("/{id : \\d+}/kaoa/create") public jakarta.ws.rs.core.Response addKAoAdaten(@PathParam("schema") String schema, @PathParam("id") long idSchueler, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Erzeugt einen SchuelerKAoADaten-Eintrag und gibt diesen zurück
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      idSchueler - die Schueler-ID
      is - der InputStream, mit dem JSON-Patch-Objekt der KAoA-Klassendaten
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      HTTP_201 und die angelegten SchuelerKAoADaten, wenn erfolgreich.
      HTTP_400, wenn Fehler bei der Validierung auftreten HTTP_403 bei fehlender Berechtigung,
      HTTP_404, wenn der Eintrag nicht gefunden wurde

    • patchKAoADaten

      @PATCH @Path("/{id : \\d+}/kaoa/{skid : \\d+}") public jakarta.ws.rs.core.Response patchKAoADaten(@PathParam("schema") String schema, @PathParam("id") long idSchueler, @PathParam("skid") long schuelerKAoAId, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Ändert einen SchuelerKAoADaten-Eintrag anhand seiner ID
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      idSchueler - die Schueler-ID
      schuelerKAoAId - die Datenbank-ID der Schüler-KAoA-Daten
      is - der InputStream
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      das Ergebnis der Patch-Operation

    • deleteKAoAdaten

      @DELETE @Path("/{id : \\d+}/kaoa/{skid : \\d+}") public jakarta.ws.rs.core.Response deleteKAoAdaten(@PathParam("schema") String schema, @PathParam("id") long idSchueler, @PathParam("skid") long schuelerKAoAID, @Context jakarta.servlet.http.HttpServletRequest request)
      Löscht ein SchuelerKAoADaten-Eintrag anhand dessen Id
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      idSchueler - die Schueler-ID
      schuelerKAoAID - die Datenbank-ID der Schüler-KAoA-Daten
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      HTTP_204, wenn erfolgreich.
      HTTP_403 bei fehlender Berechtigung,
      HTTP_404, wenn der Eintrag nicht gefunden wurde

    • getSchuelerSprachbelegungen

      @GET @Path("/{id : \\d+}/sprachen/belegungen") public jakarta.ws.rs.core.Response getSchuelerSprachbelegungen(@PathParam("schema") String schema, @PathParam("id") long id, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage der Sprachbelegungen eines Schülers.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      id - die Datenbank-ID zur Identifikation des Schülers
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Spachbelegungen des Schülers

    • getSchuelerSprachbelegung

      @GET @Path("/{id : \\d+}/sprache/{sprache : [A-Z]+}/belegung") public jakarta.ws.rs.core.Response getSchuelerSprachbelegung(@PathParam("schema") String schema, @PathParam("id") long id, @PathParam("sprache") @NotNull @NotNull String sprache, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage der Sprachbelegung eines Schülers in einer Sprache.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      id - die Datenbank-ID zur Identifikation des Schülers
      sprache - das Sprachkürzel der Sprache
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Spachbelegungen des Schülers

    • patchSchuelerSprachbelegung

      @PATCH @Path("/{id : \\d+}/sprache/{sprache : [A-Z]+}/belegung") public jakarta.ws.rs.core.Response patchSchuelerSprachbelegung(@PathParam("schema") String schema, @PathParam("id") long id, @PathParam("sprache") @NotNull @NotNull String sprache, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Patchen der Sprachbelegung eines Schülers in einer Sprache.
      Parameter:
      schema - das Datenbankschema, auf welches der Patch ausgeführt werden soll
      id - die Datenbank-ID zur Identifikation des Schülers
      sprache - das Sprachkürzel der Sprache
      is - der InputStream, mit dem JSON-Patch-Objekt nach RFC 7386
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      das Ergebnis der Patch-Operation

    • addSchuelerSprachbelegung

      @POST @Path("/{id : \\d+}/sprachen/belegungen") public jakarta.ws.rs.core.Response addSchuelerSprachbelegung(@PathParam("schema") String schema, @PathParam("id") long id, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Erzeugt einen Sprachbelegung für den Schüler mit der angebenen ID.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      id - die Schueler-ID
      is - der Input-Stream mit den Daten der Sprachbelegung
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Response im Erfolgsfall mit der neuen Sprachbelegung

    • deleteSchuelerSprachbelegung

      @DELETE @Path("/{id : \\d+}/sprache/{sprache : [A-Z]+}/belegung") public jakarta.ws.rs.core.Response deleteSchuelerSprachbelegung(@PathParam("schema") String schema, @PathParam("id") long id, @PathParam("sprache") @NotNull @NotNull String sprache, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Entfernen der Sprachbelegung eines Schülers.
      Parameter:
      schema - das Datenbankschema
      id - die Schueler-ID
      sprache - das Sprachkürzel der Sprache
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die HTTP-Antwort mit dem Status und ggf. der gelöschten Sprachbelegung

    • getSchuelerSprachpruefungen

      @GET @Path("/{id : \\d+}/sprachen/pruefungen") public jakarta.ws.rs.core.Response getSchuelerSprachpruefungen(@PathParam("schema") String schema, @PathParam("id") long id, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage der Sprachprüfungen eines Schülers.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      id - die Datenbank-ID zur Identifikation des Schülers
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Spachprüfungen des Schülers

    • getSchuelerSprachpruefung

      @GET @Path("/{id : \\d+}/sprache/{sprache : [A-Z]+}/pruefung") public jakarta.ws.rs.core.Response getSchuelerSprachpruefung(@PathParam("schema") String schema, @PathParam("id") long id, @PathParam("sprache") @NotNull @NotNull String sprache, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage der Sprachprüfung eines Schülers in einer Sprache.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      id - die Datenbank-ID zur Identifikation des Schülers
      sprache - das Sprachkürzel der Sprache
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Spachprüfung des Schülers

    • patchSchuelerSprachpruefung

      @PATCH @Path("/{id : \\d+}/sprache/{sprache : [A-Z]+}/pruefung") public jakarta.ws.rs.core.Response patchSchuelerSprachpruefung(@PathParam("schema") String schema, @PathParam("id") long id, @PathParam("sprache") @NotNull @NotNull String sprache, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Patchen der Sprachprüfung eines Schülers in einer Sprache.
      Parameter:
      schema - das Datenbankschema, auf welches der Patch ausgeführt werden soll
      id - die Datenbank-ID zur Identifikation des Schülers
      sprache - das Sprachkürzel der Sprache
      is - der InputStream, mit dem JSON-Patch-Objekt nach RFC 7386
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      das Ergebnis der Patch-Operation

    • addSchuelerSprachpruefung

      @POST @Path("/{id : \\d+}/sprachen/pruefungen") public jakarta.ws.rs.core.Response addSchuelerSprachpruefung(@PathParam("schema") String schema, @PathParam("id") long id, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Erzeugt einen Sprachprüfung für den Schüler mit der angebenen ID.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      id - die Schueler-ID
      is - der Input-Stream mit den Daten der Sprachprüfung
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Response im Erfolgsfall mit der neuen Sprachprüfung

    • deleteSchuelerSprachpruefung

      @DELETE @Path("/{id : \\d+}/sprache/{sprache : [A-Z]+}/pruefung") public jakarta.ws.rs.core.Response deleteSchuelerSprachpruefung(@PathParam("schema") String schema, @PathParam("id") long id, @PathParam("sprache") @NotNull @NotNull String sprache, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Entfernen der Sprachprüfung eines Schülers.
      Parameter:
      schema - das Datenbankschema
      id - die Schueler-ID
      sprache - das Sprachkürzel der Sprache
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die HTTP-Antwort mit dem Status und ggf. der gelöschten Sprachprüfung