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 bei Bedarf zusätzlich zum Formular ausgeben können.

Je nach Einsatzzweck können Sie das Formular neu aufbauen oder nach einer erfolgten Anmeldung als Folgeformular ausgeben. In diesem Fall wird Verowa das Formular bereits mit einigen Werten befüllen. Diese Funktion ist bei den Usern sehr beliebt, weil sie so mehrere Personen hintereinander anmelden können, ohne alle Felder neu ausfüllen zu müssen. Welche Werte übernommen werden (z.B. Nachname ja, Vorname nein), wird in Verowa je nach Formular individuell konfiguriert.

Aufruf

Resource URL
https://api.verowa.ch/get_subscription_form

Parameter als POST-Anfrage
HEADER (Beispiel):
apikey:8209042b1786e26c355d4aea1b8c7b78
member:demo

BODY (JSON, Beispiel für neues Formular):

{
	"event_id": 2581,
}

BODY (JSON, Beispiel für Folgeformular):

{
	"subs_id": 307,
}

Antwort

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

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

	"datetime_to": "2023-10-04 11:00:00",
	"datetime_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": false, [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)

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

	"subs_state": "subs_link", [i]
Zustand der Anmeldungen: 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 Anmeldeformular, typischerweise wenn die Anmeldung über einen externen Dienst erfolgen muss), canceled (die Veranstaltung ist annulliert), none (= es ist keine Anmeldung vorgesehen)

	"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); falls es keinen Anmeldeschluss gibt, wird Verowa hier die Start-Datetime der Veranstaltung einsetzen

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

	"seats_available": 21, [i]
noch verfügbare Plätze (–1 = unbegrenzt)

	"max_seats_per_subs": 6, [i]
max. Plätze pro Anmeldung (0 = unbegrenzt)

	"subs_formfields": [
		{
			detaillierte Feldbeschreibungen 
		}
	],
	"subs_form_text": "Für diese Veranstaltung ist die Anmeldung obligatorisch.", [i]
Info-Text über dem Anmeldeformular; je nach Anmeldeformular unterschiedlich

	"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

}

Zurück