Package de.svws_nrw.api.server

Klasse APIBKGym

java.lang.Object
de.svws_nrw.api.server.APIBKGym
@Path("/db/{schema}/bk/gym") @Produces("application/json") @Consumes("application/json") public class APIBKGym extends Object
Die Klasse spezifiziert die OpenAPI-Schnittstelle für den Zugriff auf die SVWS-Datenbank in Bezug auf das berufliche Gymnasium. Ein Zugriff erfolgt über den Pfad https://{hostname}/db/{schema}/bk/gym/.

  • Konstruktorübersicht

    Konstruktoren
    Konstruktor
    Beschreibung
    APIBKGym()
     

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    jakarta.ws.rs.core.Response
    getBKGymSchuelerAbiturdatenAusLeistungsdaten(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage der Abiturdaten des beruflichen Gymnasiums aus den Leistungsdaten eines Schülers.
    jakarta.ws.rs.core.Response
    getBKGymSchuelerLeistungsdaten(String schema, long id, jakarta.servlet.http.HttpServletRequest request)
    Liest die Leistungsdaten in Bezug auf das berufliche Gymnasium des Schülers mit der angegebene ID aus der Datenbank und liefert diese zurück.

    Von Klasse geerbte Methoden java.lang.Object

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

  • Konstruktordetails

    • APIBKGym

      public APIBKGym()

  • Methodendetails

    • getBKGymSchuelerLeistungsdaten

      @GET @Path("/schueler/{id : \\d+}/leistungsdaten") public jakarta.ws.rs.core.Response getBKGymSchuelerLeistungsdaten(@PathParam("schema") String schema, @PathParam("id") long id, @Context jakarta.servlet.http.HttpServletRequest request)
      Liest die Leistungsdaten in Bezug auf das berufliche Gymnasium des Schülers mit der angegebene ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen der Leistungsdaten besitzt.
      Parameter:
      schema - das Schema aus dem die Leistungsdaten des Schülers kommen sollen
      id - die ID des Schülers zu dem die Leistungsdaten geliefert werden sollen
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Leistungsdaten für das berufliche Gymnasium für den Schüler mit der angegebenen ID

    • getBKGymSchuelerAbiturdatenAusLeistungsdaten

      @GET @Path("/schueler/{id : \\d+}/laufbahn") public jakarta.ws.rs.core.Response getBKGymSchuelerAbiturdatenAusLeistungsdaten(@PathParam("schema") String schema, @PathParam("id") long id, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage der Abiturdaten des beruflichen Gymnasiums aus den Leistungsdaten eines Schülers.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      id - die ID des Schülers zu dem Abiturdaten ermittelt werden
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      die Abiturdaten des Schülers