Package de.svws_nrw.api.server

Klasse APIKataloge

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

  • Konstruktorübersicht

    Konstruktoren
    Konstruktor
    Beschreibung
    APIKataloge()
    Leerer Standardkonstruktor.

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    jakarta.ws.rs.core.Response
    getHaltestellen(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Liste der Haltestellen im angegebenen Schema.
    jakarta.ws.rs.core.Response
    getKatalogOrte(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Orts-Kataloges von IT.NRW.
    jakarta.ws.rs.core.Response
    getKatalogOrtsteile(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Ortsteil-Kataloges von IT.NRW.
    jakarta.ws.rs.core.Response
    getKatalogStrassen(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage des Strassen-Kataloges.
    jakarta.ws.rs.core.Response
    getOrte(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Liste der Orte im angegebenen Schema.
    jakarta.ws.rs.core.Response
    getOrtsteile(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Liste der Ortsteile im angegebenen Schema.

    Von Klasse geerbte Methoden java.lang.Object

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

  • Konstruktordetails

    • APIKataloge

      public APIKataloge()
      Leerer Standardkonstruktor.

  • Methodendetails

    • getKatalogStrassen

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

    • getKatalogOrte

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

    • getOrte

      @GET @Path("/orte") public jakarta.ws.rs.core.Response getOrte(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage der Liste der Orte im angegebenen Schema.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Liste der Orte mit ID des Datenbankschemas

    • getKatalogOrtsteile

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

    • getOrtsteile

      @GET @Path("/ortsteile") public jakarta.ws.rs.core.Response getOrtsteile(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage der Liste der Ortsteile im angegebenen Schema.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Liste der Ortsteile mit ID des Datenbankschemas

    • getHaltestellen

      @GET @Path("/haltestellen") public jakarta.ws.rs.core.Response getHaltestellen(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage der Liste der Haltestellen im angegebenen Schema.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Liste der Haltestellen mit ID des Datenbankschemas