Package de.svws_nrw.api.server

Klasse APIWiedervorlage

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

  • Konstruktorübersicht

    Konstruktoren
    Konstruktor
    Beschreibung
    APIWiedervorlage()
    Leerer Standardkonstruktor.

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    jakarta.ws.rs.core.Response
    addWiedervorlageEintrag(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Erzeugt einen Wiedervorlage-Eintrag.
    jakarta.ws.rs.core.Response
    deleteWiedervorlageEintraege(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Entfernen mehrerer Wiedervorlage-Einträge.
    jakarta.ws.rs.core.Response
    deleteWiedervorlageEintrag(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Entfernen eines Wiedervorlage-Eintrags.
    jakarta.ws.rs.core.Response
    getWiedervorlageEintrag(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage eines Wiedervorlage-Eintrags.
    jakarta.ws.rs.core.Response
    getWiedervorlageListe(String schema, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Liste Einträge in der Wiedervorlage des Benutzers, welche diese Anfrage gestellt hat.
    jakarta.ws.rs.core.Response
    patchWiedervorlageEintrag(String schema, long id, InputStream is, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für das Patchen eines Wiedervorlage-Eintrags.
    jakarta.ws.rs.core.Response
    setWiedervorlageEintragErledigt(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Markiert einen Wiedervorlage-Eintrag als erledigt.

    Von Klasse geerbte Methoden java.lang.Object

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

  • Konstruktordetails

    • APIWiedervorlage

      public APIWiedervorlage()
      Leerer Standardkonstruktor.

  • Methodendetails

    • getWiedervorlageListe

      @GET @Path("/liste") public jakarta.ws.rs.core.Response getWiedervorlageListe(@PathParam("schema") String schema, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage der Liste Einträge in der Wiedervorlage des Benutzers, welche diese Anfrage gestellt hat.
      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 Einträge der Wiedervorlage

    • getWiedervorlageEintrag

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

    • patchWiedervorlageEintrag

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

    • addWiedervorlageEintrag

      @POST @Path("/neu") public jakarta.ws.rs.core.Response addWiedervorlageEintrag(@PathParam("schema") String schema, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Erzeugt einen Wiedervorlage-Eintrag.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      is - der Input-Stream mit den Daten des Wiedervorlage-Eintrags
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Response im Erfolgsfall mit dem neuen Wiedervorlage-Eintrag

    • deleteWiedervorlageEintrag

      @DELETE @Path("/{id : \\d+}") public jakarta.ws.rs.core.Response deleteWiedervorlageEintrag(@PathParam("schema") String schema, @PathParam("id") long id, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Entfernen eines Wiedervorlage-Eintrags.
      Parameter:
      schema - das Datenbankschema
      id - die ID des Wiedervorlage-Eintrags
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die HTTP-Antwort mit dem Status und ggf. dem gelöschten Wiedervorlage-Eintrag

    • deleteWiedervorlageEintraege

      @DELETE @Path("/delete/multiple") public jakarta.ws.rs.core.Response deleteWiedervorlageEintraege(@PathParam("schema") String schema, InputStream is, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für das Entfernen mehrerer Wiedervorlage-Einträge.
      Parameter:
      schema - das Datenbankschema
      is - die IDs der Wiedervorlage-Einträge
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die HTTP-Antwort mit dem Status und ggf. den gelöschten Wiedervorlage-Einträgen

    • setWiedervorlageEintragErledigt

      @POST @Path("/{id : \\d+}/erledigt") public jakarta.ws.rs.core.Response setWiedervorlageEintragErledigt(@PathParam("schema") String schema, @PathParam("id") long id, @Context jakarta.servlet.http.HttpServletRequest request)
      Markiert einen Wiedervorlage-Eintrag als erledigt.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      id - die ID des Wiedervorlage-Eintrags
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Response im Erfolgsfall mit dem angepassten Wiedervorlage-Eintrag