Package de.svws_nrw.api.server

Klasse APIKlassen

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

  • Konstruktorübersicht

    Konstruktoren
    Konstruktor
    Beschreibung
    APIKlassen()
    Leerer Standardkonstruktor.

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    jakarta.ws.rs.core.Response
    addKlasse(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Erstellen einer neuen Klasse mit den angegebenen Klassendaten.
    jakarta.ws.rs.core.Response
    deleteKlasse(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Entfernen einer Klasse.
    jakarta.ws.rs.core.Response
    deleteKlassen(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Entfernen mehrerer Klassen.
    jakarta.ws.rs.core.Response
    getKatalogKlassenarten(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Katalogs der gültigen Klassenarten.
    jakarta.ws.rs.core.Response
    getKlasse(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Daten einer Klasse.
    jakarta.ws.rs.core.Response
    getKlassenFuerAbschnitt(String schema, long abschnitt, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Liste der Klassen im angegebenen Schema.
    jakarta.ws.rs.core.Response
    patchKlasse(String schema, long id, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die API-Methode für das Patchen einer Klasse.
    jakarta.ws.rs.core.Response
    setKlassenSortierungFuerAbschnitt(String schema, long abschnitt, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Setzen einer Default-Sortierung bei der Liste der Klassen im angegebenen Schema.

    Von Klasse geerbte Methoden java.lang.Object

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

  • Konstruktordetails

    • APIKlassen

      public APIKlassen()
      Leerer Standardkonstruktor.

  • Methodendetails

    • getKlassenFuerAbschnitt

      @GET @Path("/abschnitt/{abschnitt : \\d+}") public jakarta.ws.rs.core.Response getKlassenFuerAbschnitt(@PathParam("schema") String schema, @PathParam("abschnitt") long abschnitt, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage der Liste der Klassen 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 Klassen mit ID des Datenbankschemas

    • getKlasse

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

    • patchKlasse

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

    • addKlasse

      @POST @Path("/create") public jakarta.ws.rs.core.Response addKlasse(@PathParam("schema") String schema, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Erstellen einer neuen Klasse mit den angegebenen Klassendaten.
      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 der Klasse

    • deleteKlasse

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

    • deleteKlassen

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

    • getKatalogKlassenarten

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

    • setKlassenSortierungFuerAbschnitt

      @POST @Path("/abschnitt/{abschnitt : \\d+}/sortierung/setdefault") public jakarta.ws.rs.core.Response setKlassenSortierungFuerAbschnitt(@PathParam("schema") String schema, @PathParam("abschnitt") long abschnitt, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Setzen einer Default-Sortierung bei der Liste der Klassen 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 HTTP-Response