Package de.svws_nrw.api.server

Klasse APIGostDatenaustausch

java.lang.Object
de.svws_nrw.api.server.APIGostDatenaustausch
@Path("/db/{schema}/gost") @Produces("application/json") @Consumes("application/json") public class APIGostDatenaustausch extends Object
Die Klasse spezifiziert die OpenAPI-Schnittstelle für den Import-/Export von Laufbahnplanungsdaten aus der SVWS-Datenbank in Bezug auf die gymnasiale Oberstufe für das Program LuPO. Ein Zugriff erfolgt über den Pfad https://{Hostname}/db/{schema}/gost/lupo...

  • Konstruktordetails

    • APIGostDatenaustausch

      public APIGostDatenaustausch()
      Leerer Standardkonstruktor.

  • Methodendetails

    • setGostLupoImportMDBFuerJahrgang

      @POST @Consumes("multipart/form-data") @Path("/lupo/import/mdb/jahrgang/replace/{mode}") public jakarta.ws.rs.core.Response setGostLupoImportMDBFuerJahrgang(@PathParam("schema") String schemaname, @PathParam("mode") String mode, SimpleBinaryMultipartBody multipart, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für den Import einer LuPO-MDB-Datenbank in ein Schema mit dem angegebenen Namen.
      Parameter:
      schemaname - Name des Schemas, in welches die LuPO-Daten importiert werden sollen
      mode - der Modus, wie vorhandene Daten ersetzt werden sollen (node, schueler oder all)
      multipart - LuPO-MDB-Datenbank im Binärformat
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      Rückmeldung, ob die Operation erfolgreich war mit dem Log der Operation

    • getGostLupoExportMDBFuerJahrgang

      @GET @Produces("application/octet-stream") @Path("/lupo/export/mdb/jahrgang/{jahrgang}") public jakarta.ws.rs.core.Response getGostLupoExportMDBFuerJahrgang(@PathParam("schema") String schemaname, @PathParam("jahrgang") String jahrgang, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für den Export einer einer LuPO-MDB-Datenbank aus dem aktuellen Schema.
      Parameter:
      schemaname - Name des Schemas, in das hinein migriert werden soll
      jahrgang - der Jahrgang, für den die LuPO-Datei erzeugt werden soll.
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die LUPO-Datei im Erfolgsfall

    • importKurs42Blockung

      @POST @Consumes("multipart/form-data") @Path("/kurs42/import/zip") public jakarta.ws.rs.core.Response importKurs42Blockung(@PathParam("schema") String schemaname, SimpleBinaryMultipartBody multipart, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für den Import einer Kurs42-Blockung, deren Daten in einer ZIP-Datei vorliegen.
      Parameter:
      schemaname - Name des Schemas, in welches die Kurs 42-Blockung importiert werden sollen
      multipart - Die Kurs42-Blockung in einer ZIP-Datei
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      Rückmeldung, ob die Operation erfolgreich war mit dem Log der Operation

    • importKurs42Raeume

      @POST @Consumes("multipart/form-data") @Path("/kurs42/import/raeume") public jakarta.ws.rs.core.Response importKurs42Raeume(@PathParam("schema") String schemaname, SimpleBinaryMultipartBody multipart, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für den Import des Raum-Katalogs aus Kurs42.
      Parameter:
      schemaname - Name des Schemas, in welches die Räume importiert werden sollen
      multipart - Die Kurs42-Raumdatei (CSV)
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      Rückmeldung, ob die Operation erfolgreich war mit dem Log der Operation

    • importStundenplanUntisGPU001

      @POST @Consumes("multipart/form-data") @Path("/untis/import/gpu001/{ingore_missing:[01]}") public jakarta.ws.rs.core.Response importStundenplanUntisGPU001(@PathParam("schema") String schemaname, @PathParam("ingore_missing") int ignoreMissing, UntisGPU001MultipartBody multipart, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für den Import eines einfachen Untis-Stundenplans, der im Untis-Format GPU001.txt vorliegt.
      Parameter:
      schemaname - Name des Schemas, in welches der Untis-Stundenplan importiert werden soll
      ignoreMissing - gibt an, ob fehlerhafte Unterrichtseinträge ignoriert werden ohne eine Abbruch der Operation zu Erzeugen
      multipart - Die GPU001.txt
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      Rückmeldung, ob die Operation erfolgreich war mit dem Log der Operation

    • importUntisRaeumeGPU005

      @POST @Consumes("multipart/form-data") @Path("/untis/import/gpu005") public jakarta.ws.rs.core.Response importUntisRaeumeGPU005(@PathParam("schema") String schemaname, SimpleBinaryMultipartBody multipart, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für den Import des Raum-Katalogs aus Untis (GPU005.txt).
      Parameter:
      schemaname - Name des Schemas, in welches die Räume importiert werden sollen
      multipart - Die Datei GPU005.txt aus Untis (CSV)
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      Rückmeldung, ob die Operation erfolgreich war mit dem Log der Operation

    • exportUntisKursblockungAsZip

      @POST @Produces("application/zip") @Path("/untis/export/blockung/{ergebnisid : \\d+}/zip/{unterrichtid : \\d+}") public jakarta.ws.rs.core.Response exportUntisKursblockungAsZip(@PathParam("schema") String schema, @PathParam("ergebnisid") long idErgebnis, @PathParam("unterrichtid") long idUnterricht, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für den Export eines Blockungsergebnisses für Untis. Dabei werden die GPU-Dateien GPU002.txt, GPU010.txt, GPU015.txt und GPU019.txt generiert und in einer ZIP-Datei gepackt.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      idErgebnis - die ID des Kursblockungsergebnisses, welches exportiert werden soll
      idUnterricht - die erste ID für den Unterricht, der für Untis generiert wird
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Zip-Datei mit dem Export