Package de.svws_nrw.api.server

Klasse APIAbteilungen

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

  • Konstruktorübersicht

    Konstruktoren
    Konstruktor
    Beschreibung
    APIAbteilungen()
    Leerer Standardkonstruktor.

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    jakarta.ws.rs.core.Response
    addAbteilung(String schema, long idSchuljahresabschnitt, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Hinzufügen einer Abteilung.
    jakarta.ws.rs.core.Response
    addAbteilungKlassenzuordnung(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Hinzufügen einer Abteilung.
    jakarta.ws.rs.core.Response
    deleteAbteilung(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Entfernen der Abteilung.
    jakarta.ws.rs.core.Response
    deleteAbteilungen(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Entfernen der Abteilung.
    jakarta.ws.rs.core.Response
    deleteAbteilungKlassenzuordnung(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Entfernen von AbteilungKlassenzuordnungen.
    jakarta.ws.rs.core.Response
    getAbteilungenByIdJahresAbschnitt(String schema, long idSchuljahresabschnitt, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Liste der Abteilungen für die Id des Jahresabschnittes im angegebenen Schema.
    jakarta.ws.rs.core.Response
    patchAbteilung(String schema, long id, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Patchen einer Abteilung.

    Von Klasse geerbte Methoden java.lang.Object

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

  • Konstruktordetails

    • APIAbteilungen

      public APIAbteilungen()
      Leerer Standardkonstruktor.

  • Methodendetails

    • getAbteilungenByIdJahresAbschnitt

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

    • addAbteilung

      @POST @Path("/{idSchuljahresabschnitt : \\d+}") public jakarta.ws.rs.core.Response addAbteilung(@PathParam("schema") String schema, @PathParam("idSchuljahresabschnitt") long idSchuljahresabschnitt, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Hinzufügen einer Abteilung.
      Parameter:
      schema - das Datenbankschema, auf welches der Create ausgeführt werden soll
      idSchuljahresabschnitt - die Id des Schuljahresabschnitts für die Abteilung
      is - der Input-Stream mit den Daten der Abteilung
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die HTTP-Antwort mit der neuen Abteilung

    • patchAbteilung

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

    • deleteAbteilungen

      @DELETE @Path("/delete/multiple") public jakarta.ws.rs.core.Response deleteAbteilungen(@PathParam("schema") String schema, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Entfernen der Abteilung.
      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 und ggf. der gelöschten Abteilung

    • deleteAbteilung

      @DELETE @Path("/{id : \\d+}") public jakarta.ws.rs.core.Response deleteAbteilung(@PathParam("schema") String schema, @PathParam("id") long id, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Entfernen der Abteilung.
      Parameter:
      schema - das Datenbankschema
      id - 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 und ggf. der gelöschten Abteilung

    • addAbteilungKlassenzuordnung

      @POST @Path("/klassenzuordnung") public jakarta.ws.rs.core.Response addAbteilungKlassenzuordnung(@PathParam("schema") String schema, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Hinzufügen einer Abteilung.
      Parameter:
      schema - das Datenbankschema, auf welches der Create ausgeführt werden soll
      is - der Input-Stream mit den Daten der Abteilung
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die HTTP-Antwort mit der neuen Abteilung

    • deleteAbteilungKlassenzuordnung

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