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 -
Methodenübersicht
Modifizierer und TypMethodeBeschreibungjakarta.ws.rs.core.Response
addEntlassgrund
(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Hinzufügen eines Entlassgrundes.jakarta.ws.rs.core.Response
addHaltestelle
(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Hinzufügen einer Haltestelle.jakarta.ws.rs.core.Response
addKatalogFoerderschwerpunkt
(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Hinzufügen eines neuen Förderschwerpunktes.jakarta.ws.rs.core.Response
addKindergarten
(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Hinzufügen neuer Kindergärten.jakarta.ws.rs.core.Response
addMerkmal
(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Hinzufügen eines Merkmals.jakarta.ws.rs.core.Response
addSportbefreiung
(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Hinzufügen einer Sportbefreiung.jakarta.ws.rs.core.Response
deleteEntlassgruende
(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Entfernen mehrerer Entlassgründe.jakarta.ws.rs.core.Response
deleteHaltestellen
(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Entfernen mehrerer Haltestellen.jakarta.ws.rs.core.Response
deleteKatalogFoerderschwerpunkte
(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Entfernen mehrerer Förderschwerpunkte.jakarta.ws.rs.core.Response
deleteKindergaerten
(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Entfernen mehrerer Kindergärten.jakarta.ws.rs.core.Response
deleteMerkmale
(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Entfernen mehrerer Merkmale.jakarta.ws.rs.core.Response
deleteSportbefreiungen
(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Entfernen mehrerer Sportbefreiungen.jakarta.ws.rs.core.Response
getEntlassgruende
(String schema, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für die Abfrage der Liste der Entlassgruende.jakarta.ws.rs.core.Response
getHaltestellen
(String schema, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für die Abfrage der Liste der Haltestellen.jakarta.ws.rs.core.Response
getKatalogFoerderschwerpunkt
(String schema, long id, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für die Abfrage eines Förderschwerpunktes.jakarta.ws.rs.core.Response
getKatalogFoerderschwerpunkte
(String schema, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für die Abfrage des Kataloges für die Förderschwerpunkte.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
getKindergaerten
(String schema, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für die Abfrage des schulspezifischen Kataloges für die Kindergärten.jakarta.ws.rs.core.Response
getMerkmale
(String schema, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für die Abfrage der Merkmale.jakarta.ws.rs.core.Response
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.jakarta.ws.rs.core.Response
getSportbefreiungen
(String schema, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für die Abfrage der Liste der Sportbefreiungen.jakarta.ws.rs.core.Response
patchEntlassgrund
(String schema, long id, InputStream is, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Patchen eines Entlassgrundes.jakarta.ws.rs.core.Response
patchHaltestelle
(String schema, long id, InputStream is, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Patchen einer Haltestelle.jakarta.ws.rs.core.Response
patchKatalogFoerderschwerpunkt
(String schema, long id, InputStream is, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Patchen eines Förderschwerpunktes.jakarta.ws.rs.core.Response
patchKindergarten
(String schema, long id, InputStream is, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Patchen eines Kindergartens im angegebenen Schemajakarta.ws.rs.core.Response
patchMerkmal
(String schema, long id, InputStream is, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Patchen eines Merkmals.jakarta.ws.rs.core.Response
patchSportbefreiung
(String schema, long id, InputStream is, jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Patchen einer Sportbefreiung.
-
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 sollrequest
- 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 sollrequest
- 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 sollrequest
- 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 sollrequest
- 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 sollrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die Liste der Ortsteile mit ID des Datenbankschemas
-
getEntlassgruende
@GET @Path("/entlassgruende") public jakarta.ws.rs.core.Response getEntlassgruende(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für die Abfrage der Liste der Entlassgruende.- Parameter:
schema
- das Datenbankschema, auf welches die Abfrage ausgeführt werden sollrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die Liste der Entlassgruende
-
patchEntlassgrund
@PATCH @Path("/entlassgruende/{id : \\d+}") public jakarta.ws.rs.core.Response patchEntlassgrund(@PathParam("schema") String schema, @PathParam("id") long id, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Patchen eines Entlassgrundes.- Parameter:
schema
- das Datenbankschema, auf welches der Patch ausgeführt werden sollid
- die Datenbank-ID zur Identifikation des Entlassgrundesis
- der InputStream, mit dem JSON-Patch-Objekt nach RFC 7386request
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- das Ergebnis der Patch-Operation
-
addEntlassgrund
@POST @Path("/entlassgruende/create") public jakarta.ws.rs.core.Response addEntlassgrund(@PathParam("schema") String schema, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Hinzufügen eines Entlassgrundes.- Parameter:
schema
- das Datenbankschemais
- der Input-Stream mit den Daten der Entlassgründerequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die HTTP-Antwort mit den erstellen Entlassgründe
-
deleteEntlassgruende
@DELETE @Path("/entlassgruende/delete/multiple") public jakarta.ws.rs.core.Response deleteEntlassgruende(@PathParam("schema") String schema, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Entfernen mehrerer Entlassgründe.- Parameter:
schema
- das Datenbankschemais
- der InputStream, mit der Liste der zu löschenden IDsrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die HTTP-Antwort mit dem Status der Lösch-Operationen
-
getMerkmale
@GET @Path("/merkmale") public jakarta.ws.rs.core.Response getMerkmale(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für die Abfrage der Merkmale.- Parameter:
schema
- das Datenbankschema, auf welches die Abfrage ausgeführt werden sollrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die Liste der Merkmale
-
patchMerkmal
@PATCH @Path("/merkmale/{id : \\d+}") public jakarta.ws.rs.core.Response patchMerkmal(@PathParam("schema") String schema, @PathParam("id") long id, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Patchen eines Merkmals.- Parameter:
schema
- das Datenbankschema, auf welches der Patch ausgeführt werden sollid
- die Datenbank-ID zur Identifikation des Merkmalsis
- der InputStream, mit dem JSON-Patch-Objekt nach RFC 7386request
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- das Ergebnis der Patch-Operation
-
addMerkmal
@POST @Path("/merkmale/create") public jakarta.ws.rs.core.Response addMerkmal(@PathParam("schema") String schema, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Hinzufügen eines Merkmals.- Parameter:
schema
- das Datenbankschemais
- der Input-Stream mit den Daten des Merkmalsrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die HTTP-Antwort mit dem erstellten Merkmal
-
deleteMerkmale
@DELETE @Path("/merkmale/delete/multiple") public jakarta.ws.rs.core.Response deleteMerkmale(@PathParam("schema") String schema, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Entfernen mehrerer Merkmale.- Parameter:
schema
- das Datenbankschemais
- der InputStream, mit der Liste der zu löschenden IDsrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die HTTP-Antwort mit dem Status der Lösch-Operationen
-
getKindergaerten
@GET @Path("/kindergaerten") public jakarta.ws.rs.core.Response getKindergaerten(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für die Abfrage des schulspezifischen Kataloges für die Kindergärten.- Parameter:
schema
- das Datenbankschema, auf welches die Abfrage ausgeführt werden sollrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die Liste mit dem Katalog der Kindergärten
-
addKindergarten
@POST @Path("/kindergarten/create") public jakarta.ws.rs.core.Response addKindergarten(@PathParam("schema") String schema, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Hinzufügen neuer Kindergärten.- Parameter:
schema
- das Datenbankschema, in welchem der Kindergarten erstellt wirdis
- das JSON-Objektrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die HTTP-Antwort mit neuem Kindergarten
-
patchKindergarten
@PATCH @Path("/kindergarten/{id : \\d+}") public jakarta.ws.rs.core.Response patchKindergarten(@PathParam("schema") String schema, @PathParam("id") long id, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Patchen eines Kindergartens im angegebenen Schema- Parameter:
schema
- das Datenbankschema, auf welches der Patch ausgeführt werden sollid
- die Datenbank-ID zur Identifikation des Kindergartensis
- der InputStream, mit dem JSON-Patch-Objekt nach RFC 7386request
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- das Ergebnis der Patch-Operation
-
deleteKindergaerten
@DELETE @Path("/kindergaerten/delete/multiple") public jakarta.ws.rs.core.Response deleteKindergaerten(@PathParam("schema") String schema, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Entfernen mehrerer Kindergärten.- Parameter:
schema
- das Datenbankschemais
- die IDs der Kindergärtenrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die HTTP-Antwort mit dem Status der Lösch-Operationen
-
getKatalogFoerderschwerpunkte
@GET @Path("/foerderschwerpunkte") public jakarta.ws.rs.core.Response getKatalogFoerderschwerpunkte(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für die Abfrage des Kataloges für die Förderschwerpunkte.- Parameter:
schema
- das Datenbankschema, auf welches die Abfrage ausgeführt werden sollrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die Liste mit dem Katalog der Förderschwerpunkte
-
addKatalogFoerderschwerpunkt
@POST @Path("/foerderschwerpunkte/create") public jakarta.ws.rs.core.Response addKatalogFoerderschwerpunkt(@PathParam("schema") String schema, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Hinzufügen eines neuen Förderschwerpunktes.- Parameter:
schema
- das Datenbankschemais
- der Input-Stream mit den Daten des Förderschwerpunktesrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die HTTP-Antwort mit dem erstellten Förderschwerpunkt
-
patchKatalogFoerderschwerpunkt
@PATCH @Path("/{id : \\d+}/foerderschwerpunkte") public jakarta.ws.rs.core.Response patchKatalogFoerderschwerpunkt(@PathParam("schema") String schema, @PathParam("id") long id, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Patchen eines Förderschwerpunktes.- Parameter:
schema
- das Datenbankschema, auf welches der Patch ausgeführt werden sollid
- die Datenbank-ID zur Identifikation des Förderschwerpunktesis
- der InputStream, mit dem JSON-Patch-Objekt nach RFC 7386request
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- das Ergebnis der Patch-Operation
-
deleteKatalogFoerderschwerpunkte
@DELETE @Path("/foerderschwerpunkte/delete/multiple") public jakarta.ws.rs.core.Response deleteKatalogFoerderschwerpunkte(@PathParam("schema") String schema, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Entfernen mehrerer Förderschwerpunkte.- Parameter:
schema
- das Datenbankschemais
- die IDs der Förderschwerpunkterequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die HTTP-Antwort mit dem Status der Lösch-Operationen
-
getKatalogFoerderschwerpunkt
@GET @Path("/foerderschwerpunkte/{id : \\d+}") public jakarta.ws.rs.core.Response getKatalogFoerderschwerpunkt(@PathParam("schema") String schema, @PathParam("id") long id, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für die Abfrage eines Förderschwerpunktes.- Parameter:
schema
- das Datenbankschema, auf welches die Abfrage ausgeführt werden sollid
- die Datenbank-ID zur Identifikation des Förderschwerpunktesrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die Daten zum Förderschwerpunkt
-
getSportbefreiungen
@GET @Path("/sportbefreiungen") public jakarta.ws.rs.core.Response getSportbefreiungen(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für die Abfrage der Liste der Sportbefreiungen.- Parameter:
schema
- das Datenbankschema, auf welches die Abfrage ausgeführt werden sollrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die Liste der Sportbefreiungen
-
patchSportbefreiung
@PATCH @Path("/sportbefreiungen/{id : \\d+}") public jakarta.ws.rs.core.Response patchSportbefreiung(@PathParam("schema") String schema, @PathParam("id") long id, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Patchen einer Sportbefreiung.- Parameter:
schema
- das Datenbankschema, auf welches der Patch ausgeführt werden sollid
- die Datenbank-ID zur Identifikation der Sportbefreiungis
- der InputStream, mit dem JSON-Patch-Objekt nach RFC 7386request
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- das Ergebnis der Patch-Operation
-
addSportbefreiung
@POST @Path("/sportbefreiungen/create") public jakarta.ws.rs.core.Response addSportbefreiung(@PathParam("schema") String schema, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Hinzufügen einer Sportbefreiung.- Parameter:
schema
- das Datenbankschemais
- der Input-Stream mit den Daten der Sportbefreiungrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die HTTP-Antwort mit der erstellten Sportbefreiung
-
deleteSportbefreiungen
@DELETE @Path("/sportbefreiungen/delete/multiple") public jakarta.ws.rs.core.Response deleteSportbefreiungen(@PathParam("schema") String schema, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Entfernen mehrerer Sportbefreiungen.- Parameter:
schema
- das Datenbankschemais
- der InputStream, mit der Liste der zu löschenden IDsrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die HTTP-Antwort mit dem Status der Lösch-Operationen
-
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.- Parameter:
schema
- das Datenbankschema, auf welches die Abfrage ausgeführt werden sollrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die Liste der Haltestellen
-
patchHaltestelle
@PATCH @Path("/haltestellen/{id : \\d+}") public jakarta.ws.rs.core.Response patchHaltestelle(@PathParam("schema") String schema, @PathParam("id") long id, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Patchen einer Haltestelle.- Parameter:
schema
- das Datenbankschema, auf welches der Patch ausgeführt werden sollid
- die Datenbank-ID zur Identifikation der Haltestelleis
- der InputStream, mit dem JSON-Patch-Objekt nach RFC 7386request
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- das Ergebnis der Patch-Operation
-
addHaltestelle
@POST @Path("/haltestellen/create") public jakarta.ws.rs.core.Response addHaltestelle(@PathParam("schema") String schema, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Hinzufügen einer Haltestelle.- Parameter:
schema
- das Datenbankschemais
- der Input-Stream mit den Daten der Haltestellerequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die HTTP-Antwort mit der erstellten Haltestelle
-
deleteHaltestellen
@DELETE @Path("/haltestellen/delete/multiple") public jakarta.ws.rs.core.Response deleteHaltestellen(@PathParam("schema") String schema, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request) Die OpenAPI-Methode für das Entfernen mehrerer Haltestellen.- Parameter:
schema
- das Datenbankschemais
- der InputStream, mit der Liste der zu löschenden IDsrequest
- die Informationen zur HTTP-Anfrage- Gibt zurück:
- die HTTP-Antwort mit dem Status der Lösch-Operationen
-