Funktionsreferenz – API Dokumentation

get_childcare_options

Funktion Jede Kirchgemeinde kann selbst Kinderhüte-Optionen wählen. Mit dieser Funktion können Sie die definierte Liste abrufen. So ist es möglich, Angebote aus den Veranstaltungsdetails z.B. direkt mit einer Seite zu…

get_doc_by_id

Funktion Liefert den Inhalt eines einzelnen öffentlichen Dokuments im Base64-Format. Die können mit dieser Funktion die vom Benutzer gewünschten Dateien on the fly abholen oder sie intern auf Ihrem Webserver…

get_docs_by_group

Funktion Liefert alle oder einzelne öffentliche Dokumentegruppen inklusive Angaben zu den darin enthaltenen öffentlichen Dokumenten aus Verowa zurück, damit diese im Frontend einer Webseite aufgelistet werden können. Aus Performancegründen enthält…

get_events

Funktion Liefert eine Liste mit allen aktuellen Veranstaltungen. Sie können die Abfrage durch einige allgemeine Parameter eingrenzen, um z.B. eine Anzeige nach Monaten oder einzelnen Seiten zu generieren, ohne dass…

get_events_by_group

Funktion Liefert eine Liste von Veranstaltungen zu einer Zielgruppe, z.B. einer Altersgruppe (siehe get_target_groups). Falls Sie mehrere Zielgruppen-IDs übergeben, wird die Schnittmenge der Ergebnisse abgefragt, nicht die Summe. So können…

get_events_by_group_merged

Funktion Liefert eine Liste von Veranstaltungen zu einer Zielgruppe, z.B. einer Altersgruppe (siehe get_target_groups). Falls Sie mehrere Zielgruppen-IDs übergeben, wird die Summe der Ergebnisse abgefragt, nicht die Schnittmenge. So können…

get_events_by_ids

Funktion Liefert eine Liste von Veranstaltungen nach Veranstaltungs-IDs. Dies ist insbesondere nützlich, falls Sie eine freie Liste zusammenstellen möchten, die nicht über Zielgruppen, Bereiche, Serien oder Ähnliches definiert werden kann,…

get_events_by_keyword

Funktion Liefert eine Liste von Veranstaltungen nach Suchbegriffen. Falls Sie mehrere Begriffe übergeben, wird die Schnittmenge der Ergebnisse abgefragt, nicht die Summe. Sie können die Abfrage durch weitere Parameter eingrenzen,…

get_events_by_layer

Funktion Liefert eine Liste von Veranstaltungen zu einem Bereich, z.B. rpg, Kirchenchor oder «nur für Frauen» (siehe get_layers). Falls Sie mehrere Bereichs-IDs übergeben, wird die Schnittmenge der Ergebnisse abgefragt, nicht…

get_events_by_layer_merged

get_events_by_list

Funktion Liefert eine Liste von Veranstaltungen anhand einer VEROWA-Listendefinition (siehe z.B. get_listnames_by_group). Diese Funktion ist sehr praktisch, um eine Veranstaltungsliste auf statischen Seiten zusammenzustellen, da die Konfiguration der Liste nicht…

get_events_by_list_merged

get_events_by_series

Funktion Liefert eine Liste von Veranstaltungen aus einer VEROWA-Serie. Serien werden meistens dazu benutzt, wiederkehrende Veranstaltungen zu gruppieren. Falls Sie mehrere Serien-IDs übergeben, wird die Summe der Ergebnisse abgefragt, nicht…

get_layername_by_id

Funktion Den Veranstaltungen können Bereiche zugeordnet werden. Über diese Bereiche lassen sich Veranstaltungslisten zusammenstellen, z.B. «nur für Frauen», «Fiire mit de Chliine» oder «niederschwellige Angebote». Mit dieser Funktion können Sie…

get_layers

Funktion Mit dieser Funktion rufen Sie eine Liste aller Bereiche ab. Mit den Angaben können Sie z.B. auf einer Übersichtsseite alle Bereiche ausgeben, verlinkt mit den entsprechenden Detailseiten, oder Sie…

get_listnames_by_id

Funktion Anhang von einer oder mehreren Listen-IDs können Sie die Titel holen. Falls für eine Liste ein spezieller öffentlicher Titel definiert ist, wird dieser verwendet, ansonsten der interne. Wenn Sie…

get_locations

Funktion Mit dieser Funktion rufen Sie eine vollständige Liste aller erfassten Gebäude ab. Mit den Angaben können Sie z.B. auf einer Übersichtsseite alle Gebäude ausgeben, verlinkt mit den entsprechenden Detailseiten,…

get_person_details

Funktion Diese Funktion liefert Details zu einer einzelnen Person anhand ihrer ID. Sie ist gedacht, um Detailseiten anzuzeigen, deshalb ist der Detailgrad höher als bei Funktionen, die für Listen gedacht…

get_person_groups

Funktion Es gibt verschiedenste Personengruppen (Kirchenpflege, Pfarrteam, Gemeindedienst etc.). Eine Person kann mehreren Gruppen zugewiesen werden. Mit dieser Funktion verschaffen Sie sich einen Überblick über die öffentlich sichtbaren Gruppen und…

get_persons_by_group

Funktion Diese Funktion liefert eine Liste mit mehreren Personen anhand ihrer Gruppe, z.B. des Pfarrteams oder der Kirchenpflege. (Angaben zur Person werden nur übermittelt, wenn die Person im Web sichtbar…

get_persons_by_id

Funktion Diese Funktion liefert eine Liste mit einer oder mehreren Personen anhand ihrer IDs. (Angaben zur Person werden nur übermittelt, wenn die Person im Web sichtbar sein möchte.) Um den…

get_rooms

Funktion Verwenden Sie diese Funktion, um eine Liste aller in VEROWA eingetragener Räume zu erhalten. Die Einträge umfassen neben dem Raumnamen jeweils auch eine Verknüpfungs-ID zum Gebäude sowie dessen Bezeichnung…

get_roster_entries

Funktion Liefert Einträge zu einem bestimmten Dienstplan. Sie können die Abfrage durch einige allgemeine Parameter eingrenzen, um z.B. eine zeitliche Eingrenzung zu definieren. Eingabe • ID des Dienstplans (INT), z.B. 2…

get_subscription_form (POST)

Funktion Liefert die detaillierten Informationen zu den Feldern eines Anmeldeformulars. Ausserdem gibt diese Funktion einige allgemeine Angaben zur Veranstaltung zurück wie den Titel und die Start-Datetime, damit Sie diese Angaben…

get_target_groups

Funktion Mit dieser Funktion rufen Sie eine Liste aller Zielgruppen ab. Mit den Angaben können Sie z.B. auf einer Übersichtsseite alle Zielgruppen ausgeben, verlinkt mit den entsprechenden Detailseiten, oder Sie…

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…

geteventlistgroups

Funktion Gibt die in Verowa definierten öffentlichen Listengruppen zurück. Eine gute Grundlage für getlistsbygroup, um sich einen Überblick über die Struktur zu verschaffen. Resource URL https://api.verowa.ch/geteventlistgroups/:instance/:apikey/ Parameter Instanzname :instance API…

getevents

Funktion Liefert eine Liste mit allen aktuellen Veranstaltungen. Resource URL https://api.verowa.ch/getevents/:instance/:apikey Parameter – Instanzname :instance – API Key :apikey Beispielanfrage GET https://api.verowa.ch/getevents/demo/8209042b1786e26c355d4aea1b8c7b79 Ausführliche Feldbeschreibung get_events Server Antwort { «total_events_nbr»: 114,…

geteventsbygroup

Liefert eine Liste von Veranstaltungen zu einer Zielgruppe, z.B. einer Altersgruppe.

geteventsbylayermerged

Funktion Liefert eine Liste von Veranstaltungen anhand einer VEROWA-Bereichs-ID. Diese Funktion ist sehr praktisch, um eine Veranstaltungsliste auf statischen Seiten zusammenzustellen, da die Konfiguration des Bereichs nicht im CMS erfolgt,…

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…

geteventsbylistfromdate

Funktion Liefert eine Liste von Veranstaltungen anhand einer VEROWA-Listendefinition (siehe z.B. getlistnamesbygroup). Diese Funktion ist sehr praktisch, um eine Veranstaltungsliste auf statischen Seiten zusammenzustellen, da die Konfiguration der Liste nicht…

getholidays

Funktion Liefert alle in VEROWA hinterlegten Schulferien sowie Feier- und Spezialtage ab dem aktuellen Datum. Eingabe – Ausgabe

getlayers

Funktion Liefert eine Liste von allen angelegten Bereichen aus VEROWA Resource URL https://api.verowa.ch/getlayers/:instance/:apikey_get/ Parameter – Instanzname :instance – API Key :apikey Ausführliche Feldbeschreibung get_layers Beispielanfrage GET https://api.verowa.ch/getlayers/demo/8209042b1786e26c355d4aea1b8c7b79 Server Antwort […

getlistsbygroup

Funktion Anhand von einer oder mehreren Listengruppen-IDs (aus geteventlistgroups) können Sie die entsprechenden Titel holen. Falls für eine Liste ein spezieller öffentlicher Titel definiert ist, wird dieser verwendet, ansonsten der…

getpersondetails

getpersongroups

getpersonsbygroup

getpersonsbyid

Funktion Diese Funktion liefert eine Liste mit einer oder mehreren Personen anhand ihrer IDs. (Angaben zur Person werden nur übermittelt, wenn die Person im Web sichtbar sein möchte.) Um den…

getrooms

getrosterentries

Funktion Liefert Einträge zu einem bestimmten Dienstplan. Resource URL https://api.verowa.ch/getrosterentries/:instance/:apikey/:id/ Parameter – Instanzname :instance – API Key :apikey – Plan ID :id Ausführliche Feldbeschreibung get_roster_enttries Beispielanfrage https://api.verowa.ch/getrosterentries/demo/67971d0749a26ed4767c21990ff2a9da/1 Server Antwort […