geteventsbylist

Funktion

Liefert eine Liste von Veranstaltungen anhand einer VEROWA-Listendefinition (siehe z.B. getlistsbygroup). Diese Funktion ist sehr praktisch, um eine kurze gefilterte Liste auf statischen Seiten zusammenzustellen – z.B. die nächsten fünf Gottesdienste mit Taufangebot –, da die Konfiguration der Liste nicht im CMS erfolgt, sondern in VEROWA. Damit hat der Admin. die Möglichkeit, die Liste anzupassen, ohne ins CMS einzugreifen.

Falls Sie mehrere Listen-IDs übergeben, wird die Schnittmenge der Ergebnisse abgefragt, nicht die Summe. Damit können Sie z.B. eine Liste mit allen Gottesdiensten mit einer Liste aller Anlässe in der Kirche kreuzen, um alle Gottesdienste in der Kirche zu erhalten.

Sie können die Abfrage durch weitere Parameter eingrenzen, um z.B. die Liste auf mehrere Seiten aufzuteilen, ohne dass beim Seiten wechseln jedes Mal alle Veranstaltungen übertragen werden müssten. In jedem Fall werden nur Veranstaltungen angezeigt, deren Endzeitpunkt noch nicht vorbei ist.

Struktur

https://api.verowa.ch/geteventsbylist/:instance/:apikey/:id/:offset/:max_events/

Parameter

  • Instanzname :instance
  • API Key :apikey
  • Listen-ID :id (mehrere können mit Kommata getrent werden, z.B. 122,123)
  • Offset (so viele Ergebnisse werden vom Anfang her übersprungen) :offset
  • maximale Anzahl von Events (0 = alle) :max_events

Server-Antwort

  • total_events_nbr (INT): Anzahl der Veranstaltungen in der gesamten Liste. Auch wenn Sie die Anzahl über max_events eingeschränkt haben, werden hier alle gezählt. So können Sie etwa bei einer geteilten Liste für die Seitennavigation ausrechnen, wie viele Seitenzahlen dargestellt werden müssen.
  • events (ARRAY)
    • event_id (INT): laufende Veranstaltungsnummer (innerhalb der Verowa-Installation eindeutig)
    • state (STRING): Status: «definite», «planned» oder «canceled». In den meisten Fällen werden nur definitive Veranstaltungen über die API ausgegeben. Je nach Konfiguration können aber auch geplante oder annullierte Veranstaltungen ausgegeben werden. Gerade in der Corona-Zeit war es wichtig, auch kurzfristig annullierte Veranstaltungen anzuzeigen, um den Besucher*innen Gewissheit zu geben. In diesem Fall kann Verowa auf Wunsch dem Titel einen entsprechenden Zusatz mitgeben, z.B. «Sonntagsgottesdienst (ABGESAGT)»
    • event_type (INT): 1 = kirchliche Veranstaltung, 2 = externe Vermietung, 3 = Sperrzeit. In den meisten Fällen werden nur kirchliche Veranstaltungen ausgegeben. Je nach Konfiguration können aber auch Vermietungen übertragen werden, was z.B. für Kongresszentren wichtig sein kann.
    • date_from (STRING): Startdatum und -zeit, Format «JJJJ-MM-DD HH:MM:SS»
    • date_to (STRING): Enddatum und -zeit
    • hide_time (BOOL): Soll die Uhrzeit verborgen werden? Das kann z.B. sinnvoll sein, wenn die Zeit erst provisorisch eingetragen ist.
    • date_text (STRING): z.B. «Montag, 6. Mai 2024, 15.00–17.00 Uhr» als HTML-Code (vor «Uhr» gibt es z.B. ein  -Zeichen, um dort den Zeilenumbruch zu verhindern)
    • title (STRING): Titel/Bezeichnung der Veranstaltung, evtl. mit automatischem Zusatz (siehe state)
    • topic (STRING): Thema der Veranstaltung (meistens leer)
    • short_desc (STRING): Kurzbeschreibung
    • long_desc (STRING): ausführliche Beschreibung im HTML-Format, kann z.B. auch Inline-Links enthalten
    • organizer (ARRAY): Veranstalter/in
      • id (INT): Personen-ID, z.B. für getpersondetails
      • name (STRING): Vor- und Nachname
      • phone (STRING): Telefonnummer. Verowa verwaltet separate Nummern fürs Geschäft und für privat, jeweils Mobile und Festnetz. Sie werden nur herausgegeben, wenn sie als öffentlich gelten. In diesem Feld erscheint immer max. eine öffentliche Nummer.
      • profession (STRING): Berufsbezeichnung
      • email (STRING): E-Mail-Adresse
    • childcare_id (INT): ID des Kinderhüte-Angebots (siehe get_childcare_options)
    • subscription (BOOL): Anmeldung erforderlich? Anhand dieser Angabe können Sie in einer Veranstaltungsliste bereits vermerken, wenn zu einer Veranstaltung eine Anmeldung nötig ist.
    • subscribe_date (STRING): Anmelde-Datum, Format «JJJJMMDD»
    • subscribe_time (STRING): Anmeldezeit, Format «HHMM» (leer, falls nicht spezifiziert)
    • subscribe_person_id (INT): Personen-ID, z.B. für getpersondetails; falls das Anmelde-Modul aktiv ist, enthält diese Angabe die ID des Formular-Templates (Details zum Formular siehe geteventdetails)
    • subscription_person_name (STRING): Vor- und Nachname
    • subscription_person_email (STRING): E-Mail-Adresse
    • baptism_offer_id (INT): ID des Taufangebots (Details zu den Taufangeboten siehe geteventdetails)
    • room (ARRAY): erster Ort. In Verowa können Veranstaltungen mehrere Räume belegen. Hier wird aber nur der erste angegeben, quasi als Treffpunkt. In den Verowa-Schulungen betonen wir regelmässig, dass der «erste Ort» in dieser Beziehung etwas Spezielles ist.
      • id (INT): Raumnummer, z.B. für getrooms. In Verowa kann man statt einem Raum aus der konfigurierten Liste auch einen Freitext einsetzen, z.B. «Wiese hinter der Kirche» oder «Kiosk beim Hauptbahnhof». In diesem Fall ist diese ID 0.
      • name (STRING): Raumbezeichnung oder Freitext (siehe oben).
      • public_name (STRING): falls speziell eine öffentliche Bezeichnung erfasst ist, verwenden Sie bitte ausschliesslich diese; sie wird dann auch das Gebäude beinhalten, z.B. «Aula Pfarreizentrum».
      • location_id (INT): Gebäudenummer. Alle Räume in Verowa müssen einem Gebäude zugeordnet sein.
      • location_name (STRING): Bezeichnung des Gebäudes. Viele Gemeinden möchten in den Veranstaltungslisten auf der Webseite nur das Gebäude angezeigt haben statt dem Raum.
      • loc_public_name (STRING): ggf. für Auswärtige klarere Bezeichnung
      • address (STRING): Strasse, Nr.
      • postcode (STRING): Postleitzahl
      • city (STRING): Ort
      • location_url (STRING): URL zur Seite, die das Gebäude beschreibt. Falls es um eine interne URL geht (siehe location_url_is_external), ist hier nur der Teil hinter der Domain angegeben.
      • location_url_is_external (BOOL): Verweist die URL auf eine externe Seite? Falls ja, können Sie den Link in einem neuen Fenster öffnen.

Bitte beachten Sie, dass jede Verowa-Installation gemäss den Kundenwünschen etwas anders konfiguriert ist. So ist es deshalb möglich, dass Felder wie das Thema (topic) oder die Kurchbeschreibung (short_desc) nicht aktiv sind, um das Eingabeformular zu vereinfachen. In diesem Fall sind diese Felder einfach leer.

Beispielanfrage

GET https://api.verowa.ch/geteventsbylist/demo/8209042b1786e26c355d4aea1b8c7b79/7756/0/10