Package de.svws_nrw.api.server

Klasse APIENM

java.lang.Object
de.svws_nrw.api.server.APIENM
@Path("/db/{schema}/enm") @Produces("application/json") @Consumes("application/json") public class APIENM extends Object
Die Klasse spezifiziert die OpenAPI-Schnittstelle für die Arbeit mit den grundlegenden Daten des Externen Notenmoduls (ENM). Ein Zugriff erfolgt über den Pfad https://{Hostname}/db/{schema}/enm/...

  • Konstruktorübersicht

    Konstruktoren
    Konstruktor
    Beschreibung
    APIENM()
    Leerer Standardkonstruktor.

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    jakarta.ws.rs.core.Response
    downloadENMDaten(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für den Upload von Daten an das Externe Datenmodul (ENM) in Bezug auf alle Lehrer.
    jakarta.ws.rs.core.Response
    generateENMLehrerCredentials(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode zum Generieren von Initial-Kennwörtern für Lehrer für das externe Notenmodul, sofern diese noch keine haben.
    jakarta.ws.rs.core.Response
    getENMDaten(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Daten für das Externe Datenmodul (ENM) in Bezug auf alle Lehrer des aktuellen Schuljahresabschnitts der Schule.
    jakarta.ws.rs.core.Response
    getENMDatenGZip(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Daten für das Externe Datenmodul (ENM) in Bezug auf alle Lehrer des aktuellen Schuljahresabschnitts der Schule als GZIP-Json.
    jakarta.ws.rs.core.Response
    getENMDatenLeer(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage einer leeren Datendatei für das Externe Datenmodul (ENM).
    jakarta.ws.rs.core.Response
    getLehrerENMDaten(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Daten für das Externe Datenmodul (ENM) in Bezug auf einen Lehrer.
    jakarta.ws.rs.core.Response
    importENMDaten(String schema, ENMDaten enmDaten, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode zum Importieren von ENM-Daten in die SVWS-Datenbank.
    jakarta.ws.rs.core.Response
    importENMDatenGZip(String schema, SimpleBinaryMultipartBody multipart, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode zum Importieren von ENM-Daten in die SVWS-Datenbank.
    jakarta.ws.rs.core.Response
    resetENMLehrerPasswordToInitial(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode zum Zurücksetzen eines Kennwortes für Lehrer für das externe Notenmodul.
    jakarta.ws.rs.core.Response
    setENMLehrerPassword(String schema, long id, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode zum Setzen eines Kennwortes für Lehrer für das externe Notenmodul.
    jakarta.ws.rs.core.Response
    synchronizeENMDaten(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Synchronisation der Daten für das Externe Datenmodul (ENM) in Bezug auf alle Lehrer.
    jakarta.ws.rs.core.Response
    truncateENMServer(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für den Upload von Daten an das Externe Datenmodul (ENM) in Bezug auf alle Lehrer.
    jakarta.ws.rs.core.Response
    uploadENMDaten(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für den Upload von Daten an das Externe Datenmodul (ENM) in Bezug auf alle Lehrer.

    Von Klasse geerbte Methoden java.lang.Object

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

  • Konstruktordetails

    • APIENM

      public APIENM()
      Leerer Standardkonstruktor.

  • Methodendetails

    • getENMDatenLeer

      @GET @Path("/empty") public jakarta.ws.rs.core.Response getENMDatenLeer(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage einer leeren Datendatei für das Externe Datenmodul (ENM).
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die leeren ENM-Daten

    • getENMDaten

      @GET @Path("/alle") public jakarta.ws.rs.core.Response getENMDaten(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage der Daten für das Externe Datenmodul (ENM) in Bezug auf alle Lehrer des aktuellen Schuljahresabschnitts der Schule.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die ENM-Daten

    • getENMDatenGZip

      @GET @Produces("application/octet-stream") @Path("/alle/gzip") public jakarta.ws.rs.core.Response getENMDatenGZip(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage der Daten für das Externe Datenmodul (ENM) in Bezug auf alle Lehrer des aktuellen Schuljahresabschnitts der Schule als GZIP-Json.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die ENM-Daten

    • getLehrerENMDaten

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

    • generateENMLehrerCredentials

      @POST @Path("/credentials/generate") public jakarta.ws.rs.core.Response generateENMLehrerCredentials(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode zum Generieren von Initial-Kennwörtern für Lehrer für das externe Notenmodul, sofern diese noch keine haben.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die HTTP-Reponse

    • resetENMLehrerPasswordToInitial

      @POST @Path("/credentials/reset/{id : \\d+}") public jakarta.ws.rs.core.Response resetENMLehrerPasswordToInitial(@PathParam("schema") String schema, @PathParam("id") long id, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode zum Zurücksetzen eines Kennwortes für Lehrer für das externe Notenmodul. Hat der Lehrer noch kein Initialkennwort, so wird dieses neu erzeugt.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      id - die ID des Lehrers
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die HTTP-Reponse

    • setENMLehrerPassword

      @POST @Path("/credentials/set/{id : \\d+}") public jakarta.ws.rs.core.Response setENMLehrerPassword(@PathParam("schema") String schema, @PathParam("id") long id, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode zum Setzen eines Kennwortes für Lehrer für das externe Notenmodul. Hat der Lehrer noch kein Initialkennwort, so wird dieses zusätzlich neu erzeugt, allerdings das übergebene aktiviert.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      id - die ID des Lehrers
      is - der Input-Stream mit dem zu setzenden Kennwort
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die HTTP-Reponse

    • importENMDaten

      @POST @Path("/import") public jakarta.ws.rs.core.Response importENMDaten(@PathParam("schema") String schema, ENMDaten enmDaten, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode zum Importieren von ENM-Daten in die SVWS-Datenbank. Dabei wird die Aktualität der zu importierenden Daten anhand der Zeitstempel in den ENM-Daten geprüft.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      enmDaten - die ENM-Daten
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die HTTP-Reponse

    • importENMDatenGZip

      @POST @Consumes("multipart/form-data") @Path("/import/gzip") public jakarta.ws.rs.core.Response importENMDatenGZip(@PathParam("schema") String schema, SimpleBinaryMultipartBody multipart, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode zum Importieren von ENM-Daten in die SVWS-Datenbank. Dabei wird die Aktualität der zu importierenden Daten anhand der Zeitstempel in den ENM-Daten geprüft.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      multipart - enthält die ENM-Daten
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die HTTP-Reponse

    • synchronizeENMDaten

      @GET @Path("/synchronize") public jakarta.ws.rs.core.Response synchronizeENMDaten(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Synchronisation der Daten für das Externe Datenmodul (ENM) in Bezug auf alle Lehrer.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      Die HTTP-Response

    • uploadENMDaten

      @GET @Path("/upload") public jakarta.ws.rs.core.Response uploadENMDaten(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für den Upload von Daten an das Externe Datenmodul (ENM) in Bezug auf alle Lehrer.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      Die HTTP-Response

    • downloadENMDaten

      @GET @Path("/download") public jakarta.ws.rs.core.Response downloadENMDaten(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für den Upload von Daten an das Externe Datenmodul (ENM) in Bezug auf alle Lehrer.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      true, wenn der Datenimport erfolgreich war

    • truncateENMServer

      @GET @Path("/truncate") public jakarta.ws.rs.core.Response truncateENMServer(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für den Upload von Daten an das Externe Datenmodul (ENM) in Bezug auf alle Lehrer.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      eine Response mit Boolean True, wenn das Truncate erfolgreich war