REST API Überblick

Version 112.1 von Carina Enke am 24.02.2025

REST-Schnittstelle der Lernplattform

Die Lernplattform bietet Ihnen eine Schnittstelle, die nach dem REST-Schema (Representational State Transfer) Anfragen per HTTP(S) verarbeiten kann. Ziel der Schnittstelle ist die Bereitstellung und der Austausch von Daten mit anderen Systemen.

Unabhängig vom Login in der Benutzeroberfläche können registrierte NutzerInnen mit Hilfe der Schnittstelle konkrete Anfragen und regelmäßige Aufgaben automatisieren. Grundsätzlich sind dabei nur solche Aktionen möglich, die Ihnen auch in der Oberfläche aufgrund Ihrer individuellen Berechtigungen zur Verfügung stehen.

 

Dokumentation zur Schnittstelle

Zur Schnittstelle der Lernplattform ist eine Dokumentation verfügbar. Diese enthält je Abfrage die benötigte Syntax mit Beispiel, eine Beschreibung zum Funktionsinhalt sowie Angaben zu möglichen Parametern.

Download der Dokumentation

Der Download der Dokumentation ist passwortgeschützt. Jede neue Version der Dokumentation erhält ein neues Passwort. Bitte senden Sie eine E-Mail zur Passwortanfrage support@bps-system.de.

Aktuelle Version: REST API-v85-202400612.pdf

Link zum Download: https://www.bps-system.de/share/download.jsp?id=e62c0b3e-1294-4010-848d-28e609ca97c7