NB-Public/schaufenster
14
0
Fork 0
mirror of https://github.com/netzbegruenung/schaufenster.git synced 2024-04-28 15:24:53 +02:00
Code Issues Projects Releases Wiki Activity
schaufenster/service
History
Marian Steinbach 1fcc52925e First version of an iCal calender service
2018-02-04 13:20:24 +01:00
..
api First version of an iCal calender service 2018-02-04 13:20:24 +01:00
tests First version of an iCal calender service 2018-02-04 13:20:24 +01:00
.gitignore First version of an iCal calender service 2018-02-04 13:20:24 +01:00
Makefile First version of an iCal calender service 2018-02-04 13:20:24 +01:00
README.md First version of an iCal calender service 2018-02-04 13:20:24 +01:00
requirements.txt First version of an iCal calender service 2018-02-04 13:20:24 +01:00

README.md

Schaufenster Service

Dies ist ein Webservice zur Erzeugung dynamischer Inhalte für Digital Signage Anwendungen.

Anwendungsbeispiel:

Auf einer digitalen Anzeigetafel soll stets aktuell der nächste Sitzungstermin angezeigt werden. Hierfür geben wir eine iCal-Kalender-URL an und bekommen dafür Titel und weitere Details der nächsten Termine in diesem Kalender zurück.

API

GET /events/ - Die nächsten Termine eines iCal Kalenders ausgeben

Request URL Parameter:

  • ical_url: Adresse des iCal-Kalenders (erforderlich).
  • num: Maximale Anzahl der Termine, die ausgegeben werden.
  • charset: Zeichensatz der iCal-Quelle. Normalerweise wird der Zeichensatz angenommen, den der Webserver im Content-type header angibt. Mit diesem Parameter kann der Wert des Servers überschrieben werden. Beispiel: charset=utf-8.

Ausgabe:

[
  {
    "title": "Karfreitag",
    "start": "2018-03-30",
    "end": "2018-03-31"
  },
  ...
]

Liste mit Terminen als JSON Array. Jeder Termin enthält:

  • title: Titel des Termins
  • start: Start-Datum (oder Datum/Uhrzeit) des Termins
  • end: (optional) Enddatum (oder Datum/Uhrzeit) des Termins