Exclamation.png Dieses Wiki wird auf einen neuen Server umgezogen und ist deshalb read-only (kein Login, kein Semantic-Mediawiki-Features, ..).


Labor-API

Version vom 5. Juni 2017, 15:10 Uhr von Basti (Diskussion | Beiträge) (Status aktualisiert)

(Unterschied) ← Nächstältere Version | Aktuelle Version (Unterschied) | Nächstjüngere Version → (Unterschied)
Wechseln zu: Navigation, Suche
Labor-API
Beschreibung: Sammelt und stellt Informationen rund ums Labor bereit
Kontakt: Basti
Status: abgeschlossen (Was heißt das?)

Die Labor-API ist in Python (mit Flask) geschrieben und läuft auf einem gunicorn-Server.

Das Ausgabeformat ist momentan auf JSON beschränkt. Die schreibenden Methoden benötigen API-User und API-Key zur Authentifizierung (Nachricht an Basti).


GET /api/room/

Gibt den aktuellen Laborstatus und den Zeitpunkt der letzten Änderung zurück. (Bildrepräsentation: /api/room_image.png)

Rückgabewerte: NameTypBeschreibung
open boolean Türstatus
since integer Unix Timestamp der letzten Aktualisierung

GET /api/room_archive/

Gibt das Laborstatus-Archiv zurück.

Rückgabewerte: NameTypBeschreibung
open boolean Türstatus
timestamp string Zeitstempel im Format ISO 8601

GET /api/info/ bzw. /api/room_extended/

Stellt allgemeine Informationen (inkl. Laborstatus) zur Verfügung. API Version: 0.13.

Siehe Spezifikation.


Schreibende Methoden

POST /api/room/ (Authentifizierung erforderlich)

Setzt den Raumstatus.

Parameter: NameTypBeschreibung
open boolean Raumstatus
Rückgabewerte: NameTypBeschreibung
success boolean Erfolgsstatus
status string Fehlermeldung (KANN verfügbar sein WENN success == false)

Andere API-Inhalte