Package de.svws_nrw.api.server

Klasse APIBetrieb

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

  • Konstruktorübersicht

    Konstruktoren
    Konstruktor
    Beschreibung
    APIBetrieb()
    Leerer Standardkonstruktor.

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    jakarta.ws.rs.core.Response
    createBeschaeftigungsArt(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Erstellen einer neuen Beschäftigungsart.
    jakarta.ws.rs.core.Response
    createBetrieb(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Erstellen einer neuen Betriebes.
    jakarta.ws.rs.core.Response
    createBetriebansprechpartner(String schema, long betrieb_id, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Erstellen eines neuen Betriebansprechpartners.
    jakarta.ws.rs.core.Response
    createBetriebsart(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Erstellen einer neuen Betriebsart.
    jakarta.ws.rs.core.Response
    createSchuelerbetrieb(String schema, long schueler_id, long betrieb_id, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Erstellen eines neuen Schülerbetriebs.
    jakarta.ws.rs.core.Response
    getBetriebAnsprechpartner(String schema, long betrieb_id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Liste aller Betriebe.
    jakarta.ws.rs.core.Response
    getBetriebAnsprechpartnerdaten(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage eines Betriebanpsrechpartners im angegebenen Schema.
    jakarta.ws.rs.core.Response
    getBetriebe(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Liste aller Betriebe.
    jakarta.ws.rs.core.Response
    getBetriebeAnsprechpartner(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Liste aller Betriebe.
    jakarta.ws.rs.core.Response
    getBetriebStammdaten(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Stammdaten eines Betriebs.
    jakarta.ws.rs.core.Response
    getKatalogBeschaeftigungsart(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Liste der Beschäftigungsarten im angegebenen Schema.
    jakarta.ws.rs.core.Response
    getKatalogBeschaeftigungsartmitID(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage einer Beschäftigungsart im angegebenen Schema.
    jakarta.ws.rs.core.Response
    getKatalogBetriebsart(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Liste der Beschäftigungsarten im angegebenen Schema.
    jakarta.ws.rs.core.Response
    getKatalogBetriebsartmitID(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage einer Betriebsart im angegebenen Schema.
    jakarta.ws.rs.core.Response
    getSchuelerBetriebsdaten(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage eines Schülerbetriebs im angegebenen Schema.
    jakarta.ws.rs.core.Response
    patchBeschaeftigungsart(String schema, long id, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Patchen einer Beschäftigungsart im angegebenen Schema
    jakarta.ws.rs.core.Response
    patchBetriebanpsrechpartnerdaten(String schema, long id, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Patchen der Stammdaten eines Schülerbetriebs.
    jakarta.ws.rs.core.Response
    patchBetriebsart(String schema, long id, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Patchen einer Betriebsart im angegebenen Schema
    jakarta.ws.rs.core.Response
    patchBetriebStammdaten(String schema, long id, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Patchen der Stammdaten eines Betriebs.
    jakarta.ws.rs.core.Response
    patchSchuelerBetriebsdaten(String schema, long id, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Patchen der Stammdaten eines Schülerbetriebs.
    jakarta.ws.rs.core.Response
    removeBetrieb(String schema, List<Long> bids, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode zum Löschen von einer oder mehreren Betriebsansprechpartner
    jakarta.ws.rs.core.Response
    removeBetriebansprechpartner(String schema, List<Long> bids, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode zum Löschen von einer oder mehreren Betriebsansprechpartner

    Von Klasse geerbte Methoden java.lang.Object

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

  • Konstruktordetails

    • APIBetrieb

      public APIBetrieb()
      Leerer Standardkonstruktor.

  • Methodendetails

    • getBetriebe

      @GET @Path("/") public jakarta.ws.rs.core.Response getBetriebe(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage der Liste aller Betriebe.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Liste mit den einzelnen Betrieben

    • getBetriebStammdaten

      @GET @Path("/{id : \\d+}/stammdaten") public jakarta.ws.rs.core.Response getBetriebStammdaten(@PathParam("schema") String schema, @PathParam("id") long id, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage der Stammdaten eines Betriebs.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      id - die Datenbank-ID zur Identifikation des Betriebs
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Stammdaten eines Betriebs

    • createBetrieb

      @POST @Path("/new") public jakarta.ws.rs.core.Response createBetrieb(@PathParam("schema") String schema, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Erstellen einer neuen Betriebes.
      Parameter:
      schema - das Datenbankschema, in welchem der Betriebsansprechpartner erstellt wird
      is - das JSON-Objekt
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die HTTP-Antwort mit der neuen Betriebsart

    • patchBetriebStammdaten

      @PATCH @Path("/{id : \\d+}/stammdaten") public jakarta.ws.rs.core.Response patchBetriebStammdaten(@PathParam("schema") String schema, @PathParam("id") long id, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Patchen der Stammdaten eines Betriebs.
      Parameter:
      schema - das Datenbankschema, auf welches der Patch ausgeführt werden soll
      id - die Datenbank-ID zur Identifikation des Erziehers
      is - der InputStream, mit dem JSON-Patch-Objekt nach RFC 7386
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      das Ergebnis der Patch-Operation

    • removeBetrieb

      @DELETE @Path("/remove") public jakarta.ws.rs.core.Response removeBetrieb(@PathParam("schema") String schema, List<Long> bids, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode zum Löschen von einer oder mehreren Betriebsansprechpartner
      Parameter:
      schema - das Datenbankschema
      bids - die IDs des Benutzer
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die HTTP-Antwort

    • createSchuelerbetrieb

      @POST @Path("/schuelerbetrieb/new/schueler/{schueler_id : \\d+}/betrieb/{betrieb_id: \\d+}") public jakarta.ws.rs.core.Response createSchuelerbetrieb(@PathParam("schema") String schema, @PathParam("schueler_id") long schueler_id, @PathParam("betrieb_id") long betrieb_id, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Erstellen eines neuen Schülerbetriebs.
      Parameter:
      schema - das Datenbankschema, in welchem der Schülerbetrieb erstellt wird
      schueler_id - die Datanbenk_ID des Schülers des neuen Schülebetriebs
      betrieb_id - die Datenbank_ID des Betriebes des neuen Schülerbetriebs.
      is - JSON-Objekt mit den Daten
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die HTTP-Antwort mit der neuen Blockung

    • patchSchuelerBetriebsdaten

      @PATCH @Path("/{id : \\d+}/betrieb") public jakarta.ws.rs.core.Response patchSchuelerBetriebsdaten(@PathParam("schema") String schema, @PathParam("id") long id, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Patchen der Stammdaten eines Schülerbetriebs.
      Parameter:
      schema - das Datenbankschema, auf welches der Patch ausgeführt werden soll
      id - die Datenbank-ID zur Identifikation des Schülerbetriebs
      is - der InputStream, mit dem JSON-Patch-Objekt nach RFC 7386
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      das Ergebnis der Patch-Operation

    • getSchuelerBetriebsdaten

      @GET @Path("/{id : \\d+}/betrieb") public jakarta.ws.rs.core.Response getSchuelerBetriebsdaten(@PathParam("schema") String schema, @PathParam("id") long id, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage eines Schülerbetriebs im angegebenen Schema.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      id - die Datenbank-ID zur Identifikation des Schülerbetriebs
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      der Schülerbetrieb mit ID des Datenbankschemas

    • getBetriebAnsprechpartner

      @GET @Path("/{id : \\d+}betriebansprechpartnerliste") public jakarta.ws.rs.core.Response getBetriebAnsprechpartner(@PathParam("schema") String schema, @PathParam("id") long betrieb_id, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage der Liste aller Betriebe.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      betrieb_id - die ID des Betriebs
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Liste mit den einzelnen Betrieben

    • getBetriebeAnsprechpartner

      @GET @Path("/betriebansprechpartner") public jakarta.ws.rs.core.Response getBetriebeAnsprechpartner(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage der Liste aller Betriebe.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Liste mit den einzelnen Betrieben

    • getBetriebAnsprechpartnerdaten

      @GET @Path("/{id : \\d+}/betriebansprechpartner") public jakarta.ws.rs.core.Response getBetriebAnsprechpartnerdaten(@PathParam("schema") String schema, @PathParam("id") long id, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage eines Betriebanpsrechpartners im angegebenen Schema.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      id - die Datenbank-ID zur Identifikation des Schülerbetriebs
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      der Betriebansprechpartner mit ID des Datenbankschemas

    • patchBetriebanpsrechpartnerdaten

      @PATCH @Path("/{id : \\d+}/betriebansprechpartner") public jakarta.ws.rs.core.Response patchBetriebanpsrechpartnerdaten(@PathParam("schema") String schema, @PathParam("id") long id, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Patchen der Stammdaten eines Schülerbetriebs.
      Parameter:
      schema - das Datenbankschema, auf welches der Patch ausgeführt werden soll
      id - die Datenbank-ID zur Identifikation des Schülerbetriebs
      is - der InputStream, mit dem JSON-Patch-Objekt nach RFC 7386
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      das Ergebnis der Patch-Operation

    • createBetriebansprechpartner

      @POST @Path("/{betrieb_id : \\d+}/ansprechpartner/new") public jakarta.ws.rs.core.Response createBetriebansprechpartner(@PathParam("schema") String schema, @PathParam("betrieb_id") long betrieb_id, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Erstellen eines neuen Betriebansprechpartners.
      Parameter:
      schema - das Datenbankschema, in welchem der Betriebsansprechpartner erstellt wird
      betrieb_id - des Betrieb
      is - das JSON-Objekt
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die HTTP-Antwort mit der neuen Blockung

    • removeBetriebansprechpartner

      @DELETE @Path("/betriebansprechpartner/remove") public jakarta.ws.rs.core.Response removeBetriebansprechpartner(@PathParam("schema") String schema, List<Long> bids, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode zum Löschen von einer oder mehreren Betriebsansprechpartner
      Parameter:
      schema - das Datenbankschema
      bids - die IDs des Benutzer
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die HTTP-Antwort

    • getKatalogBeschaeftigungsart

      @GET @Path("/beschaeftigungsart") public jakarta.ws.rs.core.Response getKatalogBeschaeftigungsart(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage der Liste der Beschäftigungsarten 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 Beschäftigungsarten mit ID des Datenbankschemas

    • getKatalogBeschaeftigungsartmitID

      @GET @Path("/beschaeftigungsart/{id : \\d+}") public jakarta.ws.rs.core.Response getKatalogBeschaeftigungsartmitID(@PathParam("schema") String schema, @PathParam("id") long id, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage einer Beschäftigungsart im angegebenen Schema.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      id - die Datenbank-ID zur Identifikation der Beschäftigungsart
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Liste der Beschäftigungsarten mit ID des Datenbankschemas

    • createBeschaeftigungsArt

      @POST @Path("/beschaeftigungsart/new") public jakarta.ws.rs.core.Response createBeschaeftigungsArt(@PathParam("schema") String schema, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Erstellen einer neuen Beschäftigungsart.
      Parameter:
      schema - das Datenbankschema, in welchem die Beschäftigungsart erstellt wird
      is - das JSON-Objekt
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die HTTP-Antwort mit der neuen Beschäftigungsart

    • patchBeschaeftigungsart

      @PATCH @Path("/beschaeftigungsart/{id : \\d+}") public jakarta.ws.rs.core.Response patchBeschaeftigungsart(@PathParam("schema") String schema, @PathParam("id") long id, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Patchen einer Beschäftigungsart im angegebenen Schema
      Parameter:
      schema - das Datenbankschema, auf welches der Patch ausgeführt werden soll
      id - die Datenbank-ID zur Identifikation der Beschäftigungsart
      is - der InputStream, mit dem JSON-Patch-Objekt nach RFC 7386
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      das Ergebnis der Patch-Operation

    • getKatalogBetriebsart

      @GET @Path("/betriebsart") public jakarta.ws.rs.core.Response getKatalogBetriebsart(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage der Liste der Beschäftigungsarten 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 Beschäftigungsarten mit ID des Datenbankschemas

    • getKatalogBetriebsartmitID

      @GET @Path("/beschaeftigungsart/{id : \\d+}") public jakarta.ws.rs.core.Response getKatalogBetriebsartmitID(@PathParam("schema") String schema, @PathParam("id") long id, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage einer Betriebsart im angegebenen Schema.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      id - die Datenbank-ID zur Identifikation der Betriebsart
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Betriebsart mit ID des Datenbankschemas

    • createBetriebsart

      @POST @Path("/betriebsart/new") public jakarta.ws.rs.core.Response createBetriebsart(@PathParam("schema") String schema, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Erstellen einer neuen Betriebsart.
      Parameter:
      schema - das Datenbankschema, in welchem der Betriebsansprechpartner erstellt wird
      is - das JSON-Objekt
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die HTTP-Antwort mit der neuen Betriebsart

    • patchBetriebsart

      @PATCH @Path("/betriebsart/{id : \\d+}") public jakarta.ws.rs.core.Response patchBetriebsart(@PathParam("schema") String schema, @PathParam("id") long id, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Patchen einer Betriebsart im angegebenen Schema
      Parameter:
      schema - das Datenbankschema, auf welches der Patch ausgeführt werden soll
      id - die Datenbank-ID zur Identifikation der Betriebsart
      is - der InputStream, mit dem JSON-Patch-Objekt nach RFC 7386
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      das Ergebnis der Patch-Operation