Package de.svws_nrw.api.server

Klasse APIErzieher

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

  • Konstruktorübersicht

    Konstruktoren
    Konstruktor
    Beschreibung
    APIErzieher()
    Leerer Standardkonstruktor.

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    jakarta.ws.rs.core.Response
    getErzieher(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Liste aller Erzieher.
    jakarta.ws.rs.core.Response
    getErzieherArten(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Liste aller Erzieherarten.
    jakarta.ws.rs.core.Response
    getErzieherStammdaten(String schema, long tmpid, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Stammdaten eines Erziehers.
    jakarta.ws.rs.core.Response
    patchErzieherStammdaten(String schema, long tmpid, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Patchen der Stammdaten eines Erziehers.

    Von Klasse geerbte Methoden java.lang.Object

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

  • Konstruktordetails

    • APIErzieher

      public APIErzieher()
      Leerer Standardkonstruktor.

  • Methodendetails

    • getErzieher

      @GET @Path("/") public jakarta.ws.rs.core.Response getErzieher(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage der Liste aller Erzieher.
      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 Erziehern

    • getErzieherArten

      @GET @Path("/arten") public jakarta.ws.rs.core.Response getErzieherArten(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage der Liste aller Erzieherarten.
      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 Erzieherarten

    • getErzieherStammdaten

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

    • patchErzieherStammdaten

      @PATCH @Path("/{id : \\d+}/stammdaten") public jakarta.ws.rs.core.Response patchErzieherStammdaten(@PathParam("schema") String schema, @PathParam("id") long tmpid, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Patchen der Stammdaten eines Erziehers.
      Parameter:
      schema - das Datenbankschema, auf welches der Patch ausgeführt werden soll
      tmpid - 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