Package de.svws_nrw.api.server

Klasse APIJahrgaenge

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

  • Konstruktorübersicht

    Konstruktoren
    Konstruktor
    Beschreibung
    APIJahrgaenge()
    Leerer Standardkonstruktor.

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    jakarta.ws.rs.core.Response
    addJahrgang(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Hinzufügen eines neuen Jahrgangs.
    jakarta.ws.rs.core.Response
    deleteJahrgaenge(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Entfernen mehrerer Jahrgänge.
    jakarta.ws.rs.core.Response
    deleteJahrgang(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Entfernen eines Jahrgangs.
    jakarta.ws.rs.core.Response
    getJahrgaenge(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Liste der Jahrgänge im angegebenen Schema.
    jakarta.ws.rs.core.Response
    getJahrgang(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Daten eines Jahrgangs.
    jakarta.ws.rs.core.Response
    getKatalogJahrgaenge(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Katalogs der in den einzelnen Schulformen gültigen Jahrgänge.
    jakarta.ws.rs.core.Response
    patchJahrgang(String schema, long id, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Patchen eines Jahrgangs.

    Von Klasse geerbte Methoden java.lang.Object

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

  • Konstruktordetails

    • APIJahrgaenge

      public APIJahrgaenge()
      Leerer Standardkonstruktor.

  • Methodendetails

    • getJahrgaenge

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

    • getJahrgang

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

    • getKatalogJahrgaenge

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

    • patchJahrgang

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

    • addJahrgang

      @POST @Path("/create") public jakarta.ws.rs.core.Response addJahrgang(@PathParam("schema") String schema, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Hinzufügen eines neuen Jahrgangs.
      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

    • deleteJahrgang

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

    • deleteJahrgaenge

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