Optionale Parameter
Im Folgenden werden die optionalen Parameter beschrieben. Es kann jedoch sein, dass einer der folgenden Parameter einen oder mehrere andere zwingend bedingt, d.h. zu einem erforderlichen Parameter macht.
| Parameter | Typ | Beschreibung |
|---|---|---|
| ALTER_BIS | int | Geeignet für Personen bis x Jahren, Werte von 0 (= egal) bis 18 und 99 |
| ALTER_VON | int | Geeignet für Personen ab x Jahren, Werte von 0 (= egal) bis 18 und 60 |
| ANMELDUNG | bool | Anmeldung erforderlich, 1 für ja, 0 für nein, entspricht dem Tag "Anmeldung erforderlich" |
| ANMERKUNG | string | Kurze Anmerkung, z.B. "Wetterfeste Kleidung mitbringen" |
| BILDALTERNATIV1...n | string | Alternativtext des n-ten Bildes, für eine barrierefreie Bildbeschreibung |
| BILDFOTOGRAF1...n | string | Name des Fotografen des n-ten Bildes |
| BILDLINKS | int | x-Koordinate für Platzierung des 4:3-Bildausschnittes |
| BILDOBEN | int | y-Koordinate für Platzierung des 4:3-Bildausschnittes |
| BILDRECHTE1...n | string | Copyright-Informationen des n-ten Bildes, z.B. Name der Bilddatenbank |
| BILDVORSCHAU | int | Nummer des Listen-/Vorschaubildes (für 4:3 Ausschnitt), mögliche Werte: 1, 2 oder 3 |
| EINTRITTFREI | bool | Angabe für Eintritt frei, alternativ zu EINTRITT 1: Eintritt frei, 0: kostenpflichtig, Angaben zu PREISVAL1...n sind Pflicht |
| string | Facebook-Seite der Veranstaltung / des Veranstalters, inkl. https://, entspricht dem ersten LINKS->FACEBOOK |
|
| FAMILIEN | bool | Veranstaltung für Familien, 1 für ja, 0 für nein, entspricht dem Tag "Für Familien" |
| FORMAT | string | Format der Schnittstellenantwort, möglich sind JSON und XML, default ist XML |
| INTERKULTUR | bool | Interkulturelle Veranstaltung, 1 für ja, 0 für nein, entspricht dem Tag "Interkultur" |
| INTERNET | string | Internetseite der Veranstaltung, inkl. https://, entspricht dem ersten LINKS->WEBSEITE |
| INTERNETREIHE | string | Internetseite der Veranstaltungsreihe, inkl. https://, entspricht dem ersten LINKS->WEBSEITEREIHE |
| KALENDERID1...n | int | ID des n-ten Ausgabekalender |
| KINDER | bool | Veranstaltung für Kinder, 1 für ja, 0 für nein, entspricht dem Tag "Für Kinder" |
| LINKS | json | Liste von verschiedenen Links zu Veranstaltung, sie Kapitel "Parameter für Links" |
| PREIS_ART1...n | int | Art des Eintritts, aktuell möglich: 2: Eintritt 4: Voverkauf |
| PREIS_ERM1...n | bool | Ermäßigter Preis, 0 für nein, 1 für ja |
| PREIS_KAT1...n | int | Preiskategorie |
| PREIS_INFO1...n | string | zusätzlicher Infotext zum Preis |
| PRIVATETAGS | string | Private Tags, getrennt mittels '||' (Doppel-Pipe) |
| REIHE | string | Die gemeldete Veranstaltung ist Teil der Reihe mit dem angegebenen Namen |
| REIHEN | string | Die gemeldete Veranstaltung ist Teil der Reihe(n) mit dem angegebenen Namen; falls mehrere Reihen angegeben werden sollen, sind diese mittels '||' (Doppel-Pipe) zu trennen |
| TAGS | string | Tags, getrennt mittels '||' (Doppel-Pipe) |
| string | Twitter-Kanal der Veranstaltung / des Veranstalters, inkl. https://, entspricht dem ersten LINKS->TWITTER |
|
| UNTERKATEGORIEID1...n | int | ID der n-ten Unterkategorie der Veranstaltung, wobei es immer eine passende Kategorie geben muß |
| UNTERTITEL | string | Untertitel bzw. Kurzbeschreibung, maximal 100 Zeichen lang |
| VERANSTALTUNGID | int | ID der Veranstaltung, falls eine bestehende Veranstaltung geupdatet werden soll |
| VEROEFFENTLICHT | date | Datum, ab dem die Veranstaltung in den Kalendern veröffentlicht wird, z.B. 2020-12-31; fehlt die Angabe ist das gleichbedeutend mit „sofort“ |
| VERSION | int | Version der Schnittstelle, default ist immer die aktuellste Version |
| VIDEO | string | Video zur Veranstaltung, inkl. https://, kein Videochannel!, , entspricht dem ersten LINKS->VIDEO |
| VVKDATUM | date | Datum, ab dem der Online-VVK beginnt,z.B. 2020-12-31 |
| VVKINFOS | string | Eigener Hinweistext zum Thema VVK, z.B. „Verkauf der Karten im Sekretariat der Schule“ |
| VVKLINK | string | Link zum bevorzugten, allgemeinen Online-Kartenvorverkauf, inkl. https:// |
| VVKLINKS | json | VVK-Links zu den konkreten einzelnen Terminen, genaues Format siehe Kapitel "Parameter für Termine" |
| VVKSTELLEN | bool | Vorverkauf findet an den gängigen VVK-Stellen statt, 1 für ja, 0 für nein |
| WH | json | Information zu Wiederholungsterminen, genaues Format siehe Kapitel "Parameter für Termine" |