Wiki-Quellcode von Dokumentation REST API
Version 99.2 von Carina Enke am 20.12.2023
Verstecke letzte Bearbeiter
| author | version | line-number | content |
|---|---|---|---|
 |
33.1 | 1 | {{sv-translation language="de"}} |
| 2 | {{layout}} | ||
| 3 | {{layout-section ac:type="single"}} | ||
| |
97.1 | 4 | {{layout-cell}}{{/layout-cell}} |
| |
33.1 | 5 | {{/layout-section}} |
| 6 | |||
| 7 | {{layout-section ac:type="two_right_sidebar"}} | ||
| 8 | {{layout-cell}} | ||
| 9 | == REST-Schnittstelle der Lernplattform == | ||
| 10 | |||
| 11 | Die Lernplattform bietet Ihnen eine S(% style="color: rgb(50,50,50);" %)chnittstelle, 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. | ||
| 12 | |||
| 13 | |||
| 14 | (% style="color: rgb(50,50,50);" %)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. | ||
| 15 | |||
| 16 | \\ | ||
| 17 | |||
| 18 | \\ | ||
| 19 | {{/layout-cell}} | ||
| 20 | |||
| 21 | {{layout-cell}} | ||
| 22 | {{scroll-ignore}} | ||
| 23 | {{panel title="Inhalt"}} | ||
| 24 | |||
| 25 | |||
| 26 | {{toc maxLevel="2"/}} | ||
| 27 | {{/panel}} | ||
| 28 | {{/scroll-ignore}} | ||
| 29 | {{/layout-cell}} | ||
| 30 | {{/layout-section}} | ||
| 31 | |||
| 32 | {{layout-section ac:type="single"}} | ||
| 33 | {{layout-cell}} | ||
| 34 | == Dokumentation zur Schnittstelle == | ||
| 35 | |||
| 36 | 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. | ||
| 37 | |||
| 38 | \\ | ||
| 39 | {{/layout-cell}} | ||
| 40 | {{/layout-section}} | ||
| 41 | |||
| 42 | {{layout-section ac:type="single"}} | ||
| 43 | {{layout-cell}} | ||
| 44 | === Download der Dokumentation === | ||
| 45 | |||
| 46 | {{info}} | ||
| |
99.1 | 47 | 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>>mailto:support@bps-system.de||shape="rect"]]. |
| |
33.1 | 48 | {{/info}} |
| 49 | |||
| 50 | \\ | ||
| 51 | |||
| 52 | (% style="margin-left: 40.0px;" %) | ||
| |
99.1 | 53 | Aktuelle Version: REST API-v78-20230906 |
| |
33.1 | 54 | |
| 55 | (% style="margin-left: 40.0px;" %) | ||
| |
99.1 | 56 | Link zum Download: [[https:~~/~~/www.bps-system.de/share/download.jsp?id=1b1f9bad-91fa-418c-b4eb-6a258f3077d0>>url:https://www.bps-system.de/share/download.jsp?id=1b1f9bad-91fa-418c-b4eb-6a258f3077d0||shape="rect"]] |
| |
33.1 | 57 | |
| |
49.1 | 58 | |
| |
43.1 | 59 | \\ |
| |
33.1 | 60 | |
| 61 | \\ | ||
| 62 | {{/layout-cell}} | ||
| 63 | {{/layout-section}} | ||
| 64 | {{/layout}} | ||
| 65 | {{/sv-translation}} | ||
| 66 | |||
| 67 | {{sv-translation language="en"}} | ||
| 68 | |||
| 69 | |||
| 70 | {{includeplus spaceKey="LMS" scrollPageId="8AC9158F0169E71FC07AAFD92398FD30"/}} | ||
| 71 | {{/sv-translation}} |