Package de.svws_nrw.api.server

Klasse APIDatenaustausch

java.lang.Object
de.svws_nrw.api.server.APIDatenaustausch
@Path("/db/{schema}/datenaustausch") @Produces("application/json") @Consumes("application/json") public class APIDatenaustausch extends Object
Die Klasse spezifiziert die OpenAPI-Schnittstelle für den Import-/Export von Daten aus der SVWS-Datenbank.

  • Konstruktorübersicht

    Konstruktoren
    Konstruktor
    Beschreibung
    APIDatenaustausch()
    Leerer Standardkonstruktor.

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    jakarta.ws.rs.core.Response
    exportUntisBlockungGPU002GPU015GPU019(String schema, long id, LongAndStringLists params, int sidvariante, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für den Export von Blockungen zu den übergebenen Abiturjahrgängen in dem übergebenen Schuljahresabschnitt.
    jakarta.ws.rs.core.Response
    exportUntisFachwahlenGPU015(String schema, long id, int sidvariante, InputStream gpu002, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für den Export der Fachwahlen zu einem Schuljahresabschnitt für Untis.
    jakarta.ws.rs.core.Response
    exportUntisFaecherGPU006(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für den Export einer Fächer- bzw Kursliste zu einem Schuljahresabschnitt für Untis.
    jakarta.ws.rs.core.Response
    exportUntisKlassenGPU003(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für den Export einer Klassenliste zu einem Schuljahresabschnitt für Untis.
    jakarta.ws.rs.core.Response
    exportUntisKlausurenGPU017(String schema, long id, int sidvariante, InputStream gpu002, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für den Export einer Klausurplanung zu einem Schuljahresabschnitt für Untis.
    jakarta.ws.rs.core.Response
    exportUntisLehrerGPU004(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für den Export einer Lehrerliste zu einem Schuljahresabschnitt für Untis.
    jakarta.ws.rs.core.Response
    exportUntisSchienenGPU019(String schema, long id, InputStream gpu002, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für den Export der Schienenzuordnungen eines Schuljahresabschnittes für Untis.
    jakarta.ws.rs.core.Response
    exportUntisSchuelerGPU010(String schema, long id, int sidvariante, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für den Export einer Schülerliste zu einem Schuljahresabschnitt für Untis.
    jakarta.ws.rs.core.Response
    getGostLupoExportMDBFuerJahrgang(String schemaname, String jahrgang, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für den Export einer einer LuPO-MDB-Datenbank aus dem aktuellen Schema.
    jakarta.ws.rs.core.Response
    importKurs42Blockung(String schemaname, SimpleBinaryMultipartBody multipart, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für den Import einer Kurs42-Blockung, deren Daten in einer ZIP-Datei vorliegen.
    jakarta.ws.rs.core.Response
    importKurs42Raeume(String schemaname, SimpleBinaryMultipartBody multipart, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für den Import des Raum-Katalogs aus Kurs42.
    jakarta.ws.rs.core.Response
    importStundenplanUntisGPU001(String schemaname, int ignoreMissing, UntisGPU001MultipartBody multipart, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für den Import eines einfachen Untis-Stundenplans, der im Untis-Format GPU001.txt vorliegt.
    jakarta.ws.rs.core.Response
    importUntisRaeumeGPU005(String schemaname, SimpleBinaryMultipartBody multipart, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für den Import des Raum-Katalogs aus Untis (GPU005.txt).
    jakarta.ws.rs.core.Response
    setGostLupoImportMDBFuerJahrgang(String schemaname, String mode, SimpleBinaryMultipartBody multipart, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für den Import einer LuPO-MDB-Datenbank in ein Schema mit dem angegebenen Namen.

    Von Klasse geerbte Methoden java.lang.Object

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

  • Konstruktordetails

    • APIDatenaustausch

      public APIDatenaustausch()
      Leerer Standardkonstruktor.

  • Methodendetails

    • setGostLupoImportMDBFuerJahrgang

      @POST @Consumes("multipart/form-data") @Path("/gost/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("/gost/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("/gost/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("/gost/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

    • exportUntisKlassenGPU003

      @POST @Produces("application/octet-stream") @Path("/untis/export/klassen/{id : \\d+}") public jakarta.ws.rs.core.Response exportUntisKlassenGPU003(@PathParam("schema") String schema, @PathParam("id") long id, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für den Export einer Klassenliste zu einem Schuljahresabschnitt für Untis. Dabei wird die GPU-Datei GPU003.txt generiert.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      id - die ID des Schuljahresabschnittes, für den die Klassendaten exportiert werden sollen
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die GPU003-Datei

    • exportUntisLehrerGPU004

      @POST @Produces("application/octet-stream") @Path("/untis/export/lehrer/{id : \\d+}") public jakarta.ws.rs.core.Response exportUntisLehrerGPU004(@PathParam("schema") String schema, @PathParam("id") long id, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für den Export einer Lehrerliste zu einem Schuljahresabschnitt für Untis. Dabei wird die GPU-Datei GPU004.txt generiert.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      id - die ID des Schuljahresabschnittes, für den die Lehrerdaten exportiert werden sollen
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die GPU004-Datei

    • exportUntisFaecherGPU006

      @POST @Produces("application/octet-stream") @Path("/untis/export/faecher/{id : \\d+}") public jakarta.ws.rs.core.Response exportUntisFaecherGPU006(@PathParam("schema") String schema, @PathParam("id") long id, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für den Export einer Fächer- bzw Kursliste zu einem Schuljahresabschnitt für Untis. Dabei wird die GPU-Datei GPU006.txt generiert.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      id - die ID des Schuljahresabschnittes, für den die Daten exportiert werden sollen
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die GPU006-Datei

    • exportUntisSchuelerGPU010

      @POST @Produces("application/octet-stream") @Path("/untis/export/schueler/{id : \\d+}/{sidvariante : \\d+}") public jakarta.ws.rs.core.Response exportUntisSchuelerGPU010(@PathParam("schema") String schema, @PathParam("id") long id, @PathParam("sidvariante") int sidvariante, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für den Export einer Schülerliste zu einem Schuljahresabschnitt für Untis. Dabei wird die GPU-Datei GPU010.txt generiert.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      id - die ID des Schuljahresabschnittes, für den die Schülerdaten exportiert werden sollen
      sidvariante - die Variante, wie die Schüler-Bezeichner generiert werden (1 - ID, 2 - Nachname, drei Stellen Vorname und Geurtsdatum, 3 - Nachname, Vorname, Geburtsdatum)
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die GPU010-Datei

    • exportUntisFachwahlenGPU015

      @POST @Produces("application/octet-stream") @Path("/untis/export/fachwahlen/{id : \\d+}/{sidvariante : \\d+}") public jakarta.ws.rs.core.Response exportUntisFachwahlenGPU015(@PathParam("schema") String schema, @PathParam("id") long id, @PathParam("sidvariante") int sidvariante, InputStream gpu002, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für den Export der Fachwahlen zu einem Schuljahresabschnitt für Untis. Dabei wird die GPU-Datei GPU015.txt generiert.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      id - die ID des Schuljahresabschnittes, für den die Fachwahlen exportiert werden sollen
      sidvariante - die Variante, wie die Schüler-Bezeichner generiert werden (1 - ID, 2 - Nachname, drei Stellen Vorname und Geurtsdatum, 3 - Nachname, Vorname, Geburtsdatum)
      gpu002 - GPU002-Datei
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die GPU015-Datei

    • exportUntisKlausurenGPU017

      @POST @Produces("application/octet-stream") @Path("/untis/export/klausuren/{id : \\d+}/{sidvariante : \\d+}") public jakarta.ws.rs.core.Response exportUntisKlausurenGPU017(@PathParam("schema") String schema, @PathParam("id") long id, @PathParam("sidvariante") int sidvariante, InputStream gpu002, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für den Export einer Klausurplanung zu einem Schuljahresabschnitt für Untis. Dabei wird die GPU-Datei GPU017.txt generiert.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      id - die ID des Schuljahresabschnittes, für den die Klausurdaten exportiert werden sollen
      sidvariante - die Variante, wie die Schüler-Bezeichner generiert werden (1 - ID, 2 - Nachname, drei Stellen Vorname und Geurtsdatum, 3 - Nachname, Vorname, Geburtsdatum)
      gpu002 - GPU002-Datei
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die GPU017-Datei

    • exportUntisSchienenGPU019

      @POST @Produces("application/octet-stream") @Path("/untis/export/schienen/{id : \\d+}") public jakarta.ws.rs.core.Response exportUntisSchienenGPU019(@PathParam("schema") String schema, @PathParam("id") long id, InputStream gpu002, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für den Export der Schienenzuordnungen eines Schuljahresabschnittes für Untis. Dabei wird die GPU-Datei GPU019.txt generiert.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      id - die ID des Schuljahresabschnittes, für den die Schienenzuordnungen exportiert werden sollen
      gpu002 - GPU002-Datei
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die GPU019-Datei

    • exportUntisBlockungGPU002GPU015GPU019

      @POST @Produces("application/json") @Path("/untis/export/blockung/{id : \\d+}/{sidvariante : \\d+}") public jakarta.ws.rs.core.Response exportUntisBlockungGPU002GPU015GPU019(@PathParam("schema") String schema, @PathParam("id") long id, LongAndStringLists params, @PathParam("sidvariante") int sidvariante, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für den Export von Blockungen zu den übergebenen Abiturjahrgängen in dem übergebenen Schuljahresabschnitt. Dabei wird eine GPU002.txt für neue Unterrichte, eine GPU015.txt für die zugrundeliegenden Fachwahlen und eine GPU019.txt für die genutzten Schienen generiert.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      id - die ID des Schuljahresabschnittes, für welche die Blockungsergebnisse exportiert werden sollen
      params - die für die bisherigen Unterricht übergebene GPU002-Datei und die IDs der Blckungsergebnisse
      sidvariante - die Variante, wie die Schüler-Bezeichner generiert werden (1 - ID, 2 - Nachname, drei Stellen Vorname und Geurtsdatum, 3 - Nachname, Vorname, Geburtsdatum)
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die GPU019-Datei