Package de.svws_nrw.api.server

Klasse APIFaecher

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

  • Konstruktorübersicht

    Konstruktoren
    Konstruktor
    Beschreibung
    APIFaecher()
    Leerer Standardkonstruktor.

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    jakarta.ws.rs.core.Response
    addFach(String schema, long id, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Hinzufügen eines neuen Faches.
    jakarta.ws.rs.core.Response
    deleteFach(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Entfernen des Faches.
    jakarta.ws.rs.core.Response
    getFach(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Daten eines Faches.
    jakarta.ws.rs.core.Response
    getFachgruppen(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Kataloges der Fachgruppen für die Schulform dieser Schule.
    jakarta.ws.rs.core.Response
    getFaecher(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Liste der Fächer im angegebenen Schema.
    jakarta.ws.rs.core.Response
    getKatalogBilingualeSprachen(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Kataloges der bilingualen Sprachen für die Schulform dieser Schule.
    jakarta.ws.rs.core.Response
    getKatalogBilingualeSprachenAlle(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Kataloges aller bilingualen Sprachen aller Schulformen.
    jakarta.ws.rs.core.Response
    getKatalogBilingualeSprachenEintrag(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Katalog-Eintrags einer bilingualen Sprache für die angegebene ID.
    jakarta.ws.rs.core.Response
    getKatalogFachgruppen(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Kataloges aller Fachgruppen aller Schulformen.
    jakarta.ws.rs.core.Response
    getKatalogFachgruppenEintrag(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage eines Fachgruppen-Katalog-Eintrags für die angegebene ID.
    jakarta.ws.rs.core.Response
    getKatalogFaecher(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Katalogs der zulässigen Fächer.
    jakarta.ws.rs.core.Response
    getKatalogSprachpruefungsniveaus(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Kataloges der Sprachprüfungsniveaus.
    jakarta.ws.rs.core.Response
    getKatalogSprachreferenzniveaus(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Kataloges der Sprachreferenzniveaus.
    jakarta.ws.rs.core.Response
    patchFach(String schema, long id, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Patchen eines Faches.
    jakarta.ws.rs.core.Response
    setFaecherSortierungSekII(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Setzen der Sortierung bei der Liste der Fächer im angegebenen Schema auf eine Standard-Sortierung für dei Sekundarstufe II.

    Von Klasse geerbte Methoden java.lang.Object

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

  • Konstruktordetails

    • APIFaecher

      public APIFaecher()
      Leerer Standardkonstruktor.

  • Methodendetails

    • getFaecher

      @GET @Path("/") public jakarta.ws.rs.core.Response getFaecher(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage der Liste der Fächer 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 Fächer mit ID des Datenbankschemas

    • getFach

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

    • patchFach

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

    • addFach

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

    • deleteFach

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

    • getKatalogFaecher

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

    • getKatalogFachgruppen

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

    • getFachgruppen

      @GET @Path("/fachgruppen") public jakarta.ws.rs.core.Response getFachgruppen(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage des Kataloges der Fachgruppen 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 Informationen zu den Fachgruppen für die Schulform dieser Schule

    • getKatalogFachgruppenEintrag

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

    • getKatalogBilingualeSprachenAlle

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

    • getKatalogBilingualeSprachen

      @GET @Path("/allgemein/sprachen/bilingual") public jakarta.ws.rs.core.Response getKatalogBilingualeSprachen(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage des Kataloges der bilingualen Sprachen 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 Informationen zu den bilingualen Sprachen für die Schulform dieser Schule

    • getKatalogBilingualeSprachenEintrag

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

    • getKatalogSprachpruefungsniveaus

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

    • getKatalogSprachreferenzniveaus

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

    • setFaecherSortierungSekII

      @POST @Path("/sortierung/setSekII") public jakarta.ws.rs.core.Response setFaecherSortierungSekII(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Setzen der Sortierung bei der Liste der Fächer im angegebenen Schema auf eine Standard-Sortierung für dei Sekundarstufe II. Für den Aufruf dieser API-Methode muss die Schulform eine Gymnasiale Oberstufe besitzen.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die HTTP-Response