Zdarzenia NXT programu Blackbaud Raisers Edge
Blackbaud Raiser's Edge NXT to kompleksowe oparte na chmurze rozwiązanie do zbierania funduszy i zarządzania darczyńcami opracowane specjalnie dla organizacji non-profit i całej dobrej społeczności społecznej. Łącznik Zdarzenia służy do zarządzania zdarzeniami i uczestnikami.
Ten łącznik jest dostępny w następujących produktach i regionach:
| Usługa | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Logic Apps | Standard | Wszystkie regiony usługi Logic Apps z wyjątkiem następujących: — Regiony platformy Azure Government — Regiony platformy Azure (Chiny) - Departament Obrony USA (DoD) |
| Power Apps | Premium | Wszystkie regiony usługi Power Apps z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Power Automate | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Kontakt | |
|---|---|
| Name | Obsługa rozwiązania Blackbaud |
| adres URL | https://www.blackbaud.com/support |
| skyapi@blackbaud.com |
| Metadane łącznika | |
|---|---|
| Publisher | Blackbaud, Inc. |
| Witryna internetowa | https://www.blackbaud.com/products/blackbaud-raisers-edge-nxt |
| Zasady ochrony prywatności | https://www.blackbaud.com/privacy-shield |
| Kategorie | Sprzedaż i CRM; Produktywność |
Raiser's Edge NXT to kompleksowe oparte na chmurze rozwiązanie do zbierania funduszy i zarządzania darczyńcami opracowane specjalnie dla organizacji non-profit i całej społeczności dobra społecznego.
Ten łącznik jest oparty na interfejsie API SKY firmy Blackbaud i zapewnia operacje ułatwiające zarządzanie zdarzeniami i powiązanymi jednostkami znajdującymi się w narzędziu NXT aplikacji Raiser Edge, w tym:
- Events
- Uczestnicy
- Opłaty i darowizny
- i nie tylko...
Aby uzyskać więcej informacji, zapoznaj się z dokumentacją.
Wymagania wstępne
Aby korzystać z tego łącznika, musisz mieć konto identyfikatora Blackbaud z dostępem do co najmniej jednego środowiska Blackbaud.
Ponadto administrator organizacji musi również wykonać akcję na poziomie administratora w systemie, aby umożliwić temu łącznikowi dostęp do środowiska Blackbaud. Więcej informacji na temat tych wymagań wstępnych można znaleźć w dokumentacji początkowej konfiguracji .
Jak uzyskać poświadczenia?
Administrator organizacji wyśle Ci zaproszenie do środowiska NXT aplikacji Raiser's Edge i skonfiguruje uprawnienia konta użytkownika w środowisku. Do korzystania z tego łącznika nie są wymagane żadne dodatkowe poświadczenia.
Znane problemy i ograniczenia
Łącznik będzie działać w kontekście konta użytkownika i w związku z tym będzie podlegać uprawnieniam użytkownika w środowisku.
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
| Aktualizowanie opcji uczestnika |
Aktualizuje szczegóły dotyczące opcji uczestnika. |
| Aktualizowanie uczestnika |
Aktualizuje szczegóły dotyczące uczestnika. |
| Aktualizowanie załącznika zdarzenia |
Aktualizuje załącznik zdarzeń. |
| Aktualizowanie zdarzenia |
Aktualizuje szczegóły zdarzenia. |
| Lista darowizn uczestników |
Wyświetla listę datków dla uczestnika. |
| Lista opłat za uczestnika |
Wyświetla listę opłat dla uczestnika. |
| Pobieranie zdarzenia |
Zwraca informacje o zdarzeniu. |
| Tworzenie darowizny uczestnika |
Tworzy nową darowiznę dla uczestnika. |
| Tworzenie opłaty za uczestnika |
Tworzy nową opłatę dla uczestnika. |
| Tworzenie opłaty za zdarzenie |
Tworzy nową opłatę za zdarzenie. |
| Tworzenie płatności za opłatę uczestnika |
Tworzy nową płatność opłatą dla uczestnika. |
| Tworzenie uczestnika |
Tworzy nowego uczestnika wydarzenia. |
| Tworzenie załącznika zdarzenia |
Tworzy nowy załącznik zdarzenia. |
| Tworzenie zdarzenia |
Tworzy nowe zdarzenie. |
| Utwórz opcję uczestnika |
Tworzy nową opcję uczestnika dla uczestnika. |
| Utwórz opcję uczestnika zdarzenia |
Tworzy nową opcję uczestnika dla wydarzenia. |
| Uzyskiwanie uczestnika |
Zwraca informacje o określonym uczestniku zdarzenia. |
| Wyświetlanie listy opcji uczestnika |
Wyświetla listę opcji uczestnika dla uczestnika. |
| Wyświetlanie listy opcji uczestnika zdarzenia |
Wyświetla listę opcji uczestnika dla zdarzenia. |
| Wyświetlanie listy opłat za zdarzenia |
Wyświetla listę opłat za wydarzenie. |
| Wyświetlanie listy płatności za opłatę uczestnika |
Wyświetla listę płatności opłat dla uczestnika. |
| Wyświetlanie listy uczestników wydarzenia |
Wyświetla listę uczestników wydarzenia. |
| Wyświetlanie listy załączników zdarzeń |
Wyświetla listę załączników dla zdarzenia. |
| Wyświetlanie listy zdarzeń |
Zwraca listę zdarzeń. |
Aktualizowanie opcji uczestnika
Aktualizuje szczegóły dotyczące opcji uczestnika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator opcji uczestnika
|
option_id | True | string |
Identyfikator rekordu systemowego opcji uczestnika do zaktualizowania. |
|
Wartość
|
option_value | True | string |
Odpowiedź uczestnika na tę opcję. |
Aktualizowanie uczestnika
Aktualizuje szczegóły dotyczące uczestnika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator uczestnika
|
participant_id | True | string |
Identyfikator rekordu systemowego uczestnika do aktualizacji. |
|
Identyfikator składowy
|
constituent_id | string |
Identyfikator składowy uczestnika. |
|
|
Identyfikator hosta
|
host_id | string |
Identyfikator rekordu uczestnika hosta. |
|
|
Stan RSVP
|
rsvp_status | string |
Stan zaangażowania uczestnika w wydarzenie. |
|
|
Uczestniczyło?
|
attended | boolean |
Czy uczestnik uczestniczył w wydarzeniu? |
|
|
Stan zaproszenia
|
invitation_status | string |
Stan zaproszenia do uczestnika. |
|
|
day
|
d | integer |
Dzień w dacie rozmytej. |
|
|
miesiąca
|
m | integer |
Miesiąc w dacie rozmytej. |
|
|
rok
|
y | integer |
Rok w dacie rozmytej. |
|
|
day
|
d | integer |
Dzień w dacie rozmytej. |
|
|
miesiąca
|
m | integer |
Miesiąc w dacie rozmytej. |
|
|
rok
|
y | integer |
Rok w dacie rozmytej. |
|
|
Poziom uczestnictwa
|
name | True | string |
Nazwa poziomu uczestnictwa. |
|
Notatka podsumowująca
|
summary_note | string |
Szybkie informacje referencyjne przypięte do rekordu uczestnika. |
Aktualizowanie załącznika zdarzenia
Aktualizuje załącznik zdarzeń.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator zdarzenia
|
event_id | True | string |
Identyfikator rekordu systemu zdarzenia. |
|
Identyfikator załącznika
|
attachment_id | True | string |
Identyfikator rekordu systemu załącznika do aktualizacji. |
|
Name
|
name | string |
Nazwa załącznika. Limit znaków: 150. |
|
|
Date
|
date | date-time |
Data załącznika (np. "2020-09-18T04:13:56Z"). |
|
|
adres URL
|
url | string |
Adres URL załącznika. Jest to wymagane w przypadku załączników linków i nie dotyczy załączników fizycznych. |
|
|
Etykiety
|
tags | array of string |
Tagi skojarzone z załącznikiem. |
Aktualizowanie zdarzenia
Aktualizuje szczegóły zdarzenia.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator zdarzenia
|
event_id | True | string |
Identyfikator rekordu systemu zdarzenia do zaktualizowania. |
|
Nazwa zdarzenia
|
name | string |
Nazwa zdarzenia. |
|
|
Description
|
description | string |
Opis zdarzenia. |
|
|
Kategoria
|
name | True | string |
Nazwa kategorii. |
|
Data rozpoczęcia
|
start_date | date |
Data rozpoczęcia wydarzenia (np. "2020-09-18"). |
|
|
Godzina rozpoczęcia
|
start_time | string |
Godzina rozpoczęcia zdarzenia (np. "07:30"). |
|
|
Data zakończenia
|
end_date | date |
Data zakończenia wydarzenia (np. "2020-09-18"). |
|
|
Godzina zakończenia
|
end_time | string |
Godzina zakończenia zdarzenia (np. "07:30"). |
|
|
Identyfikator odnośnika
|
lookup_id | string |
Identyfikator odnośnika zdarzenia. |
|
|
Pojemność
|
capacity | integer |
Liczba osób, które mogą wziąć udział w wydarzeniu. |
|
|
Goal
|
goal | double |
Cel pieniężny zdarzenia. |
|
|
Identyfikator kampanii
|
campaign_id | string |
Identyfikator rekordu systemu kampanii skojarzonej ze zdarzeniem. |
|
|
Identyfikator funduszu
|
fund_id | string |
Identyfikator rekordu systemu funduszu skojarzonego ze zdarzeniem. |
|
|
Nieaktywny?
|
inactive | boolean |
Czy zdarzenie jest aktywne? |
Lista darowizn uczestników
Wyświetla listę datków dla uczestnika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator uczestnika
|
participant_id | True | string |
Identyfikator rekordu systemowego uczestnika. |
|
Ograniczenie
|
limit | integer |
Reprezentuje liczbę rekordów do zwrócenia. Wartość domyślna to 500. Wartość maksymalna to 10000. |
|
|
Przesunięcie
|
offset | integer |
Reprezentuje liczbę rekordów do pominięcia. Do użycia z podziałem na strony. Wartość domyślna to 0. |
Zwraca
Darowizny
Lista opłat za uczestnika
Wyświetla listę opłat dla uczestnika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator uczestnika
|
participant_id | True | string |
Identyfikator rekordu systemowego uczestnika. |
|
Ograniczenie
|
limit | integer |
Reprezentuje liczbę rekordów do zwrócenia. Wartość domyślna to 500. Wartość maksymalna to 10000. |
|
|
Przesunięcie
|
offset | integer |
Reprezentuje liczbę rekordów do pominięcia. Do użycia z podziałem na strony. Wartość domyślna to 0. |
Zwraca
Opłaty
Pobieranie zdarzenia
Zwraca informacje o zdarzeniu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator zdarzenia
|
event_id | True | string |
Identyfikator rekordu systemu zdarzenia do pobrania. |
Zwraca
Event
- Body
- EventApi.Event
Tworzenie darowizny uczestnika
Tworzy nową darowiznę dla uczestnika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator uczestnika
|
participant_id | True | string |
Identyfikator rekordu systemowego uczestnika. |
|
Identyfikator prezentu
|
gift_id | True | string |
Identyfikator rekordu systetm prezentu, do którego jest połączona darowizna uczestnika. |
Zwraca
Utworzono darowiznę uczestnika
Tworzenie opłaty za uczestnika
Tworzy nową opłatę dla uczestnika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator uczestnika
|
participant_id | True | string |
Identyfikator rekordu systemowego uczestnika. |
|
Identyfikator zdarzenia
|
event_id | True | string |
Identyfikator rekordu systemu zdarzenia. |
|
Opłata
|
event_fee_id | True | string |
Opłata za zdarzenie. |
|
Ilość
|
quantity | True | integer |
Zakupiona ilość. |
|
Kwota opłaty
|
fee_amount | True | double |
Kwota pieniędzy związana z opłatą. |
|
Kwota wkładu
|
contribution_amount | True | double |
Kwota opłaty, która jest darowizną powyżej kosztów wydarzenia. Jest to kwota, która zwykle pojawia się na paragonach. |
|
day
|
d | integer |
Dzień w dacie rozmytej. |
|
|
miesiąca
|
m | integer |
Miesiąc w dacie rozmytej. |
|
|
rok
|
y | integer |
Rok w dacie rozmytej. |
Zwraca
Utworzono opłatę za uczestnika
Tworzenie opłaty za zdarzenie
Tworzy nową opłatę za zdarzenie.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator zdarzenia
|
event_id | True | string |
Identyfikator rekordu systemu zdarzenia. |
|
Name
|
name | True | string |
Nazwa opłaty. |
|
Kwota opłaty
|
cost | True | double |
Kwota pieniędzy związana z opłatą. |
|
Kwota wkładu
|
contribution_amount | True | double |
Kwota opłaty, która jest darowizną powyżej kosztów wydarzenia. |
Zwraca
Utworzono opłatę za zdarzenie
Tworzenie płatności za opłatę uczestnika
Tworzy nową płatność opłatą dla uczestnika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator uczestnika
|
participant_id | True | string |
Identyfikator rekordu systemowego uczestnika. |
|
Identyfikator prezentu
|
gift_id | True | string |
Identyfikator rekordu systetm prezentu, do którego jest połączona opłata uczestnika. |
|
Zastosowana kwota
|
applied_amount | True | double |
Kwota płatności, która ma zastosowanie do opłat uczestnika. |
Zwraca
Utworzono płatność za opłatę uczestnika
Tworzenie uczestnika
Tworzy nowego uczestnika wydarzenia.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator zdarzenia
|
event_id | True | string |
Identyfikator rekordu systemu zdarzenia. |
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator składowy uczestnika. |
|
Identyfikator hosta
|
host_id | string |
Identyfikator rekordu uczestnika hosta. |
|
|
Stan RSVP
|
rsvp_status | string |
Stan zaangażowania uczestnika w wydarzenie. |
|
|
Uczestniczyło?
|
attended | boolean |
Czy uczestnik uczestniczył w wydarzeniu? |
|
|
Stan zaproszenia
|
invitation_status | string |
Stan zaproszenia do uczestnika. |
|
|
day
|
d | integer |
Dzień w dacie rozmytej. |
|
|
miesiąca
|
m | integer |
Miesiąc w dacie rozmytej. |
|
|
rok
|
y | integer |
Rok w dacie rozmytej. |
|
|
day
|
d | integer |
Dzień w dacie rozmytej. |
|
|
miesiąca
|
m | integer |
Miesiąc w dacie rozmytej. |
|
|
rok
|
y | integer |
Rok w dacie rozmytej. |
|
|
Poziom uczestnictwa
|
name | True | string |
Nazwa poziomu uczestnictwa. |
|
Notatka podsumowująca
|
summary_note | string |
Szybkie informacje referencyjne przypięte do rekordu uczestnika. |
Zwraca
Utworzony uczestnik
Tworzenie załącznika zdarzenia
Tworzy nowy załącznik zdarzenia.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator zdarzenia
|
event_id | True | string |
Identyfikator rekordu systemu zdarzenia. |
|
Typ
|
type | True | string |
Typ załącznika. Fizyczne załączniki są przekazywane, takie jak obrazy, pliki PDF lub dokumenty programu Word zapisywane lokalnie lub w sieci. Są one przechowywane i zarządzane w systemie. Załączniki linków to linki do plików, takich jak obrazy, wpisy w blogu lub filmy wideo w serwisie YouTube, które są w trybie online lub na koncie magazynu w chmurze. Są one przechowywane i zarządzane zewnętrznie. |
|
Name
|
name | string |
Nazwa załącznika. Limit znaków: 150. |
|
|
Date
|
date | date-time |
Data załącznika (np. "2020-09-18T04:13:56Z"). To pole domyślnie jest domyślnie ustawiona na bieżącą datę i godzinę, jeśli nie zostanie podana. |
|
|
adres URL
|
url | string |
Adres URL załącznika. Jest to wymagane w przypadku załączników linków i nie dotyczy załączników fizycznych. |
|
|
Nazwa pliku
|
file_name | string |
Nazwa pliku. Limit znaków: 36. Tylko w przypadku załączników fizycznych. |
|
|
Identyfikator pliku
|
file_id | string |
Identyfikator pliku. Limit znaków: 36. Tylko w przypadku załączników fizycznych. |
|
|
Identyfikator miniatury
|
thumbnail_id | string |
Identyfikator miniatury. Limit znaków: 36. Tylko w przypadku załączników fizycznych. |
|
|
Etykiety
|
tags | array of string |
Tagi skojarzone z załącznikiem. |
Zwraca
Utworzony załącznik zdarzenia
Tworzenie zdarzenia
Tworzy nowe zdarzenie.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa zdarzenia
|
name | True | string |
Nazwa zdarzenia. |
|
Description
|
description | string |
Opis zdarzenia. |
|
|
Kategoria
|
name | True | string |
Nazwa kategorii. |
|
Data rozpoczęcia
|
start_date | True | date |
Data rozpoczęcia wydarzenia (np. "2020-09-18"). |
|
Godzina rozpoczęcia
|
start_time | string |
Godzina rozpoczęcia zdarzenia (np. "07:30"). |
|
|
Data zakończenia
|
end_date | date |
Data zakończenia wydarzenia (np. "2020-09-18"). |
|
|
Godzina zakończenia
|
end_time | string |
Godzina zakończenia zdarzenia (np. "07:30)". |
|
|
Identyfikator odnośnika
|
lookup_id | string |
Identyfikator odnośnika zdarzenia. |
|
|
Pojemność
|
capacity | integer |
Liczba osób, które mogą wziąć udział w wydarzeniu. |
|
|
Goal
|
goal | double |
Cel pieniężny zdarzenia. |
|
|
Identyfikator kampanii
|
campaign_id | string |
Identyfikator rekordu systemu kampanii skojarzonej ze zdarzeniem. |
|
|
Identyfikator funduszu
|
fund_id | string |
Identyfikator rekordu systemu funduszu skojarzonego ze zdarzeniem. |
|
|
Nieaktywny?
|
inactive | boolean |
Czy zdarzenie jest aktywne? |
Zwraca
Zdarzenie utworzone
Utwórz opcję uczestnika
Tworzy nową opcję uczestnika dla uczestnika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator uczestnika
|
participant_id | True | string |
Identyfikator uczestnika. |
|
body
|
body | True | dynamic |
Obiekt reprezentujący opcję uczestnika do utworzenia. |
Zwraca
Opcja Utworzono uczestnika
Utwórz opcję uczestnika zdarzenia
Tworzy nową opcję uczestnika dla wydarzenia.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator zdarzenia
|
event_id | True | string |
Identyfikator zdarzenia. |
|
Name
|
name | True | string |
Nazwa opcji uczestnika wydarzenia. |
|
Typ danych wejściowych
|
input_type | True | string |
Typy wartości, których uczestnicy mogą używać do dostarczania odpowiedzi. |
|
Czy zezwolić na wybór wielokrotny?
|
multi_select | boolean |
Czy zezwolić na więcej niż jedną wartość list? |
|
|
nazwa
|
name | string |
Nazwa opcji listy. |
|
|
sekwencja
|
sequence | integer |
Sekwencja oparta na 0 używana do zamawiania. |
Zwraca
Opcja utworzonego uczestnika zdarzenia
Uzyskiwanie uczestnika
Zwraca informacje o określonym uczestniku zdarzenia.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator uczestnika
|
participant_id | True | string |
Identyfikator rekordu systemowego uczestnika. |
Zwraca
Uczestnik
- Body
- EventApi.Participant
Wyświetlanie listy opcji uczestnika
Wyświetla listę opcji uczestnika dla uczestnika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator uczestnika
|
participant_id | True | string |
Identyfikator rekordu systemowego uczestnika. |
Zwraca
Opcje uczestnika
Wyświetlanie listy opcji uczestnika zdarzenia
Wyświetla listę opcji uczestnika dla zdarzenia.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator zdarzenia
|
event_id | True | string |
Identyfikator zdarzenia. |
Zwraca
Opcje uczestnika zdarzenia
Wyświetlanie listy opłat za zdarzenia
Wyświetla listę opłat za wydarzenie.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator zdarzenia
|
event_id | True | string |
Identyfikator rekordu systemu zdarzenia. |
Zwraca
Opłaty
Wyświetlanie listy płatności za opłatę uczestnika
Wyświetla listę płatności opłat dla uczestnika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator uczestnika
|
participant_id | True | string |
Identyfikator rekordu systemowego uczestnika. |
|
Ograniczenie
|
limit | integer |
Reprezentuje liczbę rekordów do zwrócenia. Wartość domyślna to 500. Wartość maksymalna to 10000. |
|
|
Przesunięcie
|
offset | integer |
Reprezentuje liczbę rekordów do pominięcia. Do użycia z podziałem na strony. Wartość domyślna to 0. |
Zwraca
Płatności opłat
Wyświetlanie listy uczestników wydarzenia
Wyświetla listę uczestników wydarzenia.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator zdarzenia
|
event_id | True | string |
Identyfikator rekordu systemu zdarzenia. |
|
Stan RSVP
|
rsvp_status | string |
Filtruj uczestników na podstawie stanu RSVP. |
|
|
Stan zaproszenia
|
invitation_status | string |
Filtruj uczestników na podstawie stanu zaproszenia. |
|
|
Poziom uczestnictwa
|
participation_level | string |
Filtruj uczestników na podstawie poziomu zaangażowania. |
|
|
Uczestniczyło?
|
attended_filter | boolean |
Filtruj pod kątem dołączania lub wykluczania uczestników oznaczonych jako uczestniczyli. |
|
|
Opłaty zapłacone?
|
fees_paid_filter | boolean |
Filtruj pod kątem dołączania lub wykluczania uczestników, którzy zapłacili swoje opłaty. |
|
|
Ograniczenie
|
limit | integer |
Reprezentuje liczbę rekordów do zwrócenia. Wartość domyślna to 500. Wartość maksymalna to 10000. |
|
|
Przesunięcie
|
offset | integer |
Reprezentuje liczbę rekordów do pominięcia. Do użycia z podziałem na strony. |
|
|
Czy składnik?
|
is_constituent_filter | boolean |
Filtruj pod kątem dołączania lub wykluczania uczestników, którzy są składnikami. |
|
|
Czy kwalifikuje się wiadomość e-mail?
|
email_eligible_filter | boolean |
Filtruj pod kątem dołączania lub wykluczania uczestników na podstawie tego, czy mają podstawowy adres e-mail, który nie jest oznaczony jako Nie wysyłaj wiadomości e-mail? |
|
|
Ma uprawniony telefon?
|
phone_call_eligible_filter | boolean |
Filtruj pod kątem dołączania lub wykluczania uczestników na podstawie tego, czy mają podstawowy numer telefonu, który nie jest oznaczony jako Nie dzwonij. |
|
|
Name
|
name | string |
Filtruj dla uczestników, którzy są zgodni z określoną nazwą. |
|
|
Dodano polecenie lub po
|
date_added | date-time |
Przefiltruj wyniki do uczestników utworzonych w określonym dniu lub po określonej dacie (np. "2020-09-18T04:13:56Z"). |
|
|
Zmodyfikowano w dniu lub po
|
last_modified | date-time |
Przefiltruj wyniki do uczestników zmodyfikowanych w określonym dniu lub po określonej dacie (np. "2020-09-18T04:13:56Z"). |
Zwraca
Uczestnicy
Wyświetlanie listy załączników zdarzeń
Wyświetla listę załączników dla zdarzenia.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator zdarzenia
|
event_id | True | string |
Identyfikator rekordu systemu zdarzenia. |
Zwraca
Załączniki
Wyświetlanie listy zdarzeń
Zwraca listę zdarzeń.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Kategoria
|
category | string |
Filtruj na podstawie kategorii zdarzeń. |
|
|
Identyfikator odnośnika
|
lookup_id | string |
Filtr wyników pasujących do niestandardowego identyfikatora rekordu zdarzenia. |
|
|
Data rozpoczęcia od
|
start_date_from | date |
Przefiltruj wyniki do zdarzeń z datą rozpoczęcia lub po określonej dacie (np. "2020-09-18"). |
|
|
Data rozpoczęcia do
|
start_date_to | date |
Przefiltruj wyniki do zdarzeń z datą rozpoczęcia lub przed określoną datą (np. "2020-09-18"). |
|
|
Uwzględnij nieaktywne?
|
include_inactive | boolean |
Uwzględnij nieaktywne zdarzenia? |
|
|
Ograniczenie
|
limit | integer |
Reprezentuje liczbę rekordów do zwrócenia. Wartość domyślna to 500. Wartość maksymalna to 10000. |
|
|
Przesunięcie
|
offset | integer |
Reprezentuje liczbę rekordów do pominięcia. Do użycia z podziałem na strony. |
|
|
Identyfikator zdarzenia
|
event_id | string |
Filtruj zdarzenia zgodne z określonym identyfikatorem rekordu systemu. |
|
|
Name
|
name | string |
Filtruj pod kątem zdarzeń, które są zgodne z określoną nazwą. |
|
|
Dodano polecenie lub po
|
date_added | date-time |
Przefiltruj wyniki do zdarzeń utworzonych w określonym dniu lub po określonej dacie (np. "2020-09-18T04:13:56Z"). |
|
|
Zmodyfikowano w dniu lub po
|
last_modified | date-time |
Przefiltruj wyniki do zdarzeń zmodyfikowanych w określonym dniu lub po określonej dacie (np. "2020-09-18T04:13:56Z"). |
Zwraca
Events
Definicje
EventApi.AdministrativeArea
Definiuje model danych używany w obszarze administracyjnym adresu (np. stan w Stanach Zjednoczonych).
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu obszaru administracyjnego. |
|
nazwa
|
name | string |
Nazwa obszaru administracyjnego. |
|
krótki opis
|
short_description | string |
Krótki opis obszaru administracyjnego. |
EventApi.ApiCollectionOfEventFee
Opłaty
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba
|
count | integer |
Liczba elementów dostępnych do pobrania do kolekcji po zastosowaniu dowolnych parametrów żądania. Parametry limitu i przesunięcia nie mają wpływu na liczbę, ale aby ułatwić stronicowanie, mogą mieć wpływ na liczbę elementów w zestawie wyników wartości. |
|
value
|
value | array of EventApi.EventFee |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
EventApi.ApiCollectionOfEventListEntry
Events
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba
|
count | integer |
Liczba elementów dostępnych do pobrania do kolekcji po zastosowaniu dowolnych parametrów żądania. Parametry limitu i przesunięcia nie mają wpływu na liczbę, ale aby ułatwić stronicowanie, mogą mieć wpływ na liczbę elementów w zestawie wyników wartości. |
|
value
|
value | array of EventApi.EventListEntry |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
EventApi.ApiCollectionOfEventParticipantOption
Opcje uczestnika zdarzenia
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba
|
count | integer |
Liczba elementów dostępnych do pobrania do kolekcji po zastosowaniu dowolnych parametrów żądania. Parametry limitu i przesunięcia nie mają wpływu na liczbę, ale aby ułatwić stronicowanie, mogą mieć wpływ na liczbę elementów w zestawie wyników wartości. |
|
value
|
value | array of EventApi.EventParticipantOption |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
EventApi.ApiCollectionOfParticipantDonation
Darowizny
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba
|
count | integer |
Liczba elementów dostępnych do pobrania do kolekcji po zastosowaniu dowolnych parametrów żądania. Parametry limitu i przesunięcia nie mają wpływu na liczbę, ale aby ułatwić stronicowanie, mogą mieć wpływ na liczbę elementów w zestawie wyników wartości. |
|
value
|
value | array of EventApi.ParticipantDonation |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
EventApi.ApiCollectionOfParticipantFee
Opłaty
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba
|
count | integer |
Liczba elementów dostępnych do pobrania do kolekcji po zastosowaniu dowolnych parametrów żądania. Parametry limitu i przesunięcia nie mają wpływu na liczbę, ale aby ułatwić stronicowanie, mogą mieć wpływ na liczbę elementów w zestawie wyników wartości. |
|
value
|
value | array of EventApi.ParticipantFee |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
EventApi.ApiCollectionOfParticipantFeePayment
Płatności opłat
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba
|
count | integer |
Liczba elementów dostępnych do pobrania do kolekcji po zastosowaniu dowolnych parametrów żądania. Parametry limitu i przesunięcia nie mają wpływu na liczbę, ale aby ułatwić stronicowanie, mogą mieć wpływ na liczbę elementów w zestawie wyników wartości. |
|
value
|
value | array of EventApi.ParticipantFeePayment |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
EventApi.ApiCollectionOfParticipantListEntry
Uczestnicy
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba
|
count | integer |
Liczba elementów dostępnych do pobrania do kolekcji po zastosowaniu dowolnych parametrów żądania. Parametry limitu i przesunięcia nie mają wpływu na liczbę, ale aby ułatwić stronicowanie, mogą mieć wpływ na liczbę elementów w zestawie wyników wartości. |
|
value
|
value | array of EventApi.ParticipantListEntry |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
EventApi.ApiCollectionOfParticipantOption
Opcje uczestnika
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba
|
count | integer |
Liczba elementów dostępnych do pobrania do kolekcji po zastosowaniu dowolnych parametrów żądania. Parametry limitu i przesunięcia nie mają wpływu na liczbę, ale aby ułatwić stronicowanie, mogą mieć wpływ na liczbę elementów w zestawie wyników wartości. |
|
value
|
value | array of EventApi.ParticipantOption |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
EventApi.Country
Definiuje model danych używany dla kraju adresu.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu kraju. |
|
nazwa wyświetlana
|
display_name | string |
Nazwa wyświetlana kraju. |
|
Kod ISO
|
iso_alpha2_code | string |
Kod ISO 3166-1 alfa-2 dla kraju. |
EventApi.CreatedEvent
Zdarzenie utworzone
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonego zdarzenia. |
EventApi.CreatedEventAttachment
Utworzony załącznik zdarzenia
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonego załącznika zdarzenia. |
EventApi.CreatedEventFee
Utworzono opłatę za zdarzenie
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonej opłaty za zdarzenie. |
EventApi.CreatedEventParticipantOption
Opcja utworzonego uczestnika zdarzenia
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonej opcji uczestnika zdarzenia. |
EventApi.CreatedParticipant
Utworzony uczestnik
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonego uczestnika. |
EventApi.CreatedParticipantDonation
Utworzono darowiznę uczestnika
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonej darowizny uczestnika. |
EventApi.CreatedParticipantFee
Utworzono opłatę za uczestnika
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonej opłaty uczestnika. |
EventApi.CreatedParticipantFeePayment
Utworzono płatność za opłatę uczestnika
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonej płatności za opłatę uczestnika. |
EventApi.CreatedParticipantOption
Opcja Utworzono uczestnika
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonej opcji uczestnika. |
EventApi.Event
Event
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemu zdarzenia. Nie jest to takie samo, jak identyfikator zdarzenia, który można definiować przez użytkownika, który jest przechowywany w lookup_id. |
|
Name
|
name | string |
Nazwa zdarzenia. |
|
Description
|
description | string |
Opis zdarzenia. |
|
Data rozpoczęcia
|
start_date | date |
Data rozpoczęcia zdarzenia. |
|
Godzina rozpoczęcia
|
start_time | string |
Godzina rozpoczęcia zdarzenia. |
|
Data zakończenia
|
end_date | date |
Data zakończenia wydarzenia. |
|
Godzina zakończenia
|
end_time | string |
Godzina zakończenia zdarzenia. |
|
Kategoria
|
category | EventApi.EventCategory |
Kategoria zdarzeń to niestandardowa kategoryzacja zdarzenia. |
|
Identyfikator odnośnika
|
lookup_id | string |
Identyfikator odnośnika zdarzenia. |
|
Lokalizacja
|
location | EventApi.Location |
Definiuje model danych używany dla lokalizacji. |
|
Pojemność
|
capacity | integer |
Liczba osób, które mogą wziąć udział w wydarzeniu. |
|
Goal
|
goal | double |
Cel pieniężny zdarzenia. |
|
Identyfikator kampanii
|
campaign_id | string |
Identyfikator rekordu systemu kampanii skojarzonej ze zdarzeniem. |
|
Identyfikator funduszu
|
fund_id | string |
Identyfikator rekordu systemu funduszu skojarzonego ze zdarzeniem. |
|
Nieaktywny?
|
inactive | boolean |
Czy zdarzenie jest nieaktywne? |
|
Data dodania
|
date_added | date-time |
Data utworzenia zdarzenia. |
|
Data modyfikacji
|
date_modified | date-time |
Data ostatniej modyfikacji zdarzenia. |
EventApi.EventAttachment
Załącznik
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemu załącznika. |
|
Identyfikator zdarzenia
|
parent_id | string |
Identyfikator rekordu systemu zdarzenia skojarzonego z załącznikiem. |
|
Typ
|
type | string |
Typ załącznika. Fizyczne załączniki są przekazywane, takie jak obrazy, pliki PDF lub dokumenty programu Word zapisywane lokalnie lub w sieci. Są one przechowywane i zarządzane w systemie. Załączniki linków to linki do plików, takich jak obrazy, wpisy w blogu lub filmy wideo w serwisie YouTube, które są w trybie online lub na koncie magazynu w chmurze. Są one przechowywane i zarządzane zewnętrznie. |
|
Name
|
name | string |
Nazwa załącznika. Limit znaków: 150. |
|
Date
|
date | date-time |
Data załącznika. |
|
adres URL
|
url | string |
Adres URL załącznika. Jest to wymagane w przypadku załączników linków i nie dotyczy załączników fizycznych. |
|
Nazwa pliku
|
file_name | string |
Nazwa pliku. Limit znaków: 36. Tylko w przypadku załączników fizycznych. |
|
Identyfikator pliku
|
file_id | string |
Identyfikator pliku. Limit znaków: 36. Tylko w przypadku załączników fizycznych. |
|
Identyfikator miniatury
|
thumbnail_id | string |
Identyfikator miniatury. Limit znaków: 36. Tylko w przypadku załączników fizycznych. |
|
Adres URL miniatury
|
thumbnail_url | string |
Adres URL miniatury. W przypadku załączników fizycznych, które są tylko obrazami. Zawiera sygnaturę związaną z czasem, która ogranicza dostęp do 60 minut. |
|
Typ zawartości
|
content_type | string |
Typ zawartości. Tylko w przypadku załączników fizycznych. |
|
Rozmiar pliku
|
file_size | integer |
Rozmiar pliku w bajtach. Tylko w przypadku załączników fizycznych. |
|
Etykiety
|
tags | array of string |
Tagi skojarzone z załącznikiem. |
EventApi.EventAttachmentCollection
Załączniki
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba
|
count | integer |
Liczba elementów dostępnych do pobrania do kolekcji po zastosowaniu dowolnych parametrów żądania. Parametry limitu i przesunięcia nie mają wpływu na liczbę, ale aby ułatwić stronicowanie, mogą mieć wpływ na liczbę elementów w zestawie wyników wartości. |
|
value
|
value | array of EventApi.EventAttachment |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
EventApi.EventCategory
Kategoria zdarzeń to niestandardowa kategoryzacja zdarzenia.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemu kategorii zdarzeń. |
|
nazwa
|
name | string |
Nazwa kategorii zdarzeń. |
|
nieaktywny?
|
inactive | boolean |
Czy ta kategoria jest nieaktywna? |
EventApi.EventFee
Opłaty za wydarzenia są naliczane przez organizację opłaty za uczestnictwo w wydarzeniu lub uczestnictwo w nim osób lub organizacji.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemu opłaty za zdarzenie. |
|
nazwa
|
name | string |
Nazwa opłaty za zdarzenie. |
|
kwota
|
cost | double |
Koszt opłaty. |
|
kwota składek
|
contribution_amount | double |
Kwota odliczana od podatku za tę opłatę. |
|
liczba sprzedanych
|
number_sold | integer |
Liczba sprzedanych opłat. |
EventApi.EventListEntry
Event
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemu zdarzenia. |
|
Name
|
name | string |
Nazwa zdarzenia. |
|
Data rozpoczęcia
|
start_date | date |
Data rozpoczęcia zdarzenia. |
|
Godzina rozpoczęcia
|
start_time | string |
Godzina rozpoczęcia zdarzenia. |
|
Data zakończenia
|
end_date | date |
Data zakończenia wydarzenia. |
|
Godzina zakończenia
|
end_time | string |
Godzina zakończenia zdarzenia. |
|
Kategoria
|
category | EventApi.EventCategory |
Kategoria zdarzeń to niestandardowa kategoryzacja zdarzenia. |
|
Identyfikator odnośnika
|
lookup_id | string |
Identyfikator odnośnika zdarzenia. |
|
Pojemność
|
capacity | integer |
Liczba osób, które mogą wziąć udział w wydarzeniu. |
|
Uczestniczy
|
attending_count | integer |
Liczba uczestników wydarzenia, którzy planują wziąć udział. |
|
Nadzorowane
|
attended_count | integer |
Liczba uczestników wydarzenia. |
|
Zaproszony
|
invited_count | integer |
Liczba zaproszeń zdarzeń. |
|
Przychód
|
revenue | double |
Zrealizowany przychód wydarzenia. |
|
Goal
|
goal | double |
Cel pieniężny zdarzenia. |
|
Procent celu
|
percent_of_goal | integer |
Zrealizowany przychód jako procent przychodu z celu. |
|
Nieaktywny?
|
inactive | boolean |
Czy zdarzenie jest nieaktywne? |
|
Data dodania
|
date_added | date-time |
Data utworzenia zdarzenia. |
|
Data modyfikacji
|
date_modified | date-time |
Data ostatniej modyfikacji zdarzenia. |
EventApi.EventParticipantOption
Opcje uczestników wydarzenia to pola, które zbierają szczegółowe informacje o uczestnikach, takie jak rozmiary koszulki, preferencje dotyczące posiłków lub prośby o siedzenia. Ustaw opcje i ich wartości dla zdarzenia, a następnie dodaj odpowiedzi dla każdego uczestnika.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemu opcji uczestnika zdarzenia. |
|
nazwa
|
name | string |
Nazwa opcji uczestnika wydarzenia. |
|
typ danych wejściowych
|
input_type | string |
Typ opcji uczestnika zdarzenia. |
|
czy zezwolić na wybór wielokrotny?
|
multi_select | boolean |
Czy zezwolić na więcej niż jedną wartość list? |
|
list_options
|
list_options | array of EventApi.EventParticipantOptionListOption |
Dostępne opcje listy. |
|
dodane przez użytkownika
|
added_by_user | string |
Identyfikator użytkownika, który dodał opcję. |
|
zmodyfikowane przez użytkownika
|
updated_by_user | string |
Identyfikator użytkownika, który zmodyfikował tę opcję. |
|
dodane przez usługę
|
added_by_service | string |
Nazwa usługi, która dodała tę opcję. |
|
zmodyfikowane przez usługę
|
updated_by_service | string |
Nazwa usługi, która zmodyfikowała tę opcję. |
|
data dodania
|
date_added | date-time |
Data utworzenia opcji. |
|
data modyfikacji
|
date_updated | date-time |
Data ostatniej modyfikacji opcji. |
|
wersja
|
version | integer |
Numer wersji opcji. |
EventApi.EventParticipantOptionListOption
Opcja listy opcji uczestnika zdarzenia
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator opcji listy |
|
nazwa
|
name | string |
Nazwa opcji listy |
|
sekwencja
|
sequence | integer |
Sekwencja używana do zamawiania opcji listy |
EventApi.Locality
Definiuje model danych używany na potrzeby lokalizacji adresu.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu lokalizacji. |
|
nazwa
|
name | string |
Nazwa lokalizacji. |
EventApi.Location
Definiuje model danych używany dla lokalizacji.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
nazwa
|
name | string |
Nazwa lokalizacji. |
|
wiersze adresu
|
address_lines | string |
Wiersze adresu lokalizacji. |
|
kod pocztowy
|
postal_code | string |
Kod pocztowy lokalizacji. |
|
miejscowość
|
locality | EventApi.Locality |
Definiuje model danych używany na potrzeby lokalizacji adresu. |
|
obszar administracyjny
|
administrative_area | EventApi.AdministrativeArea |
Definiuje model danych używany w obszarze administracyjnym adresu (np. stan w Stanach Zjednoczonych). |
|
obszar podrzędny administracyjny
|
sub_administrative_area | EventApi.SubAdministrativeArea |
Definiuje model danych używany dla obszaru administracyjnego adresu (np. miasto w USA). |
|
country
|
country | EventApi.Country |
Definiuje model danych używany dla kraju adresu. |
|
sformatowany adres
|
formatted_address | string |
Adres sformatowany lokalizacji |
EventApi.Membership
Informacje o członkostwie dla uczestnika.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Kategoria członkostwa
|
category | EventApi.MembershipCategory |
Kategoria członkostwa osoby. |
EventApi.MembershipCategory
Kategoria członkostwa osoby.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemu kategorii członkostwa. |
|
nazwa
|
name | string |
Nazwa kategorii członkostwa. |
EventApi.Participant
Uczestnik
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemowego uczestnika. |
|
Identyfikator składowy
|
constituent_id | string |
Identyfikator składowy uczestnika. |
|
Identyfikator zdarzenia
|
event_id | string |
Identyfikator rekordu systemu udziału zdarzenia. |
|
Identyfikator hosta
|
host_id | string |
Identyfikator rekordu uczestnika hosta. |
|
Stan RSVP
|
rsvp_status | string |
Stan zaangażowania uczestnika w wydarzenie. |
|
Uczestniczyło?
|
attended | boolean |
Czy uczestnik uczestniczył w wydarzeniu? |
|
Stan zaproszenia
|
invitation_status | string |
Stan zaproszenia do uczestnika. |
|
day
|
rsvp_date.d | integer |
Dzień w dacie rozmytej. |
|
miesiąca
|
rsvp_date.m | integer |
Miesiąc w dacie rozmytej. |
|
rok
|
rsvp_date.y | integer |
Rok w dacie rozmytej. |
|
day
|
invitation_date.d | integer |
Dzień w dacie rozmytej. |
|
miesiąca
|
invitation_date.m | integer |
Miesiąc w dacie rozmytej. |
|
rok
|
invitation_date.y | integer |
Rok w dacie rozmytej. |
|
Notatka podsumowująca
|
summary_note | string |
Szybkie informacje referencyjne przypięte do rekordu uczestnika. |
|
Poziom uczestnictwa
|
participation_level | EventApi.ParticipationLevel |
Poziomy uczestnictwa to poziom zaangażowania uczestników wydarzenia. |
|
Data dodania
|
date_added | date-time |
Data utworzenia uczestnika. |
|
Data modyfikacji
|
date_modified | date-time |
Data ostatniej modyfikacji uczestnika. |
EventApi.ParticipantDonation
Definiuje model danych dla darowizny uczestnika
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemu darowizny uczestnika. |
|
identyfikator prezentu
|
gift_id | string |
Identyfikator prezentu, do którego jest połączona darowizna uczestnika. |
EventApi.ParticipantFee
Definiuje model danych dla opłaty uczestnika
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator opłaty uczestnika. |
|
identyfikator uczestnika
|
participant_id | string |
Identyfikator rekordu, z którą jest połączona opłata uczestnika. |
|
ilość
|
quantity | integer |
Zakupiona ilość. |
|
kwota opłaty
|
fee_amount | double |
Kwota opłaty za uczestnika. |
|
kwota składek
|
tax_receiptable_amount | double |
Kwota odliczana od podatku za tę opłatę. |
|
day
|
date.d | integer |
Dzień w dacie rozmytej. |
|
miesiąca
|
date.m | integer |
Miesiąc w dacie rozmytej. |
|
rok
|
date.y | integer |
Rok w dacie rozmytej. |
|
Opłata za zdarzenie
|
event_fee | EventApi.EventFee |
Opłaty za wydarzenia są naliczane przez organizację opłaty za uczestnictwo w wydarzeniu lub uczestnictwo w nim osób lub organizacji. |
EventApi.ParticipantFeePayment
Definiuje model danych dla płatności za opłatę uczestnika
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemowego płatności opłaty uczestnika. |
|
identyfikator uczestnika
|
participant_id | string |
Identyfikator rekordu systemu uczestnika, z którym jest połączona płatność z opłatą uczestnika. |
|
identyfikator prezentu
|
gift_id | string |
Identyfikator prezentu, do którego jest połączona opłata uczestnika. |
|
zastosowana kwota
|
applied_amount | double |
Zastosowana kwota płatności z opłatą uczestnika. |
EventApi.ParticipantListEntry
Uczestnik
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemowego uczestnika. |
|
Identyfikator kontaktu
|
contact_id | string |
Identyfikator kontaktu biorącego udział w wydarzeniu. |
|
Stan RSVP
|
rsvp_status | string |
Stan zaangażowania uczestnika w wydarzenie. |
|
Uczestniczyło?
|
attended | boolean |
Czy uczestnik uczestniczył w wydarzeniu? |
|
Stan zaproszenia
|
invitation_status | string |
Stan zaproszenia do uczestnika. |
|
day
|
rsvp_date.d | integer |
Dzień w dacie rozmytej. |
|
miesiąca
|
rsvp_date.m | integer |
Miesiąc w dacie rozmytej. |
|
rok
|
rsvp_date.y | integer |
Rok w dacie rozmytej. |
|
Poziom uczestnictwa
|
participation_level | EventApi.ParticipationLevel |
Poziomy uczestnictwa to poziom zaangażowania uczestników wydarzenia. |
|
Title
|
title | string |
Tytuł uczestnika. |
|
Imię
|
first_name | string |
Imię uczestnika. |
|
Nazwisko
|
last_name | string |
Nazwisko uczestnika. |
|
Name
|
name | string |
Pełna nazwa uczestnika. |
|
Preferowana nazwa
|
preferred_name | string |
Preferowana nazwa uczestnika. |
|
Sufiks
|
suffix | string |
Sufiks uczestnika. |
|
Identyfikator odnośnika
|
lookup_id | string |
LookupId uczestnika. |
|
Email
|
string |
Adres e-mail uczestnika. |
|
|
Nie wysyłaj wiadomości e-mail?
|
do_not_email | boolean |
Czy uczestnik może skontaktować się pod tym adresem e-mail? |
|
Telefon
|
phone | string |
Numer telefonu uczestnika. |
|
Nie dzwonisz?
|
do_not_call | boolean |
Czy można skontaktować się z uczestnikiem pod tym numerem? |
|
Drugie imię
|
middle_name | string |
Drugie imię uczestnika. |
|
Była nazwa
|
former_name | string |
Była nazwa uczestnika. |
|
Czy składnik?
|
is_constituent | boolean |
Czy uczestnik jest składnikiem? |
|
Klasa klasy
|
class_of | string |
Ukończenie zajęć przez uczestnika. |
|
Łączne opłaty rejestracyjne
|
total_registration_fees | double |
Suma kwot opłaty uczestnika. |
|
Łączna liczba płatnych
|
total_paid | double |
Suma płatnych prezentów uczestnika z typem Opłat rejestracyjnych. |
|
Darowizny
|
donations | double |
Suma płatnych prezentów uczestnika z typem Darowizny. |
|
Przychód
|
revenue | double |
Suma płatnych prezentów uczestnika we wszystkich typach. |
|
Siedzenie
|
seat | string |
Przypisanie miejsca dla uczestnika. |
|
Tag nazwy
|
name_tag | string |
Tag nazwy uczestnika |
|
Notatka podsumowująca
|
summary_note | string |
Szybkie informacje referencyjne przypięte do rekordu uczestnika. |
|
Data dodania
|
date_added | date-time |
Data utworzenia uczestnika. |
|
Data modyfikacji
|
date_modified | date-time |
Data ostatniej modyfikacji uczestnika. |
|
identyfikator kontaktu
|
host.contact_id | string |
Identyfikator kontaktu biorącego udział w wydarzeniu. |
|
identyfikator uczestnika
|
host.participant_id | string |
Identyfikator uczestnika. |
|
nazwa
|
host.name | string |
Pełna nazwa uczestnika. |
|
Gości
|
guests | array of EventApi.ParticipantListParticipantSummary |
Goście uczestnika. |
|
Członkostwa
|
memberships | array of EventApi.Membership |
Informacje o członkostwie dla uczestnika. |
EventApi.ParticipantListParticipantSummary
Podstawowe informacje podsumowujące uczestnika.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator kontaktu
|
contact_id | string |
Identyfikator kontaktu biorącego udział w wydarzeniu. |
|
identyfikator uczestnika
|
participant_id | string |
Identyfikator uczestnika. |
|
nazwa
|
name | string |
Pełna nazwa uczestnika. |
EventApi.ParticipantOption
Opcja uczestnika skojarzona z danym uczestnikiem
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemu opcji uczestnika. |
|
identyfikator uczestnika
|
participant_id | string |
Identyfikator rekordu systemowego uczestnika. |
|
identyfikator zdarzenia
|
event_id | string |
Identyfikator rekordu systemu zdarzenia. |
|
identyfikator opcji uczestnika zdarzenia
|
event_participant_option_id | string |
Identyfikator rekordu systemu opcji uczestnika zdarzenia. |
|
value
|
option_value | string |
Odpowiedź uczestnika na tę opcję. |
|
dodane przez użytkownika
|
added_by_user | string |
Identyfikator użytkownika, który dodał opcję uczestnika. |
|
zmodyfikowane przez użytkownika
|
updated_by_user | string |
Identyfikator użytkownika, który zmodyfikował opcję uczestnika. |
|
dodane przez usługę
|
added_by_service | string |
Nazwa usługi, która dodała tę opcję uczestnika. |
|
zmodyfikowane przez usługę
|
updated_by_service | string |
Nazwa usługi, która zmodyfikowała tę opcję uczestnika. |
|
data dodania
|
date_added | date-time |
Data utworzenia opcji uczestnika. |
|
data modyfikacji
|
date_updated | date-time |
Data ostatniej modyfikacji opcji uczestnika. |
EventApi.ParticipationLevel
Poziomy uczestnictwa to poziom zaangażowania uczestników wydarzenia.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemu poziomu uczestnictwa. |
|
nazwa
|
name | string |
Nazwa poziomu uczestnictwa. |
|
nieaktywny?
|
is_inactive | boolean |
Czy poziom uczestnictwa jest nieaktywny? |
EventApi.SubAdministrativeArea
Definiuje model danych używany dla obszaru administracyjnego adresu (np. miasto w USA).
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator obszaru podrzędnego administracyjnego. |
|
nazwa
|
name | string |
Nazwa obszaru podrzędnego administracyjnego. |