Package de.svws_nrw.api.server

Klasse APIKurse

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

  • Konstruktorübersicht

    Konstruktoren
    Konstruktor
    Beschreibung
    APIKurse()
    Leerer Standardkonstruktor.

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    jakarta.ws.rs.core.Response
    addKurs(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Erstellen eines neuen Kurses mit den angegebenen Kursdaten.
    jakarta.ws.rs.core.Response
    deleteKurs(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Entfernen eines Kurses.
    jakarta.ws.rs.core.Response
    getKatalogKursarten(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Katalogs der gültigen Kursarten.
    jakarta.ws.rs.core.Response
    getKurs(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Daten eines Kurses.
    jakarta.ws.rs.core.Response
    getKurse(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Liste der Kurse aller Schuljahresabschniite im angegebenen Schema.
    jakarta.ws.rs.core.Response
    getKurseFuerAbschnitt(String schema, long abschnitt, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Liste der Kurse im angegebenen Schema.
    jakarta.ws.rs.core.Response
    patchKurs(String schema, long id, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Patchen eines Kurses.

    Von Klasse geerbte Methoden java.lang.Object

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

  • Konstruktordetails

    • APIKurse

      public APIKurse()
      Leerer Standardkonstruktor.

  • Methodendetails

    • getKurse

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

    • getKurseFuerAbschnitt

      @GET @Path("/abschnitt/{abschnitt : \\d+}") public jakarta.ws.rs.core.Response getKurseFuerAbschnitt(@PathParam("schema") String schema, @PathParam("abschnitt") long abschnitt, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage der Liste der Kurse im angegebenen Schema.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      abschnitt - die ID des Schuljahresabschnitts
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Liste der Kurse mit der jeweiligen ID im Datenbankschema

    • getKurs

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

    • patchKurs

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

    • addKurs

      @POST @Path("/create") public jakarta.ws.rs.core.Response addKurs(@PathParam("schema") String schema, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Erstellen eines neuen Kurses mit den angegebenen Kursdaten.
      Parameter:
      schema - das Datenbankschema
      is - der InputStream, mit dem JSON-Patch-Objekt nach RFC 7386
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die HTTP-Antwort mit den Daten des Kurses

    • deleteKurs

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

    • getKatalogKursarten

      @GET @Path("/allgemein/kursarten") public jakarta.ws.rs.core.Response getKatalogKursarten(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage des Katalogs der gültigen Kursarten.
      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 Kursarten