Package de.svws_nrw.api.external

Klasse APILernplattformenV1

java.lang.Object
de.svws_nrw.api.external.APILernplattformenV1
@Path("/api/external/{schema}/v1/lernplattformen") @Produces("application/json") @Consumes("application/json") public class APILernplattformenV1 extends Object
Die Klasse spezifiziert die OpenAPI-Schnittstelle für den Zugriff auf die Lernplattform-API. Diese Schnittstelle stellt einen Export für externe Lernplattformen zur Verfügung.

  • Konstruktorübersicht

    Konstruktoren
    Konstruktor
    Beschreibung
    APILernplattformenV1()
    Leerer Standardkonstruktor.

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    jakarta.ws.rs.core.Response
    getLernplattformenExport(String schema, long idLernplattform, int idSchuljahresabschnitt, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage eines Datenexports aller relevanten Informationen im angefragten Schuljahresabschnitt für die angefragte Lernplattform im Json-Format.
    jakarta.ws.rs.core.Response
    getLernplattformenExportAsGzip(String schema, long idLernplattform, int idSchuljahresabschnitt, jakarta.servlet.http.HttpServletRequest request)
    Die OpenAPI-Methode für die Abfrage eines Datenexports aller relevanten Informationen im angefragten Schuljahresabschnitt für die angefragte Lernplattform im gzip-Format.

    Von Klasse geerbte Methoden java.lang.Object

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

  • Konstruktordetails

    • APILernplattformenV1

      public APILernplattformenV1()
      Leerer Standardkonstruktor.

  • Methodendetails

    • getLernplattformenExport

      @GET @Path("/{idLernplattform : \\d+}/{idSchuljahresabschnitt : \\d+}") public jakarta.ws.rs.core.Response getLernplattformenExport(@PathParam("schema") String schema, @PathParam("idLernplattform") long idLernplattform, @PathParam("idSchuljahresabschnitt") int idSchuljahresabschnitt, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage eines Datenexports aller relevanten Informationen im angefragten Schuljahresabschnitt für die angefragte Lernplattform im Json-Format.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      idLernplattform - die ID der Lernplattform
      idSchuljahresabschnitt - die ID des Schuljahresabschnitts
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      der Lernplattform Datenexport im Json-Format

    • getLernplattformenExportAsGzip

      @GET @Produces("application/octet-stream") @Path("/{idLernplattform : \\d+}/{idSchuljahresabschnitt : \\d+}/gzip") public jakarta.ws.rs.core.Response getLernplattformenExportAsGzip(@PathParam("schema") String schema, @PathParam("idLernplattform") long idLernplattform, @PathParam("idSchuljahresabschnitt") int idSchuljahresabschnitt, @Context jakarta.servlet.http.HttpServletRequest request)
      Die OpenAPI-Methode für die Abfrage eines Datenexports aller relevanten Informationen im angefragten Schuljahresabschnitt für die angefragte Lernplattform im gzip-Format.
      Parameter:
      schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
      idLernplattform - die ID der Lernplattform
      idSchuljahresabschnitt - die ID des Schuljahresabschnitts
      request - die Informationen zur HTTP-Anfrage
      Gibt zurück:
      der Lernplattform Datenexport im gzip-Format