geteventdetails

Funktion

Liefert alle Detail-Informationen zu einer oder mehreren Veranstaltungen. Nutzen Sie diese Funktion, um die Detailseite zu einer Veranstaltung aufzubauen oder um alle öffentlichen Verowa-Daten in Ihre Datenbank zu übernehmen – z.B. über einen täglich ausgeführten Cronjob.

Wenn Sie mit dieser Funktion auf einen Schlag alle Veranstaltungen abholen, wird aufgrund der Vielzahl an zusammengeführten Daten eine vergleichsweise hohe Serverlast erzeugt. Bitte nutzen Sie diese Möglichkeit verantwortungsbewusst. Um Ihren Datenbestand stets aktuell zu halten, gibt es bessere Möglichkeiten als hochfrequente Cronjobs.

Resource URL

https://api.verowa.ch/geteventdetails/:instance/:apikey/:event-ids/

Parameter

  • Ihr Instanzname :instance
  • Ihr API-Key :apikey
  • Veranstaltungs-IDs :event-ids (mehrere Veranstaltungen können mit Kommata getrennt werden z.B. 21383,22761); 0 = alle Veranstaltungen

Beispiele

Details zu allen aktuellen Veranstaltungen:

GET https://api.verowa.ch/geteventdetails/demo/8209042b1786e26c355d4aea1b8c7b79/0

Details zum Event 21383:

GET https://api.verowa.ch/geteventdetails/demo/8209042b1786e26c355d4aea1b8c7b79/21383
Die API gibt nur Veranstaltungen aus, die noch nicht ganz vergangen sind. Der obige Link wird deshalb kein Resultat liefern. Dazu müsste eine aktuelle Event-ID mitgegeben werden. Falls Sie Veranstaltungen archivieren möchten – z.B. damit Permalinks von Flyern oder Newslettern auch ein paar Tage nach dem Anlass noch funktionieren –, müssen Sie die Daten lokal vorhalten.
Diese Funktion gibt temporär noch mehr Angaben aus, als hier dokumentiert sind, teilweise dieselben, aber in anders benannten Feldern. Alle Felder, die hier nicht aufgeführt sind, gelten als veraltet und sollten nicht mehr verwendet werden.

Server-Antwort (Muster)

[
	{
		"event_id": "33131", [i]
Laufnummer, wird von Verowa vergeben; ist innerhalb einer Installation einzigartig



		"date_from": "2023-10-04 10:00:00", [i]
Lokale Zeit



		"date_to": "2023-10-04 11:00:00",
		"date_text": "Mittwoch, 4. Oktober 2023, 10.00–11.00 Uhr", [i]
Falls die Veranstaltung mehrtägig ist, werden die Angaben ebenfalls gut lesbar zusammengestellt



		"hide_time": "0", [i]
soll die Uhrzeigt verborgen werden? (z.B. für ganztägige Veranstaltungen)



		"state": "definite" [i]
Status der Veranstaltung: «planned», «definite» oder «canceled»; viele Pfarreien sind so konfiguriert, dass Veranstaltungen in Planung über die API nicht ausgegeben werden, annullierte aber schon, um darauf hinzuweisen, dass der Anlass abgesagt wurde; in diesem Fall gibt die API meistens im Titel schon einen entsprechenden Hinweis mit, z.B. «ABGESAGT: »



		"title": "Eucharistiefeier", [i]
falls die Veranstaltung annulliert wurde (siehe Feld «state», ergänzt die API je nach Konfiguration im Titel einen entsprechenden Hinweis, z.B. «ABGESAGT»



		"topic": "", [i]
Thema, Untertitel (wird nicht bei allen Verowa-Installationen verwendet)



		"short_desc": "", [i]
Kurztext (wird nicht bei allen Verowa-Installationen verwendet)



		"long_desc": "", [i]
hat immer HTML-Tags, mindestens sind die Absätze mit <p>-Tags ausgezeichnet



		"organizer": { [i]
Kontaktperson mit Hauptverantwortung (falls die Person ausgeblendet ist, sind diese Felder leer)



			"name": "Quentin Baumgartner", [i]
firstname und lastname zusammengehängt



			"firstname": "Quentin",
			"lastname": "Baumgartner",
			"person_id": "50",
			"phone": "044 331 71 77", [i]
nur öffentliche Telefonnummern werden angezeigt



			"profession": "", [i]
Berufsbezeichnung, z.B. «Organistin»



			"email": "q.baumgart@verowa.ch",
			"url": "/personen/qbaumgart", [i]
je nach url_type relativ (1, 2) oder absolut (3)



			"url_type": "1" [i]
URL führt zu: 1 = lokale Detailseite; 2 = lokale Personenliste; 3 = externe Webseite



		},
		"coorganizers": [], [i]
ein Array von Personen-Arrays, aufgebaut wie der Organizer (siehe oben)



		"further_coorganizer": "", [i]
ein Freitext mit weiteren Personen, die nicht als Verowa-Personen erfasst sind (z.B. Solisten oder Aushilfen)



		"service1": [], [i]
ein Array von Personen-Arrays, aufgebaut wie der Organizer (siehe oben)



		"service1_label": "LektorInnen", [i]
je nach Konfiguration haben diese Dienste eine andere Bedeutung



		"service4": [], [i]
es gibt bis zu 8 Dienste, aber nicht alle müssen öffentlich sein



		"service4_label": "OrganistInnen",
		"catering": "Grillieren", [i]
Angabe zur Gastronomie



		"with_sacrament": 0, [i]
mit Abendmahl? (0 oder 1, kann je nach Konfiguration auch für ein anderes Attribut verwendet werden)



		"childcare_id": "2", [i]
ID des Kinderhüte-Angebots, wird in childcare_text erläutert; die Angebote können bei jeder Konfiguration anders sein



		"childcare_text": "Kinderhüte",
		"childcare_person": [], [i]
Angaben zur Person, die fürs Kinderhüte-Angebot zuständig ist; aufgebaut wie der Organizer (siehe oben)



		"additional_text1": "", [i]
Inhalt des ersten von vier freien Textfeldern; sie sind je nach Konfiguration anders eingesetzt; das Label erläutert den Einsatzzweck.



		"additional_text1_label": "Todesfälle/Taufen im Pastoralraum",
		...
		"additional_text4": "",
		"additional_text4_label": "Zusätzliches Textfeld 4",
		"subs_module_active": true, [i]
Ist das Anmelde-Zusatzmodul grundsätzlich aktiviert? (Das sagt nichts darüber aus, ob es für die Veranstaltung eine Anmeldemöglichkeit gibt! Verwenden Sie dazu das Feld subs_state.)



		"subs_deadline": "2022-01-27 23:59:59", [i]
Anmeldeschluss (falls nur ein Datum ohne Zeit gilt, gibt Verowa 23:59:59 aus; wir empfehlen, in diesem Fall die Zeit nicht anzuzeigen)



		"subs_last_days": true, [i]
true, wenn es nur noch wenige Tage bis zum Anmeldeschluss dauert (ggf. für entsprechenden Hinweis)



		"subs_state": "deadline_expired", [i]
Zustand der Anmeldungen: none (= Veranstaltung ohne Anmeldemöglichkeit), subs_link (= Link zum Anmeldeformular gültig), deadline_expired (= Anmeldefrist abgelaufen), waiting_list (= ausgebucht, neue Anmeldungen kommen auf die Warteliste), booked_up (= ausgebucht, es wird keine Warteliste geführt), no_subs_form (= es gibt kein Verowa-Anmeldeformular, typischerweise wenn die Anmeldung über einen externen Dienst erfolgen muss)



		"participants_max": "30", [i]
max. Teilnehmerzahl (0 = unbegrenzt)



		"seats_available": 24, [i]
max. online buchbare Plätze



		"subs_last_seats": false, [i]
true, wenn es nur noch wenige Plätze gibt (ggf. für entsprechenden Hinweis)



		"url_event_details": "https://.../veranstaltung/3511", [i]
URL, die dem Details-Button hinterlegt werden kann



		"subs_button_text": "Anm. abgelaufen" [i]
Beschriftung für den Anmeldeknopf



		"subs_button_helptext": "Der Anmeldeschluss ist vorbei." [i]
Tooltip/Hilfetext für den Anmeldeknopf



		"subs_button_active": true [i]
wenn false, muss der Knopf disabled sein (z.B., wenn der Anmeldeschluss vorbei ist oder alle Plätze belegt sind



		"baptism_offer_id": "1", [i]
ID des Taufangebots, wird in baptism_offer_text erläutert; die Angebote können bei jeder Konfiguration anders sein



		"baptism_offer_text": "keine Taufen",
		"collection": { [i]
Angaben zur Kollekte, falls zugewiesen



			"project": "Christoffel Blindenmission", [i]
Bezeichnung des unterstützten Werks



			"url": "https://cbmswiss.ch" [i]
vollständige URL zu weiteren Informationen des unterstützten Werks



		}
		"target_groups": [ [i]
zugeordnete Zielgruppen



			{
				"id": "4",
				"url": "/node/237", [i]
interner, relativer Link zur entsprechenden Unterseite; wird in Verowa hinterlegt



				"text": "Familien mit Jugendlichen von 16 bis 20 Jahren"
			}
		],
		"layers": [ [i]
zugeordnete Bereiche (Kategorien); in Verowa sind die Bereiche als Baum angelegt; die API gibt fürs einfache Handling automatisch alle Parents in einer flachen Struktur mit; die Baumstruktur können Sie mit getlayers abholen



			{
				"id": "73",
				"text": "Gottesdienst festlich",
				"url": "/node/294" [i]
interner, relativer Link zur entsprechenden Unterseite; wird in Verowa hinterlegt



			},
			{
				"id": "74",
				"text": "Gottesdienste & Andachten",
				"url": "/node/48"
			}
		],
		"rooms": [ [i]
jede Veranstaltung kann mehrere Räume/Orte belegen; normalerweise soll nur der erste angezeigt werden, quasi als Treffpunkt



			{
				"id": "1", [i]
Raum-ID (INT), z.B. für get_rooms; leer falls Freitext



				"name": "Saal", [i]
Raumbezeichnung oder Ort als Freitext



				"location_name": "Kirchgemeindehaus", [i]
Gebäude, in dem sich der Raum befindet, oder Ort als Freitext



				"location_address": "Ackersteinstrasse 190", [i]
kann auch leer sein



				"location_postcode": "8049", [i]
kann auch leer sein



				"location_city": "Zürich", [i]
kann auch leer sein



				"location_url": "/kgh", [i]
URL zur Seite, die das Gebäude beschreibt; wird in Verowa hinterlegt; je nach location_url_is_external absolut oder relativ ab dem Root



				"location_url_is_external": false, [i]
ist die URL eine externe Seite?



				"order": 1 [i]
kann auch leer sein



			}
		],
		"files": [ [i]
kann auch leer sein



			{
				"url": "https://secure.verowa.ch/users/demo/docs/events/010563/Sprachtreffen.pdf", [i]
vollständige URL zur Datei auf dem Verowa-Server



				"filesize_kb": 778 [i]
Dateigrösse in KB, gerundet



				"file_type": "PDF", [i]
Art der Datei, z.B. «PDF», «Word», «Excel», «PowerPoint» oder «Text»



				"desc": "Info-Flyer", [i]
Bezeichnung, kann auch leer sein



				"hash": "a1564c8cc2b76ca22e049cbc0e9772f5" [i]
Hash-String zur Versionskontrolle; falls Sie die Dateien lokal abspeichern, können Sie anhand des Hashs bestimmen, ob Sie die Datei neu importieren müssen



			}
		],
		"image": { [i]
kann auch leer sein



			"url": "https://secure.verowa.ch/users/demo/images/comp/7OKe2kTflaDHfLIa7e95wd.jpg", [i]
vollständige URL zur Bilddatei auf dem Verowa-Server; Bilder aus Verowa sind gemäss Konfiguration passend skaliert und/oder zugeschnitten



			"width": "1600", [i]
Breite in Pixeln



			"height": "1200", [i]
Höhe in Pixeln



			"thumb_url": "https://secure.verowa.ch/users/demo/images/comp/7OKe2kTflaDHfLIa7e95th.jpg", [i]
vollständige URL zur Thumbnail-Bilddatei auf dem Verowa-Server; verkleinerte Version für schnelle Listenansichten



			"caption": "Gute Laune am letztjährigen Kirchenfest", [i]
Bildlegende, kann auch leer sein



			"source_text": "Fritz Bucher", [i]
Quellenangabe



			"source_url": "", [i]
URL zur Quelle (z.B. Pixabay), kann auch leer sein



			"hash": "1267abe4b167605c0179f36b52b01b1a" [i]
Hash-String zur Versionskontrolle; falls Sie die Bilder lokal abspeichern, können Sie anhand des Hashs bestimmen, ob Sie die Datei neu importieren müssen



		}
	}
]