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.
Die möglichen Datentypen lauten:
"default: nicht gesetzt" heißt dass der Parameter ignoriert wird
Unter "Login" wird angegeben, ob ein Login erforderlich ist, um den entsprechenden Parameter verwenden zu können.
ACHTUNG: Als Partner haben Sie durch geeignete Maßnahmen dafür Sorge zu tragen, dass Ihre Zugangsberechtigung nicht in falsche Hände gerät!
Weitere Parameter in alphabetischer Reihenfolge:
| Parameter | Typ | Beschreibung | Login |
|---|---|---|---|
| ABFRAGE | string | selbst zusammengestellte Abfrage, siehe Kapitel "Flexible Abfrage" | ja |
| ABGESAGT | bool |
0: zeige nur nicht abgesagte Veranstaltungen 1: zeige nur abgesagte Veranstaltungen default: nicht gesetzt |
ja |
| ALLETERMINE | bool |
1: es werden bei jeder Veranstaltung alle noch ab START_DATUM statt findenden Termine angezeigt default: 0 |
ja |
| ALLEUHRZEITEN | bool |
1: Falls eine Veranstaltung mehrmals im Ergebnis vor kommt, wird sie auch mehrmals an entsprechender Stelle ausgegeben, z.B. bei einer Ausstellung; nur bei ORDER=DATUM anwendbar default: 0 |
ja |
| ALTER_BIS | int |
0: Bis-Alter ist egal größer 0: geeignet für Personen bis maximal ALTER_BIS default: 0 |
ja |
| ALTER_VON | int |
0: egal größer 0: geeignet für Personen ab ALTER_VON default: 0 |
ja |
| ARTID1...n | int | IDs der Veranstaltungsarten, nach denen gefiltert werden soll | ja |
| AUSGABEFELDER | string |
Kommaseparierte Liste aller Felder, die im Ergebnis ausgegeben werden sollen. Möglich sind: TITEL, KURZTITEL, UNTERTITEL, BESCHREIBUNG, INTERNETSEITE, FACEBOOK, TWITTER, VIDEO, VVKLINK, VVKDATUM, VVKUEBLICH, VVKINFOS, KINDER, FAMILIEN, INTERKULTUR, ALTER_VON, ALTER_BIS, LETZTEAENDERUNG, ORT, VERANSTALTER, DATUM, ERSTERTERMIN, KATEGORIE, ART, BILD, BILDER, PREISE, TAGS, PRIVATETAGS default: TITEL, UNTERTITEL, REIHE, MWZLINK, VVKLINK, ORT, BILD, DATUM |
ja |
| BEENDET | bool |
1: zeige nur Veranstaltungen, die noch nicht beendet sind default: 0 |
ja |
| EINTRITT | bool |
0: zeige nur kostenpflichtige Veranstaltungen 1: zeige nur kostenlose Veranstaltungen default: nicht gesetzt |
ja |
| ENDE_DATUM | date |
Es werden nur Veranstaltungen ausgegeben, die spätestens am ENDE_DATUM beginnen |
nein |
| ENDE_ZEIT | time |
Es werden nur Veranstaltungen ausgegeben, die spätestens um ENDE_ZEIT beginnen, unabhängig vom Datum (z.B. um Vormittagsveranstaltungen bis 12 Uhr auszugeben) |
ja |
| EXCLUDETAGSANDOR | string |
Legt die Art der Verknüpfung der auszuschliessenden Tags fest 'AND': AND-Verknüpfung 'OR': OR-Verknüpfung default: 'AND' |
ja |
| FAMILIEN | bool |
0: es werden nur Veranstaltungen ausgegeben, die keine Familienveranstaltung sind, d.h. das Tag "Für Familien" nicht gesetzt ist 1: es werden nur Familienveranstaltungen ausgegeben, d.h. das Tag "Für Familien" ist angegeben default: nicht gesetzt |
|
| FAVEXID1...n | int |
Alle angegebenen Veranstaltungs-IDs sollen nicht ausgegeben werden |
ja |
| FAVID1...n | int | Alle angegebenen Veranstaltungs-IDs werden (zusätzlich mit, siehe FAVODER) ausgegeben | ja |
| FAVORIT1...n | string |
Alle angegebenen Veranstaltungen werden (zusätzlich mit, siehe FAVODER) ausgegeben, das Format lautet: "Veranstaltungs-ID ISO-Datum Uhrzeit", also zum Beispiel: "118444 2021-10-10 10:00" Soll eine Veranstaltungs-ID mehrmals vorkommen und alle Ergebnisse ausgegeben werden, dann muss noch "ALLEUHRZEITEN" auf 1 gesetzt werden. |
ja |
| FAVODER | bool |
0: nur die angegebenen Veranstaltungs-IDs werden mit ausgegeben default: 0 |
ja |
| FORMAT | string |
JSON oder XML default: JSON |
nein |
| INTERKULTUR | bool |
0: es werden nur Veranstaltungen ausgegeben, für die das Tag "Interkultur" nicht gesetzt ist 1: es werden nur Veranstaltungen ausgegeben, für die das Tag "Interkultur" gesetzt ist default: nicht gesetzt |
ja |
| KALENDER1...n | int | Ausgabe wird auf die angegebenen Kalender-IDs beschränkt (bitte Hinweis bei NOKALENDERID1...n beachten) | ja |
| KALENDERID | int | Ausgabe wird auf die angegebene Kalender-ID beschränkt (bitte Hinweis bei NOKALENDERID1...n beachten) | ja |
| KATEGORIEID1...n | int | IDs der Kategorien, auf die die Ausgabe beschränkt werden soll | ja |
| KINDER | bool |
0: es werden nur Veranstaltungen ausgegeben, die keine Familienveranstaltung sind, d.h. das Tag "Für Kinder" nicht gesetzt ist 1: es werden nur Familienveranstaltungen ausgegeben, d.h. das Tag "Für Kinder" ist angegeben default: nicht gesetzt |
ja |
| KOMPLETT | bool |
0: es werden nur die bei AUSGABEFELDER angegebenen Feld ausgegeben 1: es werden alle Ausgabefelder ausgegeben default: 0 |
ja |
| KOMPLETTVERANSTALTER | bool |
0: Veranstalter werden nur mit ID und Name ausgegeben 1: es werden alle Daten der Veranstalter (Adresse, etc.) ausgegeben Wenn KOMPLETT=1, dann ist auch automatisch KOMPLETTVERANSTALTER=1 default: 0 |
ja |
| KOMPLETTVERANSTALTUNSGORT | bool |
0: beim Veranstaltungsort wird nur die ID und der komplette Name ausgegeben 1: es werden alle Daten des Veranstalteungsortes (Adresse, etc.) ausgegeben Wenn KOMPLETT=1, dann ist auch automatisch KOMPLETTVERANSTALTUNSGORT=1 default: 0 |
ja |
| LAT | float | Latitutde, Breitengrad; wird nur beachtete, wenn Umkreis gesetzt ist | ja |
| LNG | float | Longitude, Längengrad; wird nur beachtete, wenn Umkreis gesetzt ist | ja |
| MAX_LIMIT | int |
Falls größer 0, wird maximal die angegebene Anzahl an Veranstaltungen ausgegeben Achtung: Kann maximal 100 sein |
nein |
| NOARTID1...n | int | IDs der Veranstaltungsarten, die ausgeschlossen werden sollen | ja |
| NOKALENDER1...n | int | Kalender-IDs, die ausgeschlossen werden sollen, hat Vorrang vor KALENDERID und KALENDERID1...n | ja |
| NOKATEGORIEID1...n | int | IDs der Veranstaltungskategorien, die ausgeschlossen werden sollen | ja |
| NOUNTERARTID1...n | int | IDs der Veranstaltungsunterarten, die ausgeschlossen werden sollen | ja |
| NOUNTERKATEGORIEID1...n | int | IDs der Veranstaltungsunterkategorien, die ausgeschlossen werden sollen | ja |
| NUR_EIGENE | bool | es werden nur Veranstaltungen ausgegeben, die vom abfragenden Benutzer erstellt wurde |
ja |
| ONLINE | bool |
0: nur Veranstaltungen, die nicht mit dem Tag oder der Reihe "Online-Veranstaltung" markiert sind 1: nur Veranstaltungen, die entweder mit dem Tag und/oder der Reihe "Online-Veranstaltung" markiert sind default: nicht gesetzt |
ja |
| ONLINEVVK | bool |
0: nur Veranstaltungen ohne VVK ausgeben 1: nur Veranstaltungen mit VVK ausgeben default: nicht gesetzt |
ja |
| ORDER | string |
TITEL: Nach Veranstaltungsname sortieren VERANSTALTERNAME: Nach Veranstaltername sortieren ORTSNAME: Nach Ortsname sortieren DATUM: Nach Veranstaltungsdatum sortieren STARTDATUM: nach dem ersten Veranstaltungstag sortieren LETZTEAENDERUNG: Nach dem Datum der letzten Änderung sortieren DISTANZ: Nach dem Abstand zu LAT, LNG sortieren |
ja |
| ORT1...n | string | Nach den angegebenen Ortsnamen filtern | ja |
| ORTID1...n | int | Nach den angegebenen Ort-IDs filtern | ja |
| ORTODERV | bool |
0: wenn Orts- und Veranstalter-IDs angegeben sind, dann werden nur Veranstaltungen ausgegeben, bei denen beides passt 1: wenn Orts- und Veranstalter-IDs angegeben sind, dann werden alle Veranstaltungen ausgegeben, bei denen eines von beiden passt default: 0 |
ja |
| PASSWORD | string | Das Ihnen zugewiesene Passwort | ja |
| PLZ1...n | string | Es wird nach den angegebenen PLZ gefiltert | ja |
| PRETTYJSON | bool |
0: Falls FORMAT=JSON, dann wird das Ergebniss ohne Whitespaces ausgegeben 1: Falls FORMAT=JSON, dann wird das Ergebniss mit Whitespaces leserlich formatiert default: 0 |
nein |
| PTAGSANDOR | string |
Legt die Art der Verknüpfung der privaten Suchtags fest 'AND': AND-Verknüpfung 'OR': OR-Verknüpfung default: 'OR' |
ja |
| REIHE | string | Es wird nach der angegebenen Reihe gefiltert | ja |
| REIHENANDOR | string |
Legt die Art der Verknüpfung der gesuchten Reihen fest 'AND': AND-Verknüpfung 'OR': OR-Verknüpfung default: 'OR' |
ja |
| STADT1...n | string | Es wird nach den angegebenen Städten gefiltert | ja |
| START_DATUM | date | Es werden nur Veranstaltungen ausgegeben, die am START_DATUM beginnen | nein |
| START_LIMIT | int | Die Ausgabe des Ergebnisses beginnt bei der START_LIMIT-ten Veranstaltung | ja |
| START_ZEIT | time |
Es werden nur Veranstaltungen ausgegeben, die ab START_ZEIT beginnen, unabhängig vom Datum (z.B. um Abendveranstaltungen ab 19 Uhr auszugeben) |
ja |
| STARTZEITRAUM1...n | date2 | Beschränkung auf Veranstaltungen, die in den angegebenen Zeiträumen beginnen | ja |
| SUCHEORTZUSATZ | bool |
0: bei der Namenssuche nach einem Ort wird das Zusatzfeld nicht durchsucht 1: bei der Namenssuche nach einem Ort wird das Zusatzfeld mit durchsucht default: 0 |
ja |
| SUCHEXCLUDETAGS | string | Mittels '||' getrennte Liste von Tags, die nicht vorkommen dürfen | ja |
| SUCHFELDER | string |
Kommaseparierte Liste von Feldern, die bei der Volltextsuche durchsucht werden sollen; möglich sind: ID, TITEL, UNTERTITEL, BESCHREIBUNG, ANMERKUNG, ORTNAME, VERANSTALTERNAME, KATEGORIE, ART, REIHE, ERSTERTAG, AENDERUNG, TAGS, PRIVATETAGS |
ja |
| SUCHPRIVATETAGS | string | Mittels '||' getrennte Liste von Privatetags, nach denen gesucht werden soll | ja |
| SUCHTAGS | string | Mittels '||' getrennte Liste von Tags, nach denen gesucht werden soll | ja |
| SUCHTEXT | string |
Text, nach dem in der Volltextsuche gesucht werden soll. Werden mehrere Wörte angeben, werden alle Veranstaltungen ausgegeben, in denen mindestens eines der Wörter vor kommt. Für einen Suchbegriff aus mehreren Wörtern müssen diese in Anführungsstriche gesetzt werden, z.B. "Für Kinder" |
ja |
| TAGSANDOR | string |
Legt die Art der Verknüpfung der Suchtags fest 'AND': AND-Verknüpfung 'OR': OR-Verknüpfung default: 'OR' |
ja |
| TYP | string |
Art der Abfrage, möglich sind: ARTEN: Liste aller Veranstaltungsarten DETAIL: Abfrage der Detaildaten einer Veranstaltung an Hand der VeranstaltungsID FAVORITEN: Abfrufen einer benutzerspezifischen Favoritenliste KATEGORIEN: Liste aller Kategorien ORTE: Liste aller dem Benutzer zugeordneten Orte PRIVATETAGS: Liste aller von einem Benutzer verwendeten Private Tags in alphabetischer Reihenfolge SUCHE: Liste von Veranstaltungen TAGS: Liste aller jemals verwendeten Tags in alphabetischer Reihenfolge VERANSTALTER: Liste aller dem Benutzer zugeordneten Veranstalter |
ja / nein |
| UMKREIS | float | Entfernung in km von LAT und LNG für Umkreissuche | ja |
| UNTERARTID1...n | int | IDs der Veranstaltungsunterarten, nach denen gefiltert werden soll | ja |
| UNTERKATEGORIEID1...n | int | IDs der Unterkategorien, auf die die Ausgabe beschränkt werden soll | ja |
| UPDATE | date1 | Es werden nur Veranstaltungen ausgegeben, die seit UPDATE verändert wurden | ja |
| USERNAME | string | Der Ihnen zugewiesene Benutzername | ja |
| VERANSTALTER1...n | string | Es wird nach den angegebenen Veranstalternamen gefiltert | ja |
| VERANSTALTERID1...n | int | Es wird nach den angegebenen Veranstalter-IDs gefiltert | ja |
| VERANSTALTUNGID1...n | int | Es wird nach den angegebenen Veranstaltungs-IDs gefiltert | ja |
| VERSION | float |
Legt die Version der zu verwendenden Schnittstelle fest default: immer die aktuellste Version |
ja |
| ZEIGETAG | bool |
Nur bei ORDER=DATUM und ALLEUHRZEITEN=1 0: keine Ausgabe der jeweiligen Öffnungszeit einer Veranstaltung 1: bei jeder ausgegebenen Veranstaltung wird die Öffnungszeit mit ausgegeben, somit sieht man z.B. bei einer Ausstellung, die mehrmals vorkommen kann, um welchen Tag und welche Uhrzeit es sich genau handelt default: 0 |
ja |