Almabase (wersja zapoznawcza)
Almabase to najbardziej lubiane na świecie oprogramowanie do zarządzania absolwentami, które tworzy programy skoncentrowane na absolwentach, aby zwiększyć udział, zaangażowanie darczyńców i hostować angażujące społeczności online.
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 | Pomoc techniczna almabase |
| adres URL | https://docs.almabase.com |
| help@almabase.com |
| Metadane łącznika | |
|---|---|
| Publisher | Almabase, Inc. |
| Witryna internetowa | https://almabase.com |
| Zasady ochrony prywatności | https://www.almabase.com/ecloud-privacy-policy |
| Kategorie | Sprzedaż i CRM; Produktywność |
Almabase udostępnia narzędzia i strategie oprogramowania dla instytucji edukacyjnych w celu tworzenia programów skoncentrowanych na absolwentach, które przekształcają niezaangażowanych absolwentów w zwolenników na życie.
Ten łącznik jest oparty na interfejsach API i elementach Webhook firmy Almabase oraz udostępnia operacje ułatwiające zarządzanie jednostkami znajdującymi się w bazie Almabase, w tym:
- Rekord (składniki)
- Prezenty
- Events
- Punkty dotykowe zaangażowania
- Formularze
- Funduszy
- Nadawanie stron
- Komunikacja równorzędna w kampaniach pozyskiwania funduszy
- i nie tylko...
Wymagania wstępne
Aby użyć tego łącznika,
- Musisz mieć aktywną subskrypcję Almabase.
- Musisz mieć rolę administratora witryny.
Jak uzyskać poświadczenia
- Zaloguj się do portalu administracyjnego udostępnionego przez almabase.
- Przejdź do
API's & Tokensfolderu w obszarzeSettings. - Kliknij pozycję
Add Auth Tokeni wypełnijdescriptionpole , a następnie ustaw tokenexpiry date & time. - Zanotuj element
Workflow Access Token(kliknij token, aby skopiować do schowka). - Użyj polecenia
Workflow Access Tokenpodczas tworzenia nowego połączenia w usłudze Power Automate.
Wprowadzenie do łącznika
Typowe przypadki użycia
- Po otrzymaniu prezentu wyślij spersonalizowaną wiadomość i potwierdzenie prezentu.
- Gdy aktywność zakontraktowania jest rejestrowana w usłudze Slack, Gmail lub w innych mediach społecznościowych, dodaj aktywność zakontraktowania do usługi Engagement Studio na almabase przy użyciu
Create Custom Touchpointakcji. - Po znalezieniu nowego adresu e-mail (utraconego absolwenta) w podarunku lub rejestracji wydarzenia lub przesłania formularza dodaj ten adres e-mail do rekordu w Almabase lub Składnik w aplikacji Raiser's Edge lub Kontakt w usłudze Salesforce.
- Projektowanie dwukierunkowej synchronizacji danych między Almabase i Blackbaud Raiser's Edge.
- Projektowanie dwukierunkowej synchronizacji danych między almabase i salesforce.
Znane problemy i ograniczenia
- Prezent wyzwala pracę tylko wtedy, gdy płatność online jest dokonana na Almabase. Ręcznie dodane prezenty nie wyzwalają przepływów.
Tworzenie połączenia
Łącznik obsługuje następujące typy uwierzytelniania:
| Wartość domyślna | Parametry tworzenia połączenia. | Wszystkie regiony | Nie można udostępniać |
Domyślny
Dotyczy: wszystkie regiony
Parametry tworzenia połączenia.
Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.
| Name | Typ | Description | Wymagane |
|---|---|---|---|
| Adres URL domeny | ciąg | Określ adres URL domeny Almabase, np. https://your.domain.com | Prawda |
| Klucz interfejsu API | securestring | Klucz interfejsu API użytkownika | Prawda |
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
| Aktualizowanie adresu e-mail rekordu |
Aktualizuje pola adresu e-mail rekordu |
| Aktualizowanie funduszu |
Aktualizuje fundusz. |
| Aktualizowanie osoby kontaktowej |
Aktualizuje osobę kontaktową na imprezie. |
| Aktualizowanie prezentu |
Aktualizuje prezent |
| Aktualizowanie rekordu |
Aktualizuje rekord. |
| Aktualizowanie zdarzenia |
Aktualizuje zdarzenie. |
| Dodawanie osoby kontaktowej |
Dodaje osobę kontaktową do wydarzenia. |
| Formularze listy |
Pobieranie listy formularzy. |
| Lista osób kontaktowych |
Zwraca listę wszystkich osób kontaktowych na imprezie. |
| Lista prezentów |
Zwraca listę prezentów. |
| Otrzymasz prezent |
Zwraca informacje o prezentie. |
| Pobieranie przesyłania formularza |
Zwraca informacje o przesłaniu formularza. |
| Pobieranie rekordu |
Zwraca informacje o rekordzie. |
| Pobieranie strony dającej |
Zwraca informacje o stronie dającej. |
| Pobieranie zdarzenia |
Zwraca informacje o zdarzeniu. |
| Przesyłanie formularza |
Tworzy nowy formularz do przesyłania formularza |
| Tworzenie adresu e-mail dla rekordu |
Tworzy nowy adres e-mail dla rekordu. |
| Tworzenie funduszu |
Tworzy nowy fundusz. |
| Tworzenie prezentu |
Tworzy nowy prezent. |
| Tworzenie punktu dotykowego |
Wyślij nowy niestandardowy punkt dotykowy do Almabase. |
| Tworzenie rekordu |
Tworzy nowy rekord. |
| Tworzenie zdarzenia |
Tworzy nowe zdarzenie. |
| Usuwanie adresu e-mail rekordu |
Usuń adres e-mail rekordu. |
| Uzyskiwanie adresu e-mail rekordu |
Zwraca informacje o adresie e-mail rekordu. |
| Uzyskiwanie funduszu |
Zwraca informacje o funduszu. |
| Wyświetlanie listy adresów e-mail rekordu |
Zwraca listę adresów e-mail dla rekordu. |
| Wyświetlanie listy funduszy |
Zwraca listę funduszy |
| Wyświetlanie listy rekordów |
Zwraca listę rekordów. |
| Wyświetlanie listy stron |
Zwraca listę stron. |
| Wyświetlanie listy zdarzeń |
Zwraca listę wszystkich zdarzeń. |
Aktualizowanie adresu e-mail rekordu
Aktualizuje pola adresu e-mail rekordu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator rekordu
|
record_id | True | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania rekordu. |
|
Identyfikator adresu e-mail
|
email_id | True | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania adresu e-mail rekordu. |
|
Czy używać do logowania?
|
is_login_email | boolean |
Wskazuje, czy użytkownik może zalogować się do platformy przy użyciu tego adresu e-mail. |
|
|
Czy jest podstawowy?
|
is_primary | boolean |
Podstawowa wiadomość e-mail służy do wysyłania automatycznych wiadomości e-mail wyzwalanych przez system. Służy również do wysyłania zbiorczej wiadomości e-mail do profilu. To obowiązkowe, że tylko jedna wiadomość e-mail jest ustawiona jako podstawowa. |
|
|
Status
|
status | string |
Stan adresu e-mail |
|
|
Typ
|
type | string |
Typ wiadomości e-mail |
Zwraca
Adres e-mail
Aktualizowanie funduszu
Aktualizuje fundusz.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator funduszu
|
id | True | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania funduszu. |
|
Identyfikator zewnętrznej bazy danych
|
external_database_id | string |
System przypisany unikatowy identyfikator funduszu przez zewnętrzną bazę danych. np. identyfikator rekordu systemowego dla NXT programu Raiser Edge, identyfikator obiektu dla usługi Salesforce |
|
|
Czy fundusz domyślny?
|
is_default | boolean |
Wskazuje na skojarzenie wszystkich podziałów z tym funduszem, jeśli na stronie dającej nie zdefiniowano żadnych innych funduszy. |
|
|
Czy inny fundusz?
|
is_other_fund | boolean |
Wskazuje, że darczyńcy tego funduszu otrzymali niestandardową nazwę funduszu. |
|
|
Nazwa funduszu
|
name | True | string |
Nazwa funduszu |
Zwraca
Fundusz związany z podziałem prezentu.
- Fundusz
- v1.GivingApi.FundRead
Aktualizowanie osoby kontaktowej
Aktualizuje osobę kontaktową na imprezie.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator zdarzenia
|
id | True | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania zdarzenia. |
|
Identyfikator osoby kontaktu zdarzeń
|
person_id | True | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania osoby kontaktowej w zdarzeniu. |
|
Email
|
Adres e-mail osoby kontaktowej |
|||
|
Name
|
name | string |
Imię i nazwisko osoby kontaktowej |
|
|
Numer telefonu
|
phone_number | string |
Numer telefonu osoby kontaktowej |
Zwraca
Osoba kontaktowa z wydarzeniem
Aktualizowanie prezentu
Aktualizuje prezent
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator prezentu
|
id | True | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania prezentu. |
|
Numer partii
|
batch_number | string |
Numer partii prezentu. |
|
|
Adres dawcy: wiersz 1
|
donor_address_line1 | string |
Wiersz adresu 1 używany przez dawcę dla prezentu. |
|
|
Adres dawcy: wiersz 2
|
donor_address_line2 | string |
Wiersz adresu 2 używany przez dawcę dla prezentu. |
|
|
Nazwa: Miasto, Stan, Kraj
|
name | string |
Miasto dawcy. Format: Nazwa miasta, Krótka nazwa stanu, Krótka nazwa kraju |
|
|
Nazwa dawcy
|
donor_name | string |
Imię i nazwisko dawcy. |
|
|
Numer telefonu dawcy
|
donor_phone_number | string |
Numer telefonu używany przez darczyńcę do prezentu. |
|
|
Adres dawcy: kod pocztowy
|
donor_zip_code | string |
Kod pocztowy adresu używanego przez darczyńcę dla prezentu. |
|
|
Czy nie jest ukryty w rankingu?
|
exclude_from_leaderboard | boolean |
Czy nie jest ukryty w rankingu? |
|
|
Identyfikator zewnętrznej bazy danych
|
external_database_id | string |
System przypisany unikatowy identyfikator prezentu przez zewnętrzną bazę danych. |
|
|
Wiadomość hołdu
|
honor_message | string |
Wiadomość dla hołdu prezentowego. |
|
|
Prefiks hołdu
|
honor_prefix | string |
Prefiks hołdu prezentowego. Dostępne opcje to in_honor_of, in_memory_of, in_support_of |
|
|
Czy jest anonimowy?
|
is_anonymous | boolean |
Wskazuje, że życzenie dawcy jest anonimowe dla innych darczyńców dla tego prezentu. |
|
|
Uwaga / Notatka
|
note | string |
Tekst notatki. |
|
|
Inna nazwa funduszu
|
other_fund_name | string |
Gdy darczyńca wybierze fundusz oznaczony jako is_other_fund, dodają niestandardową nazwę funduszu, aby przypisać prezent. |
|
|
Strona nadania
|
id | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania strony dającej. |
|
|
identyfikator
|
id | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania rekordu. |
|
|
Kwota
|
amount | True | string |
Kwota podziału prezentu. |
|
Fundusz
|
id | True | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania funduszu. |
Zwraca
Prezent
Aktualizowanie rekordu
Aktualizuje rekord.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator rekordu
|
id | True | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania rekordu. |
|
Identyfikator zewnętrznej bazy danych
|
external_database_id | string |
System ma przypisany unikatowy identyfikator rekordu przez zewnętrzną bazę danych. np. identyfikator rekordu systemu dla programu Raiser Edge NXT, identyfikator kontaktu dla usługi Salesforce |
|
|
Identyfikator wyszukiwania zewnętrznej bazy danych
|
external_database_lookup_id | string |
Niestandardowy identyfikator wyszukiwania zdefiniowany przez użytkownika dla rekordu w zewnętrznej bazie danych. np. identyfikator składowy |
|
|
Imię
|
first_name | string |
Imię rekordu. |
|
|
Nazwisko
|
last_name | string |
Nazwisko rekordu. |
Zwraca
rekord
Aktualizowanie zdarzenia
Aktualizuje zdarzenie.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator zdarzenia
|
id | True | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania zdarzenia. |
|
Description
|
description | string |
Opis wydarzenia |
|
|
Godzina zakończenia
|
end_datetime | string |
Godzina zakończenia zdarzenia |
|
|
Identyfikator zewnętrznej bazy danych
|
external_database_id | string |
System ma przypisany unikatowy identyfikator rekordu przez zewnętrzną bazę danych. np. identyfikator rekordu systemu dla programu Raiser Edge NXT, identyfikator kontaktu dla usługi Salesforce |
|
|
Adres URL rejestracji zewnętrznej
|
external_registration_url | string |
Adres URL rejestracji zdarzenia w zewnętrznej witrynie internetowej |
|
|
Name
|
name | string |
Nazwa wydarzenia |
|
|
Godzina rozpoczęcia
|
start_datetime | string |
Godzina rozpoczęcia zdarzenia |
|
|
Timezone
|
timezone | string |
Strefa czasowa zdarzenia |
|
|
Name
|
display_name | string |
Miasto,Państwo,Kraj miejsca |
Zwraca
Event
Dodawanie osoby kontaktowej
Dodaje osobę kontaktową do wydarzenia.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator zdarzenia
|
id | True | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania zdarzenia. |
|
Email
|
Adres e-mail osoby kontaktowej |
|||
|
Name
|
name | string |
Imię i nazwisko osoby kontaktowej |
|
|
Numer telefonu
|
phone_number | string |
Numer telefonu osoby kontaktowej |
Zwraca
Osoba kontaktowa z wydarzeniem
Formularze listy
Pobieranie listy formularzy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Pola formularza
|
fields | array |
Rozdzielana przecinka lista pól w odpowiedzi. |
Zwraca
- response
- array of v1.FormApi.FormRead
Lista osób kontaktowych
Zwraca listę wszystkich osób kontaktowych na imprezie.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator zdarzenia
|
id | True | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania zdarzenia. |
Zwraca
Lista prezentów
Zwraca listę prezentów.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Status
|
status | True | string |
Filtruj prezenty na podstawie stanu. |
|
Strona nadania
|
campaign | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania strony dającej. |
|
|
Filtruj według identyfikatora grupy prezentów
|
group_id | uuid |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania grupy prezentów lub listy. |
|
|
Powinien mieć pusty numer partii?
|
batch_number__isnull | boolean |
Filtruj prezenty na podstawie ich numeru wsadowego lub nie. |
|
|
Powinien mieć pusty identyfikator zewnętrznej bazy danych?
|
external_database_id__isnull | boolean |
Odfiltruj prezenty na podstawie identyfikatora zewnętrznej bazy danych lub nie. UWAGA: Prezenty, które mają identyfikator zewnętrznej bazy danych, są już wypychane do zewnętrznej bazy danych. |
|
|
Filtruj według identyfikatora zewnętrznej bazy danych
|
external_database_id | string |
Filtruj prezenty na podstawie identyfikatora zewnętrznej bazy danych. |
|
|
Filtruj według wiadomości e-mail dawcy
|
donor_email | string |
Filtrowanie prezentów na podstawie adresu e-mail dawcy |
|
|
Wyszukaj według
|
search | string |
Wyszukaj prezenty według nazwy lub adresu e-mail. |
|
|
Pola formularza
|
fields | array |
Rozdzielana przecinka lista pól w odpowiedzi. |
|
|
Rozmiar strony
|
page_size | integer |
Reprezentuje liczbę rekordów do zwrócenia. Wartość domyślna to 10. Maksymalna wartość to 50. |
|
|
Numer strony
|
page | integer |
Reprezentują numery stron (przesunięcie). Do użycia z podziałem na strony. |
|
|
Zamów według
|
ordering | string |
Zdefiniuj kolejność prezentów w odpowiedzi. Prefiks "-" reprezentuje kolejność malejącą, a brak prefiksu zwróci wyniki w kolejności rosnącej. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Następny adres URL wyników
|
nextlink | uri |
Adres URL następnego zestawu wyników strony. Do użycia z podziałem na strony. |
|
Poprzedni adres URL wyników
|
previouslink | uri |
Adres URL poprzedniego zestawu wyników. Do użycia z podziałem na strony. |
|
Łączna liczba prezentów
|
total | integer |
Łączna liczba prezentów dla podanych filtrów |
|
Prezenty
|
value | array of v1.GivingApi.GiftRead |
Lista prezentów zwróconych dla podanych filtrów. Wyniki są podzielone na strony. |
Otrzymasz prezent
Zwraca informacje o prezentie.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator prezentu
|
id | True | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania prezentu. |
|
Pola formularza
|
fields | array |
Rozdzielana przecinka lista pól w odpowiedzi. |
Zwraca
Prezent
Pobieranie przesyłania formularza
Zwraca informacje o przesłaniu formularza.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Form
|
form_id | True | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania formularza. |
|
Identyfikator odpowiedzi
|
entry_id | True | string |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania przesyłania formularza. |
Zwraca
Pobieranie rekordu
Zwraca informacje o rekordzie.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator rekordu
|
id | True | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania rekordu. |
|
Pola formularza
|
fields | array |
Rozdzielana przecinka lista pól w odpowiedzi. |
Zwraca
rekord
Pobieranie strony dającej
Zwraca informacje o stronie dającej.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nadanie identyfikatora strony
|
id | True | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania strony dającej. |
|
Pola formularza
|
fields | array |
Rozdzielana przecinka lista pól w odpowiedzi. |
Zwraca
Strona nadania
Pobieranie zdarzenia
Zwraca informacje o zdarzeniu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator zdarzenia
|
id | True | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania zdarzenia. |
|
Pola formularza
|
fields | array |
Rozdzielana przecinka lista pól w odpowiedzi. |
Zwraca
Event
Przesyłanie formularza
Tworzy nowy formularz do przesyłania formularza
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Form
|
form_id | True | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania formularza. |
|
body
|
body | dynamic |
Tworzenie nowego przesyłania formularza |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator odpowiedzi
|
id | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania przesyłania formularza. |
Tworzenie adresu e-mail dla rekordu
Tworzy nowy adres e-mail dla rekordu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator rekordu
|
record_id | True | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania rekordu. |
|
Address
|
address |
Adres e-mail |
||
|
Czy używać do logowania?
|
is_login_email | boolean |
Wskazuje, czy użytkownik może zalogować się do platformy przy użyciu tego adresu e-mail. |
|
|
Czy jest podstawowy?
|
is_primary | boolean |
Podstawowa wiadomość e-mail służy do wysyłania automatycznych wiadomości e-mail wyzwalanych przez system. Służy również do wysyłania zbiorczej wiadomości e-mail do profilu. To obowiązkowe, że tylko jedna wiadomość e-mail jest ustawiona jako podstawowa. |
|
|
Źródło
|
source | string |
Źródło wskazuje sposób dodawania wiadomości e-mail do bazy danych. |
|
|
Status
|
status | string |
Stan adresu e-mail |
|
|
Typ
|
type | string |
Typ wiadomości e-mail |
Zwraca
Adres e-mail
Tworzenie funduszu
Tworzy nowy fundusz.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator zewnętrznej bazy danych
|
external_database_id | string |
System przypisany unikatowy identyfikator funduszu przez zewnętrzną bazę danych. np. identyfikator rekordu systemowego dla NXT programu Raiser Edge, identyfikator obiektu dla usługi Salesforce |
|
|
Czy fundusz domyślny?
|
is_default | boolean |
Wskazuje na skojarzenie wszystkich podziałów z tym funduszem, jeśli na stronie dającej nie zdefiniowano żadnych innych funduszy. |
|
|
Czy inny fundusz?
|
is_other_fund | boolean |
Wskazuje, że darczyńcy tego funduszu otrzymali niestandardową nazwę funduszu. |
|
|
Nazwa funduszu
|
name | True | string |
Nazwa funduszu |
Zwraca
Fundusz związany z podziałem prezentu.
- Fundusz
- v1.GivingApi.FundRead
Tworzenie prezentu
Tworzy nowy prezent.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Kwota prezentu
|
amount | True | string |
Kwota prezentu z dwoma liczbami dziesiętnymi. |
|
Numer partii
|
batch_number | string |
Numer partii prezentu. |
|
|
Data prezentu
|
completed_at | True | date-time |
Data, w przypadku gdy stan prezentu jest oznaczony jako ukończony. |
|
Waluta
|
currency | True | integer |
Waluta używana przez darczyńcę dla prezentu. |
|
Adres dawcy: wiersz 1
|
donor_address_line1 | string |
Wiersz adresu 1 używany przez dawcę dla prezentu. |
|
|
Adres dawcy: wiersz 2
|
donor_address_line2 | string |
Wiersz adresu 2 używany przez dawcę dla prezentu. |
|
|
Nazwa: Miasto, Stan, Kraj
|
name | string |
Miasto dawcy. Format: Nazwa miasta, Krótka nazwa stanu, Krótka nazwa kraju |
|
|
Adres e-mail dawcy
|
donor_email | True |
Identyfikator e-mail używany przez darczyńcę do prezentu. |
|
|
Nazwa dawcy
|
donor_name | True | string |
Imię i nazwisko dawcy. |
|
Numer telefonu dawcy
|
donor_phone_number | string |
Numer telefonu używany przez darczyńcę do prezentu. |
|
|
Adres dawcy: kod pocztowy
|
donor_zip_code | string |
Kod pocztowy adresu używanego przez darczyńcę dla prezentu. |
|
|
Czy nie jest ukryty w rankingu?
|
exclude_from_leaderboard | boolean |
Czy nie jest ukryty w rankingu? |
|
|
Identyfikator zewnętrznej bazy danych
|
external_database_id | string |
System przypisany unikatowy identyfikator prezentu przez zewnętrzną bazę danych. |
|
|
Wiadomość hołdu
|
honor_message | string |
Wiadomość dla hołdu prezentowego. |
|
|
Prefiks hołdu
|
honor_prefix | string |
Prefiks hołdu prezentowego. Dostępne opcje to in_honor_of, in_memory_of, in_support_of |
|
|
Czy jest anonimowy?
|
is_anonymous | boolean |
Wskazuje, że życzenie dawcy jest anonimowe dla innych darczyńców dla tego prezentu. |
|
|
Tryb płatności
|
mode | True | string |
Tryb płatności, online lub offline. |
|
Uwaga / Notatka
|
note | string |
Tekst notatki. |
|
|
Inna nazwa funduszu
|
other_fund_name | string |
Gdy darczyńca wybierze fundusz oznaczony jako is_other_fund, dodają niestandardową nazwę funduszu, aby przypisać prezent. |
|
|
Strona nadania
|
id | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania strony dającej. |
|
|
identyfikator
|
id | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania rekordu. |
|
|
Kwota
|
amount | True | string |
Kwota podziału prezentu. |
|
Fundusz
|
id | True | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania funduszu. |
|
Status
|
status | True | string |
Status prezentu. |
Zwraca
Prezent
Tworzenie punktu dotykowego
Wyślij nowy niestandardowy punkt dotykowy do Almabase.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Program
|
touchpoint_program | True | integer |
Filtruje typy według programów punktów dotykowych. |
|
Email
|
Identyfikator wiadomości e-mail używany do działania. |
|||
|
identyfikator
|
id | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania rekordu. |
|
|
Zarejestrowano pod adresem
|
recorded_at | True | date-time |
Sygnatura czasowa działania. |
|
Typ
|
id | True | integer |
Zwraca
Treść punktu dotykowego w celu utworzenia nowego punktu dotykowego
Tworzenie rekordu
Tworzy nowy rekord.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Wiersz 1
|
line1 | True | string |
Wiersz 1 adresu |
|
Wiersz 2
|
line2 | string |
Wiersz 2 adresu |
|
|
Name
|
name | string |
Miasto, Stan,Kraj lokalizacji |
|
|
Prywatność
|
privacy | string |
prywatność |
|
|
Typ
|
type | True | string |
Typ liczby |
|
Kod pocztowy
|
zip_code | string |
Kod pocztowy adresu |
|
|
Data urodzenia
|
date_of_birth | string |
Data urodzenia. |
|
|
Zmarły
|
deceased | boolean |
Zmarły. |
|
|
Address
|
address |
Adres e-mail |
||
|
Czy używać do logowania?
|
is_login_email | boolean |
Wskazuje, czy użytkownik może zalogować się do platformy przy użyciu tego adresu e-mail. |
|
|
Czy jest podstawowy?
|
is_primary | boolean |
Podstawowa wiadomość e-mail służy do wysyłania automatycznych wiadomości e-mail wyzwalanych przez system. Służy również do wysyłania zbiorczej wiadomości e-mail do profilu. To obowiązkowe, że tylko jedna wiadomość e-mail jest ustawiona jako podstawowa. |
|
|
Źródło
|
source | string |
Źródło wskazuje sposób dodawania wiadomości e-mail do bazy danych. |
|
|
Status
|
status | string |
Stan adresu e-mail |
|
|
Typ
|
type | string |
Typ wiadomości e-mail |
|
|
Identyfikator zewnętrznej bazy danych
|
external_database_id | string |
System ma przypisany unikatowy identyfikator rekordu przez zewnętrzną bazę danych. np. identyfikator rekordu systemu dla programu Raiser Edge NXT, identyfikator kontaktu dla usługi Salesforce |
|
|
Identyfikator wyszukiwania zewnętrznej bazy danych
|
external_database_lookup_id | string |
Niestandardowy identyfikator wyszukiwania zdefiniowany przez użytkownika dla rekordu w zewnętrznej bazie danych. np. identyfikator składowy |
|
|
Imię
|
first_name | True | string |
Imię rekordu. |
|
Nazwisko
|
last_name | True | string |
Nazwisko rekordu. |
|
Drugie imię
|
middle_name | string |
Nazwa środkowa rekordu. |
|
|
Number
|
number | True | string |
Number |
|
Prywatność
|
privacy | string |
prywatność |
|
|
Typ
|
type | True | string |
Typ liczby |
Zwraca
rekord
Tworzenie zdarzenia
Tworzy nowe zdarzenie.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Description
|
description | string |
Opis wydarzenia |
|
|
Godzina zakończenia
|
end_datetime | string |
Godzina zakończenia zdarzenia |
|
|
Identyfikator zewnętrznej bazy danych
|
external_database_id | string |
System ma przypisany unikatowy identyfikator rekordu przez zewnętrzną bazę danych. np. identyfikator rekordu systemu dla programu Raiser Edge NXT, identyfikator kontaktu dla usługi Salesforce |
|
|
Adres URL rejestracji zewnętrznej
|
external_registration_url | string |
Adres URL rejestracji zdarzenia w zewnętrznej witrynie internetowej |
|
|
Name
|
name | True | string |
Nazwa wydarzenia |
|
Godzina rozpoczęcia
|
start_datetime | string |
Godzina rozpoczęcia zdarzenia |
|
|
Timezone
|
timezone | string |
Strefa czasowa zdarzenia |
|
|
Name
|
display_name | string |
Miasto,Państwo,Kraj miejsca |
Zwraca
Event
Usuwanie adresu e-mail rekordu
Usuń adres e-mail rekordu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator rekordu
|
record_id | True | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania rekordu. |
|
identyfikator
|
email_id | True | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania adresu e-mail rekordu. |
Uzyskiwanie adresu e-mail rekordu
Zwraca informacje o adresie e-mail rekordu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator rekordu
|
record_id | True | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania rekordu. |
|
identyfikator
|
email_id | True | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania adresu e-mail rekordu. |
Zwraca
Adres e-mail
Uzyskiwanie funduszu
Zwraca informacje o funduszu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator funduszu
|
id | True | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania funduszu. |
|
Pola formularza
|
fields | array |
Rozdzielana przecinka lista pól w odpowiedzi. |
Zwraca
Fundusz związany z podziałem prezentu.
- Fundusz
- v1.GivingApi.FundRead
Wyświetlanie listy adresów e-mail rekordu
Zwraca listę adresów e-mail dla rekordu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator rekordu
|
record_id | True | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania rekordu. |
|
Czy jest podstawowy?
|
is_primary | boolean |
Wyszukaj podstawową wiadomość e-mail. |
|
|
Pola formularza
|
fields | array |
Rozdzielana przecinka lista pól w odpowiedzi. |
|
|
Rozmiar strony
|
page_size | integer |
Reprezentuje liczbę rekordów do zwrócenia. Wartość domyślna to 10. Maksymalna wartość to 50. |
|
|
Numer strony
|
page | integer |
Reprezentują numery stron (przesunięcie). Do użycia z podziałem na strony. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Następny adres URL wyników
|
nextlink | uri |
Adres URL następnego zestawu wyników strony. Do użycia z podziałem na strony. |
|
Poprzedni adres URL wyników
|
previouslink | uri |
Adres URL poprzedniego zestawu wyników. Do użycia z podziałem na strony. |
|
Łączna liczba adresów e-mail
|
total | integer |
Łączna liczba adresów e-mail dla podanych filtrów |
|
Adres e-mail
|
value | array of v1.RecordApi.EmailAddressRead |
Lista adresów e-mail rekordu zwróconego dla podanych filtrów. Wyniki są podzielone na strony. |
Wyświetlanie listy funduszy
Zwraca listę funduszy
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Pola formularza
|
fields | array |
Rozdzielana przecinka lista pól w odpowiedzi. |
Zwraca
- response
- array of v1.GivingApi.FundRead
Wyświetlanie listy rekordów
Zwraca listę rekordów.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Wyszukaj według nazwy
|
search | string |
Wyszukaj rekordy według nazwy. |
|
|
Wyszukiwanie według adresu e-mail
|
email_addresses__address | string |
Wyszukaj rekordy według adresu e-mail. |
|
|
Wyszukiwanie według identyfikatora zewnętrznej bazy danych
|
external_database_id | string |
Wyszukaj rekordy według zewnętrznego identyfikatora bazy danych. |
|
|
Pola formularza
|
fields | array |
Rozdzielana przecinka lista pól w odpowiedzi. |
|
|
Zaktualizowano lub później
|
updated_at__gte | date-time |
Zaktualizowano lub późniejszą datę. |
|
|
Utworzone w dniu lub po
|
created_at__gte | date-time |
Utworzone w dniu lub po dacie. |
|
|
Rozmiar strony
|
page_size | integer |
Reprezentuje liczbę rekordów do zwrócenia. Wartość domyślna to 10. Maksymalna wartość to 50. |
|
|
Numer strony
|
page | integer |
Reprezentują numery stron (przesunięcie). Do użycia z podziałem na strony. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Następny adres URL wyników
|
nextlink | uri |
Adres URL następnego zestawu wyników strony. Do użycia z podziałem na strony. |
|
Poprzedni adres URL wyników
|
previouslink | uri |
Adres URL poprzedniego zestawu wyników. Do użycia z podziałem na strony. |
|
Łączna liczba rekordów
|
total | integer |
Łączna liczba rekordów dla podanych filtrów |
|
Rekordy
|
value | array of v1.RecordApi.RecordRead |
Lista rekordów rekordu zwróconego dla danych filtrów. |
Wyświetlanie listy stron
Zwraca listę stron.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Pola formularza
|
fields | array |
Rozdzielana przecinka lista pól w odpowiedzi. |
Zwraca
- response
- array of v1.GivingApi.GivingPageRead
Wyświetlanie listy zdarzeń
Zwraca listę wszystkich zdarzeń.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Wyszukiwanie według identyfikatora zewnętrznej bazy danych
|
external_database_id | string |
Wyszukaj zdarzenia według zewnętrznego identyfikatora bazy danych. |
|
|
Pola formularza
|
fields | array |
Rozdzielana przecinka lista pól w odpowiedzi. |
Zwraca
- response
- array of v1.EventApi.EventRead
Wyzwalacze
| Gdy nowy prezent zakończy się powodzeniem lub płatność za prezent online nie powiedzie się |
Wyzwala, gdy nowy prezent zostanie pomyślnie zarejestrowany na stronie dającej przez darczyńcę lub wypłatę prezentu nie powiedzie się. |
| Po przesłaniu formularza lub zaktualizowaniu istniejącego przesłania formularza |
Wyzwala wyzwalane po przesłaniu formularza lub zaktualizowaniu istniejącego przesłania formularza. |
| Po utworzeniu, zaktualizowaniu lub usunięciu wiadomości e-mail w rekordzie |
Wyzwala, gdy nowa wiadomość e-mail zostanie utworzona w rekordzie lub istniejąca wiadomość e-mail zostanie zaktualizowana lub usunięta z rekordu. |
| Po utworzeniu lub zaktualizowaniu rekordu w Almabase |
Wyzwalane po utworzeniu nowego rekordu na bazie Almabase lub zaktualizowaniu istniejącego rekordu. |
Gdy nowy prezent zakończy się powodzeniem lub płatność za prezent online nie powiedzie się
Wyzwala, gdy nowy prezent zostanie pomyślnie zarejestrowany na stronie dającej przez darczyńcę lub wypłatę prezentu nie powiedzie się.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Kiedy
|
events | True | string |
Lista zdarzeń wyzwalanych przez przepływ. |
|
Strona nadania
|
object_id | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania strony dającej. |
Zwraca
Po przesłaniu formularza lub zaktualizowaniu istniejącego przesłania formularza
Wyzwala wyzwalane po przesłaniu formularza lub zaktualizowaniu istniejącego przesłania formularza.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Kiedy
|
events | True | string |
Lista zdarzeń wyzwalanych przez przepływ. |
|
Form
|
object_id | True | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania formularza. |
Zwraca
Po utworzeniu, zaktualizowaniu lub usunięciu wiadomości e-mail w rekordzie
Wyzwala, gdy nowa wiadomość e-mail zostanie utworzona w rekordzie lub istniejąca wiadomość e-mail zostanie zaktualizowana lub usunięta z rekordu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Kiedy
|
events | True | string |
Lista zdarzeń wyzwalanych przez przepływ. |
Zwraca
Po utworzeniu lub zaktualizowaniu rekordu w Almabase
Wyzwalane po utworzeniu nowego rekordu na bazie Almabase lub zaktualizowaniu istniejącego rekordu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Kiedy
|
events | True | string |
Lista zdarzeń wyzwalanych przez przepływ. |
Zwraca
Definicje
Wersja 1. FormApi.FormRead
Form
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania formularza. |
|
Nazwa formularza
|
title | string |
Nazwa formularza |
Wersja 1. GivingApi.GiftWebhookRecordRead
Rekord
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator zewnętrznej bazy danych
|
external_database_id | string |
System ma przypisany unikatowy identyfikator rekordu przez zewnętrzną bazę danych. np. identyfikator rekordu systemu dla programu Raiser Edge NXT, identyfikator kontaktu dla usługi Salesforce |
|
Imię
|
first_name | string |
Imię zamapowanego rekordu |
|
identyfikator
|
id | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania rekordu. |
|
Czy dawca jest zarejestrowany w Almabase?
|
is_registered | boolean |
Wskazuje, czy zamapowany rekord lub dawca zarejestrowany w Almabase |
|
Nazwisko
|
last_name | string |
Nazwisko zamapowanego rekordu |
Wersja 1. GivingApi.GiftWebhookResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Kwota
|
data.amount | string |
Kwota prezentu z dwoma liczbami dziesiętnymi. |
|
Date
|
data.completed_at | date-time |
Data, w przypadku gdy stan prezentu jest oznaczony jako ukończony. |
|
Adres e-mail dawcy
|
data.email |
Identyfikator e-mail używany przez darczyńcę do prezentu. |
|
|
Identyfikator zewnętrznej bazy danych
|
data.external_database_id | string |
System przypisany unikatowy identyfikator prezentu przez zewnętrzną bazę danych. |
|
identyfikator
|
data.id | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania prezentu. |
|
Czy nowa wiadomość e-mail jest nowa?
|
data.is_email_new | boolean |
Wskazuje, czy wiadomość e-mail dostarczona przez darczyńcę już istnieje na rekordach Almabase. |
|
schemat
|
data.mapped_profile.schema | v1.GivingApi.GiftWebhookRecordRead |
Rekord |
|
Mode
|
data.mode | string |
Tryb prezentu. |
|
Nazwa dawcy
|
data.name | string |
Imię i nazwisko dawcy. |
|
identyfikator
|
data.page.id | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania strony dającej. |
|
Nadanie nazwy strony
|
data.page.name | string |
Nazwa skojarzonej strony dającej |
|
Status
|
data.status | string |
Status prezentu. |
|
Zdarzenie wyzwolone o
|
time | string |
Czas zdarzenia. |
|
Typ zdarzenia
|
type | string |
Typ zdarzenia. |
Wersja 1. GivingApi.LocationRead
Miasto używane przez darczyńcę dla prezentu.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Miejscowość
|
city | string |
Miasto dawcy |
|
Krótka nazwa miasta
|
city_short_name | string |
Krótka reprezentacja miasta, np. SF |
|
Szerokość
|
coordinates.latitude | string |
Szerokość geograficzna lokalizacji |
|
Długość
|
coordinates.longitude | string |
Długość geograficzna lokalizacji |
|
Country
|
country | string |
Kraj dawcy |
|
Krótka nazwa kraju
|
country_short_name | string |
Krótka reprezentacja kraju, np. USA |
|
Identyfikator miejsca Google
|
gpid | string |
Identyfikator miejsca uzyskany z google |
|
Miasto, Stan, Kraj
|
name | string |
Miasto dawcy. Format: Nazwa miasta, Krótka nazwa stanu, Krótka nazwa kraju |
|
State
|
state | string |
Stan dawcy |
|
Krótka nazwa stanu
|
state_short_name | string |
Krótka reprezentacja stanu, np. urzędu certyfikacji |
Wersja 1. GivingApi.FormFieldRead
Pole formularza
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Wartość
|
display_value | string |
Sformatowana wartość wprowadzona przez osoby reagujące. Np. nazwa przekazywania pliku. |
|
Nazwa pola pytania/formularza
|
label | string |
Nazwa pola pytania/formularza w formularzu |
Wersja 1. GivingApi.FundRead
Fundusz związany z podziałem prezentu.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator zewnętrznej bazy danych
|
external_database_id | string |
System przypisany unikatowy identyfikator funduszu przez zewnętrzną bazę danych. np. identyfikator rekordu systemowego dla NXT programu Raiser Edge, identyfikator obiektu dla usługi Salesforce |
|
identyfikator
|
id | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania funduszu. |
|
Czy fundusz domyślny?
|
is_default | boolean |
Wskazuje na skojarzenie wszystkich podziałów z tym funduszem, jeśli na stronie dającej nie zdefiniowano żadnych innych funduszy. |
|
Czy inny fundusz?
|
is_other_fund | boolean |
Wskazuje, że darczyńcy tego funduszu otrzymali niestandardową nazwę funduszu. |
|
Name
|
name | string |
Nazwa funduszu |
Wersja 1. GivingApi.GiftRead
Prezent
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Kwota prezentu
|
amount | string |
Kwota prezentu z dwoma liczbami dziesiętnymi. |
|
Numer partii
|
batch_number | string |
Numer partii prezentu. |
|
Data prezentu
|
completed_at | date-time |
Data, w przypadku gdy stan prezentu jest oznaczony jako ukończony. |
|
Waluta
|
currency | integer |
Waluta używana przez darczyńcę dla prezentu. |
|
Device
|
device | string |
Zidentyfikuj urządzenie używane do prezentu, np. pc, mobile lub tablet. |
|
Adres dawcy: wiersz 1
|
donor_address_line1 | string |
Wiersz adresu 1 używany przez dawcę dla prezentu. |
|
Adres dawcy: wiersz 2
|
donor_address_line2 | string |
Wiersz adresu 2 używany przez dawcę dla prezentu. |
|
Adres dawcy: lokalizacja
|
donor_city_place | v1.GivingApi.LocationRead |
Miasto używane przez darczyńcę dla prezentu. |
|
Adres e-mail dawcy
|
donor_email |
Identyfikator e-mail używany przez darczyńcę do prezentu. |
|
|
Nazwa dawcy
|
donor_name | string |
Imię i nazwisko dawcy. |
|
Numer telefonu dawcy
|
donor_phone_number | string |
Numer telefonu używany przez darczyńcę do prezentu. |
|
Adres dawcy: kod pocztowy
|
donor_zip_code | string |
Kod pocztowy adresu używanego przez darczyńcę dla prezentu. |
|
Czy nie jest ukryty w rankingu?
|
exclude_from_leaderboard | boolean |
Czy nie jest ukryty w rankingu? |
|
Identyfikator zewnętrznej bazy danych
|
external_database_id | string |
System przypisany unikatowy identyfikator prezentu przez zewnętrzną bazę danych. |
|
Wiadomość hołdu
|
honor_message | string |
Wiadomość dla hołdu prezentowego. |
|
Prefiks hołdu
|
honor_prefix | string |
Prefiks hołdu prezentowego. Dostępne opcje to in_honor_of, in_memory_of, in_support_of |
|
identyfikator
|
id | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania prezentu. |
|
Wpływającą
|
influencer | v1.GivingApi.InfluencerRead |
Link do udziału publicznego i link do prywatnego pulpitu nawigacyjnego |
|
Czy jest anonimowy?
|
is_anonymous | boolean |
Wskazuje, że życzenie dawcy jest anonimowe dla innych darczyńców dla tego prezentu. |
|
Czy darczyńca pokrył opłaty za bramę płatności?
|
is_donor_covered_charges | boolean |
Wskazuje, czy darczyńca zdecydował się pokryć opłaty za bramę płatności podczas dokonywania tego prezentu? |
|
Czy wiadomość e-mail jest dodawana do rekordu w Almabase?
|
is_email_added_to_profile | boolean |
Wskazuje, czy wiadomość e-mail dostarczona przez darczyńcę jest dodawana do rekordu Almabase (niezależnie od stanu is_email_new) |
|
Czy nowa wiadomość e-mail jest nowa?
|
is_email_new | boolean |
Wskazuje, czy wiadomość e-mail dostarczona przez darczyńcę już istnieje na rekordach Almabase. |
|
Czy mapowanie na rekord na Almabase jest ignorowane?
|
is_profile_mapping_ignored | boolean |
Wskazuje, czy mapowanie rekordów powinno być ignorowane. |
|
Tryb płatności
|
mode | string |
Tryb płatności, online lub offline. |
|
Uwaga / Notatka
|
note | string |
Tekst notatki. |
|
Inna nazwa funduszu
|
other_fund_name | string |
Gdy darczyńca wybierze fundusz oznaczony jako is_other_fund, dodają niestandardową nazwę funduszu, aby przypisać prezent. |
|
Strona nadania
|
page | v1.GivingApi.GivingPageAssociatedWithGift |
Strona dająca skojarzona z prezentem. |
|
Pola formularza
|
post_payment_form_entry.fields | array of v1.GivingApi.FormFieldRead | |
|
Identyfikator odpowiedzi
|
post_payment_form_entry.id | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania przesyłania formularza. |
|
Pola formularza
|
pre_payment_form_entry.fields | array of v1.GivingApi.FormFieldRead | |
|
Identyfikator odpowiedzi
|
pre_payment_form_entry.id | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania przesyłania formularza. |
|
Zamapowany rekord
|
profile | v1.GivingApi.RecordRead |
Zamapowany rekord na Almabase |
|
Link odwołującego
|
referrer_link | string |
Link do witryny internetowej, aby zidentyfikować źródło wizyty dawcy. np. Darczyńca odwiedził kampanię Giving z Facebooka, Google itp. |
|
Kwota zwrotu
|
refund_amount | string |
Kwota zwrócona dawcy. Jeśli cała kwota zostanie zwrócona, status prezentu zostanie zwrócony zamiast ukończonego. |
|
Dzieli
|
splits | array of v1.GivingApi.GiftSplitRead |
Podziały związane z darem. |
|
Status
|
status | string |
Status prezentu. |
|
Transakcja online
|
transaction | v1.GivingApi.TransactionRead |
Transakcja płatności online skojarzona z prezentem. |
|
Kampania UTM
|
utm_campaign | string |
Służy do analizy słów kluczowych. utm_campaign zidentyfikować konkretną kampanię promocyjną lub strategiczną. np. annual_fund_2020 |
|
UtM — średni rozmiar
|
utm_medium | string |
utm_medium zidentyfikować medium, takie jak poczta e-mail lub koszt za kliknięcie. np. cpc |
|
Źródło UTM
|
utm_source | string |
utm_source zidentyfikować wyszukiwarkę, nazwę biuletynu lub inne źródło. np. Google |
Wersja 1. GivingApi.GiftSplitRead
Podział prezentu
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Kwota
|
amount | string |
Kwota podziału prezentu. |
|
Fundusz
|
fund | v1.GivingApi.FundRead |
Fundusz związany z podziałem prezentu. |
|
identyfikator
|
id | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania podziału prezentu. |
Wersja 1. GivingApi.GivingPageAssociatedWithGift
Strona dająca skojarzona z prezentem.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania strony dającej. |
|
Name
|
name | string |
Nazwa skojarzonej strony dającej. |
Wersja 1. GivingApi.GivingPageRead
Strona nadania
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania strony dającej. |
|
Name
|
name | string |
Nazwa strony dającej |
Wersja 1. GivingApi.InfluencerRead
Link do udziału publicznego i link do prywatnego pulpitu nawigacyjnego
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Link pulpitu nawigacyjnego prywatnego elementu mającego wpływ
|
dashboard_url | uri |
Prywatny pulpit nawigacyjny darczyńcy do monitorowania liczby wizyt na stronie i prezentów, na które mają wpływ |
|
Link do udziału publicznego
|
page_share_url | uri |
Publiczny link do nadawania strony/kampanii darczyńcy do śledzenia wpływu na wizyty na Stronie dającej i prezenty. |
Wersja 1. GivingApi.PaymentAccountRead
Konto płatnicze skojarzone z transakcją, np. BBMS, Stripe, PayPal itp.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania konta płatniczego. |
|
Name
|
name | string |
Nazwa konta płatniczego. |
|
Gateway
|
type | string |
Nazwa bramy płatności. |
Wersja 1. GivingApi.RecordRead
Zamapowany rekord na Almabase
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator zewnętrznej bazy danych
|
external_database_id | string |
System ma przypisany unikatowy identyfikator rekordu przez zewnętrzną bazę danych. np. identyfikator rekordu systemu dla programu Raiser Edge NXT, identyfikator kontaktu dla usługi Salesforce |
|
Imię
|
first_name | string |
Imię zamapowanego rekordu |
|
Pełna nazwa
|
formatted_name | string |
Pełna nazwa zamapowanego rekordu |
|
identyfikator
|
id | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania rekordu. |
|
Czy dawca jest zarejestrowany w Almabase?
|
is_registered | boolean |
Wskazuje, czy zamapowany rekord lub dawca zarejestrowany w Almabase |
|
Nazwisko
|
last_name | string |
Nazwisko zamapowanego rekordu |
|
Adres URL obrazu
|
present_picture | uri |
Adres URL obrazu rekordu |
|
Link
|
profile_url | uri |
Link do rekordu w Almabase |
Wersja 1. GivingApi.TransactionRead
Transakcja płatności online skojarzona z prezentem.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Konto płatności
|
account | v1.GivingApi.PaymentAccountRead |
Konto płatnicze skojarzone z transakcją, np. BBMS, Stripe, PayPal itp. |
|
Utworzono w
|
created_at | date-time |
Czas tworzenia tej transakcji. |
|
Przyczyna błędu
|
failure_reason | string |
Przyczyna niepowodzenia transakcji zwrócona przez bramę płatności. |
|
identyfikator
|
id | uuid |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania transakcji. |
|
Status
|
status | integer |
Stan transakcji. - 1 (Nieprzetworzone) — 2 (Powodzenie) — 3 (Niepowodzenie) — 4 (Oczekujące) — 5 (Błąd) UWAGA: Ten stan jest skojarzony ze stanem transakcji przez bramę płatności |
|
Identyfikator referencyjny bramy płatności
|
transaction_id | string |
Unikatowy identyfikator wygenerowany przez bramę płatności w celu zidentyfikowania transakcji. np. Identyfikator transakcji Blackbaud Merchant Services (BBMS) lub Identyfikator opłaty stripe, PayPal identyfikator transakcji |
Wersja 1. AlmasightsApi.RecordAddOrEdit
Nagraj na Almabase.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania rekordu. |
Wersja 1. AlmasightsApi.TouchpointCustomObjectAdd
Treść punktu dotykowego w celu utworzenia nowego punktu dotykowego
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Email
|
Identyfikator wiadomości e-mail używany do działania. |
||
|
Rekord
|
mapped_profile | v1.AlmasightsApi.RecordAddOrEdit |
Nagraj na Almabase. |
|
Zarejestrowano pod adresem
|
recorded_at | date-time |
Sygnatura czasowa działania. |
|
Typ
|
touchpoint_type.id | integer |
Wersja 1. RecordApi.LocationRead
Lokalizacja adresu
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Miejscowość
|
city | string |
Nazwa miasta lokalizacji |
|
Country
|
country | string |
Nazwa kraju lokalizacji |
|
Szerokość
|
latitude | double |
Szerokość geograficzna lokalizacji |
|
Długość
|
longitude | double |
Długość geograficzna lokalizacji |
|
State
|
state | string |
Nazwa stanu lokalizacji |
Wersja 1. RecordApi.AddressRead
Address
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Wiersz1
|
line1 | string |
Wiersz 1 adresu |
|
Wiersz2
|
line2 | string |
Wiersz 2 adresu |
|
schemat
|
location.schema | v1.RecordApi.LocationRead |
Lokalizacja adresu |
|
Kod pocztowy
|
zipcode | string |
Kod pocztowy adresu |
Wersja 1. RecordApi.EmailWebhookRecordRead
Rekord
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator zewnętrznej bazy danych
|
external_database_id | string |
System ma przypisany unikatowy identyfikator rekordu przez zewnętrzną bazę danych. np. identyfikator rekordu systemu dla programu Raiser Edge NXT, identyfikator kontaktu dla usługi Salesforce |
|
Imię
|
first_name | string |
Imię zamapowanego rekordu |
|
identyfikator
|
id | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania rekordu. |
|
Czy rekord jest zarejestrowany w Almabase?
|
is_registered | boolean |
Wskazuje, czy zamapowany rekord zarejestrowany w Almabase |
|
Nazwisko
|
last_name | string |
Nazwisko zamapowanego rekordu |
Wersja 1. RecordApi.EmailWebhookResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Adres e-mail
|
data.address |
Adres e-mail. |
|
|
identyfikator
|
data.id | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania wiadomości e-mail. |
|
Jest podstawowym
|
data.is_primary | boolean |
Wskazuje, czy wiadomość e-mail jest podstawowa, czy nie. |
|
schemat
|
data.profile.schema | v1.RecordApi.EmailWebhookRecordRead |
Rekord |
|
Typ wiadomości e-mail
|
data.type | string |
Typ adresu e-mail (podstawowy, osobisty, służbowy itp.). |
|
Zdarzenie wyzwolone o
|
time | string |
Czas zdarzenia. |
|
Typ zdarzenia
|
type | string |
Typ zdarzenia. |
Wersja 1. RecordApi.RecordWebhookResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Przynależności
|
data.affiliations | array of string | |
|
Rok zajęć
|
data.class_year | string |
Rok klasy rekordu |
|
Adres e-mail
|
data.email |
Adres e-mail. |
|
|
Identyfikator zewnętrznej bazy danych
|
data.external_database_id | string |
System ma przypisany unikatowy identyfikator rekordu przez zewnętrzną bazę danych. np. identyfikator rekordu systemu dla programu Raiser Edge NXT, identyfikator kontaktu dla usługi Salesforce |
|
Imię
|
data.first_name | string |
Imię zamapowanego rekordu |
|
schemat
|
data.home_address.schema | v1.RecordApi.AddressRead |
Address |
|
identyfikator
|
data.id | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania rekordu. |
|
Nazwisko
|
data.last_name | string |
Nazwisko zamapowanego rekordu |
|
Data wygaśnięcia członkostwa
|
data.membership_expiry_date | date-time |
Data wygaśnięcia członkostwa rekordu |
|
Nazwa typu członkostwa
|
data.membership_type_name | string |
Nazwa typu członkostwa rekordu |
|
Numer telefonu komórkowego
|
data.mobile_number | string |
Numer telefonu komórkowego rekordu |
|
schemat
|
data.office_address.schema | v1.RecordApi.AddressRead |
Address |
|
Numer telefonu pakietu Office
|
data.office_phone_number | string |
Numer telefonu pakietu Office rekordu |
|
Numer telefonu rezydencji
|
data.residence_phone_number | string |
Numer telefonu zamieszkania rekordu |
|
Zdarzenie wyzwolone o
|
time | string |
Czas zdarzenia. |
|
Typ zdarzenia
|
type | string |
Typ zdarzenia. |
Wersja 1. RecordApi.EmailAddressRead
Adres e-mail
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Address
|
address |
Adres e-mail |
|
|
identyfikator
|
id | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania adresu e-mail rekordu. |
|
Czy jest zaangażowany?
|
is_engaged | boolean |
Wskazuje, czy jest klikana lub otwierana zbiorcza wiadomość e-mail, albo użytkownik odpowiada na jedną wiadomość e-mail |
|
Czy używać do logowania?
|
is_login_email | boolean |
Wskazuje, czy użytkownik może zalogować się do platformy przy użyciu tego adresu e-mail. |
|
Czy jest podstawowy?
|
is_primary | boolean |
Podstawowa wiadomość e-mail służy do wysyłania automatycznych wiadomości e-mail wyzwalanych przez system. Służy również do wysyłania zbiorczej wiadomości e-mail do rekordu. To obowiązkowe, że tylko jedna wiadomość e-mail jest ustawiona jako podstawowa. |
|
Czy zweryfikowano przez użytkownika?
|
is_verified | boolean |
Określ, czy użytkownik zweryfikował, że jest właścicielem wiadomości e-mail. |
|
przesłać źródło
|
source | string |
Źródło wskazuje sposób dodawania wiadomości e-mail do bazy danych. |
|
stan
|
status | string | |
|
Typ
|
type | string |
Typ wiadomości e-mail |
Wersja 1. RecordApi.RecordRead
rekord
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Adresy e-mail
|
email_addresses | array of v1.RecordApi.EmailAddressRead |
Lista adresów e-mail profilu |
|
Identyfikator zewnętrznej bazy danych
|
external_database_id | string |
System ma przypisany unikatowy identyfikator rekordu przez zewnętrzną bazę danych. np. identyfikator rekordu systemu dla programu Raiser Edge NXT, identyfikator kontaktu dla usługi Salesforce |
|
Imię
|
first_name | string |
Imię rekordu. |
|
Pełna nazwa
|
formatted_name | string |
Pełna nazwa rekordu. |
|
identyfikator
|
id | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania rekordu. |
|
Czy zarejestrowano się w Almabase?
|
is_registered | boolean |
Wskaż, czy rekord lub darczyńca zarejestrował się w Almabase |
|
Nazwisko
|
last_name | string |
Nazwisko rekordu. |
|
Adres URL obrazu
|
present_picture | uri |
Adres URL obrazu rekordu |
|
Link
|
record_url | uri |
Link do rekordu w Almabase |
Wersja 1. EventApi.ContactPersonRead
Osoba kontaktowa z wydarzeniem
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Email
|
Adres e-mail osoby kontaktowej |
||
|
identyfikator
|
id | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania osoby kontaktowej. |
|
Name
|
name | string |
Imię i nazwisko osoby kontaktowej |
|
Numer telefonu
|
phone_number | string |
Numer telefonu osoby kontaktowej |
Wersja 1. EventApi.EventRead
Event
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Description
|
description | string |
Opis wydarzenia |
|
Godzina zakończenia
|
end_datetime | string |
Godzina zakończenia zdarzenia |
|
Identyfikator zewnętrznej bazy danych
|
external_database_id | string |
System ma przypisany unikatowy identyfikator rekordu przez zewnętrzną bazę danych. np. identyfikator rekordu systemu dla programu Raiser Edge NXT, identyfikator kontaktu dla usługi Salesforce |
|
Adres URL rejestracji zewnętrznej
|
external_registration_url | string |
Adres URL rejestracji zdarzenia w zewnętrznej witrynie internetowej |
|
identyfikator
|
id | integer |
Identyfikator wygenerowany przez system w celu unikatowego zidentyfikowania zdarzenia. |
|
Name
|
name | string |
Nazwa wydarzenia |
|
Godzina rozpoczęcia
|
start_datetime | string |
Godzina rozpoczęcia zdarzenia |
|
Timezone
|
timezone | string |
Strefa czasowa zdarzenia |