Funktionsreferenz

get_doc_by_id

Funktion Liefert ein öffentliches Dokument aus Verowa zurück. Diese Funktion, dauert je nach Dokumentengrösse so lange, wie die Leitung braucht. Der Grund, warum das so gepaselt wurde, liegt in der…

get_docs_by_group

Funktion Liefert alle oder einzelne öffentliche Dokumentengruppen inklusive der der angelgten Dokumente aus Verowa zurück, damit diese im Front-End einer Webseite angezeigt werden können. Diese Methode enthält nicht den Inhalt…

get_doc_groups

Funktion Liefert alle öffentlichen Dokumentengruppen aus Verowa zurück, damit diese im Backend einer Webseite ausgewählt werden können. Resource URL https://api.verowa.ch/get_doc_groups/:instance/:apikey Parameter – Diese Funktion hat keine Paramter Beispielanfrage GET https://api.verowa.ch/get_doc_groups/demo/8209042b1786e26c355d4aea1b8c7b79…

*_with_images

Sie können jede Listen-SOAP-Funktion mit dem Anhang _with_images verwenden, so z.B get_events_by_list_with_images(). Als Rückgabewert erhalten Sie dann zusätzlich das Feld «image_url».

getnlsubscriberfrom

Liefert eine Beschreibung der benötigten Felder des Newsletter-Formulars. Damit und mit updatenlsubscriber wird die Verowa-Newsletter-Registration umgesetzt.

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 […

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,…

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…

getpersonsbygroup

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…

status

Funktion Zeigt an, ob die Verowa Datenbank erreichbar ist. Resource URL https://api.verowa.ch/status Parameter Keine Beispielanfrage GET https://api.verowa.ch/status Server Antwort The Verowa API is running. Please Request an API Key and…

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 […

getrooms

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…

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…

getpersongroups

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…

getpersondetails

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…

getlistsbygroup

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

geteventsbylist

Funktion Liefert eine Liste von Veranstaltungen anhand einer VEROWA-Listendefinition (siehe z.B. getlistnamesbygroup). Diese Funktion ist sehr praktisch, um eine kurze gefilterte Liste auf statischen Seiten zusammenzustellen – z.B. die nächsten…

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,…

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…

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_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_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_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_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_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_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_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_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_list_groups

Funktion Die Listen sind zur besseren Übersicht intern in Gruppen unterteilt (z.B. Raumbelegung, Kulinarium, Öffentlichkeitsarbeit, CMS etc.). Mit dieser Funktion verschaffen Sie sich einen Überblick über die definierten Gruppen. Mit…

get_listnames_by_group

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

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_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…

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_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…

getholidays

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

get_event_details

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 –…

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

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_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_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_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

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 Summe der Ergebnisse abgefragt, nicht…

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_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,…