API

Calls

Der Endpunkt des APIs ist

https://filmplaner.codecivil.de/api/?

Call	Kommentar
events	keine Werte; listet alle verfügbaren Events als JSON-String einer Liste von Objekten mit den Eigenschaften code und description auf;
code	mögliche Werte: code-Werte aus dem Ergebnis des events-Call; gibt einen JSON-String mit den Zeiten aller Vorstellungen des Festivals zurück. Genaueres dazu s. unten.
file	mögliche Werte: file-Werte aus dem Ergebnis des events-Call; gibt einen JSON-String mit den Zeiten aller Vorstellungen des Festivals zurück. Genaueres dazu s. unten.

Beispiele:

Call:

curl "https://filmplaner.codecivil.de/api/?events"

Antwort:

[{"code":"hof2019","description":"53. Hofer Filmtage"},{"code":"hof2022","description":"56. Hofer Filmtage"}]

Call:

curl "https://filmplaner.codecivil.de/api/?code=hof2022"

Antwort:

{"screenings":[{"id":18,"unixtimestart":1666802160,"unixtimeend":1666806420,"identifier":"26-18_0-Central2","title":"153 Meter","extras":"Central2"},{"id":290,"unixtimestart":1667136060,"unixtimeend":1667140320,"identifier":"30-14_45-Central3","title":"153 Meter","extras":"Central3"},...

JSON-Format der Antwort des code/file-Calls

Das JSON-Objekt hat die Eigenschaften

Eigenschaft	Wert
screenings	Objekt, das alle Vorstellungen aller Filme enthält, s. unten
date	Objekt mit den Eigenschaften starttime und endtime als UNIX-Zeitstempel in Sekunden des ersten Festivaltags, 0h00 UTC und des letzten Festivaltags, 0h00 UTC
rates	Objekt mit den Eigenschaften day und night, die die Preise für Tickets der jeweiligen Preisgruppen in Euro angeben
context	Objekt mit den Kontext der Veranstaltung beschreibenden Eigenschaften (s. unten)

Das Objekt screenings ist ein Array von Objekten mit folgenden Eigenschaften

Eigenschaft	Wert
id	interner Zähler, kann mit dem Index des Arrays übereinstimmen
unixtimestart	Startzeitpunkt der Vorstellung als UNIX Zeitstempel in Sekunden
unixtimeend	Endzeitpunkt der Vorstellung als UNIX Zeitstempel in Sekunden
identifier	eindeutige Bezeichnung der Vorstellung, z.b. Vorstellungsnummer
title	Titel des Films
extras	Zusatzinfos, z.B. Kino der Vorstellung

Das Objekt context hat die Eigenschaften

Eigenschaft	Wert
name	Name der Veranstaltung
gap	Mindestzeit zwischen zwei Vorstellungen in Sekunden; hier gehen z.B. Transferzeiten für den Wechsel von Locations und Puffer für gute Platzauswahl ein.
public	Öffentlichkeit der Veranstaltung (boolsch); öffentliche Veranstaltung erscheinen in der Veranstaltungliste der App und der Webseite, wenn sie hochgeladen werden.