Für den Terminimport werden folgende Parameter benötigt:
Parameter: ZEITEN
Schnittstelle: ab Version 2
Format: JSON-String
Erklärung: Im Parameter "ZEITEN" werden alle Daten zu einzelnen Terminen übergeben. Diese müssen in einem JSON-formatierten String übergeben werden.
Beispiel: {"2020-11-11T11:00":{"E":"2020-11-11 17:00","EIN":"10:00"},"2020-11-13T18:15":{"E":"2020-11-13 23:31"}}
"2020-11-11T11:00":{"E":"2020-11-11 17:00","EIN":"10:00","AUS":1}: 1. Termin am 11.11.2020, von 11 bis 17 Uhr, Einlass um 10 Uhr, Termin ist ausverkauft
"2020-11-13T18:15":{"E":"2020-11-13 23:31","AB":1}: 2. Termin am 13.11.2020, von 18:15 Uhr bis 23:31 Uhr, Termin ist abgesagt
Parameter: WH
Schnittstelle: ab Version 2
Format: JSON-String
Erklärung: Über den Parameter "WH" können Wiederholungstermine festgelegt werden. Als Uhrzeiten für die Wiederholungstermine werden die Uhrzeiten des ersten Termins aus "ZEITEN" genommen, d.h. Beginn, Ende und Einlass
Beispiel 1: {"SCHEMATYP":1,"TAEGLICHTYP":1,"TAEGLICHXTEN":3,"ZEITRAUMENDE":"2020-11-23"}
täglich wiederholend, an jedem 3. Tag bis maximal 23.11.2020
Beispiel 2: {"SCHEMATYP":2,"WOCHEXTE":2,"WOMO":0,"WODI":1,"WOMI":0,"WODO":1,"WOFR":0,"WOSA":0,"WOSO":0,"WOTERMINE":"{"Di":{"B1":"10:00","E1":"14:00","B2":"16:00","E2":"21:00"},"Do":{"B1":"17:00","E1":"22:00","B2":"","E2":""}}","ZEITRAUMENDE":"2020-12-31"}
wöchentlich wiederholend, jede 2. Woche, Termine Dienstags und Donnerstags, Dienstags von 10 bis 14 Uhr und 16 bis 21 Uhr, Donnerstags von 17 bis 22 Uhr, bis maximal 31.12.2020
Es können pro Wochentag maximal 2 Beginn- und Endeuhrzeiten (B1/E1 und B2/E2) angegeben werden, B1 und E1 sind pro Öffnungstag aber Pflicht.
| Variable | Typ | Beschreibung |
| SCHEMATYP | int | Art der Wiederholung; 1 für "täglich wiederholend" und 2 für "wöchentlich wiederholend" |
| TAEGLICHTYP | int | (nur bei SCHEMATYP = 1) Art der täglichen Wiederholung; 1 für "jeden Tag", 2 für "jeden Werktag Montag bis Freitag" |
| TAEGLICHXTEN | int | (nur bei SCHEMATYP = 1 und TAEGLICHTYP = 1) nur jeden TAEGLICHXTEN Tag wiederholen, z.B. jeden 3. Tag |
| ZEITRAUMENDE | date | Tag bis zu dem die Wiederholungen einschliesslich laufen sollen, Pflichtfeld bei Wiederholungen! |
| WOCHEXTE | int | (nur bei SCHEMATYP = 2) nur jede WOCHEXTE wiederholen, z.B. jede 4. Woche |
| WOMO...MOSO | int | Tage (MO, DI, MI, DO, FR, SA oder SO) an denen geöffnet sein soll, 1 für ja, 0 für nein |
| WOTERMINE | string | Definition der Öffnungszeiten der einzelnen Tagen an denen laut WOMO bis WOSO geöffnet ist |
Parameter: VVKLINKS
Schnittstelle: ab Version 2
Format: JSON-String
Erklärung: Eine Liste von URLs von Vorverkaufslinks für jeden einzelnen Termin, falls die Veranstaltung an mehr als einem Termin statt findet
Passend zum folgenden komplexen Beispiel: {"2020-11-11T11:00":"https://www.vvklink1.de","2020-11-15T11:00":"https://www.vvklink1.de","2020-11-17R10:00":"https://www.vvklink1.de"}
Komplexeres Beispiel:
ZEITEN: {"2020-11-11T11:00":{"E":"2020-11-11 17:00","EIN":"10:00"},"2020-11-13T18:00":{"E":"2020-11-13 23:00"},"2020-11-17R10:00":{"R":"2020-11-17E11:00","E":"2020-11-17 18:00","EIN":"09:00","AUS":1,"AB":1},"2020-11-17E11:00":{"R":"2020-11-17R10:00"},"2020-11-19D11:00":[]}
WH: {"SCHEMATYP":1,"TAEGLICHTYP":1,"TAEGLICHXTEN":2,"ZEITRAUMENDE":"2020-11-30"}
Bedeutet:
1. Termin: 11.11.2020, von 11 bis 17 Uhr, Einlass um 10 Uhr
2. Termin: 13.11.2020, von 18 bis 23:31 Uhr
Täglich wiederholend an jedem 2. Tag, von 11 bis 17 Uhr mit Einlass um 10 Uhr (siehe 1. Termin), mit folgenden Ausnahmen:
Der Termin am 17.11.2020 um 11 Uhr wird ersetzt durch den Termin um 10 Uhr ("2020-11-17E11:00":{"R":"2020-11-17R10:00"}, "E"-Markierung zwischen Datum und Uhrzeit beim Ursprungstermin und "R" für den Ersatztermin)
Die Details zum Ersatztermin lauten: von 10 bis 18 Uhr, Einlass 9 Uhr, ist aber abgesagt und war ausverkauft ("2020-11-17R10:00":{"R":"2020-11-17E11:00","E":"2020-11-17 18:00","EIN":"09:00","AUS":1,"AB":1}, "R"-Markierung zwischen Datum und Uhrzeit beim Ersatztermin und "R" für den ersetzten Termin)
Am 19.11.2020 um 10 Uhr gibt es keinen Termin. ("2020-11-19D11:00":[], "D"-Markierung zwischen Datum und Uhrzeit)
Es gibt einen Unterschied zwischen abgesagten und nicht vorgesehenen Terminen:
- mit der Markierung "AB":1 wird ein Termin, der eigentlich hätte statt finden sollen, weiterhin ausgegeben aber als abgesagt markiert
- ein Termin, der mittels "D" (siehe komplexeres Beispiel) in "ZEITEN" aufgeführt wird, ist ein Termin, der von den durch die Wiederholungsangaben in "WH" generierten Terminen ausgenommen werden soll, d.h. auch nirgends als Termin (auch nicht als abgesagter) auftaucht; ein Beispiel wäre eine Ausstellung, die eigentlich den gesamten Dezember über geht, die aber am 25.12. wegen Weihnachtsfeiertag geschlossen ist
Für eine Kompatibilität zur alten Schnittstelle (Parameter VERSION=1) können die alten Angaben für die Öffnungszeiten verwendet werden:
DATUMTYP: Angabe, in welchem Zeitraum eine Veranstaltung stattfindet. Mögliche Zeiträume sind:
EINZELN: Veranstaltung findet nur einmal an einem einzelnen Tag zu einer einzelnen Uhrzeit statt
MEHRERE: Veranstaltung findet an mehreren Tagen und / oder zu mehreren Uhrzeiten statt
ZEITRAUM: Veranstaltung findet über einen bestimmten Zeitraum statt (z.B. Ausstellung)
Beispiel: DATUMTYP=MEHRERE
Minimale Pflichtangaben:
Datumsangaben falls DATUMTYP=EINZELN:
DATUM Tag der Veranstaltung, im Format YYYY-MM-DD, z.B. 2012-12-31
BEGIN Uhrzeit, zu der die Veranstaltung anfängt, im Format HH:MM, z.B. 20:30
Beispiel: DATUM=2020-11-11&BEGIN=20:30
Datumsangaben falls DATUMTYP=MEHRERE:
DATUM1 erster Tag der Veranstaltung, im Format YYYY-MM-DD, z.B. 2012-12-31
BEGIN1_1 erste Uhrzeit, zu der die Veranstaltung am ersten Tag anfängt, im Format HH:MM, z.B. 20:30
Beispiel: DATUM1=2020-11-01&BEGIN1_1=21:00
Datumsangaben falls DATUMTYP=ZEITRAUM:
DATUM1 Tag, an dem die Veranstaltung beginnt, im Format YYYY-MM-DD, z.B. 2012-12-31
DATUM2 Tag, an dem die Veranstaltung spätestens endet, im Format YYYY-MM-DD, z.B. 2012-12-31
Es muss für mindestens einen Wochentag die Öffnungszeit angegeben werden. Beispiel:
MONTAG_VON1 erste Uhrzeit, zu der die Veranstaltung montags anfängt, im Format HH:MM, z.B. 20:30
MONTAG_BIS1 erste Uhrzeit, zu der die Veranstaltung montags endet, im Format HH:MM, z.B. 20:30
Beispiel: DATUM1=2020-11-01&DATUM2=2020-12-31&MONTAG_VON1=10:00&MONTAG_BIS1=20:30
Folgende Parameter sind möglich:
Öffnungszeiten, falls es sich um eine Veranstaltung vom Typ EINZELN handelt:
DATUM Tag der Veranstaltung, im Format YYYY-MM-DD, z.B. 2012-12-31
BEGIN Uhrzeit, zu der die Veranstaltung anfängt, im Format HH:MM, z.B. 20:30
ENDE Uhrzeit, zu der die Veranstaltung endet, im Format HH:MM, z.B. 20:30
EINLASS Uhrzeit, zu der der Einlass beginnt, im Format HH:MM, z.B. 20:30
Beispiel: DATUM=2020-11-11&BEGIN=20:30&ENDE=23:00&EINLASS=20:00
Öffnungszeiten, falls es sich um eine Veranstaltung vom Typ MEHRERE handelt:
DATUM1...n n-ter Tag der Veranstaltung, im Format YYYY-MM-DD, z.B. 2012-12-31
BEGIN1_1...n n-te Uhrzeit, zu der die Veranstaltung am ersten Tag anfängt, im Format HH:MM, z.B. 20:30
ENDE1_1...n n-te Uhrzeit, zu der die Veranstaltung am ersten Tag endet, im Format HH:MM, z.B. 20:30
EINLASS1_1...n n-te Uhrzeit, zu der der Einlass beginnt, im Format HH:MM, z.B. 20:30
Beispiel: DATUM1=2020-11-01&BEGIN1_1=21:00&DATUM2=2020-11-02&BEGIN2_1=10:00&BEGIN2_2=20:00
Öffnungszeiten, falls es sich um eine Veranstaltung vom Typ ZEITRAUM handelt:
DATUM1 Tag, an dem die Veranstaltung beginnt, im Format YYYY-MM-DD, z.B. 2012-12-31
DATUM2 Tag, an dem die Veranstaltung endet, im Format YYYY-MM-DD, z.B. 2012-12-31
Es muss für mindestens einen Wochentag die Öffnungszeit angegeben werden. Beispiel:
MONTAG_VON1 erste Uhrzeit, zu der die Veranstaltung montags anfängt, im Format HH:MM, z.B. 20:30
MONTAG_BIS1 erste Uhrzeit, zu der die Veranstaltung montags endet, im Format HH:MM, z.B. 20:30
MONTAG_VON2 zweite Uhrzeit, zu der die Veranstaltung montags anfängt, im Format HH:MM, z.B. 20:30
MONTAG_BIS2 zweite Uhrzeit, zu der die Veranstaltung montags endet, im Format HH:MM, z.B. 20:30
Mehr als 2 Öffnungszeiten pro Tag sind bei diesem Typ nicht möglich. Ein Beispiel für diesen Typ ist eine Ausstellung mit regelmäßigen Öffnungszeiten, inkl. Mittagspause. Deswegen die 2 Öffnungszeiten.
AUSNAHME1...n n-ter Tag innerhalb des Veranstaltungszeitraums, an dem die Veranstaltung gar nicht stattfindet, im Format YYYY-MM-DD, z.B. 2012-12-31
ABWEICHENDER1...n n-ter Tag mit abweichenden Öffnungszeiten, im Format YYYY-MM-DD, z.B. 2012-12-31
ABWEICHENDER1_VON1 erste Uhrzeit, zu der am ersten abweichenden Tag geöffnet wird, im Format HH:MM, z.B. 20:30
ABWEICHENDER1_BIS1 erste Uhrzeit, zu der am ersten abweichenden Tag geschlossen wird, im Format HH:MM, z.B. 20:30
ABWEICHENDER1_VON2 zweite Uhrzeit, zu der am ersten abweichenden Tag geöffnet wird, im Format HH:MM, z.B. 20:30
ABWEICHENDER1_BIS2 zweite Uhrzeit, zu der am ersten abweichenden Tag geschlossen wird, im Format HH:MM, z.B. 20:30
Beispiel: DATUM1=2020-11-01&DATUM2=2020-12-31&MONTAG_VON1=10:00&MONTAG_BIS1=20:30&AUSNAHME1=2020-11-23&ABWEICHENDER1=2020-11-30&ABWEICHENDER1_VON1=12:00&ABWEICHENDER1_BIS1=19:00