Blackbaud Raisers Edge NXT-Ereignisse
Blackbaud Raiser es Edge NXT ist eine umfassende cloudbasierte Spenden- und Spendermanagement-Softwarelösung, die speziell für gemeinnützige Organisationen und die gesamte soziale Gute Community entwickelt wurde. Verwenden Sie den Ereignisconnector, um Ereignisse und Teilnehmer zu verwalten.
Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:
| Dienstleistung | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Logik-Apps | Norm | Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche: – Azure Government-Regionen - Azure China-Regionen - US Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps-Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Kontakt | |
|---|---|
| Name | Blackbaud Support |
| URL | https://www.blackbaud.com/support |
| skyapi@blackbaud.com |
| Connectormetadaten | |
|---|---|
| Herausgeber | Blackbaud, Inc. |
| Webseite | https://www.blackbaud.com/products/blackbaud-raisers-edge-nxt |
| Datenschutzrichtlinie | https://www.blackbaud.com/privacy-shield |
| Kategorien | Vertrieb und CRM; Produktivität |
Raisers Edge NXT ist eine umfassende cloudbasierte Spenden- und Spendermanagement-Softwarelösung, die speziell für gemeinnützige Organisationen und die gesamte soziale Gute Community entwickelt wurde.
Dieser Connector basiert auf der SKY-API von Blackbaud und bietet Vorgänge zur Verwaltung von Ereignissen und verwandten Entitäten, die in The Raisers Edge NXT gefunden wurden, einschließlich:
- Ereignisse
- Teilnehmer
- Gebühren und Spenden
- und vieles mehr...
Weitere Informationen finden Sie in der Dokumentation.
Voraussetzungen
Um diesen Connector zu verwenden, müssen Sie über ein Blackbaud ID-Konto mit Zugriff auf eine oder mehrere Blackbaud-Umgebungen verfügen.
Darüber hinaus muss der Administrator Ihrer Organisation auch eine Aktion auf Administratorebene innerhalb des Systems ausführen, damit dieser Connector auf Ihre Blackbaud-Umgebung zugreifen kann. Weitere Informationen zu diesen Voraussetzungen finden Sie in der Ersteinrichtungsdokumentation .
Wie erhalten Sie Anmeldeinformationen?
Der Administrator Ihrer Organisation sendet Ihnen eine Einladung zur Edge NXT-Umgebung der Organisation und konfiguriert Ihre Benutzerkontoberechtigungen innerhalb der Umgebung. Für die Verwendung dieses Connectors sind keine zusätzlichen Anmeldeinformationen erforderlich.
Bekannte Probleme und Einschränkungen
Der Connector wird im Kontext Ihres Benutzerkontos ausgeführt und unterliegt daher Ihren Benutzerberechtigungen innerhalb der Umgebung.
Drosselungsgrenzwerte
| Name | Aufrufe | Verlängerungszeitraum |
|---|---|---|
| API-Aufrufe pro Verbindung | 100 | 60 Sekunden |
Aktionen
| Abrufen eines Ereignisses |
Gibt Informationen zu einem Ereignis zurück. |
| Abrufen eines Teilnehmers |
Gibt Informationen zu einem bestimmten Ereignisteilnehmer zurück. |
| Aktualisieren einer Ereignisanlage |
Aktualisiert eine Ereignisanlage. |
| Aktualisieren einer Teilnehmeroption |
Aktualisiert die Details zu einer Teilnehmeroption. |
| Aktualisieren eines Ereignisses |
Aktualisiert die Details zu einem Ereignis. |
| Aktualisieren eines Teilnehmers |
Aktualisiert die Details zu einem Teilnehmer. |
| Auflisten von Veranstaltungsgebühren |
Listet die Gebühren für ein Ereignis auf. |
| Ereignis erstellen |
Erstellt ein neues Ereignis. |
| Ereignisse auflisten |
Gibt eine Liste von Ereignissen zurück. |
| Ereignisteilnehmer auflisten |
Listet die Teilnehmer für ein Ereignis auf. |
| Erstellen einer Ereignisanlage |
Erstellt eine neue Ereignisanlage. |
| Erstellen einer Ereignisteilnehmeroption |
Erstellt eine neue Teilnehmeroption für ein Ereignis. |
| Erstellen einer Teilnehmergebühr |
Erstellt eine neue Gebühr für einen Teilnehmer. |
| Erstellen einer Teilnehmergebühr |
Erstellt eine neue Gebührenzahlung für einen Teilnehmer. |
| Erstellen einer Teilnehmeroption |
Erstellt eine neue Teilnehmeroption für einen Teilnehmer. |
| Erstellen einer Teilnehmerspende |
Erstellt eine neue Spende für einen Teilnehmer. |
| Erstellen einer Veranstaltungsgebühr |
Erstellt eine neue Gebühr für ein Ereignis. |
| Erstellen eines Teilnehmers |
Erstellt einen neuen Teilnehmer für ein Ereignis. |
| Listenereignisanlagen |
Listet die Anlagen für ein Ereignis auf. |
| Optionen für Ereignisteilnehmer auflisten |
Listet die Teilnehmeroptionen für ein Ereignis auf. |
| Teilnehmergebühren auflisten |
Listet die Gebühren für einen Teilnehmer auf. |
| Teilnehmergebührzahlungen auflisten |
Listet die Gebührenzahlungen für einen Teilnehmer auf. |
| Teilnehmeroptionen auflisten |
Listet die Teilnehmeroptionen für einen Teilnehmer auf. |
| Teilnehmerspenden auflisten |
Listet die Spenden für einen Teilnehmer auf. |
Abrufen eines Ereignisses
Gibt Informationen zu einem Ereignis zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Ereignis-ID
|
event_id | True | string |
Die Systemdatensatz-ID des abzurufenden Ereignisses. |
Gibt zurück
Event
- Body
- EventApi.Event
Abrufen eines Teilnehmers
Gibt Informationen zu einem bestimmten Ereignisteilnehmer zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Teilnehmer-ID
|
participant_id | True | string |
Die Systemdatensatz-ID des Teilnehmers. |
Gibt zurück
Teilnehmer
- Body
- EventApi.Participant
Aktualisieren einer Ereignisanlage
Aktualisiert eine Ereignisanlage.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Ereignis-ID
|
event_id | True | string |
Die Systemdatensatz-ID des Ereignisses. |
|
Anlagen-ID
|
attachment_id | True | string |
Die Systemdatensatz-ID der zu aktualisierenden Anlage. |
|
Name
|
name | string |
Der Name der Anlage. Zeichenlimit: 150. |
|
|
Datum
|
date | date-time |
Das Datum der Anlage (z. B. '2020-09-18T04:13:56Z'). |
|
|
URL
|
url | string |
Die URL für die Anlage. Dies ist für Verknüpfungsanlagen erforderlich und gilt nicht für physische Anlagen. |
|
|
Stichwörter
|
tags | array of string |
Die tags, die der Anlage zugeordnet sind. |
Aktualisieren einer Teilnehmeroption
Aktualisiert die Details zu einer Teilnehmeroption.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Teilnehmeroptions-ID
|
option_id | True | string |
Die Systemdatensatz-ID der zu aktualisierenden Teilnehmeroption. |
|
Wert
|
option_value | True | string |
Die Antwort des Teilnehmers auf die Option. |
Aktualisieren eines Ereignisses
Aktualisiert die Details zu einem Ereignis.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Ereignis-ID
|
event_id | True | string |
Die Systemdatensatz-ID des zu aktualisierenden Ereignisses. |
|
Ereignisname
|
name | string |
Der Name des Ereignisses. |
|
|
Description
|
description | string |
Die Beschreibung des Ereignisses. |
|
|
Kategorie
|
name | True | string |
Der Kategoriename. |
|
Startdatum
|
start_date | date |
Das Startdatum des Ereignisses (z. B. "2020-09-18"). |
|
|
Startzeit
|
start_time | string |
Die Startzeit des Ereignisses (z. B. "07:30"). |
|
|
Enddatum
|
end_date | date |
Das Enddatum des Ereignisses (z. B. '2020-09-18'). |
|
|
Endzeitpunkt
|
end_time | string |
Die Endzeit des Ereignisses (z. B. "07:30"). |
|
|
Nachschlage-ID
|
lookup_id | string |
Die Nachschlage-ID des Ereignisses. |
|
|
Kapazität
|
capacity | integer |
Die Anzahl der Personen, die an der Veranstaltung teilnehmen können. |
|
|
Ziel
|
goal | double |
Das monetäre Ziel des Ereignisses. |
|
|
Kampagnen-ID
|
campaign_id | string |
Die Systemdatensatz-ID der Kampagne, die dem Ereignis zugeordnet ist. |
|
|
Fund-ID
|
fund_id | string |
Die Systemdatensatz-ID des Fonds, der dem Ereignis zugeordnet ist. |
|
|
Inaktiv?
|
inactive | boolean |
Ist das Ereignis aktiv? |
Aktualisieren eines Teilnehmers
Aktualisiert die Details zu einem Teilnehmer.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Teilnehmer-ID
|
participant_id | True | string |
Die Systemdatensatz-ID des zu aktualisierenden Teilnehmers. |
|
Bestandteil-ID
|
constituent_id | string |
Die Konstituierende ID des Teilnehmers. |
|
|
Host-ID
|
host_id | string |
Die ID des Teilnehmerdatensatzes des Hosts. |
|
|
RSVP-Status
|
rsvp_status | string |
Der Status des Engagements des Teilnehmers mit dem Ereignis. |
|
|
Besucht?
|
attended | boolean |
Hat der Teilnehmer an der Veranstaltung teilgenommen? |
|
|
Einladungsstatus
|
invitation_status | string |
Der Status der Einladung an den Teilnehmer. |
|
|
Tag
|
d | integer |
Der Tag im Fuzzydatum. |
|
|
Monat
|
m | integer |
Der Monat im Fuzzydatum. |
|
|
Jahr
|
y | integer |
Das Jahr im Fuzzydatum. |
|
|
Tag
|
d | integer |
Der Tag im Fuzzydatum. |
|
|
Monat
|
m | integer |
Der Monat im Fuzzydatum. |
|
|
Jahr
|
y | integer |
Das Jahr im Fuzzydatum. |
|
|
Teilnahmestufe
|
name | True | string |
Der Name der Teilnahmestufe. |
|
Zusammenfassungsnotiz
|
summary_note | string |
Kurzübersichtsinformationen, die an den Datensatz des Teilnehmers angeheftet sind. |
Auflisten von Veranstaltungsgebühren
Listet die Gebühren für ein Ereignis auf.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Ereignis-ID
|
event_id | True | string |
Die Systemdatensatz-ID des Ereignisses. |
Gibt zurück
Fees
Ereignis erstellen
Erstellt ein neues Ereignis.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Ereignisname
|
name | True | string |
Der Name des Ereignisses. |
|
Description
|
description | string |
Die Beschreibung des Ereignisses. |
|
|
Kategorie
|
name | True | string |
Der Kategoriename. |
|
Startdatum
|
start_date | True | date |
Das Startdatum des Ereignisses (z. B. "2020-09-18"). |
|
Startzeit
|
start_time | string |
Die Startzeit des Ereignisses (z. B. "07:30"). |
|
|
Enddatum
|
end_date | date |
Das Enddatum des Ereignisses (z. B. '2020-09-18'). |
|
|
Endzeitpunkt
|
end_time | string |
Die Endzeit des Ereignisses (z. B. "07:30)". |
|
|
Nachschlage-ID
|
lookup_id | string |
Die Nachschlage-ID des Ereignisses. |
|
|
Kapazität
|
capacity | integer |
Die Anzahl der Personen, die an der Veranstaltung teilnehmen können. |
|
|
Ziel
|
goal | double |
Das monetäre Ziel des Ereignisses. |
|
|
Kampagnen-ID
|
campaign_id | string |
Die Systemdatensatz-ID der Kampagne, die dem Ereignis zugeordnet ist. |
|
|
Fund-ID
|
fund_id | string |
Die Systemdatensatz-ID des Fonds, der dem Ereignis zugeordnet ist. |
|
|
Inaktiv?
|
inactive | boolean |
Ist das Ereignis aktiv? |
Gibt zurück
Created-Ereignis
Ereignisse auflisten
Gibt eine Liste von Ereignissen zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Kategorie
|
category | string |
Filter basierend auf der Ereigniskategorie. |
|
|
Nachschlage-ID
|
lookup_id | string |
Ein Filter für Ergebnisse, die dem benutzerdefinierten Bezeichner für den Ereignisdatensatz entsprechen. |
|
|
Startdatum von
|
start_date_from | date |
Filtern Sie die Ergebnisse nach Ereignissen mit Dem Anfangstermin am oder nach dem angegebenen Datum (z. B. '2020-09-18'). |
|
|
Startdatum bis
|
start_date_to | date |
Filtern Sie die Ergebnisse auf Ereignisse mit dem Startdatum am oder vor dem angegebenen Datum (z. B. "2020-09-18"). |
|
|
Inaktiv einschließen?
|
include_inactive | boolean |
Inaktive Ereignisse einschließen? |
|
|
Limit
|
limit | integer |
Stellt die Anzahl der zurückzugebenden Datensätze dar. Der Standardwert ist 500. Das Maximum beträgt 10000. |
|
|
Offset
|
offset | integer |
Stellt die Anzahl der zu überspringenden Datensätze dar. Zur Verwendung mit Paginierung. |
|
|
Ereignis-ID
|
event_id | string |
Filtern Sie die Ereignisse, die der angegebenen Systemdatensatz-ID entsprechen. |
|
|
Name
|
name | string |
Filtern Sie nach Ereignissen, die dem angegebenen Namen entsprechen. |
|
|
Hinzugefügt am oder nach
|
date_added | date-time |
Filtern Sie die Ergebnisse nach Ereignissen, die am oder nach dem angegebenen Datum erstellt wurden (z. B. '2020-09-18T04:13:56Z'). |
|
|
Geändert am oder nach
|
last_modified | date-time |
Filtern Sie die Ergebnisse nach Ereignissen, die am oder nach dem angegebenen Datum geändert wurden (z. B. '2020-09-18T04:13:56Z'). |
Gibt zurück
Ereignisse
Ereignisteilnehmer auflisten
Listet die Teilnehmer für ein Ereignis auf.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Ereignis-ID
|
event_id | True | string |
Die Systemdatensatz-ID des Ereignisses. |
|
RSVP-Status
|
rsvp_status | string |
Filtert Teilnehmer basierend auf dem RSVP-Status. |
|
|
Einladungsstatus
|
invitation_status | string |
Filtert Teilnehmer basierend auf dem Einladungsstatus. |
|
|
Teilnahmestufe
|
participation_level | string |
Filtern Sie Teilnehmer basierend auf der Beteiligungsstufe. |
|
|
Besucht?
|
attended_filter | boolean |
Filtern Nach Einschließen oder Ausschließen von Teilnehmern, die als teilnehmergemarkiert gekennzeichnet sind. |
|
|
Gebühren?
|
fees_paid_filter | boolean |
Filtern Sie nach dem Einschließen oder Ausschließen von Teilnehmern, die ihre Gebühren bezahlt haben. |
|
|
Limit
|
limit | integer |
Stellt die Anzahl der zurückzugebenden Datensätze dar. Der Standardwert ist 500. Das Maximum beträgt 10000. |
|
|
Offset
|
offset | integer |
Stellt die Anzahl der zu überspringenden Datensätze dar. Zur Verwendung mit Paginierung. |
|
|
Ist ein Bestandteil?
|
is_constituent_filter | boolean |
Filtern Sie nach dem Einschließen oder Ausschließen von Teilnehmern, die Bestandteil sind. |
|
|
Hat eine berechtigte E-Mail?
|
email_eligible_filter | boolean |
Filtern Sie nach dem Einschließen oder Ausschließen von Teilnehmern basierend darauf, ob sie über eine primäre E-Mail-Adresse verfügen, die nicht als "Keine E-Mail" gekennzeichnet ist? |
|
|
Hat ein berechtigtes Telefon?
|
phone_call_eligible_filter | boolean |
Filtern Sie nach dem Einschließen oder Ausschließen von Teilnehmern basierend darauf, ob sie über eine primäre Telefonnummer verfügen, die nicht als "Nicht anrufen" gekennzeichnet ist. |
|
|
Name
|
name | string |
Filtern Sie nach Teilnehmern, die dem angegebenen Namen entsprechen. |
|
|
Hinzugefügt am oder nach
|
date_added | date-time |
Filtern Sie die Ergebnisse nach Teilnehmern, die am oder nach dem angegebenen Datum erstellt wurden (z. B. '2020-09-18T04:13:56Z'). |
|
|
Geändert am oder nach
|
last_modified | date-time |
Filtern Sie die Ergebnisse nach Teilnehmern, die am oder nach dem angegebenen Datum geändert wurden (z. B. "2020-09-18T04:13:56Z"). |
Gibt zurück
Teilnehmer
Erstellen einer Ereignisanlage
Erstellt eine neue Ereignisanlage.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Ereignis-ID
|
event_id | True | string |
Die Systemdatensatz-ID des Ereignisses. |
|
Typ
|
type | True | string |
Der Anlagentyp. Physische Anlagen werden hochgeladene Dateien wie Bilder, PDFs oder Word-Dokumente, die lokal oder im Netzwerk gespeichert werden. Sie werden im System gespeichert und verwaltet. Linkanlagen sind Links zu Dateien wie Bildern, Blogbeiträgen oder YouTube-Videos, die online oder in einem Cloudspeicherkonto gespeichert sind. Sie werden extern gespeichert und verwaltet. |
|
Name
|
name | string |
Der Name der Anlage. Zeichenlimit: 150. |
|
|
Datum
|
date | date-time |
Das Datum der Anlage (z. B. '2020-09-18T04:13:56Z'). Dieses Feld wird standardmäßig auf das aktuelle Datum und die aktuelle Uhrzeit festgelegt, wenn nicht angegeben. |
|
|
URL
|
url | string |
Die URL für die Anlage. Dies ist für Verknüpfungsanlagen erforderlich und gilt nicht für physische Anlagen. |
|
|
Dateiname
|
file_name | string |
Der Name der Datei. Zeichenlimit: 36. Nur für physische Anlagen. |
|
|
Datei-ID
|
file_id | string |
Der Bezeichner der Datei. Zeichenlimit: 36. Nur für physische Anlagen. |
|
|
Miniaturansichts-ID
|
thumbnail_id | string |
Der Bezeichner der Miniaturansicht. Zeichenlimit: 36. Nur für physische Anlagen. |
|
|
Stichwörter
|
tags | array of string |
Die tags, die der Anlage zugeordnet sind. |
Gibt zurück
Ereignisanlage erstellt
Erstellen einer Ereignisteilnehmeroption
Erstellt eine neue Teilnehmeroption für ein Ereignis.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Ereignis-ID
|
event_id | True | string |
Die ID des Ereignisses. |
|
Name
|
name | True | string |
Der Name der Ereignisteilnehmeroption. |
|
Eingabetyp
|
input_type | True | string |
Die Typen von Werten, die Teilnehmer verwenden können, um Antworten bereitzustellen. |
|
Mehrfachauswahl zulassen?
|
multi_select | boolean |
Mehrere Werte für Listen zulassen? |
|
|
name
|
name | string |
Der Name der Listenoption. |
|
|
Sequenz
|
sequence | integer |
Die 0-basierte Sequenz, die für die Sortierung verwendet wird. |
Gibt zurück
Ereignisteilnehmeroption erstellt
Erstellen einer Teilnehmergebühr
Erstellt eine neue Gebühr für einen Teilnehmer.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Teilnehmer-ID
|
participant_id | True | string |
Die Systemdatensatz-ID des Teilnehmers. |
|
Ereignis-ID
|
event_id | True | string |
Die Systemdatensatz-ID des Ereignisses. |
|
Gebühr
|
event_fee_id | True | string |
Die Veranstaltungsgebühr. |
|
Menge
|
quantity | True | integer |
Die gekaufte Menge. |
|
Gebührenbetrag
|
fee_amount | True | double |
Der Betrag, der mit der Gebühr verbunden ist. |
|
Beitragsbetrag
|
contribution_amount | True | double |
Der Betrag der Gebühr, die eine Spende über den Kosten der Veranstaltung liegt. Dies ist der Betrag, der in der Regel auf Quittungen angezeigt wird. |
|
Tag
|
d | integer |
Der Tag im Fuzzydatum. |
|
|
Monat
|
m | integer |
Der Monat im Fuzzydatum. |
|
|
Jahr
|
y | integer |
Das Jahr im Fuzzydatum. |
Gibt zurück
Teilnehmergebühr erstellt
Erstellen einer Teilnehmergebühr
Erstellt eine neue Gebührenzahlung für einen Teilnehmer.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Teilnehmer-ID
|
participant_id | True | string |
Die Systemdatensatz-ID des Teilnehmers. |
|
Geschenk-ID
|
gift_id | True | string |
Die Systetm Datensatz-ID des Geschenks, mit dem die Teilnehmergebühr verknüpft ist. |
|
Angewendeter Betrag
|
applied_amount | True | double |
Der Betrag der Zahlung, die für die Teilnehmergebühren gilt. |
Gibt zurück
Erstellte Teilnehmergebührzahlung
Erstellen einer Teilnehmeroption
Erstellt eine neue Teilnehmeroption für einen Teilnehmer.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Teilnehmer-ID
|
participant_id | True | string |
Die ID des Teilnehmers. |
|
body
|
body | True | dynamic |
Ein Objekt, das die zu erstellende Teilnehmeroption darstellt. |
Gibt zurück
Option "Teilnehmer erstellt"
Erstellen einer Teilnehmerspende
Erstellt eine neue Spende für einen Teilnehmer.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Teilnehmer-ID
|
participant_id | True | string |
Die Systemdatensatz-ID des Teilnehmers. |
|
Geschenk-ID
|
gift_id | True | string |
Die Systetm Datensatz-ID des Geschenks, mit dem die Teilnehmerspende verknüpft ist. |
Gibt zurück
Beteiligte Spende erstellt
Erstellen einer Veranstaltungsgebühr
Erstellt eine neue Gebühr für ein Ereignis.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Ereignis-ID
|
event_id | True | string |
Die Systemdatensatz-ID des Ereignisses. |
|
Name
|
name | True | string |
Der Name der Gebühr. |
|
Gebührenbetrag
|
cost | True | double |
Der Betrag, der mit der Gebühr verbunden ist. |
|
Beitragsbetrag
|
contribution_amount | True | double |
Der Betrag der Gebühr, die eine Spende über den Kosten der Veranstaltung liegt. |
Gibt zurück
Erstellte Veranstaltungsgebühr
Erstellen eines Teilnehmers
Erstellt einen neuen Teilnehmer für ein Ereignis.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Ereignis-ID
|
event_id | True | string |
Die Systemdatensatz-ID des Ereignisses. |
|
Bestandteil-ID
|
constituent_id | True | string |
Die Konstituierende ID des Teilnehmers. |
|
Host-ID
|
host_id | string |
Die ID des Teilnehmerdatensatzes des Hosts. |
|
|
RSVP-Status
|
rsvp_status | string |
Der Status des Engagements des Teilnehmers mit dem Ereignis. |
|
|
Besucht?
|
attended | boolean |
Hat der Teilnehmer an der Veranstaltung teilgenommen? |
|
|
Einladungsstatus
|
invitation_status | string |
Der Status der Einladung an den Teilnehmer. |
|
|
Tag
|
d | integer |
Der Tag im Fuzzydatum. |
|
|
Monat
|
m | integer |
Der Monat im Fuzzydatum. |
|
|
Jahr
|
y | integer |
Das Jahr im Fuzzydatum. |
|
|
Tag
|
d | integer |
Der Tag im Fuzzydatum. |
|
|
Monat
|
m | integer |
Der Monat im Fuzzydatum. |
|
|
Jahr
|
y | integer |
Das Jahr im Fuzzydatum. |
|
|
Teilnahmestufe
|
name | True | string |
Der Name der Teilnahmestufe. |
|
Zusammenfassungsnotiz
|
summary_note | string |
Kurzübersichtsinformationen, die an den Datensatz des Teilnehmers angeheftet sind. |
Gibt zurück
Erstellter Teilnehmer
Listenereignisanlagen
Listet die Anlagen für ein Ereignis auf.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Ereignis-ID
|
event_id | True | string |
Die Systemdatensatz-ID des Ereignisses. |
Gibt zurück
Attachments
Optionen für Ereignisteilnehmer auflisten
Listet die Teilnehmeroptionen für ein Ereignis auf.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Ereignis-ID
|
event_id | True | string |
Die ID des Ereignisses. |
Gibt zurück
Optionen für Ereignisteilnehmer
Teilnehmergebühren auflisten
Listet die Gebühren für einen Teilnehmer auf.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Teilnehmer-ID
|
participant_id | True | string |
Die Systemdatensatz-ID des Teilnehmers. |
|
Limit
|
limit | integer |
Stellt die Anzahl der zurückzugebenden Datensätze dar. Der Standardwert ist 500. Das Maximum beträgt 10000. |
|
|
Offset
|
offset | integer |
Stellt die Anzahl der zu überspringenden Datensätze dar. Zur Verwendung mit Paginierung. Der Standardwert ist 0. |
Gibt zurück
Fees
Teilnehmergebührzahlungen auflisten
Listet die Gebührenzahlungen für einen Teilnehmer auf.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Teilnehmer-ID
|
participant_id | True | string |
Die Systemdatensatz-ID des Teilnehmers. |
|
Limit
|
limit | integer |
Stellt die Anzahl der zurückzugebenden Datensätze dar. Der Standardwert ist 500. Das Maximum beträgt 10000. |
|
|
Offset
|
offset | integer |
Stellt die Anzahl der zu überspringenden Datensätze dar. Zur Verwendung mit Paginierung. Der Standardwert ist 0. |
Gibt zurück
Gebührenzahlungen
Teilnehmeroptionen auflisten
Listet die Teilnehmeroptionen für einen Teilnehmer auf.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Teilnehmer-ID
|
participant_id | True | string |
Die Systemdatensatz-ID des Teilnehmers. |
Gibt zurück
Teilnehmeroptionen
Teilnehmerspenden auflisten
Listet die Spenden für einen Teilnehmer auf.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Teilnehmer-ID
|
participant_id | True | string |
Die Systemdatensatz-ID des Teilnehmers. |
|
Limit
|
limit | integer |
Stellt die Anzahl der zurückzugebenden Datensätze dar. Der Standardwert ist 500. Das Maximum beträgt 10000. |
|
|
Offset
|
offset | integer |
Stellt die Anzahl der zu überspringenden Datensätze dar. Zur Verwendung mit Paginierung. Der Standardwert ist 0. |
Gibt zurück
Spenden
Definitionen
EventApi.AdministrativeArea
Definiert das Datenmodell, das für den Administrativen Bereich einer Adresse (z. B. Bundesland in den USA) verwendet wird.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die Datensatz-ID des Verwaltungsbereichs. |
|
name
|
name | string |
Der Name des Verwaltungsbereichs. |
|
Kurzbeschreibung
|
short_description | string |
Die kurze Beschreibung des Verwaltungsbereichs. |
EventApi.ApiCollectionOfEventFee
Fees
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Anzahl
|
count | integer |
Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken. |
|
value
|
value | array of EventApi.EventFee |
Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein. |
EventApi.ApiCollectionOfEventListEntry
Ereignisse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Anzahl
|
count | integer |
Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken. |
|
value
|
value | array of EventApi.EventListEntry |
Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein. |
EventApi.ApiCollectionOfEventParticipantOption
Optionen für Ereignisteilnehmer
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Anzahl
|
count | integer |
Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken. |
|
value
|
value | array of EventApi.EventParticipantOption |
Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein. |
EventApi.ApiCollectionOfParticipantDonation
Spenden
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Anzahl
|
count | integer |
Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken. |
|
value
|
value | array of EventApi.ParticipantDonation |
Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein. |
EventApi.ApiCollectionOfParticipantFee
Fees
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Anzahl
|
count | integer |
Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken. |
|
value
|
value | array of EventApi.ParticipantFee |
Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein. |
EventApi.ApiCollectionOfParticipantFeePayment
Gebührenzahlungen
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Anzahl
|
count | integer |
Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken. |
|
value
|
value | array of EventApi.ParticipantFeePayment |
Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein. |
EventApi.ApiCollectionOfParticipantListEntry
Teilnehmer
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Anzahl
|
count | integer |
Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken. |
|
value
|
value | array of EventApi.ParticipantListEntry |
Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein. |
EventApi.ApiCollectionOfParticipantOption
Teilnehmeroptionen
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Anzahl
|
count | integer |
Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken. |
|
value
|
value | array of EventApi.ParticipantOption |
Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein. |
EventApi.Country
Definiert das Datenmodell, das für das Land einer Adresse verwendet wird.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die ID des Länderdatensatzes. |
|
Anzeigename
|
display_name | string |
Der Anzeigename des Landes. |
|
ISO-Code
|
iso_alpha2_code | string |
Der ISO 3166-1-Alpha-2-Code für das Land. |
EventApi.CreatedEvent
Created-Ereignis
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die ID des neu erstellten Ereignisses. |
EventApi.CreatedEventAttachment
Ereignisanlage erstellt
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die ID der neu erstellten Ereignisanlage. |
EventApi.CreatedEventFee
Erstellte Veranstaltungsgebühr
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die ID der neu erstellten Veranstaltungsgebühr. |
EventApi.CreatedEventParticipantOption
Ereignisteilnehmeroption erstellt
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die ID der neu erstellten Ereignisteilnehmeroption. |
EventApi.CreatedParticipant
Erstellter Teilnehmer
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die ID des neu erstellten Teilnehmers. |
EventApi.CreatedParticipantDonation
Beteiligte Spende erstellt
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die ID der neu erstellten Teilnehmerspende. |
EventApi.CreatedParticipantFee
Teilnehmergebühr erstellt
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die ID der neu erstellten Teilnehmergebühr. |
EventApi.CreatedParticipantFeePayment
Erstellte Teilnehmergebührzahlung
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die ID der neu erstellten Teilnehmergebühr. |
EventApi.CreatedParticipantOption
Option "Teilnehmer erstellt"
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die ID der neu erstellten Teilnehmeroption. |
EventApi.Event
Event
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die Systemdatensatz-ID des Ereignisses. Dies ist nicht mit dem benutzerdefinierten Ereignisbezeichner identisch, der im lookup_id gespeichert wird. |
|
Name
|
name | string |
Der Name des Ereignisses. |
|
Description
|
description | string |
Die Beschreibung des Ereignisses. |
|
Startdatum
|
start_date | date |
Das Startdatum des Ereignisses. |
|
Startzeit
|
start_time | string |
Die Startzeit des Ereignisses. |
|
Enddatum
|
end_date | date |
Das Enddatum des Ereignisses. |
|
Endzeitpunkt
|
end_time | string |
Die Endzeit des Ereignisses. |
|
Kategorie
|
category | EventApi.EventCategory |
Die Ereigniskategorie ist die benutzerdefinierte Kategorisierung für das Ereignis. |
|
Nachschlage-ID
|
lookup_id | string |
Die Nachschlage-ID des Ereignisses. |
|
Standort
|
location | EventApi.Location |
Definiert das für einen Speicherort verwendete Datenmodell. |
|
Kapazität
|
capacity | integer |
Die Anzahl der Personen, die an der Veranstaltung teilnehmen können. |
|
Ziel
|
goal | double |
Das monetäre Ziel des Ereignisses. |
|
Kampagnen-ID
|
campaign_id | string |
Die Systemdatensatz-ID der Kampagne, die dem Ereignis zugeordnet ist. |
|
Fund-ID
|
fund_id | string |
Die Systemdatensatz-ID des Fonds, der dem Ereignis zugeordnet ist. |
|
Inaktiv?
|
inactive | boolean |
Ist das Ereignis inaktiv? |
|
Datum hinzugefügt
|
date_added | date-time |
Das Datum, an dem das Ereignis erstellt wurde. |
|
Änderungsdatum
|
date_modified | date-time |
Das Datum, an dem das Ereignis zuletzt geändert wurde. |
EventApi.EventAttachment
Attachment
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die Systemdatensatz-ID der Anlage. |
|
Ereignis-ID
|
parent_id | string |
Die Systemdatensatz-ID des Ereignisses, das der Anlage zugeordnet ist. |
|
Typ
|
type | string |
Der Anlagentyp. Physische Anlagen werden hochgeladene Dateien wie Bilder, PDFs oder Word-Dokumente, die lokal oder im Netzwerk gespeichert werden. Sie werden im System gespeichert und verwaltet. Linkanlagen sind Links zu Dateien wie Bildern, Blogbeiträgen oder YouTube-Videos, die online oder in einem Cloudspeicherkonto gespeichert sind. Sie werden extern gespeichert und verwaltet. |
|
Name
|
name | string |
Der Name der Anlage. Zeichenlimit: 150. |
|
Datum
|
date | date-time |
Das Datum der Anlage. |
|
URL
|
url | string |
Die URL für die Anlage. Dies ist für Verknüpfungsanlagen erforderlich und gilt nicht für physische Anlagen. |
|
Dateiname
|
file_name | string |
Der Name der Datei. Zeichenlimit: 36. Nur für physische Anlagen. |
|
Datei-ID
|
file_id | string |
Der Bezeichner der Datei. Zeichenlimit: 36. Nur für physische Anlagen. |
|
Miniaturansichts-ID
|
thumbnail_id | string |
Der Bezeichner der Miniaturansicht. Zeichenlimit: 36. Nur für physische Anlagen. |
|
Miniaturansichts-URL
|
thumbnail_url | string |
Die URL für eine Miniaturansicht. Nur für physische Anlagen, die Bilder sind. Enthält eine zeitgebundene Signatur, die den Zugriff auf 60 Minuten beschränkt. |
|
Inhaltstyp
|
content_type | string |
Der Inhaltstyp. Nur für physische Anlagen. |
|
Dateigröße
|
file_size | integer |
Die Dateigröße in Byte. Nur für physische Anlagen. |
|
Stichwörter
|
tags | array of string |
Die tags, die der Anlage zugeordnet sind. |
EventApi.EventAttachmentCollection
Attachments
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Anzahl
|
count | integer |
Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken. |
|
value
|
value | array of EventApi.EventAttachment |
Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein. |
EventApi.EventCategory
Die Ereigniskategorie ist die benutzerdefinierte Kategorisierung für das Ereignis.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die Systemdatensatz-ID der Ereigniskategorie. |
|
name
|
name | string |
Der Name der Ereigniskategorie. |
|
inaktiv?
|
inactive | boolean |
Ist diese Kategorie inaktiv? |
EventApi.EventFee
Ereignisgebühren sind, wie viel eine Organisation für Einzelpersonen oder Organisationen berechnet, um an der Veranstaltung teilzunehmen oder daran teilzunehmen.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die Systemdatensatz-ID der Veranstaltungsgebühr. |
|
name
|
name | string |
Der Name der Veranstaltungsgebühr. |
|
Menge
|
cost | double |
Die Kosten der Gebühr. |
|
Beitragsbetrag
|
contribution_amount | double |
Der Steuerabzugsbetrag für diese Gebühr. |
|
Verkaufte Nummer
|
number_sold | integer |
Die Anzahl der verkauften Gebühren. |
EventApi.EventListEntry
Event
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die Systemdatensatz-ID des Ereignisses. |
|
Name
|
name | string |
Der Name des Ereignisses. |
|
Startdatum
|
start_date | date |
Das Startdatum des Ereignisses. |
|
Startzeit
|
start_time | string |
Die Startzeit des Ereignisses. |
|
Enddatum
|
end_date | date |
Das Enddatum des Ereignisses. |
|
Endzeitpunkt
|
end_time | string |
Die Endzeit des Ereignisses. |
|
Kategorie
|
category | EventApi.EventCategory |
Die Ereigniskategorie ist die benutzerdefinierte Kategorisierung für das Ereignis. |
|
Nachschlage-ID
|
lookup_id | string |
Die Nachschlage-ID des Ereignisses. |
|
Kapazität
|
capacity | integer |
Die Anzahl der Personen, die an der Veranstaltung teilnehmen können. |
|
Oberarzt
|
attending_count | integer |
Die Anzahl der Teilnehmer, die teilnehmen möchten. |
|
Beaufsichtigt
|
attended_count | integer |
Die Anzahl der Ereignisteilnehmer. |
|
Eingeladen
|
invited_count | integer |
Die Anzahl der eingeladenen Ereignisse. |
|
Einnahme
|
revenue | double |
Der realisierte Umsatz der Veranstaltung. |
|
Ziel
|
goal | double |
Das monetäre Ziel des Ereignisses. |
|
Prozent des Ziels
|
percent_of_goal | integer |
Der realisierte Umsatz als Prozentsatz des Zielumsatzes. |
|
Inaktiv?
|
inactive | boolean |
Ist das Ereignis inaktiv? |
|
Datum hinzugefügt
|
date_added | date-time |
Das Datum, an dem das Ereignis erstellt wurde. |
|
Änderungsdatum
|
date_modified | date-time |
Das Datum, an dem das Ereignis zuletzt geändert wurde. |
EventApi.EventParticipantOption
Ereignisteilnehmeroptionen sind Felder, in denen Details zu Teilnehmern gesammelt werden, z. B. T-Shirt-Größen, Essenspräferenzen oder Sitzanforderungen. Legen Sie Optionen und deren Werte für ein Ereignis fest, und fügen Sie dann Antworten für jeden Teilnehmer hinzu.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die Systemdatensatz-ID der Ereignisteilnehmeroption. |
|
name
|
name | string |
Der Name der Ereignisteilnehmeroption. |
|
Eingabetyp
|
input_type | string |
Der Typ der Ereignisteilnehmeroption. |
|
Mehrfachauswahl zulassen?
|
multi_select | boolean |
Mehrere Werte für Listen zulassen? |
|
list_options
|
list_options | array of EventApi.EventParticipantOptionListOption |
Die verfügbaren Listenoptionen. |
|
Vom Benutzer hinzugefügt
|
added_by_user | string |
Die ID des Benutzers, der die Option hinzugefügt hat. |
|
vom Benutzer geändert
|
updated_by_user | string |
Die ID des Benutzers, der die Option geändert hat. |
|
vom Dienst hinzugefügt
|
added_by_service | string |
Der Name des Diensts, der diese Option hinzugefügt hat. |
|
von Dienst geändert
|
updated_by_service | string |
Der Name des Diensts, der diese Option geändert hat. |
|
hinzugefügtes Datum
|
date_added | date-time |
Das Datum, an dem die Option erstellt wurde. |
|
Änderungsdatum
|
date_updated | date-time |
Das Datum, an dem die Option zuletzt geändert wurde. |
|
Ausgabe
|
version | integer |
Die Versionsnummer der Option. |
EventApi.EventParticipantOptionListOption
Eine Listenoption für Ereignisteilnehmer
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die ID der Listenoption |
|
name
|
name | string |
Der Name der Listenoption |
|
Sequenz
|
sequence | integer |
Die Sequenz, die zum Sortieren der Listenoptionen verwendet wird |
EventApi.Locality
Definiert das Datenmodell, das für die Lokalität einer Adresse verwendet wird.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die Datensatz-ID des Gebietsschemadatensatzes. |
|
name
|
name | string |
Der Name der Gebietsschemas. |
EventApi.Location
Definiert das für einen Speicherort verwendete Datenmodell.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
name
|
name | string |
Der Name des Speicherorts. |
|
Adresszeilen
|
address_lines | string |
Die Adresszeilen des Speicherorts. |
|
Postleitzahl
|
postal_code | string |
Die Postleitzahl des Standorts. |
|
Örtlichkeit
|
locality | EventApi.Locality |
Definiert das Datenmodell, das für die Lokalität einer Adresse verwendet wird. |
|
Verwaltungsbereich
|
administrative_area | EventApi.AdministrativeArea |
Definiert das Datenmodell, das für den Administrativen Bereich einer Adresse (z. B. Bundesland in den USA) verwendet wird. |
|
Unterverwaltungsbereich
|
sub_administrative_area | EventApi.SubAdministrativeArea |
Definiert das Datenmodell, das für den Unterverwaltungsbereich einer Adresse (z. B. Stadt in den USA) verwendet wird. |
|
country
|
country | EventApi.Country |
Definiert das Datenmodell, das für das Land einer Adresse verwendet wird. |
|
formatierte Adresse
|
formatted_address | string |
Formatierte Adresse des Speicherorts |
EventApi.Membership
Mitgliedschaftsinformationen für den Teilnehmer.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Mitgliedschaftskategorie
|
category | EventApi.MembershipCategory |
Die Mitgliedschaftskategorie der Person. |
EventApi.MembershipCategory
Die Mitgliedschaftskategorie der Person.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die Systemdatensatz-ID der Mitgliedschaftskategorie. |
|
name
|
name | string |
Der Name der Mitgliedschaftskategorie. |
EventApi.Participant
Teilnehmer
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die Systemdatensatz-ID des Teilnehmers. |
|
Bestandteil-ID
|
constituent_id | string |
Die Konstituierende ID des Teilnehmers. |
|
Ereignis-ID
|
event_id | string |
Die Systemdatensatz-ID des Ereignisses, an dem teilgenommen wird. |
|
Host-ID
|
host_id | string |
Die ID des Teilnehmerdatensatzes des Hosts. |
|
RSVP-Status
|
rsvp_status | string |
Der Status des Engagements des Teilnehmers mit dem Ereignis. |
|
Besucht?
|
attended | boolean |
Hat der Teilnehmer an der Veranstaltung teilgenommen? |
|
Einladungsstatus
|
invitation_status | string |
Der Status der Einladung an den Teilnehmer. |
|
Tag
|
rsvp_date.d | integer |
Der Tag im Fuzzydatum. |
|
Monat
|
rsvp_date.m | integer |
Der Monat im Fuzzydatum. |
|
Jahr
|
rsvp_date.y | integer |
Das Jahr im Fuzzydatum. |
|
Tag
|
invitation_date.d | integer |
Der Tag im Fuzzydatum. |
|
Monat
|
invitation_date.m | integer |
Der Monat im Fuzzydatum. |
|
Jahr
|
invitation_date.y | integer |
Das Jahr im Fuzzydatum. |
|
Zusammenfassungsnotiz
|
summary_note | string |
Kurzübersichtsinformationen, die an den Datensatz des Teilnehmers angeheftet sind. |
|
Teilnahmestufe
|
participation_level | EventApi.ParticipationLevel |
Teilnahmestufen sind die Beteiligungsteilnehmer in einem Ereignis. |
|
Datum hinzugefügt
|
date_added | date-time |
Das Datum, an dem der Teilnehmer erstellt wurde. |
|
Änderungsdatum
|
date_modified | date-time |
Das Datum, an dem der Teilnehmer zuletzt geändert wurde. |
EventApi.ParticipantDonation
Definiert ein Datenmodell für eine Teilnehmerspende.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die Systemdatensatz-ID der Teilnehmerspende. |
|
Geschenk-ID
|
gift_id | string |
Die Systemdatensatz-ID des Geschenks, mit dem die Teilnehmerspende verknüpft ist. |
EventApi.ParticipantFee
Definiert ein Datenmodell für eine Teilnehmergebühr
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die ID der Teilnehmergebühr. |
|
Teilnehmer-ID
|
participant_id | string |
Die ID des Datensatzes, mit dem die Teilnehmergebühr verknüpft ist. |
|
Menge
|
quantity | integer |
Die gekaufte Menge. |
|
Gebührenbetrag
|
fee_amount | double |
Der Betrag der Teilnehmergebühr. |
|
Beitragsbetrag
|
tax_receiptable_amount | double |
Der Steuerabzugsbetrag für diese Gebühr. |
|
Tag
|
date.d | integer |
Der Tag im Fuzzydatum. |
|
Monat
|
date.m | integer |
Der Monat im Fuzzydatum. |
|
Jahr
|
date.y | integer |
Das Jahr im Fuzzydatum. |
|
Veranstaltungsgebühr
|
event_fee | EventApi.EventFee |
Ereignisgebühren sind, wie viel eine Organisation für Einzelpersonen oder Organisationen berechnet, um an der Veranstaltung teilzunehmen oder daran teilzunehmen. |
EventApi.ParticipantFeePayment
Definiert ein Datenmodell für die Zahlung einer Teilnehmergebühr
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die Systemdatensatz-ID der Teilnehmergebührzahlung. |
|
Teilnehmer-ID
|
participant_id | string |
Die Systemdatensatz-ID des Teilnehmers, mit dem die Teilnehmergebühr verbunden ist. |
|
Geschenk-ID
|
gift_id | string |
Die Systemdatensatz-ID des Geschenks, mit dem die Teilnehmergebührzahlung verknüpft ist. |
|
angewendeter Betrag
|
applied_amount | double |
Der angewendete Betrag der Teilnehmergebühr. |
EventApi.ParticipantListEntry
Teilnehmer
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die Systemdatensatz-ID des Teilnehmers. |
|
Kontakt-ID
|
contact_id | string |
Die ID des Kontakts, der an der Veranstaltung teilnimmt. |
|
RSVP-Status
|
rsvp_status | string |
Der Status des Engagements des Teilnehmers mit dem Ereignis. |
|
Besucht?
|
attended | boolean |
Hat der Teilnehmer an der Veranstaltung teilgenommen? |
|
Einladungsstatus
|
invitation_status | string |
Der Status der Einladung an den Teilnehmer. |
|
Tag
|
rsvp_date.d | integer |
Der Tag im Fuzzydatum. |
|
Monat
|
rsvp_date.m | integer |
Der Monat im Fuzzydatum. |
|
Jahr
|
rsvp_date.y | integer |
Das Jahr im Fuzzydatum. |
|
Teilnahmestufe
|
participation_level | EventApi.ParticipationLevel |
Teilnahmestufen sind die Beteiligungsteilnehmer in einem Ereignis. |
|
Title
|
title | string |
Der Titel des Teilnehmers. |
|
Vorname
|
first_name | string |
Vorname des Teilnehmers. |
|
Nachname
|
last_name | string |
Der Nachname des Teilnehmers. |
|
Name
|
name | string |
Der vollständige Name des Teilnehmers. |
|
Bevorzugter Name
|
preferred_name | string |
Der bevorzugte Name des Teilnehmers. |
|
Nachsilbe
|
suffix | string |
Das Suffix des Teilnehmers. |
|
Nachschlage-ID
|
lookup_id | string |
Die Nachschlage-ID des Teilnehmers. |
|
Email
|
string |
Die E-Mail-Adresse des Teilnehmers. |
|
|
Keine E-Mail senden?
|
do_not_email | boolean |
Kann der Teilnehmer an dieser E-Mail-Adresse kontaktiert werden? |
|
Telefonnummer
|
phone | string |
Die Telefonnummer des Teilnehmers. |
|
Rufen Sie nicht an?
|
do_not_call | boolean |
Kann der Teilnehmer an dieser Nummer kontaktiert werden? |
|
Zweiter Vorname
|
middle_name | string |
Der zweite Name des Teilnehmers. |
|
Ehemaliger Name
|
former_name | string |
Der frühere Name des Teilnehmers. |
|
Ist ein Bestandteil?
|
is_constituent | boolean |
Ist der Teilnehmer bestandteil? |
|
Klasse von
|
class_of | string |
Der Abschlusskurs des Teilnehmers. |
|
Registrierungsgebühren insgesamt
|
total_registration_fees | double |
Die Summe der Gebührenbeträge des Teilnehmers. |
|
Bezahlte Summe
|
total_paid | double |
Die Summe der bezahlten Geschenke des Teilnehmers mit einer Art von Registrierungsgebühren. |
|
Spenden
|
donations | double |
Die Summe der bezahlten Geschenke des Teilnehmers mit einer Art von Spenden. |
|
Einnahme
|
revenue | double |
Die Summe der bezahlten Geschenke des Teilnehmers in allen Arten. |
|
Sitz
|
seat | string |
Die Sitzzuweisung für den Teilnehmer. |
|
Namenstag
|
name_tag | string |
Das Namenstag für den Teilnehmer |
|
Zusammenfassungsnotiz
|
summary_note | string |
Kurzübersichtsinformationen, die an den Datensatz des Teilnehmers angeheftet sind. |
|
Datum hinzugefügt
|
date_added | date-time |
Das Datum, an dem der Teilnehmer erstellt wurde. |
|
Änderungsdatum
|
date_modified | date-time |
Das Datum, an dem der Teilnehmer zuletzt geändert wurde. |
|
Kontakt-ID
|
host.contact_id | string |
Die ID des Kontakts, der an der Veranstaltung teilnimmt. |
|
Teilnehmer-ID
|
host.participant_id | string |
Die ID des Teilnehmers. |
|
name
|
host.name | string |
Der vollständige Name des Teilnehmers. |
|
Gäste
|
guests | array of EventApi.ParticipantListParticipantSummary |
Die Gäste des Teilnehmers. |
|
Mitgliedschaften
|
memberships | array of EventApi.Membership |
Die Mitgliedschaftsinformationen für den Teilnehmer. |
EventApi.ParticipantListParticipantSummary
Grundlegende Zusammenfassungsinformationen des Teilnehmers.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Kontakt-ID
|
contact_id | string |
Die ID des Kontakts, der an der Veranstaltung teilnimmt. |
|
Teilnehmer-ID
|
participant_id | string |
Die ID des Teilnehmers. |
|
name
|
name | string |
Der vollständige Name des Teilnehmers. |
EventApi.ParticipantOption
Die Teilnehmeroption, die einem bestimmten Teilnehmer zugeordnet ist
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die Systemdatensatz-ID der Teilnehmeroption. |
|
Teilnehmer-ID
|
participant_id | string |
Die Systemdatensatz-ID des Teilnehmers. |
|
Ereignis-ID
|
event_id | string |
Die Systemdatensatz-ID des Ereignisses. |
|
Ereignisteilnehmer-Options-ID
|
event_participant_option_id | string |
Die Systemdatensatz-ID der Ereignisteilnehmeroption. |
|
value
|
option_value | string |
Die Antwort des Teilnehmers auf die Option. |
|
Vom Benutzer hinzugefügt
|
added_by_user | string |
Die ID des Benutzers, der die Teilnehmeroption hinzugefügt hat. |
|
vom Benutzer geändert
|
updated_by_user | string |
Die ID des Benutzers, der die Teilnehmeroption geändert hat. |
|
vom Dienst hinzugefügt
|
added_by_service | string |
Der Name des Diensts, der diese Teilnehmeroption hinzugefügt hat. |
|
von Dienst geändert
|
updated_by_service | string |
Der Name des Diensts, der diese Teilnehmeroption geändert hat. |
|
hinzugefügtes Datum
|
date_added | date-time |
Das Datum, an dem die Teilnehmeroption erstellt wurde. |
|
Änderungsdatum
|
date_updated | date-time |
Das Datum, an dem die Teilnehmeroption zuletzt geändert wurde. |
EventApi.ParticipationLevel
Teilnahmestufen sind die Beteiligungsteilnehmer in einem Ereignis.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die Systemdatensatz-ID der Teilnahmestufe. |
|
name
|
name | string |
Der Name der Teilnahmestufe. |
|
inaktiv?
|
is_inactive | boolean |
Ist die Teilnahmestufe inaktiv? |
EventApi.SubAdministrativeArea
Definiert das Datenmodell, das für den Unterverwaltungsbereich einer Adresse (z. B. Stadt in den USA) verwendet wird.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die ID des Unterverwaltungsbereichs. |
|
name
|
name | string |
Der Name des Unterverwaltungsbereichs. |