Package de.svws_nrw.api.server

Klasse APISchule

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

  • Konstruktorübersicht

    Konstruktoren
    Konstruktor
    Beschreibung
    APISchule()
    Leerer Standardkonstruktor.

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    jakarta.ws.rs.core.Response
    addAufsichtsbereich(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Hinzufügen eines neuen Aufsichtsbereichs zu der Schule.
    jakarta.ws.rs.core.Response
    addAufsichtsbereiche(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Hinzufügen mehrere neuer Aufsichtsbereiche zu der Schule.
    jakarta.ws.rs.core.Response
    addPausenzeit(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Hinzufügen einer neuen Pausenzeit zu der Schule.
    jakarta.ws.rs.core.Response
    addPausenzeiten(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Hinzufügen mehrerer neuer Pausenzeiten zu der Schule.
    jakarta.ws.rs.core.Response
    addRaeume(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Hinzufügen mehrerer neuer Räume zu der Schule.
    jakarta.ws.rs.core.Response
    addRaum(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Hinzufügen eines neuen Raumes zu der Schule.
    jakarta.ws.rs.core.Response
    addSchuleZuKatalog(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Hinzufügen eines Eintrags zum schulspezifischen Katalog der Schulen.
    jakarta.ws.rs.core.Response
    addSchulleitungsfunktion(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Hinzufügen einer Leitungsfunktion zu der Schule.
    jakarta.ws.rs.core.Response
    addSchulleitungsfunktionen(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Hinzufügen mehrerer Leitungsfunktionen zu der Schule.
    jakarta.ws.rs.core.Response
    addZeitrasterEintraege(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Hinzufügen mehrerer neuer Zeitraster-Einträge zu der Schule.
    jakarta.ws.rs.core.Response
    addZeitrasterEintrag(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Hinzufügen eines neuen Zeitraster-Eintrags zu der Schule.
    jakarta.ws.rs.core.Response
    createEinwilligungsart(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Erstellen einer neuen Einwilligungsart.
    jakarta.ws.rs.core.Response
    createReligion(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Erstellen einer neuen Religion.
    jakarta.ws.rs.core.Response
    createVermerkart(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Erstellen einer neuen Vermerkart.
    jakarta.ws.rs.core.Response
    deleteAufsichtsbereich(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Entfernen eines Aufsichtsbereichs der Schule.
    jakarta.ws.rs.core.Response
    deleteAufsichtsbereiche(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Entfernen mehrerer Aufsichtsbereiche der Schule.
    jakarta.ws.rs.core.Response
    deleteEinwilligungsart(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Entfernen einer Einwilligungsart der Schule.
    jakarta.ws.rs.core.Response
    deleteEinwilligungsarten(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Entfernen mehrerer Einwilligungsarten der Schule.
    jakarta.ws.rs.core.Response
    deletePausenzeit(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Entfernen einer Pausenzeit der Schule.
    jakarta.ws.rs.core.Response
    deletePausenzeiten(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Entfernen mehrerer Pausenzeiten der Schule.
    jakarta.ws.rs.core.Response
    deleteRaeume(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Entfernen mehrerer Räume der Schule.
    jakarta.ws.rs.core.Response
    deleteRaum(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Entfernen eines Raums der Schule.
    jakarta.ws.rs.core.Response
    deleteReligionEintraege(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Entfernen mehrerer Religion-Katalog-Einträge der Schule.
    jakarta.ws.rs.core.Response
    deleteReligionEintrag(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Entfernen eines Religion-Katalog-Eintrags der Schule.
    jakarta.ws.rs.core.Response
    deleteSchulenVonKatalog(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Entfernen mehrerer Einträge aus dem schulspezifischen Katalog der Schulen.
    jakarta.ws.rs.core.Response
    deleteSchuleVonKatalog(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Entfernen eines Eintrags aus dem schulspezifischen Katalog der Schulen.
    jakarta.ws.rs.core.Response
    deleteSchulleitungsfunktion(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Entfernen einer Leitungsfunktion der Schule.
    jakarta.ws.rs.core.Response
    deleteSchulleitungsfunktionen(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Entfernen mehrerer Leitungsfunktionen der Schule.
    jakarta.ws.rs.core.Response
    deleteVermerkartEintraege(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Entfernen mehrerer Vermerkart-Katalog-Einträge der Schule.
    jakarta.ws.rs.core.Response
    deleteVermerkartEintrag(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Entfernen eines Vermerkart-Katalog-Eintrags der Schule.
    jakarta.ws.rs.core.Response
    deleteZeitrasterEintraege(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Entfernen mehrerer Zeitraster-Einträge der Schule.
    jakarta.ws.rs.core.Response
    deleteZeitrasterEintrag(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Entfernen eines Zeitraster-Eintrags der Schule.
    jakarta.ws.rs.core.Response
    getAllgemeineMerkmale(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Katalogs der Allgemeinen Merkmale bei Schulen und Schülern.
    jakarta.ws.rs.core.Response
    getAufsichtsbereich(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage eines Aufsichtsbereichs der Schule.
    jakarta.ws.rs.core.Response
    getAufsichtsbereiche(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Kataloges der Aufsichtsbereiche der Schule.
    jakarta.ws.rs.core.Response
    getBerufskollegAnlagen(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Kataloges für die Anlagen am Berufskolleg.
    jakarta.ws.rs.core.Response
    getBerufskollegBerufsebenen(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Kataloges für die Berufsebenen am Berufskolleg.
    jakarta.ws.rs.core.Response
    getBerufskollegFachklassen(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Kataloges für die Fachklassen am Berufskolleg.
    jakarta.ws.rs.core.Response
    getEinschulungsarten(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Katalogs der Einschulungsarten.
    jakarta.ws.rs.core.Response
    getEinwilligungsart(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage einer Einwilligungsart.
    jakarta.ws.rs.core.Response
    getEinwilligungsarten(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des schulspezifischen Kataloges für die Einwilligungsarten.
    jakarta.ws.rs.core.Response
    getFoerderschwerpunkte(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Kataloges für die Förderschwerpunkte.
    jakarta.ws.rs.core.Response
    getKatalogAbgangsartenAllgemeinbildend(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Kataloges der Abgangsarten für allgemeinbildende Schulformen, welche im Rahmen der amtlichen Schulstatistik zulässig sind.
    jakarta.ws.rs.core.Response
    getKatalogAbgangsartenBerufsbildend(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Kataloges der Abgangsarten für berufsbildende Schulformen, welche im Rahmen der amtlichen Schulstatistik zulässig sind.
    jakarta.ws.rs.core.Response
    getKatalogHerkunftsschulnummern(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Kataloges der zusätzlichen Herkunftsschulnummern
    jakarta.ws.rs.core.Response
    getKatalogKindergartenbesuchsdauer(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Kataloges für Dauer des Kindergartenbesuchs.
    jakarta.ws.rs.core.Response
    getKatalogNoten(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Kataloges der Noten.
    jakarta.ws.rs.core.Response
    getKatalogOrganisationsformen(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Katalogs der gültigen Organisationsformen.
    jakarta.ws.rs.core.Response
    getKatalogReformpaedagogik(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Reformpädagogik-Kataloges für die Schulform dieser Schule.
    jakarta.ws.rs.core.Response
    getKatalogReformpaedagogikAlle(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Reformpädagogik-Kataloges aller Schulformen.
    jakarta.ws.rs.core.Response
    getKatalogReformpaedagogikEintrag(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Reformpädagogik-Katalog-Eintrags für die angegebene ID.
    jakarta.ws.rs.core.Response
    getKatalogReligionen(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Kataloges für die Relgionen bzw.
    jakarta.ws.rs.core.Response
    getKatalogSchuelerStatus(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Kataloges Schüler-Status.
    jakarta.ws.rs.core.Response
    getKatalogSchulen(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Schulen-Kataloges.
    jakarta.ws.rs.core.Response
    getKatalogSchultraeger(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Schulträger-Kataloges.
    jakarta.ws.rs.core.Response
    getNationaelitaeten(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Liste der Nationalitäten im angegebenen Schema.
    jakarta.ws.rs.core.Response
    getPausenzeit(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage einer Pausenzeit der Schule.
    jakarta.ws.rs.core.Response
    getPausenzeiten(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Kataloges der Pausenzeiten der Schule.
    jakarta.ws.rs.core.Response
    getPruefungsordnungen(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Kataloges der Ausbildungs- und Prüfungsordnungen.
    jakarta.ws.rs.core.Response
    getRaeume(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Kataloges der Räume der Schule.
    jakarta.ws.rs.core.Response
    getRaum(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage eines Raumes der Schule.
    jakarta.ws.rs.core.Response
    getReligion(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage einer Religion.
    jakarta.ws.rs.core.Response
    getReligionen(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des schulspezifischen Kataloges für die Religionen bzw.
    jakarta.ws.rs.core.Response
    getSchuelerByVermerkartID(String schema, long vermerkart, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Liste aller Schüler.
    jakarta.ws.rs.core.Response
    getSchuelerFoerderschwerpunkt(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage eines Förderschwerpunktes.
    jakarta.ws.rs.core.Response
    getSchuelerFoerderschwerpunkte(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Kataloges für die Förderschwerpunkte.
    jakarta.ws.rs.core.Response
    getSchulabschluesseAllgemeinbildend(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Kataloges für die allgemeinbildenden Schulabschlüsse.
    jakarta.ws.rs.core.Response
    getSchulabschluesseBerufsbildend(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Kataloges für die berufsbildenden Schulabschlüsse.
    jakarta.ws.rs.core.Response
    getSchuleAusKatalog(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage eines Eintrags des schulspezifischen Kataloges für die Schulen.
    jakarta.ws.rs.core.Response
    getSchulen(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des schulspezifischen Kataloges für die Schulen.
    jakarta.ws.rs.core.Response
    getSchulenMitKuerzel(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des schulspezifischen Kataloges für die Schulen, welche ein Kürzel gesetzt haben.
    jakarta.ws.rs.core.Response
    getSchuleNummer(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Schulnummer der Schule.
    jakarta.ws.rs.core.Response
    getSchuleStammdaten(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Stammdaten der Schule.
    jakarta.ws.rs.core.Response
    getSchulformen(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Kataloges für die Schulformen.
    jakarta.ws.rs.core.Response
    getSchulgliederungen(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Kataloges für die Schulgliederungen.
    jakarta.ws.rs.core.Response
    getSchulleitungsfunktion(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage einer Leitungsfunktion der Schule.
    jakarta.ws.rs.core.Response
    getSchulleitungsfunktionen(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage aller Leitungsfunktionen der Schule.
    jakarta.ws.rs.core.Response
    getSchullogo(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Schullogos der Schule.
    jakarta.ws.rs.core.Response
    getVerkehrssprachen(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Kataloges der Verkehrssprachen in einer Familie.
    jakarta.ws.rs.core.Response
    getVermerkart(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage einer Vermerkart.
    jakarta.ws.rs.core.Response
    getVermerkarten(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des schulspezifischen Kataloges für die Vermerkarten.
    jakarta.ws.rs.core.Response
    getZeitraster(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Zeitraster-Kataloges der Schule.
    jakarta.ws.rs.core.Response
    getZeitrasterEintrag(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage eines Zeitraster-Eintrags der Schule.
    jakarta.ws.rs.core.Response
    initSchule(String schema, int schulnummer, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Initialisieren des Schema mit einer Schulnummer.
    jakarta.ws.rs.core.Response
    patchAufsichtsbereich(String schema, long id, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Patchen eines Aufsichtsbereichs der Schule.
    jakarta.ws.rs.core.Response
    patchEinwilligungsart(String schema, long id, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Patchen einer Einwilligungsart im angegebenen Schema
    jakarta.ws.rs.core.Response
    patchPausenzeit(String schema, long id, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Patchen einer Pausenzeit der Schule.
    jakarta.ws.rs.core.Response
    patchRaum(String schema, long id, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Patchen eines Raumes der Schule.
    jakarta.ws.rs.core.Response
    patchReligion(String schema, long id, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Patchen einer Betriebsart im angegebenen Schema
    jakarta.ws.rs.core.Response
    patchSchuleAusKatalog(String schema, long id, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Patchen eines Eintrags des schulspezifischen Kataloges.
    jakarta.ws.rs.core.Response
    patchSchuleStammdaten(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Anpassen der Stammdaten der Schule.
    jakarta.ws.rs.core.Response
    patchSchulleitungsfunktion(String schema, long id, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Patchen einer Leitungsfunktion der Schule.
    jakarta.ws.rs.core.Response
    patchVermerkart(String schema, long id, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Patchen einer Vermerkart im angegebenen Schema
    jakarta.ws.rs.core.Response
    patchZeitrasterEintraege(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Patchen mehrerer Zeitraster-Einträge.
    jakarta.ws.rs.core.Response
    patchZeitrasterEintrag(String schema, long id, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Patchen eines Zeitraster-Eintrags der Schule.
    jakarta.ws.rs.core.Response
    putSchullogo(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode zum Setzen des Schullogos der Schule.

    Von Klasse geerbte Methoden java.lang.Object

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

  • Konstruktordetails

    • APISchule

      public APISchule()
      Leerer Standardkonstruktor.

  • Methodendetails

    • initSchule

      @POST @Path("/init/{schulnummer : \\d+}") public jakarta.ws.rs.core.Response initSchule(@PathParam("schema") String schema, @PathParam("schulnummer") int schulnummer, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Initialisieren des Schema mit einer Schulnummer. Es wird vorausgesetzt, dass bisher keine Schulnummer in dem Schema festgelegt wurde.
      Parameter:
      schema - das Datenbankschema, in welchem die Schule angelegt wird
      schulnummer - die Schulnummer
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die HTTP-Antwort mit den neuen Schulstammdaten

    • getSchuleNummer

      @GET @Path("/nummer") public jakarta.ws.rs.core.Response getSchuleNummer(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage der Schulnummer der Schule.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Schulnummer

    • getSchuleStammdaten

      @GET @Path("/stammdaten") public jakarta.ws.rs.core.Response getSchuleStammdaten(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage der Stammdaten der Schule.
      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 Stammdaten

    • patchSchuleStammdaten

      @PATCH @Path("/stammdaten") public jakarta.ws.rs.core.Response patchSchuleStammdaten(@PathParam("schema") String schema, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Anpassen der Stammdaten der Schule.
      Parameter:
      schema - das Datenbankschema, auf welches der Patch ausgeführt werden soll
      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

    • getSchullogo

      @GET @Path("/logo") public jakarta.ws.rs.core.Response getSchullogo(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage des Schullogos der Schule.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      das Schullogo als Base64-kodierter String

    • putSchullogo

      @PUT @Path("/logo") public jakarta.ws.rs.core.Response putSchullogo(@PathParam("schema") String schema, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode zum Setzen des Schullogos der Schule.
      Parameter:
      schema - das Datenbankschema, auf welches die Anfrage ausgeführt werden soll
      is - der JSON-String mit dem Schullogo als Base64-kodiertem String
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      das Schullogo als Base64-kodierter String

    • getSchulabschluesseAllgemeinbildend

      @GET @Path("/allgemein/schulabschluesse/allgemeinbildend") public jakarta.ws.rs.core.Response getSchulabschluesseAllgemeinbildend(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage des Kataloges für die allgemeinbildenden Schulabschlüsse.
      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 allgemeinbildenden Schulabschlüssen

    • getSchulabschluesseBerufsbildend

      @GET @Path("/allgemein/schulabschluesse/berufsbildend") public jakarta.ws.rs.core.Response getSchulabschluesseBerufsbildend(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage des Kataloges für die berufsbildenden Schulabschlüsse.
      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 berufsbildenden Schulabschlüssen

    • getSchulformen

      @GET @Path("/allgemein/schulformen") public jakarta.ws.rs.core.Response getSchulformen(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage des Kataloges für die Schulformen.
      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 Schulformen

    • getSchulgliederungen

      @GET @Path("/allgemein/schulgliederungen") public jakarta.ws.rs.core.Response getSchulgliederungen(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage des Kataloges für die Schulgliederungen.
      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 Schulgliederungen

    • getBerufskollegAnlagen

      @GET @Path("/allgemein/berufskolleg/anlagen") public jakarta.ws.rs.core.Response getBerufskollegAnlagen(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage des Kataloges für die Anlagen am Berufskolleg.
      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 Anlagen am Berufskolleg

    • getBerufskollegBerufsebenen

      @GET @Path("/allgemein/berufskolleg/berufsebenen") public jakarta.ws.rs.core.Response getBerufskollegBerufsebenen(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage des Kataloges für die Berufsebenen am Berufskolleg.
      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 Berufsebenen am Berufskolleg

    • getBerufskollegFachklassen

      @GET @Path("/allgemein/berufskolleg/fachklassen") public jakarta.ws.rs.core.Response getBerufskollegFachklassen(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage des Kataloges für die Fachklassen am Berufskolleg.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      der Katalog der Fachklassen am Berufskolleg

    • getPruefungsordnungen

      @GET @Path("/allgemein/pruefungsordnungen") public jakarta.ws.rs.core.Response getPruefungsordnungen(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage des Kataloges der Ausbildungs- und Prüfungsordnungen.
      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 Ausbildungs- und Prüfungsordnungen

    • getVerkehrssprachen

      @GET @Path("/allgemein/verkehrssprachen") public jakarta.ws.rs.core.Response getVerkehrssprachen(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage des Kataloges der Verkehrssprachen in einer Familie.
      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 Verkehrssprachen in einer Familie

    • getNationaelitaeten

      @GET @Path("/allgemein/nationalitaeten") public jakarta.ws.rs.core.Response getNationaelitaeten(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage der Liste der Nationalitäten im angegebenen Schema.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Liste der Nationalitäten mit ID des Datenbankschemas

    • getEinschulungsarten

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

    • getAllgemeineMerkmale

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

    • getFoerderschwerpunkte

      @GET @Path("/allgemein/foerderschwerpunkte") public jakarta.ws.rs.core.Response getFoerderschwerpunkte(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage des Kataloges für die Förderschwerpunkte.
      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 Förderschwerpunkte

    • getSchuelerFoerderschwerpunkte

      @GET @Path("/foerderschwerpunkte") public jakarta.ws.rs.core.Response getSchuelerFoerderschwerpunkte(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage des Kataloges für die Förderschwerpunkte.
      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 Förderschwerpunkte

    • getSchuelerFoerderschwerpunkt

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

    • getKatalogReligionen

      @GET @Path("/allgemein/religionen") public jakarta.ws.rs.core.Response getKatalogReligionen(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage des Kataloges für die Relgionen bzw. Konfessionen, welche im Rahmen der amtlichen Schulstatistik verwendet werden.
      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 Relgionen bzw. Konfessionen

    • getReligion

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

    • createReligion

      @POST @Path("/religionen/new") public jakarta.ws.rs.core.Response createReligion(@PathParam("schema") String schema, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Erstellen einer neuen Religion.
      Parameter:
      schema - das Datenbankschema, in welchem die Religion erstellt wird
      is - das JSON-Objekt
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die HTTP-Antwort mit der neuen Religion

    • patchReligion

      @PATCH @Path("/religionen/{id : \\d+}") public jakarta.ws.rs.core.Response patchReligion(@PathParam("schema") String schema, @PathParam("id") long id, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Patchen einer Betriebsart im angegebenen Schema
      Parameter:
      schema - das Datenbankschema, auf welches der Patch ausgeführt werden soll
      id - die Datenbank-ID zur Identifikation der Religion
      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

    • getReligionen

      @GET @Path("/religionen") public jakarta.ws.rs.core.Response getReligionen(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage des schulspezifischen Kataloges für die Religionen bzw. Konfessionen.
      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 Religionen bzw. Konfessionen

    • deleteReligionEintrag

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

    • deleteReligionEintraege

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

    • getVermerkarten

      @GET @Path("/vermerkarten") public jakarta.ws.rs.core.Response getVermerkarten(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage des schulspezifischen Kataloges für die Vermerkarten.
      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 Vermerkarten

    • getSchuelerByVermerkartID

      @GET @Path("/vermerkart/{vermerkart : \\d+}/schuelerinfos") public jakarta.ws.rs.core.Response getSchuelerByVermerkartID(@PathParam("schema") String schema, @PathParam("vermerkart") long vermerkart, @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
      vermerkart - 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

    • getVermerkart

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

    • createVermerkart

      @POST @Path("/vermerkarten/new") public jakarta.ws.rs.core.Response createVermerkart(@PathParam("schema") String schema, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Erstellen einer neuen Vermerkart.
      Parameter:
      schema - das Datenbankschema, in welchem die Vermerkart erstellt wird
      is - das JSON-Objekt
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die HTTP-Antwort mit der neuen Vermerkart

    • patchVermerkart

      @PATCH @Path("/vermerkarten/{id : \\d+}") public jakarta.ws.rs.core.Response patchVermerkart(@PathParam("schema") String schema, @PathParam("id") long id, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Patchen einer Vermerkart im angegebenen Schema
      Parameter:
      schema - das Datenbankschema, auf welches der Patch ausgeführt werden soll
      id - die Datenbank-ID zur Identifikation der Vermerkart
      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

    • deleteVermerkartEintrag

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

    • deleteVermerkartEintraege

      @DELETE @Path("/vermerkarten/delete/multiple") public jakarta.ws.rs.core.Response deleteVermerkartEintraege(@PathParam("schema") String schema, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Entfernen mehrerer Vermerkart-Katalog-Einträge der Schule.
      Parameter:
      schema - das Datenbankschema
      is - die IDs der Vermerkart-Katalog-Einträge
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die HTTP-Antwort mit dem Status der Lösch-Operationen

    • getEinwilligungsarten

      @GET @Path("/einwilligungsarten") public jakarta.ws.rs.core.Response getEinwilligungsarten(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage des schulspezifischen Kataloges für die Einwilligungsarten.
      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 Einwilligungsarten

    • getEinwilligungsart

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

    • createEinwilligungsart

      @POST @Path("/einwilligungsarten/new") public jakarta.ws.rs.core.Response createEinwilligungsart(@PathParam("schema") String schema, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Erstellen einer neuen Einwilligungsart.
      Parameter:
      schema - das Datenbankschema, in welchem die Einwilligungsart erstellt wird
      is - das JSON-Objekt
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die HTTP-Antwort mit der neuen Einwilligungsart

    • patchEinwilligungsart

      @PATCH @Path("/einwilligungsarten/{id : \\d+}") public jakarta.ws.rs.core.Response patchEinwilligungsart(@PathParam("schema") String schema, @PathParam("id") long id, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Patchen einer Einwilligungsart im angegebenen Schema
      Parameter:
      schema - das Datenbankschema, auf welches der Patch ausgeführt werden soll
      id - die Datenbank-ID zur Identifikation der Einwilligungsart
      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

    • deleteEinwilligungsart

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

    • deleteEinwilligungsarten

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

    • getKatalogAbgangsartenAllgemeinbildend

      @GET @Path("/allgemein/abgangsarten/allgemeinbildend") public jakarta.ws.rs.core.Response getKatalogAbgangsartenAllgemeinbildend(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage des Kataloges der Abgangsarten für allgemeinbildende Schulformen, welche im Rahmen der amtlichen Schulstatistik zulässig sind.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      der Katalog der Abgangsarten für allgemeinbildende Schulformen

    • getKatalogAbgangsartenBerufsbildend

      @GET @Path("/allgemein/abgangsarten/berufsbildend") public jakarta.ws.rs.core.Response getKatalogAbgangsartenBerufsbildend(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage des Kataloges der Abgangsarten für berufsbildende Schulformen, welche im Rahmen der amtlichen Schulstatistik zulässig sind.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      der Katalog der Abgangsarten für berufsbildende Schulformen

    • getKatalogOrganisationsformen

      @GET @Path("/allgemein/organisationsformen") public jakarta.ws.rs.core.Response getKatalogOrganisationsformen(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage des Katalogs der gültigen Organisationsformen.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      der Katalog der gültigen Organisationsformen

    • getKatalogSchulen

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

    • getKatalogSchultraeger

      @GET @Path("/allgemein/schultraeger") public jakarta.ws.rs.core.Response getKatalogSchultraeger(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage des Schulträger-Kataloges.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Liste der Schulträger

    • getKatalogSchuelerStatus

      @GET @Path("/schueler/status") public jakarta.ws.rs.core.Response getKatalogSchuelerStatus(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage des Kataloges Schüler-Status.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      der Katalog

    • getKatalogHerkunftsschulnummern

      @GET @Path("/allgemein/herkunftsschulnummern") public jakarta.ws.rs.core.Response getKatalogHerkunftsschulnummern(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage des Kataloges der zusätzlichen Herkunftsschulnummern
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      der Katalog

    • getKatalogReformpaedagogikAlle

      @GET @Path("/allgemein/reformpaedagogik/alle") public jakarta.ws.rs.core.Response getKatalogReformpaedagogikAlle(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage des Reformpädagogik-Kataloges aller Schulformen.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      der Reformpädagogik-Katalog aller Schulformen

    • getKatalogReformpaedagogik

      @GET @Path("/allgemein/reformpaedagogik") public jakarta.ws.rs.core.Response getKatalogReformpaedagogik(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage des Reformpädagogik-Kataloges für die Schulform dieser Schule.
      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 Einträgen des Reformpädagogik-Kataloges für die Schulform dieser Schule

    • getKatalogReformpaedagogikEintrag

      @GET @Path("/allgemein/reformpaedagogik/{id : \\d+}") public jakarta.ws.rs.core.Response getKatalogReformpaedagogikEintrag(@PathParam("schema") String schema, @PathParam("id") long id, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage des Reformpädagogik-Katalog-Eintrags für die angegebene ID.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      id - die ID des Reformpädagogik-Katalog-Eintrags
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      der Reformpädagogik-Katalog-Eintrag

    • getKatalogKindergartenbesuchsdauer

      @GET @Path("/allgemein/kindergartenbesuch") public jakarta.ws.rs.core.Response getKatalogKindergartenbesuchsdauer(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage des Kataloges für Dauer des Kindergartenbesuchs.
      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 für die Dauer des Kindergartenbesuchs

    • getKatalogNoten

      @GET @Path("/allgemein/noten") public jakarta.ws.rs.core.Response getKatalogNoten(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage der Kataloges der Noten.
      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 Einträgen des Noten-Kataloges

    • getRaeume

      @GET @Path("/raeume") public jakarta.ws.rs.core.Response getRaeume(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage der Kataloges der Räume der Schule.
      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 Einträgen des Raum-Kataloges

    • getRaum

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

    • patchRaum

      @PATCH @Path("/raeume/{id : \\d+}") public jakarta.ws.rs.core.Response patchRaum(@PathParam("schema") String schema, @PathParam("id") long id, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Patchen eines Raumes der Schule.
      Parameter:
      schema - das Datenbankschema, auf welches der Patch ausgeführt werden soll
      id - die Datenbank-ID zur Identifikation des Raumes
      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

    • addRaum

      @POST @Path("/raeume/create") public jakarta.ws.rs.core.Response addRaum(@PathParam("schema") String schema, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Hinzufügen eines neuen Raumes zu der Schule.
      Parameter:
      schema - das Datenbankschema
      is - der Input-Stream mit den Daten des Raums
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die HTTP-Antwort mit dem neuen Raum

    • addRaeume

      @POST @Path("/raeume/create/multiple") public jakarta.ws.rs.core.Response addRaeume(@PathParam("schema") String schema, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Hinzufügen mehrerer neuer Räume zu der Schule.
      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 den neuen Räumen

    • deleteRaum

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

    • deleteRaeume

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

    • getAufsichtsbereiche

      @GET @Path("/aufsichtsbereiche") public jakarta.ws.rs.core.Response getAufsichtsbereiche(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage der Kataloges der Aufsichtsbereiche der Schule.
      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 Einträgen des Aufsichtsbereichs-Kataloges

    • getAufsichtsbereich

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

    • patchAufsichtsbereich

      @PATCH @Path("/aufsichtsbereiche/{id : \\d+}") public jakarta.ws.rs.core.Response patchAufsichtsbereich(@PathParam("schema") String schema, @PathParam("id") long id, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Patchen eines Aufsichtsbereichs der Schule.
      Parameter:
      schema - das Datenbankschema, auf welches der Patch ausgeführt werden soll
      id - die Datenbank-ID zur Identifikation des Aufsichtsbereichs
      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

    • addAufsichtsbereich

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

    • addAufsichtsbereiche

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

    • deleteAufsichtsbereich

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

    • deleteAufsichtsbereiche

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

    • getPausenzeiten

      @GET @Path("/pausenzeiten") public jakarta.ws.rs.core.Response getPausenzeiten(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage des Kataloges der Pausenzeiten der Schule.
      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 Einträgen des Pausenzeiten-Kataloges

    • getPausenzeit

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

    • patchPausenzeit

      @PATCH @Path("/pausenzeiten/{id : \\d+}") public jakarta.ws.rs.core.Response patchPausenzeit(@PathParam("schema") String schema, @PathParam("id") long id, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Patchen einer Pausenzeit der Schule.
      Parameter:
      schema - das Datenbankschema, auf welches der Patch ausgeführt werden soll
      id - die Datenbank-ID zur Identifikation der Pausenzeit
      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

    • addPausenzeit

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

    • addPausenzeiten

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

    • deletePausenzeit

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

    • deletePausenzeiten

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

    • getZeitraster

      @GET @Path("/zeitraster") public jakarta.ws.rs.core.Response getZeitraster(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage des Zeitraster-Kataloges der Schule.
      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 Einträgen des Zeitraster-Kataloges

    • getZeitrasterEintrag

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

    • patchZeitrasterEintrag

      @PATCH @Path("/zeitraster/{id : \\d+}") public jakarta.ws.rs.core.Response patchZeitrasterEintrag(@PathParam("schema") String schema, @PathParam("id") long id, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Patchen eines Zeitraster-Eintrags der Schule.
      Parameter:
      schema - das Datenbankschema, auf welches der Patch ausgeführt werden soll
      id - die Datenbank-ID zur Identifikation des Zeitraster-Eintrags
      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

    • patchZeitrasterEintraege

      @PATCH @Path("/zeitraster/patch/multiple") public jakarta.ws.rs.core.Response patchZeitrasterEintraege(@PathParam("schema") String schema, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Patchen mehrerer Zeitraster-Einträge. Die IDs in dem Patch müssen vorhanden sein, damit die zu patchenden Daten in der DB gefunden werden können.
      Parameter:
      schema - das Datenbankschema, auf welches der Patch ausgeführt werden soll
      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

    • addZeitrasterEintrag

      @POST @Path("/zeitraster/create") public jakarta.ws.rs.core.Response addZeitrasterEintrag(@PathParam("schema") String schema, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Hinzufügen eines neuen Zeitraster-Eintrags zu der Schule.
      Parameter:
      schema - das Datenbankschema
      is - der Input-Stream mit den Daten des Zeitraster-Eintrags
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die HTTP-Antwort mit dem neuen Zeitraster-Eintrag

    • addZeitrasterEintraege

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

    • deleteZeitrasterEintrag

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

    • deleteZeitrasterEintraege

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

    • getSchulen

      @GET @Path("/schulen") public jakarta.ws.rs.core.Response getSchulen(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage des schulspezifischen Kataloges für die Schulen.
      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 Schulen

    • getSchulenMitKuerzel

      @GET @Path("/schulen/kuerzel") public jakarta.ws.rs.core.Response getSchulenMitKuerzel(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage des schulspezifischen Kataloges für die Schulen, welche ein Kürzel gesetzt haben.
      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 Schulen, welche ein Kürzel gesetzt haben

    • getSchuleAusKatalog

      @GET @Path("/schulen/{id : \\d+}") public jakarta.ws.rs.core.Response getSchuleAusKatalog(@PathParam("schema") String schema, @PathParam("id") long id, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage eines Eintrags des schulspezifischen Kataloges für die Schulen.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      id - die ID des Eintrags
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Pausenzeit der Schule

    • patchSchuleAusKatalog

      @PATCH @Path("/schulen/{id : \\d+}") public jakarta.ws.rs.core.Response patchSchuleAusKatalog(@PathParam("schema") String schema, @PathParam("id") long id, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Patchen eines Eintrags des schulspezifischen Kataloges.
      Parameter:
      schema - das Datenbankschema, auf welches der Patch ausgeführt werden soll
      id - die Datenbank-ID zur Identifikation des Eintrags
      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

    • addSchuleZuKatalog

      @POST @Path("/schulen/create") public jakarta.ws.rs.core.Response addSchuleZuKatalog(@PathParam("schema") String schema, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Hinzufügen eines Eintrags zum schulspezifischen Katalog der Schulen.
      Parameter:
      schema - das Datenbankschema
      is - der Input-Stream mit den Daten des Eintrags
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die HTTP-Antwort mit dem neuen Eintrag

    • deleteSchuleVonKatalog

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

    • deleteSchulenVonKatalog

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

    • getSchulleitungsfunktionen

      @GET @Path("/leitungsfunktion/alle") public jakarta.ws.rs.core.Response getSchulleitungsfunktionen(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage aller Leitungsfunktionen der Schule.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Leitungsfunktionen der Schule

    • getSchulleitungsfunktion

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

    • patchSchulleitungsfunktion

      @PATCH @Path("/leitungsfunktion/{id : \\d+}") public jakarta.ws.rs.core.Response patchSchulleitungsfunktion(@PathParam("schema") String schema, @PathParam("id") long id, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Patchen einer Leitungsfunktion der Schule.
      Parameter:
      schema - das Datenbankschema, auf welches der Patch ausgeführt werden soll
      id - die Datenbank-ID zur Identifikation der Leitungsfunktion der Schule
      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

    • addSchulleitungsfunktion

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

    • addSchulleitungsfunktionen

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

    • deleteSchulleitungsfunktion

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

    • deleteSchulleitungsfunktionen

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