Package de.svws_nrw.api.server

Klasse APIKAOA

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

  • Konstruktorübersicht

    Konstruktoren
    Konstruktor
    Beschreibung
    APIKAOA()
    Leerer Standardkonstruktor.

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    jakarta.ws.rs.core.Response
    getKatalogKAoAAnschlussoptionen(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des KAoA-Kataloges Anschlussoptionen.
    jakarta.ws.rs.core.Response
    getKatalogKAoABerufsfelder(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des KAoA-Kataloges Berufsfelder.
    jakarta.ws.rs.core.Response
    getKatalogKAoAEbene4(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des KAoA-Kataloges Einträge der SBO Ebene 4.
    jakarta.ws.rs.core.Response
    getKatalogKAoAKategorien(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des KAoA-Kataloges Kategorien.
    jakarta.ws.rs.core.Response
    getKatalogKAoAMerkmale(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des KAoA-Kataloges Merkmale.
    jakarta.ws.rs.core.Response
    getKatalogKAoAZusatzmerkmale(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des KAoA-Kataloges Zusatzmerkmale.

    Von Klasse geerbte Methoden java.lang.Object

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

  • Konstruktordetails

    • APIKAOA

      public APIKAOA()
      Leerer Standardkonstruktor.

  • Methodendetails

    • getKatalogKAoAKategorien

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

    • getKatalogKAoAMerkmale

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

    • getKatalogKAoAZusatzmerkmale

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

    • getKatalogKAoAEbene4

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

    • getKatalogKAoAAnschlussoptionen

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

    • getKatalogKAoABerufsfelder

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