Package de.svws_nrw.api.server

Klasse APISchild

java.lang.Object
de.svws_nrw.api.server.APISchild
@Path("/db/{schema}/schild3") @Produces("application/json") @Consumes("application/json") public class APISchild extends Object
Die Klasse spezifiziert die OpenAPI-Schnittstelle für den Zugriff auf allgemeine Kataloge aus der SVWS-Datenbank.

  • Konstruktorübersicht

    Konstruktoren
    Konstruktor
    Beschreibung
    APISchild()
    Leerer Standardkonstruktor.

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    jakarta.ws.rs.core.Response
    getKatalogSchild3AbiturInfos(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Schild3-Kataloges AbiturInfos.
    jakarta.ws.rs.core.Response
    getKatalogSchild3Datenarten(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Schild3-Kataloges Datenarten.
    jakarta.ws.rs.core.Response
    getKatalogSchild3DQRNiveaus(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Schild3-Kataloges DQR-Niveaus.
    jakarta.ws.rs.core.Response
    getKatalogSchild3ExportCSV(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Schild3-Kataloges zur Konfiguration des CSV-Exportes von Schild.
    jakarta.ws.rs.core.Response
    getKatalogSchild3FilterFehlendeEintraege(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Schild3-Kataloges Filter Fehlende Einträge.
    jakarta.ws.rs.core.Response
    getKatalogSchild3Laender(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Schild3-Kataloges Bundesländer/Nachbarländer.
    jakarta.ws.rs.core.Response
    getKatalogSchild3Pruefungsordnungen(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Schild3-Kataloges Bundesländer/Nachbarländer.
    jakarta.ws.rs.core.Response
    getKatalogSchild3PruefungsordnungOptionen(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Schild3-Kataloges Prüfungsordnung-Optionen.
    jakarta.ws.rs.core.Response
    getKatalogSchild3UnicodeUmwandlung(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Schild3-Kataloges für die Unicode-Umwandlung.
    jakarta.ws.rs.core.Response
    getKatalogSchild3Versetzungsvermerke(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Schild3-Kataloges Versetzungsvermerke / PrfSemAbschl.
    jakarta.ws.rs.core.Response
    getSchild3ReportingDaten(String schema, String datenquelle, List<Object> params, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Daten einer im SVWS-Server definierten Schild3-Datenquelle des Reportings.
    jakarta.ws.rs.core.Response
    getSchild3ReportingDatenquellen(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der im SVWS-Server definierten Schild3-Datenquellen für das Reporting.

    Von Klasse geerbte Methoden java.lang.Object

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

  • Konstruktordetails

    • APISchild

      public APISchild()
      Leerer Standardkonstruktor.

  • Methodendetails

    • getKatalogSchild3AbiturInfos

      @GET @Path("/abiturinfos") public jakarta.ws.rs.core.Response getKatalogSchild3AbiturInfos(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage des Schild3-Kataloges AbiturInfos.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      der Katalog

    • getKatalogSchild3Datenarten

      @GET @Path("/datenarten") public jakarta.ws.rs.core.Response getKatalogSchild3Datenarten(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage des Schild3-Kataloges Datenarten.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      der Katalog

    • getKatalogSchild3DQRNiveaus

      @GET @Path("/dqr_niveaus") public jakarta.ws.rs.core.Response getKatalogSchild3DQRNiveaus(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage des Schild3-Kataloges DQR-Niveaus.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      der Katalog

    • getKatalogSchild3ExportCSV

      @GET @Path("/export/csv") public jakarta.ws.rs.core.Response getKatalogSchild3ExportCSV(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage des Schild3-Kataloges zur Konfiguration des CSV-Exportes von Schild.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      der Katalog

    • getKatalogSchild3FilterFehlendeEintraege

      @GET @Path("/filter/fehlende_eintraege") public jakarta.ws.rs.core.Response getKatalogSchild3FilterFehlendeEintraege(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage des Schild3-Kataloges Filter Fehlende Einträge.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      der Katalog

    • getKatalogSchild3Laender

      @GET @Path("/laender") public jakarta.ws.rs.core.Response getKatalogSchild3Laender(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage des Schild3-Kataloges Bundesländer/Nachbarländer.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      der Katalog

    • getKatalogSchild3Pruefungsordnungen

      @GET @Path("/pruefungsordnungen") public jakarta.ws.rs.core.Response getKatalogSchild3Pruefungsordnungen(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage des Schild3-Kataloges Bundesländer/Nachbarländer.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      der Katalog

    • getKatalogSchild3PruefungsordnungOptionen

      @GET @Path("/pruefungsordnungen/optionen") public jakarta.ws.rs.core.Response getKatalogSchild3PruefungsordnungOptionen(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage des Schild3-Kataloges Prüfungsordnung-Optionen.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      der Katalog

    • getKatalogSchild3UnicodeUmwandlung

      @GET @Path("/unicode/umwandlung") public jakarta.ws.rs.core.Response getKatalogSchild3UnicodeUmwandlung(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage des Schild3-Kataloges für die Unicode-Umwandlung.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      der Katalog

    • getKatalogSchild3Versetzungsvermerke

      @GET @Path("/versetzungsvermerke") public jakarta.ws.rs.core.Response getKatalogSchild3Versetzungsvermerke(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage des Schild3-Kataloges Versetzungsvermerke / PrfSemAbschl.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      der Katalog

    • getSchild3ReportingDatenquellen

      @GET @Path("/reporting/") public jakarta.ws.rs.core.Response getSchild3ReportingDatenquellen(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage der im SVWS-Server definierten Schild3-Datenquellen für das Reporting.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Definitionen der Schild3-Report-Datenquellen

    • getSchild3ReportingDaten

      @POST @Path("/reporting/{datenquelle}") public jakarta.ws.rs.core.Response getSchild3ReportingDaten(@PathParam("schema") String schema, @PathParam("datenquelle") String datenquelle, List<Object> params, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage der Daten einer im SVWS-Server definierten Schild3-Datenquelle des Reportings.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      datenquelle - der Name der Datenquelle
      params - die Parameter der Datenquelle, d.h. die Werte für das Attribut der Master-Datenquelle, welche bei dieser Datenquelle berücksichtigt werden sollen
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Definitionen der Schild3-Report-Datenquellen