Im Folgenden werden alle Parameter besprochen, die minimal für eine erfolgreiche Übertragung und Erstellung einer Veranstaltung notwendig sind.
USERNAME Der Ihnen zugewiesene Benutzername
PASSWORD Das Ihnen zugewiesene Passwort
ACHTUNG: Als Partner haben Sie durch geeignete Maßnahmen dafür Sorge zu tragen, dass Ihre Zugangsberechtigung nicht in falsche Hände gerät!
Die möglichen Datentypen lauten:
| Parameter | Typ | Beschreibung |
| TITEL | string | Name / Titel der Veranstaltung |
| BESCHREIBUNG | string | Detaillierte Beschreibung der Veranstaltung |
| KATEGORIEID1...n | int | ID der n-ten Kategorie der Veranstaltung |
| ARTID | int | ID der Veranstaltungsart |
| EINTRITT | bool | Angabe für Eintritt kostenpflichtig 0: Eintritt frei, 1: kostenpflichtig, Angaben zu PREIS_VAL1...n sind Pflicht |
| PREIS_VAL1...n | float | Betrag vom n-ten Preis in Euro, nur bei EINTRITT = 0 |
| BILD1...n | string | URL zum Dateiimport des n-ten Bild, z.B. https://www.test.de/bild.jpg |
| BILDDATEI1...n | file | Datei zum n-ten Bild, File-Input-Element, ersetzt Parameter BILD1...n; mischen von BILD1...n und BILDDATEI1...n ist nicht möglich |
| ORTID | int | ID des Veranstaltungsortes |
| VERANSTALTERID1...n | int | IDs des/der (Co-) Veranstalter |
| ZEITEN | json | Termin(e) für die Veranstaltung, genaues Format siehe Kapitel "Parameter für Termine" |
Sollten die Veranstaltungsdaten via POST-Aufruf übertragen werden, ist auch ein Bildupload möglich. Dabei ist jedoch generell für Bilder folgendes zu beachten:
- Gültige Format sind .gif, .jpg/.jpeg oder .png
- Die maximale Dateigröße je Bild beträgt 3 MB
Der Name für den Dateiupload heißt BILDDATEI1...n. Dieses Feld muss einem File-Input-Element entsprechen. Durch dieses Feld werden die BILD1...n Parameter ersetzt, ein Mischen der Parameter bei mehreren Bildern ist nicht möglich.
Sollten Sie Version 1 der Schnittstelle verwenden wollen oder müssen, gelten ein paar Änderungen:
- ZEITEN entfällt, wird ersetzt durch DATUMTYP und die sich daraus ergebenden Parameter (siehe Kapitel "Parameter für Termine")
- PREIS_VAL1...n entfällt, wird ersetzt durch:
| PREIS_NORMAL1...n | n-ter normaler Eintrittspreis, in Euro, mit max. 2 Nachkommastellen (z.B. 3.50) |
| PREIS_ERMAESSIGT1...n | n-ter ermäßigter Eintrittspreis, in Euro, mit max. 2 Nachkommastellen, nur mit korrespondierendem PREIS_NORMAL1...n erlaubt |
| PREIS_ERMAESSIGT_BERECHTIGTE1...n | Angaben zum n-ten ermäßigungsberechtigten Personenkreis (z.B. „Senioren“) , nur mit korrespondierendem PREIS_ERMAESSIGT1...n erlaubt |
| PREIS_NORMAL_VVK1...n | n-ter normaler Vorverkaufspreis, in Euro, mit max. 2 Nachkommastellen, nur mit korrespondierendem PREIS_NORMAL1...n erlaubt |
| PREIS_ERMAESSIGT_VVK1...n | n-ter ermäßigter Vorverkaufspreis, in Euro, mit max. 2 Nachkommastellen, nur mit korrespondierendem PREIS_NORMAL1...n erlaubt |
| PREIS_ERMAESSIGT_VVK_BERECHTIGTE1...n | Angaben zum n-ten im VVK ermäßigungsberechtigten Personenkreis (z.B. „Senioren“) , nur mit korrespondierendem PREIS_ERMAESSIGT_VVK1...n erlaubt |
Sollte EINTRITT=0 oder EINTRITT nicht angegeben sein, dann muss mindestens ein Preis angegeben werden.