Blackbaud Raisers Edge NXT (wersja zapoznawcza)
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.
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 jednostkami znajdującymi się w narzędziu NXT aplikacji Raiser Edge, w tym:
- Składników
- Prezenty
- Czynności
- Notatki
- Pola niestandardowe
- Campaigns
- Funduszy
- Odwołania
- 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 sieci NXT programu Raiser's Edge. 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 | 500 | 60 sekund |
Akcje
| Akcje listy |
Zwraca listę akcji. |
| Aktualizowanie adresu składowego |
Aktualizuje adres składowy. |
| Aktualizowanie akcji składowej |
Aktualizuje akcję składową. |
| Aktualizowanie aliasu składowego |
Aktualizuje alias składowy. |
| Aktualizowanie edukacji składowej |
Aktualizuje edukację składową. |
| Aktualizowanie kodu na żądanie składników |
Aktualizuje kod żądań składników. |
| Aktualizowanie kodu składowego |
Aktualizuje kod składowy. |
| Aktualizowanie notatki składnikowej |
Aktualizuje notatkę składową. |
| Aktualizowanie obrazu profilu składowego |
Aktualizuje bieżący obraz profilu dla składnika. |
| Aktualizowanie opcji uczestnika |
Aktualizuje szczegóły dotyczące opcji uczestnika. |
| Aktualizowanie pola niestandardowego akcji |
Aktualizuje pole niestandardowe akcji. |
| Aktualizowanie pola niestandardowego funduszu |
Aktualizuje pole niestandardowe funduszu. |
| Aktualizowanie pola niestandardowego kampanii |
Aktualizuje pole niestandardowe kampanii. |
| Aktualizowanie pola niestandardowego odwołania |
Aktualizuje pole niestandardowe odwołania. |
| Aktualizowanie pola niestandardowego prezentu |
Aktualizuje pole niestandardowe prezentu. |
| Aktualizowanie pola niestandardowego składników |
Aktualizuje pole niestandardowe składników. |
| Aktualizowanie pola niestandardowego szansy sprzedaży |
Aktualizuje pole niestandardowe szans sprzedaży. |
| Aktualizowanie relacji składowej |
Aktualizuje relację dla składnika. Jeśli istnieje relacja wzajemna, jest ona również modyfikowana w celu odzwierciedlenia zmian. Nie obejmuje to zmian właściwości "komentarze", która jest specyficzna dla każdego rekordu i może być modyfikowana niezależnie w każdym rekordzie. |
| Aktualizowanie składnika |
Aktualizuje składnik. |
| Aktualizowanie składowego adresu e-mail |
Aktualizuje składnikowy adres e-mail. |
| Aktualizowanie składowej obecności w trybie online |
Aktualizuje składową obecność w trybie online. |
| Aktualizowanie szansy sprzedaży |
Aktualizuje szansę sprzedaży. |
| Aktualizowanie szczegółów paragonu upominkowego |
Aktualizuje szczegóły paragonu dla prezentu. |
| Aktualizowanie szczegółów potwierdzenia prezentu |
Aktualizuje szczegóły potwierdzenia dla prezentu. |
| Aktualizowanie telefonu składowego |
Aktualizuje telefon składowy. |
| Aktualizowanie uczestnika |
Aktualizuje szczegóły dotyczące uczestnika. |
| Aktualizowanie załącznika akcji |
Aktualizuje załącznik akcji. |
| Aktualizowanie załącznika funduszu |
Aktualizuje załącznik funduszu. |
| Aktualizowanie załącznika kampanii |
Aktualizuje załącznik kampanii. |
| Aktualizowanie załącznika odwołania |
Aktualizuje załącznik odwołania. |
| Aktualizowanie załącznika prezentu |
Aktualizuje załącznik prezentu. |
| Aktualizowanie załącznika składowego |
Aktualizuje załącznik składowy. |
| Aktualizowanie załącznika szansy sprzedaży |
Aktualizuje załącznik szans sprzedaży. |
| Aktualizowanie zdarzenia |
Aktualizuje szczegóły zdarzenia. |
| Dodawanie prezentu do partii |
Dodaj prezent do określonej partii prezentów. |
| Dodawanie rekordów do listy |
Dodaj zestaw rekordów do istniejącej listy. |
| Lista darowizn uczestników |
Wyświetla listę datków dla uczestnika. |
| Lista edukacji składowych |
Wyświetla listę rekordów edukacyjnych dla składnika. |
| Lista klasyfikacji składników |
Zwraca listę klasyfikacji dla składnika. |
| Lista kodów pozyskiwania składników |
Wyświetla listę kodów żądań dla składnika. |
| Lista notatek składowych |
Wyświetla listę notatek dla składnika. |
| Lista odwołań |
Zwraca listę odwołań. |
| Lista opłat za uczestnika |
Wyświetla listę opłat dla uczestnika. |
| Lista partii prezentów |
Wyświetl listę partii prezentów. |
| Lista prezentów |
Zwraca listę prezentów. |
| Lista składników |
Zwraca listę składników. |
| Lista składowych zbiórki funduszy |
Wyświetla listę przypisań fundraiser dla wyborców. |
| Lista telefonów składowych |
Wyświetla listę telefonów dla składnika. |
| Lista załączników akcji |
Wyświetla listę załączników dla akcji. |
| Lista załączników prezentów |
Wyświetla listę załączników dla prezentu. |
| Lista załączników składowych |
Wyświetla listę załączników dla składnika. |
| Listy załączników odwołania |
Wyświetla listę załączników odwołania. |
| Otrzymasz prezent |
Zwraca informacje o prezentie. |
| Pobieranie akcji składowej |
Zwraca informacje o akcji składowej. |
| Pobieranie obrazu profilu składowego |
Zwraca bieżący obraz profilu dla składnika. |
| Pobieranie pakietu |
Zwraca informacje o pakiecie. |
| Pobieranie składnika |
Zwraca informacje o składniku. |
| Pobieranie zdarzenia |
Zwraca informacje o zdarzeniu. |
| Pobierz najnowszy prezent dla wyborców |
Zwraca najnowszy prezent dla składnika. |
| Pola niestandardowe akcji listy |
Wyświetla listę pól niestandardowych dla akcji. |
| Tworzenie adresu składowego |
Tworzy nowy adres składowy. |
| Tworzenie akcji składowej |
Tworzy nową akcję składową. |
| Tworzenie aliasu składowego |
Tworzy nowy alias składowy. |
| Tworzenie darowizny uczestnika |
Tworzy nową darowiznę dla uczestnika. |
| Tworzenie edukacji składowej |
Tworzy nową edukację składową. |
| Tworzenie klasyfikacji składowej |
Tworzy nową ocenę składową. |
| Tworzenie kodu na żądanie składników |
Tworzy nowy kod pozyskiwania składników. |
| Tworzenie kodu składowego |
Tworzy nowy kod składowy. |
| Tworzenie listy na podstawie zestawu rekordów |
Tworzy nową listę przefiltrowaną do określonego zestawu rekordów. |
| Tworzenie lokalizacji dokumentu |
Tworzy nowy unikatowy identyfikator dokumentu i lokalizację przekazywania do użycia z załącznikami fizycznymi. Odpowiedź będzie zawierać instrukcje dotyczące miejsca i sposobu przekazywania zawartości dokumentu. |
| Tworzenie notatki składowej |
Tworzy nową notatkę składową. |
| Tworzenie opłaty za uczestnika |
Tworzy nową opłatę dla uczestnika. |
| Tworzenie opłaty za zdarzenie |
Tworzy nową opłatę za zdarzenie. |
| Tworzenie partii prezentów |
Tworzy nową partię prezentów. |
| Tworzenie pojedynczego składnika |
Tworzy nowy składnik indywidualny. |
| Tworzenie pojedynczej relacji |
Tworzy nową relację indywidualną. Jeśli relacja jest z innym składnikiem, zostanie utworzona relacja wzajemne dla tego składnika. |
| Tworzenie pola niestandardowego akcji |
Tworzy nowe pole niestandardowe akcji. |
| Tworzenie pola niestandardowego funduszu |
Tworzy nowe pole niestandardowe funduszu. |
| Tworzenie pola niestandardowego kampanii |
Tworzy nowe pole niestandardowe kampanii. |
| Tworzenie pola niestandardowego odwołania |
Tworzy nowe pole niestandardowe odwołania. |
| Tworzenie pola niestandardowego prezentu |
Tworzy nowe pole niestandardowe prezentu. |
| Tworzenie pola niestandardowego składowego |
Tworzy nowe pole niestandardowe składowe. |
| Tworzenie pola niestandardowego szansy sprzedaży |
Tworzy nowe pole niestandardowe szans sprzedaży. |
| Tworzenie prezentu |
Tworzy nowy prezent. |
| Tworzenie przypisania zbiórki pieniędzy |
Tworzy nowe przypisanie zbiórki pieniędzy. |
| Tworzenie płatności za opłatę uczestnika |
Tworzy nową płatność opłatą dla uczestnika. |
| Tworzenie rekordu zgody składników |
Tworzy nowy rekord zgody składników. |
| Tworzenie relacji organizacji |
Tworzy nową relację organizacji. Jeśli relacja jest z innym składnikiem, zostanie utworzona relacja wzajemne dla tego składnika. |
| Tworzenie składnika organizacji |
Tworzy nowy składnik organizacji. |
| Tworzenie składowego adresu e-mail |
Tworzy nowy składnikowy adres e-mail. |
| Tworzenie składowej obecności online |
Tworzy nową składową obecność online. |
| Tworzenie szansy sprzedaży |
Tworzy nową szansę sprzedaży. |
| Tworzenie telefonu składowego |
Tworzy nowy telefon składowy. |
| Tworzenie uczestnika |
Tworzy nowego uczestnika wydarzenia. |
| Tworzenie załącznika akcji |
Tworzy nowy załącznik akcji. |
| Tworzenie załącznika funduszu |
Tworzy nowy załącznik funduszu. |
| Tworzenie załącznika kampanii |
Tworzy nowy załącznik kampanii. |
| Tworzenie załącznika odwołania |
Tworzy nowy załącznik odwołania. |
| Tworzenie załącznika prezentu |
Tworzy nowy załącznik prezentu. |
| Tworzenie załącznika składowego |
Tworzy nowy załącznik składowy. |
| Tworzenie załącznika szansy sprzedaży |
Tworzy nowy załącznik szans sprzedaży. |
| Tworzenie zdarzenia |
Tworzy nowe zdarzenie. |
| Usuwanie kodu składowego |
Usuwa kod składowy. |
| Utwórz opcję uczestnika |
Tworzy nową opcję uczestnika dla uczestnika. |
| Utwórz opcję uczestnika zdarzenia |
Tworzy nową opcję uczestnika dla wydarzenia. |
| Uzyskaj pierwszy prezent składników |
Zwraca pierwszy prezent dla składnika. |
| Uzyskiwanie funduszu |
Zwraca informacje o funduszu. |
| Uzyskiwanie kampanii |
Zwraca informacje o kampanii. |
| Uzyskiwanie odwołania |
Zwraca informacje o odwołaniu. |
| Uzyskiwanie składowego okresu istnienia dającego |
Zwraca okres istnienia dając podsumowanie dla składnika. |
| Uzyskiwanie stanu potencjalnych składników |
Zwraca bieżący stan perspektywy dla składnika. |
| Uzyskiwanie szansy sprzedaży |
Zwraca informacje o szansie sprzedaży. Uwaga: ten punkt końcowy zwraca właściwość statusu z opóźnieniem około 10 minut. |
| Uzyskiwanie uczestnika |
Zwraca informacje o określonym uczestniku zdarzenia. |
| Uzyskuj prezent najwspanialszy |
Zwraca największy prezent dla składnika. |
| Wyszukiwanie składnika |
Wykonuje wyszukiwanie składowe na podstawie podanego tekstu wyszukiwania. Obsługuje imię, nazwisko, preferowaną nazwę, byłą nazwę, alias, adres e-mail, numer telefonu, adres lub identyfikator odnośnika. Kombinacje nazw, takie jak imię i nazwisko lub preferowane imię i nazwisko, są prawidłowe, ale w przeciwnym razie wyszukiwanie obsługuje tylko jeden parametr jednocześnie. Domyślnie wyszukiwania obejmują wyniki, które brzmią podobnie do kryteriów. Na przykład wyszukiwanie "Smith" obejmuje dopasowania dla "Smyth" i innych alternatywnych pisowni. To wyszukiwanie nie obsługuje symboli wieloznacznych, takich jak * lub ?. Wyniki wyszukiwania są ograniczone do 500 rekordów. |
| Wyświetlanie listy adresów e-mail składowych |
Wyświetla listę adresów e-mail dla składnika. |
| Wyświetlanie listy adresów składowych |
Wyświetla listę adresów składników. |
| Wyświetlanie listy akcji składowych |
Wyświetla listę akcji dla składnika. |
| Wyświetlanie listy aliasów składowych |
Wyświetla aliasy składników. |
| Wyświetlanie listy funduszy |
Zwraca listę funduszy. |
| Wyświetlanie listy kampanii |
Zwraca listę kampanii. |
| Wyświetlanie listy kodów składowych |
Wyświetla listę kodów składowych dla składnika. |
| 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 pakietów |
Zwraca listę pakietów. |
| Wyświetlanie listy przypisań fundraiser |
Wyświetl listę przypisań do zbiórki pieniędzy. |
| Wyświetlanie listy pól niestandardowych funduszu |
Wyświetla listę pól niestandardowych dla funduszu. |
| Wyświetlanie listy pól niestandardowych kampanii |
Wyświetla listę pól niestandardowych dla kampanii. |
| Wyświetlanie listy pól niestandardowych odwołania |
Wyświetla listę pól niestandardowych dla odwołania. |
| Wyświetlanie listy pól niestandardowych prezentów |
Wyświetla listę pól niestandardowych dla prezentu. |
| Wyświetlanie listy pól niestandardowych składowych |
Wyświetla listę pól niestandardowych dla składnika. |
| Wyświetlanie listy pól niestandardowych szans sprzedaży |
Wyświetla listę pól niestandardowych dla szansy sprzedaży. |
| Wyświetlanie listy płatności za opłatę uczestnika |
Wyświetla listę płatności opłat dla uczestnika. |
| Wyświetlanie listy rekordów zgody składników |
Wyświetla listę rekordów zgody dla składnika. |
| Wyświetlanie listy relacji składowych |
Wyświetla listę relacji dla składnika. |
| Wyświetlanie listy składników obecności online |
Wyświetla listę obecności online dla składnika. |
| Wyświetlanie listy szans sprzedaży |
Zwraca listę szans sprzedaży. |
| Wyświetlanie listy uczestników wydarzenia |
Wyświetla listę uczestników wydarzenia. |
| Wyświetlanie listy załączników funduszu |
Zawiera listę załączników dla funduszu. |
| Wyświetlanie listy załączników kampanii |
Wyświetla listę załączników kampanii. |
| Wyświetlanie listy załączników szans sprzedaży |
Wyświetla listę załączników dla szansy sprzedaży. |
| Wyświetlanie listy zdarzeń |
Zwraca listę zdarzeń. |
Akcje listy
Zwraca listę akcji.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
List
|
list_id | string |
Definiuje identyfikator listy używany do filtrowania zestawu akcji do tych uwzględnionych na określonej liście. Jeśli ta wartość zostanie ustawiona, inne określone filtry zostaną zignorowane. |
|
|
Stan obliczony
|
computed_status | string |
Reprezentuje filtr wyników na podstawie stanu obliczonej akcji. Dostępne wartości to Open, Completed lub PastDue. |
|
|
Status
|
status_code | string |
Reprezentuje kod stanu akcji do filtrowania wyników (dotyczy tylko wtedy, gdy system jest skonfigurowany do używania kodów stanu akcji). Na przykład "Oczekujące" zwraca akcje ze stanem "Oczekiwanie". |
|
|
Ograniczenie
|
limit | integer |
Reprezentuje liczbę rekordów do zwrócenia. Wartość domyślna to 500. Wartość maksymalna to 5000. |
|
|
Przesunięcie
|
offset | integer |
Reprezentuje liczbę rekordów do pominięcia. Do użycia z podziałem na strony. |
|
|
Dodano polecenie lub po
|
date_added | date-time |
Przefiltruj wyniki do akcji 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 akcji zmodyfikowanych w określonym dniu lub po określonej dacie (np. "2020-09-18T04:13:56Z"). |
Zwraca
Czynności
Aktualizowanie adresu składowego
Aktualizuje adres składowy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator adresu
|
address_id | True | string |
Identyfikator rekordu systemowego adresu do zaktualizowania. |
|
Typ adresu
|
type | string |
Typ adresu. |
|
|
Country
|
country | string |
Kraj adresu (może to być identyfikator, nazwa lub skrót). |
|
|
Wiersze adresów
|
address_lines | string |
Wiersze adresu. |
|
|
Miejscowość
|
city | string |
Miasto adresu (nie należy używać w połączeniu z polem Suburb). |
|
|
State
|
state | string |
Stan adresu. |
|
|
Kod pocztowy
|
postal_code | string |
Kod pocztowy adresu. |
|
|
Przedmieście
|
suburb | string |
Przedmieścia adresu (nie należy używać w połączeniu z polem Miasto). |
|
|
Powiat
|
county | string |
Hrabstwo adresu. |
|
|
Źródło informacji
|
information_source | string |
Źródło informacji dla adresu. |
|
|
Region
|
region | string |
Region adresu. |
|
|
WÓZEK
|
cart | string |
Trasa przewoźnika (CART) dla adresu. |
|
|
WIELE
|
lot | string |
Linia podróży (LOT) dla adresu. |
|
|
DPC
|
dpc | string |
Kod punktu dostawy (DPC) dla adresu. |
|
|
Prawidłowy od
|
start | date |
Data rozpoczęcia pobytu składnika pod tym adresem (np. "2005-09-18"). |
|
|
Prawidłowa wartość
|
end | date |
Data, w którym składnik przestał znajdować się pod tym adresem (np. "2005-09-18"). |
|
|
Podstawowy?
|
preferred | boolean |
Czy jest to preferowany adres składnika? |
|
|
Nie wyślij wiadomości e-mail?
|
do_not_mail | boolean |
Czy wyborca może się skontaktować pod tym adresem? |
|
|
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. |
Aktualizowanie akcji składowej
Aktualizuje akcję składową.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator akcji
|
action_id | True | string |
Identyfikator rekordu systemu akcji do zaktualizowania. |
|
Kategoria
|
category | string |
Kanał lub intencja interakcji składowej. |
|
|
Zakończone?
|
completed | boolean |
Czy akcja została ukończona? Jeśli system jest skonfigurowany do używania niestandardowych stanów akcji, ta wartość jest oparta na wartości stanu akcji. |
|
|
Ukończono
|
completed_date | date-time |
Data zakończenia akcji (np. "2020-09-18T04:13:56Z"). |
|
|
Date
|
date | date-time |
Data akcji (np. "2020-09-18T04:13:56Z"). |
|
|
Uwaga / Notatka
|
description | string |
Szczegółowe wyjaśnienie, które zawiera podsumowanie akcji. |
|
|
Direction
|
direction | string |
Kierunek akcji. |
|
|
Fundraiser(s)
|
fundraisers | array of string |
Zestaw identyfikatorów rekordów systemowych dla fundraisers skojarzonych z akcją. |
|
|
Lokalizacja
|
location | string |
Lokalizacja akcji. |
|
|
Identyfikator szansy sprzedaży
|
opportunity_id | string |
Identyfikator rekordu systemu szansy sprzedaży skojarzonej z akcją. |
|
|
Outcome
|
outcome | string |
Wynik akcji. |
|
|
Priority
|
priority | string |
Priorytet akcji. |
|
|
Godzina rozpoczęcia
|
start_time | string |
Godzina rozpoczęcia akcji. Używa 24-godzinnego czasu w formacie HH:mm. |
|
|
Godzina zakończenia
|
end_time | string |
Godzina zakończenia akcji. Używa 24-godzinnego czasu w formacie HH:mm. |
|
|
Status
|
status | string |
Stan akcji. |
|
|
Podsumowanie
|
summary | string |
Krótki opis akcji, która jest wyświetlana w górnej części rekordu. Limit znaków: 255. |
|
|
Typ
|
type | string |
Dodatkowy opis akcji w celu uzupełnienia kategorii. |
Aktualizowanie aliasu składowego
Aktualizuje alias składowy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator aliasu
|
alias_id | True | string |
Identyfikator rekordu systemu aliasu do zaktualizowania. |
|
Pseudonim
|
name | string |
Nazwa, która ma być używana jako alias składnika. Limit znaków: 100. |
|
|
Typ
|
type | string |
Typ aliasu. |
Aktualizowanie edukacji składowej
Aktualizuje edukację składową.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator edukacji
|
education_id | True | string |
Identyfikator rekordu systemowego rekordu edukacyjnego do zaktualizowania. |
|
Szkoła
|
school | string |
Nazwa szkoły/placówki. |
|
|
Typ
|
type | string |
Typ edukacji. |
|
|
Klasa klasy
|
class_of | string |
Rok, w ramach których składnik ukończył. |
|
|
Status
|
status | string |
Status edukacji. |
|
|
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. |
|
|
day
|
d | integer |
Dzień w dacie rozmytej. |
|
|
miesiąca
|
m | integer |
Miesiąc w dacie rozmytej. |
|
|
rok
|
y | integer |
Rok w dacie rozmytej. |
|
|
Stopień
|
degree | string |
Stopień otrzymany. |
|
|
GpA
|
gpa | double |
Średnia punktu oceny. |
|
|
Temat badania
|
subject_of_study | string |
Temat badania. |
|
|
Podstawowy?
|
primary | boolean |
Czy jest to stowarzyszenie szkoły podstawowej składowej? |
|
|
Majors
|
majors | array of string |
Główne kursy studiów. |
|
|
Nieletnich
|
minors | array of string |
Drobne kursy studiów. |
|
|
Campus
|
campus | string |
Kampus. Limit znaków: 50. |
|
|
Organizacja społeczna
|
social_organization | string |
Organizacja społeczna. Limit znaków: 50. |
|
|
Znana nazwa
|
known_name | string |
Znana nazwa. Limit znaków: 50. |
|
|
Klasa stopnia
|
class_of_degree | string |
Klasa stopnia. |
|
|
Dział
|
department | string |
Nazwa departamentu edukacji. |
|
|
Wydział
|
faculty | string |
Nazwa wydziału. |
|
|
Numer rejestracji
|
registration_number | string |
Numer rejestracji. Limit znaków: 50. |
Aktualizowanie kodu na żądanie składników
Aktualizuje kod żądań składników.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator kodu żądania
|
constituent_solicit_code_id | True | string |
Identyfikator rekordu systemowego kodu, który ma być aktualizowany. |
|
Kod na żądanie
|
solicit_code | string |
Instrukcje dotyczące komunikacji i/lub ograniczenia dotyczące składników. |
|
|
Data rozpoczęcia
|
start_date | date |
Data rozpoczęcia kodu na żądanie (np. "2005-09-18"). |
|
|
Data zakończenia
|
end_date | date |
Data zakończenia kodu na żądanie (np. "2005-09-18"). |
Aktualizowanie kodu składowego
Aktualizuje kod składowy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator kodu składowego
|
constituent_code_id | True | string |
Identyfikator rekordu systemu kodu składowego do zaktualizowania. |
|
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. |
|
|
Kolejność
|
sequence | integer |
Sekwencja liczbowa skojarzona z kodem składowym. |
Aktualizowanie notatki składnikowej
Aktualizuje notatkę składową.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator notatki
|
note_id | True | string |
Identyfikator rekordu systemu notatki do zaktualizowania. |
|
Typ
|
type | string |
Typ notatki. |
|
|
day
|
d | integer |
Dzień w dacie rozmytej. |
|
|
miesiąca
|
m | integer |
Miesiąc w dacie rozmytej. |
|
|
rok
|
y | integer |
Rok w dacie rozmytej. |
|
|
Podsumowanie
|
summary | string |
Podsumowanie notatki. Limit znaków: 50. |
|
|
Uwaga / Notatka
|
text | string |
Tekst notatki. |
Aktualizowanie obrazu profilu składowego
Aktualizuje bieżący obraz profilu dla składnika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemu składnika, którego obraz profilu ma zostać zaktualizowany. |
|
Nazwa pliku
|
file_name | True | string |
Nazwa pliku. |
|
Identyfikator dokumentu
|
document_id | True | uuid |
Identyfikator dokumentu. |
|
Identyfikator miniatury
|
thumbnail_id | True | uuid |
Identyfikator dokumentu miniatury. |
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 pola niestandardowego akcji
Aktualizuje pole niestandardowe akcji.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pola niestandardowego
|
custom_field_id | True | string |
Identyfikator rekordu systemowego pola niestandardowego do zaktualizowania. |
|
body
|
body | True | dynamic |
Obiekt reprezentujący właściwości pola niestandardowego do zaktualizowania. |
Aktualizowanie pola niestandardowego funduszu
Aktualizuje pole niestandardowe funduszu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pola niestandardowego
|
custom_field_id | True | string |
Identyfikator rekordu systemowego pola niestandardowego do zaktualizowania. |
|
body
|
body | True | dynamic |
Obiekt reprezentujący właściwości pola niestandardowego do zaktualizowania. |
Aktualizowanie pola niestandardowego kampanii
Aktualizuje pole niestandardowe kampanii.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pola niestandardowego
|
custom_field_id | True | string |
Identyfikator rekordu systemowego pola niestandardowego do zaktualizowania. |
|
body
|
body | True | dynamic |
Obiekt reprezentujący właściwości pola niestandardowego do zaktualizowania. |
Aktualizowanie pola niestandardowego odwołania
Aktualizuje pole niestandardowe odwołania.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pola niestandardowego
|
custom_field_id | True | string |
Identyfikator rekordu systemowego pola niestandardowego do zaktualizowania. |
|
body
|
body | True | dynamic |
Obiekt reprezentujący właściwości pola niestandardowego do zaktualizowania. |
Aktualizowanie pola niestandardowego prezentu
Aktualizuje pole niestandardowe prezentu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pola niestandardowego
|
custom_field_id | True | string |
Identyfikator rekordu systemowego pola niestandardowego do zaktualizowania. |
|
body
|
body | True | dynamic |
Obiekt reprezentujący właściwości pola niestandardowego do zaktualizowania. |
Aktualizowanie pola niestandardowego składników
Aktualizuje pole niestandardowe składników.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pola niestandardowego
|
custom_field_id | True | string |
Identyfikator rekordu systemowego pola niestandardowego do zaktualizowania. |
|
body
|
body | True | dynamic |
Obiekt reprezentujący właściwości pola niestandardowego do zaktualizowania. |
Aktualizowanie pola niestandardowego szansy sprzedaży
Aktualizuje pole niestandardowe szans sprzedaży.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pola niestandardowego
|
custom_field_id | True | string |
Identyfikator rekordu systemowego pola niestandardowego do zaktualizowania. |
|
body
|
body | True | dynamic |
Obiekt reprezentujący właściwości pola niestandardowego do zaktualizowania. |
Aktualizowanie relacji składowej
Aktualizuje relację dla składnika. Jeśli istnieje relacja wzajemna, jest ona również modyfikowana w celu odzwierciedlenia zmian. Nie obejmuje to zmian właściwości "komentarze", która jest specyficzna dla każdego rekordu i może być modyfikowana niezależnie w każdym rekordzie.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator relacji
|
relationship_id | True | string |
Identyfikator rekordu systemu relacji do aktualizacji. |
|
Typ
|
type | string |
Typ relacji reprezentowanej przez relację. |
|
|
Typ wzajemny
|
reciprocal_type | string |
Opisuje relację składnika z powiązanym składnikiem. Na przykład w związku między męskim składnikiem a rodzeństwem kobiet typ relacji wzajemnej będzie bratem. |
|
|
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. |
|
|
Czy współmałżonek?
|
is_spouse | boolean |
Czy powiązana osoba współmałżonka składnika (dotyczy tylko relacji między osobami)? |
|
|
Czy wyborca jest szefem gospodarstwa domowego?
|
is_constituent_head_of_household | boolean |
Czy składnik jest głową gospodarstwa domowego? |
|
|
Czy współmałżonek gospodarstwa domowego?
|
is_spouse_head_of_household | boolean |
Czy współmałżonek jest głową gospodarstwa domowego? |
|
|
Notatki
|
comment | string |
Dodatkowe uwagi dotyczące relacji. |
|
|
Czy kontakt?
|
is_organization_contact | boolean |
Czy składnik reprezentuje tę organizację jako kontakt (dotyczy tylko relacji między organizacjami i osobami)? |
|
|
Czy podstawowa firma?
|
is_primary_business | boolean |
Czy jest to podstawowa działalność składnika (dotyczy tylko relacji między organizacjami i osobami)? |
|
|
Typ kontaktu
|
organization_contact_type | string |
Udostępnia kontekst interakcji z powiązaną osobą, która reprezentuje organizację jako kontakt. Dotyczy tylko relacji między organizacjami i osobami fizycznymi. |
|
|
Position
|
position | string |
Stanowisko osoby w organizacji. Dotyczy tylko relacji między organizacjami i osobami fizycznymi. Limit znaków: 50. |
Aktualizowanie składnika
Aktualizuje składnik.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemowego składnika do aktualizacji. |
|
Title
|
title | string |
Podstawowy tytuł składnika (tylko dla osób). |
|
|
Imię
|
first | string |
Imię składnika (tylko dla osób). Limit znaków: 50. |
|
|
Nazwisko
|
last | string |
Nazwisko składnika (tylko dla osób). Limit znaków: 100. |
|
|
Nazwa organizacji
|
name | string |
W przypadku użytkowników indywidualnych jest to pole obliczane, które nie ma zastosowania do operacji edycji. W przypadku organizacji to pole jest wymagane i reprezentuje nazwę organizacji. Limit znaków: 100. |
|
|
Sufiks
|
suffix | string |
Sufiks podstawowy składnika (tylko dla osób). |
|
|
Preferowana nazwa
|
preferred_name | string |
Preferowana nazwa składnika (tylko dla osób). Limit znaków: 50. |
|
|
Identyfikator odnośnika
|
lookup_id | string |
Identyfikator zdefiniowany przez użytkownika dla składnika. |
|
|
Gender
|
gender | string |
Płeć składnika (tylko dla osób). |
|
|
Drugie imię
|
middle | string |
Drugie imię składnika (tylko dla osób). Limit znaków: 50. |
|
|
Była nazwa
|
former_name | string |
Była nazwa składnika (tylko dla osób). Limit znaków: 100. |
|
|
Tytuł 2
|
title_2 | string |
Tytuł pomocniczy składnika (tylko dla osób fizycznych). |
|
|
Sufiks 2
|
suffix_2 | string |
Sufiks pomocniczy składnika (tylko dla osób). |
|
|
Stan cywilny
|
marital_status | string |
Stan cywilny składnika (tylko dla osób fizycznych). |
|
|
Daje anonimowo?
|
gives_anonymously | boolean |
Czy składnik daje anonimowo? |
|
|
Nieaktywny?
|
inactive | boolean |
Czy składnik jest nieaktywny? |
|
|
day
|
d | integer |
Dzień w dacie rozmytej. |
|
|
miesiąca
|
m | integer |
Miesiąc w dacie rozmytej. |
|
|
rok
|
y | integer |
Rok w dacie rozmytej. |
|
|
Miejsce narodzin
|
birthplace | string |
Miejsce urodzenia składnika (tylko dla osób). |
|
|
Pochodzenie etniczne
|
ethnicity | string |
Pochodzenie etniczne wyborców (tylko dla osób). |
|
|
Dochód
|
income | string |
Dochód dla składnika (tylko dla osób fizycznych). |
|
|
Religia
|
religion | string |
Religia wyborców (tylko dla osób). |
|
|
Przemysł
|
industry | string |
Przemysł składników (tylko dla organizacji). |
|
|
Liczba pracowników
|
num_employees | integer |
Liczba pracowników w organizacji. |
|
|
Pasuje do prezentów?
|
matches_gifts | boolean |
Czy organizacja jest zgodna z prezentami? |
|
|
Dopasowywanie współczynnika prezentów
|
matching_gift_factor | double |
Pasujący współczynnik prezentów (tylko dla organizacji). |
|
|
Minimalne dopasowanie na prezent
|
value | double |
Minimalna kwota dopasowania na prezent dla składnika (tylko dla organizacji). |
|
|
Maksymalna liczba dopasowań na prezent
|
value | double |
Maksymalna kwota dopasowań na prezent dla składnika (tylko dla organizacji). |
|
|
Minimalne dopasowanie na okręg wyborczy
|
value | double |
Minimalna suma dopasowań dla składnika (tylko dla organizacji). |
|
|
Maksymalne dopasowanie na okręg wyborczy
|
value | double |
Maksymalna suma dopasowań dla składnika (tylko dla organizacji). |
|
|
Pasujące notatki prezentowe
|
matching_gift_notes | string |
Pasujące notatki prezentowe dla składnika (tylko dla organizacji). |
|
|
Zmarły?
|
deceased | boolean |
Czy składnik zmarły (tylko dla osób)? |
|
|
day
|
d | integer |
Dzień w dacie rozmytej. |
|
|
miesiąca
|
m | integer |
Miesiąc w dacie rozmytej. |
|
|
rok
|
y | integer |
Rok w dacie rozmytej. |
Aktualizowanie składowego adresu e-mail
Aktualizuje składnikowy adres e-mail.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator adresu e-mail
|
email_address_id | True | string |
Identyfikator rekordu systemowego adresu e-mail do zaktualizowania. |
|
Typ wiadomości e-mail
|
type | string |
Typ adresu e-mail. |
|
|
Adres e-mail
|
address | string |
Adres e-mail. |
|
|
Podstawowy?
|
primary | boolean |
Czy jest to podstawowy adres e-mail składnika? |
|
|
Nie wysyłaj wiadomości e-mail?
|
do_not_email | boolean |
Czy można skontaktować się z składnikiem pod tym adresem e-mail? |
|
|
Nieaktywny?
|
inactive | boolean |
Czy ten adres e-mail jest nieaktywny? |
Aktualizowanie składowej obecności w trybie online
Aktualizuje składową obecność w trybie online.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator obecności online
|
online_presence_id | True | string |
Identyfikator rekordu systemu obecności online do zaktualizowania. |
|
Typ
|
type | string |
Typ obecności online. |
|
|
Link
|
address | string |
Adres internetowy dla obecności online. |
|
|
Podstawowy?
|
primary | boolean |
Czy jest to podstawowa obecność online składnika? |
|
|
Nieaktywny?
|
inactive | boolean |
Czy ta obecność online jest nieaktywna? |
Aktualizowanie szansy sprzedaży
Aktualizuje szansę sprzedaży.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator szansy sprzedaży
|
opportunity_id | True | string |
Identyfikator rekordu systemu szansy aktualizacji. |
|
Przeznaczenie
|
purpose | string |
Zamierzone wykorzystanie wszelkich pieniędzy zebranych w wyniku szansy sprzedaży. |
|
|
Name
|
name | string |
Nazwa identyfikująca szansę sprzedaży w całym programie, na przykład na listach lub na rekordach składowych. Limit znaków: 255. |
|
|
Status
|
status | string |
Stan wskazujący, gdzie jest szansa sprzedaży w procesie pozyskiwania. |
|
|
Deadline
|
deadline | date-time |
Data celu okazji do uzyskania prezentu (np. "2020-09-18T04:13:56Z"). |
|
|
Data pytania
|
ask_date | date-time |
Data wykonania wezwania (np. "2020-09-18T04:13:56Z"). |
|
|
value
|
value | double |
Wartość pieniężna. |
|
|
Oczekiwana data
|
expected_date | date-time |
Data, kiedy oczekuje się, że perspektywa zostanie wyrażona w odpowiedzi na szansę sprzedaży (np. "2020-09-18T04:13:56Z"). |
|
|
value
|
value | double |
Wartość pieniężna. |
|
|
Data finansowania
|
funded_date | date-time |
Data, kiedy perspektywa udzieliła odpowiedzi na szansę sprzedaży (np. "2020-09-18T04:13:56Z"). |
|
|
value
|
value | double |
Wartość pieniężna. |
|
|
Identyfikator kampanii
|
campaign_id | string |
Identyfikator rekordu systemu kampanii skojarzonej z szansą sprzedaży. Kampania określa ogólne cele zbierania pieniędzy. |
|
|
Identyfikator funduszu
|
fund_id | string |
System rejestruje identyfikator funduszu skojarzonego z szansą sprzedaży. Fundusz wyznacza konkretny cel finansowy prezentu i identyfikuje konto finansowe dla tego prezentu. |
|
|
Identyfikator składowy
|
constituent_id | string |
Identyfikator rekordu systemu składnika skojarzonego z zbiórką pieniędzy. |
|
|
value
|
value | double |
Wartość pieniężna. |
|
|
Nieaktywny?
|
inactive | boolean |
Czy szansa jest nieaktywna? |
Aktualizowanie szczegółów paragonu upominkowego
Aktualizuje szczegóły paragonu dla prezentu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator potwierdzenia
|
receipt_id | True | string |
Identyfikator rekordu systemowego potwierdzenia prezentu do aktualizacji. Używa identyfikatora prezentu nadrzędnego jako jego wartości. |
|
Status
|
status | string |
Status odbioru prezentu. Jeśli stan ma wartość NeedsReceipt lub DoNotReceipt, data potwierdzenia powinna mieć wartość null. |
|
|
value
|
value | double |
Wartość pieniężna. |
|
|
Date
|
date | date-time |
Data odbioru (np. "2020-09-18T04:13:56Z"). |
|
|
Number
|
number | integer |
Liczba paragonów. |
Aktualizowanie szczegółów potwierdzenia prezentu
Aktualizuje szczegóły potwierdzenia dla prezentu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator potwierdzenia
|
acknowledgement_id | True | string |
Identyfikator rekordu systemowego potwierdzenia prezentu do aktualizacji. Używa identyfikatora prezentu nadrzędnego jako jego wartości. |
|
Status
|
status | string |
Stan potwierdzenia. Gdy stan jest ustawiony na DoNotAcknowledge, litera i data powinny mieć wartość null. Jeśli stan ma wartość NeedsAcknowledgement, data powinna mieć wartość null. |
|
|
Date
|
date | date-time |
Data skojarzona z potwierdzeniem (np. "2020-09-18T04:13:56Z"). |
|
|
List
|
letter | string |
List skojarzony z potwierdzeniem. |
Aktualizowanie telefonu składowego
Aktualizuje telefon składowy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator telefonu
|
phone_id | True | string |
Identyfikator rekordu systemu telefonu do zaktualizowania. |
|
Typ
|
type | string |
Typ telefonu. |
|
|
Number
|
number | string |
Numer telefonu. |
|
|
Podstawowy?
|
primary | boolean |
Czy jest to podstawowy telefon wyborcy? |
|
|
Nie dzwonisz?
|
do_not_call | boolean |
Czy można skontaktować się z składnikiem pod tym numerem? |
|
|
Nieaktywny?
|
inactive | boolean |
Czy ten numer telefonu jest nieaktywny? |
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. |
Aktualizowanie załącznika akcji
Aktualizuje załącznik akcji.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
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. |
Aktualizowanie załącznika funduszu
Aktualizuje załącznik funduszu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
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. |
Aktualizowanie załącznika kampanii
Aktualizuje załącznik kampanii.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
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. |
Aktualizowanie załącznika odwołania
Aktualizuje załącznik odwołania.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
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. |
Aktualizowanie załącznika prezentu
Aktualizuje załącznik prezentu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
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. |
Aktualizowanie załącznika składowego
Aktualizuje załącznik składowy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
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. |
Aktualizowanie załącznika szansy sprzedaży
Aktualizuje załącznik szans sprzedaży.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
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. |
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? |
Dodawanie prezentu do partii
Dodaj prezent do określonej partii prezentów.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Batch
|
batch_id | True | string |
Partia, do której zostanie dodany prezent. |
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemowego składnika skojarzonego z prezentem. |
|
Kwota
|
value | True | double |
Kwota pieniężna prezentu. |
|
Date
|
date | True | date |
Data prezentu (np. "2020-09-18"). |
|
Typ
|
type | True | string |
Typ prezentu. |
|
identyfikator kampanii
|
campaign_id | string |
Identyfikator rekordu systemowego kampanii skojarzonej z podziałem prezentu. |
|
|
identyfikator funduszu
|
fund_id | True | string |
Identyfikator rejestru systemu funduszu skojarzonego z podziałem prezentu. |
|
identyfikator odwołania
|
appeal_id | string |
Identyfikator rekordu systemowego odwołania skojarzonego z podziałem prezentu. |
|
|
identyfikator pakietu
|
package_id | string |
Identyfikator rekordu systemowego pakietu skojarzonego z podziałem prezentu. |
|
|
kwota
|
value | True | double |
Kwota pieniężna podziału prezentu. |
|
Forma płatności
|
payment_method | True | string |
Forma płatności. |
|
Numer kontrolny
|
check_number | string |
Numer kontrolny (dotyczy tylko wtedy, gdy forma płatności to "PersonalCheck"). |
|
|
day
|
d | integer |
Dzień w dacie rozmytej. |
|
|
miesiąca
|
m | integer |
Miesiąc w dacie rozmytej. |
|
|
rok
|
y | integer |
Rok w dacie rozmytej. |
|
|
Reference
|
reference | string |
Odwołanie do płatności (dotyczy tylko wtedy, gdy forma płatności to "Inne"). |
|
|
day
|
d | integer |
Dzień w dacie rozmytej. |
|
|
miesiąca
|
m | integer |
Miesiąc w dacie rozmytej. |
|
|
rok
|
y | integer |
Rok w dacie rozmytej. |
|
|
Czy jest anonimowy?
|
is_anonymous | boolean |
Czy prezent jest anonimowy? Jeśli nie zostanie podana żadna wartość, zostanie użyta domyślna anonimowość dawcy. |
|
|
Podtyp
|
subtype | string |
Podtyp daru. |
|
|
Comment
|
reference | string |
Uwagi do śledzenia specjalnych szczegółów dotyczących prezentu, takich jak motywacja za nim lub szczegółowy opis prezentu. |
|
|
Identyfikator odnośnika
|
lookup_id | string |
Identyfikator zdefiniowany przez użytkownika dla prezentu. |
|
|
Czy używać środków pozyskiwania funduszy?
|
default_fundraiser_credits | boolean |
Czy użyć domyślnych środków pozyskiwania funduszy? |
|
|
Czy używać środków nietrwałych?
|
default_soft_credits | boolean |
Czy używać domyślnych środków nietrwałych? |
|
|
Okręg wyborczy
|
constituency | string |
Okręg wyborczy daru. |
|
|
Stan wpisu
|
post_status | string |
Status post prezentu. |
|
|
Data pośmiertna
|
post_date | date |
Data opublikowania prezentu (np. "2020-09-18"). |
|
|
Stan potwierdzenia
|
status | True | string |
Status odbioru prezentu. |
|
Kwota paragonu
|
value | True | double |
Kwota pieniężna otrzymania prezentu. |
|
Data przyjęcia
|
date | date |
Data otrzymania prezentu (np. "2020-09-18"). |
Zwraca
Zawiera kolekcję rekordów błędów prezentów wsadowych i prezentów wsadowych dodanych przez operację
- Results
- GiftApi.BatchGiftAddResults
Dodawanie rekordów do listy
Dodaj zestaw rekordów do istniejącej listy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Typ listy
|
list_type | True | string |
Typ listy. |
|
List
|
list_id | True | string |
Identyfikator rekordu systemu listy. |
|
Identyfikatory
|
ids | True | array of string |
Unikatowe identyfikatory rekordów do dodania do listy (maksymalnie 100 000 wartości). |
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 edukacji składowych
Wyświetla listę rekordów edukacyjnych dla składnika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemu składnika. |
Zwraca
Wykształcenie
Lista klasyfikacji składników
Zwraca listę klasyfikacji dla składnika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemu składnika |
|
Uwzględnij nieaktywne?
|
include_inactive | boolean |
Uwzględnij nieaktywne oceny? |
|
|
Tylko najnowsze?
|
most_recent_only | boolean |
Uwzględnij tylko najnowsze oceny? |
Zwraca
Oceny
Lista kodów pozyskiwania składników
Wyświetla listę kodów żądań dla składnika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemu składnika. |
Zwraca
Kody żądań
Lista notatek składowych
Wyświetla listę notatek dla składnika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemu składnika. |
Zwraca
Notatki
Lista odwołań
Zwraca listę odwołań.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Ograniczenie
|
limit | integer |
Reprezentuje liczbę rekordów do zwrócenia. Wartość domyślna to 500. Wartość maksymalna to 5000. |
|
|
Przesunięcie
|
offset | integer |
Reprezentuje liczbę rekordów do pominięcia. Do użycia z podziałem na strony. |
|
|
Uwzględnij nieaktywne?
|
include_inactive | boolean |
Uwzględnij nieaktywne odwołania? |
|
|
Dodano polecenie lub po
|
date_added | date-time |
Przefiltruj wyniki w celu odwołania 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 w celu odwołania zmodyfikowanego w dniu lub po określonej dacie (np. "2020-09-18T04:13:56Z"). |
Zwraca
Odwołania
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
Lista partii prezentów
Wyświetl listę partii prezentów.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Numer partii
|
batch_number | string |
Reprezentuje filtr wyników pasujących do określonej liczby. |
|
|
Zatwierdzony?
|
approved | boolean |
Reprezentuje filtr stanu partii prezentów. |
|
|
Czy wyjątki?
|
has_exceptions | boolean |
Reprezentuje filtr, czy partia prezentów zawiera wyjątki. |
|
|
Ograniczenie
|
limit | integer |
Reprezentuje liczbę rekordów do zwrócenia. Wartość domyślna to 500. Wartość maksymalna to 5000. |
|
|
Przesunięcie
|
offset | integer |
Reprezentuje liczbę rekordów do pominięcia. Do użycia z podziałem na strony. |
|
|
Tekst wyszukiwania
|
search_text | string |
Reprezentuje filtr tekstu zawartego w polach opisu wsadowego lub numeru partii. |
|
|
Utworzone przez
|
created_by | string |
Reprezentuje filtr dla partii prezentów utworzonych przez określonego użytkownika. |
Zwraca
Partie prezentów
Lista prezentów
Zwraca listę prezentów.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
List
|
list_id | string |
Definiuje identyfikator listy używany do filtrowania zestawu prezentów na te uwzględnione na określonej liście. Jeśli ta wartość zostanie ustawiona, inne określone filtry zostaną zignorowane. |
|
|
Typ
|
gift_type | string |
Reprezentuje rozdzielaną przecinkami listę typów prezentów do filtrowania wyników. Na przykład wyrażenie "MatchingGiftPledge,RecurringGift" zwraca tylko prezenty typu MatchingGiftPledge lub RecurringGift. |
|
|
Identyfikator składowy
|
constituent_id | string |
Reprezentuje rozdzielaną przecinkami listę identyfikatorów składowych w celu filtrowania wyników. Na przykład "280,1232" zwraca tylko prezenty od wyborców 280 lub składowych 1232. |
|
|
Identyfikator kampanii
|
campaign_id | string |
Reprezentuje rozdzielaną przecinkami listę identyfikatorów kampanii w celu filtrowania wyników. Na przykład "506 918" zwraca tylko prezenty do kampanii 506 lub kampanii 918. |
|
|
Identyfikator funduszu
|
fund_id | string |
Reprezentuje rozdzielaną przecinkami listę identyfikatorów funduszu w celu filtrowania wyników. Na przykład "506 918" zwraca tylko prezenty do finansowania 506 lub funduszu 918. |
|
|
Identyfikator odwołania
|
appeal_id | string |
Reprezentuje rozdzielaną przecinkami listę identyfikatorów odwołania w celu filtrowania wyników. Na przykład "506,918" zwraca tylko prezenty odwołania 506 lub odwołania 918. |
|
|
Ograniczenie
|
limit | integer |
Reprezentuje liczbę rekordów do zwrócenia. Wartość domyślna to 500. Wartość maksymalna to 5000. |
|
|
Przesunięcie
|
offset | integer |
Reprezentuje liczbę rekordów do pominięcia. Do użycia z podziałem na strony. |
|
|
Data rozpoczęcia prezentu
|
start_gift_date | date-time |
Reprezentuje filtr prezentów z datą prezentu w dniu lub po określonej dacie (np. "2020-09-18T04:13:56Z"). |
|
|
Data prezentu końcowego
|
end_gift_date | date-time |
Reprezentuje filtr prezentów z datą prezentu lub przed określoną datą (np. "2020-09-18T04:13:56Z"). |
|
|
Kwota prezentu startowego
|
start_gift_amount | double |
Reprezentuje filtr prezentów o wartości większej lub równej określonej wartości. |
|
|
Kwota prezentu końcowego
|
end_gift_amount | double |
Reprezentuje filtr prezentów o wartości mniejszej lub równej określonej wartości. |
|
|
Stan wpisu
|
post_status | string |
Reprezentuje rozdzielaną przecinkami listę stanów postów prezentowych w celu filtrowania wyników. Na przykład "DoNotPost", "Wysłana" zwraca tylko prezenty oznaczone jako DoNotPost lub Wysłana. |
|
|
Stan potwierdzenia
|
receipt_status | string |
Reprezentuje rozdzielaną przecinkami listę stanów paragonów prezentowych w celu filtrowania wyników. Na przykład "DoNotReceipt,Receipted" zwraca tylko prezenty oznaczone jako DoNotReceipt lub Receipted. |
|
|
Stan potwierdzenia
|
acknowledgement_status | string |
Reprezentuje rozdzielaną przecinkami listę stanów potwierdzenia prezentu w celu filtrowania wyników. Na przykład "DoNotAcknowledge", Potwierdzenie" zwraca tylko prezenty oznaczone jako DoNotAcknowledge lub Potwierdzone. |
|
|
Dodano polecenie lub po
|
date_added | date-time |
Przefiltruj wyniki do prezentó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 prezentów zmodyfikowanych w określonym dniu lub po określonej dacie (np. "2020-09-18T04:13:56Z"). |
Zwraca
Prezenty
Lista składników
Zwraca listę składników.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
List
|
list_id | string |
Definiuje identyfikator listy używany do filtrowania zestawu składników do tych uwzględnionych na określonej liście. Jeśli ta wartość zostanie ustawiona, inne określone filtry zostaną zignorowane. |
|
|
Ograniczenie
|
limit | integer |
Reprezentuje liczbę rekordów do zwrócenia. Wartość domyślna to 500. Wartość maksymalna to 5000. |
|
|
Przesunięcie
|
offset | integer |
Reprezentuje liczbę rekordów do pominięcia. Do użycia z podziałem na strony. |
|
|
Kod składowy
|
constituent_code | string |
Reprezentuje kod składowy do filtrowania listy. Na przykład wyrażenie "Członek zarządu" zwraca tylko składniki z kodem składowym członka zarządu. |
|
|
Identyfikator składowy
|
constituent_id | string |
Reprezentuje rozdzielaną przecinkami listę identyfikatorów składowych w celu filtrowania wyników. Na przykład wyrażenie "280,1232" zwraca tylko składnik 280 lub składnik 1232. |
|
|
Kategoria pola niestandardowego
|
custom_field_category | string |
Reprezentuje kategorię pól niestandardowych do filtrowania wyników. Na przykład wyrażenie "Rocznica" zwraca tylko składniki z aktywnym polem niestandardowym Rocznica. |
|
|
Status zbiórki pieniędzy
|
fundraiser_status | string |
Reprezentuje rozdzielaną przecinkami listę stanów zbiórki funduszy w celu filtrowania wyników. Na przykład wartość "Aktywna,Brak" zwraca tylko składniki, których stan zbiórki pieniędzy to Aktywny lub Brak. Prawidłowe wartości tego filtru to Aktywne, Nieaktywne i Brak. |
|
|
Uwzględnij zmarłego?
|
include_deceased | boolean |
Uwzględnij zmarłych składników w odpowiedzi? |
|
|
Uwzględnij nieaktywne?
|
include_inactive | boolean |
Uwzględnij nieaktywne składniki w odpowiedzi? |
|
|
Kod pocztowy
|
postal_code | string |
Reprezentuje rozdzielaną przecinkami listę kodów pocztowych do filtrowania wyników. Na przykład "29466,29492" zwraca tylko wyborców, których preferowany adres ma kod pocztowy rozpoczynający się od 29466 lub 29492, takich jak 29466, 29492 lub 29492-0727. |
|
|
Dodano polecenie lub po
|
date_added | date-time |
Przefiltruj wyniki do składnikó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 składników zmodyfikowanych w określonym dniu lub po określonej dacie (np. "2020-09-18T04:13:56Z"). |
|
|
Sortowane według
|
sort | string |
Reprezentuje listę pól do sortowania wyników według. Wyniki są domyślnie w kolejności rosnącej, a znak "-" oznacza kolejność malejącą. Na przykład "date_added,-last" sortuje składniki według pola "date_added" w kolejności rosnącej, a następnie według pola "last" w kolejności malejącej. |
Zwraca
Składników
Lista składowych zbiórki funduszy
Wyświetla listę przypisań fundraiser dla wyborców.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemu składnika. |
|
Uwzględnij nieaktywne?
|
include_inactive | boolean |
Uwzględnij nieaktywne przydziały fundraiser? |
Zwraca
Przydziały fundraiser
Lista telefonów składowych
Wyświetla listę telefonów dla składnika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemu składnika. |
|
Uwzględnij nieaktywne?
|
include_inactive | boolean |
Czy dołączyć nieaktywne telefony? |
Zwraca
Telefony
Lista załączników akcji
Wyświetla listę załączników dla akcji.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator akcji
|
action_id | True | string |
Identyfikator rekordu systemu akcji. |
Zwraca
Załączniki
Lista załączników prezentów
Wyświetla listę załączników dla prezentu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator prezentu
|
gift_id | True | string |
Identyfikator rekordu systemowego prezentu. |
Zwraca
Załączniki
Lista załączników składowych
Wyświetla listę załączników dla składnika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemu składnika. |
Zwraca
Załączniki
Listy załączników odwołania
Wyświetla listę załączników odwołania.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator odwołania
|
appeal_id | True | string |
Identyfikator rejestru systemowego odwołania. |
Zwraca
Załączniki
Otrzymasz prezent
Zwraca informacje o prezentie.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator prezentu
|
gift_id | True | string |
Identyfikator rekordu systemu prezentu, aby uzyskać. |
Zwraca
Prezent
- Body
- GiftApi.GiftRead
Pobieranie akcji składowej
Zwraca informacje o akcji składowej.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator akcji
|
action_id | True | string |
Identyfikator rekordu systemu akcji do pobrania. |
Zwraca
Akcja
Pobieranie obrazu profilu składowego
Zwraca bieżący obraz profilu dla składnika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemu składnika, dla którego ma zostać pobrany obraz profilu. |
Zwraca
Obraz profilu
Pobieranie pakietu
Zwraca informacje o pakiecie.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
package_id | True | string |
Identyfikator rekordu systemowego pakietu do pobrania. |
Zwraca
Package
Pobieranie składnika
Zwraca informacje o składniku.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemu składnika do pobrania. |
Zwraca
Składnik
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
Pobierz najnowszy prezent dla wyborców
Zwraca najnowszy prezent dla składnika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemu składnika. |
Zwraca
Podawanie podsumowania
Pola niestandardowe akcji listy
Wyświetla listę pól niestandardowych dla akcji.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator akcji
|
action_id | True | string |
Identyfikator rekordu systemu akcji. |
Zwraca
Pola niestandardowe
Tworzenie adresu składowego
Tworzy nowy adres składowy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemu składnika skojarzonego z adresem. |
|
Typ adresu
|
type | True | string |
Typ adresu. |
|
Country
|
country | string |
Kraj adresu (może to być identyfikator, nazwa lub skrót). |
|
|
Wiersze adresów
|
address_lines | string |
Wiersze adresu. |
|
|
Miejscowość
|
city | string |
Miasto adresu (nie należy używać w połączeniu z polem Suburb). |
|
|
State
|
state | string |
Stan adresu. |
|
|
Kod pocztowy
|
postal_code | string |
Kod pocztowy adresu. |
|
|
Przedmieście
|
suburb | string |
Przedmieścia adresu (nie należy używać w połączeniu z polem Miasto). |
|
|
Powiat
|
county | string |
Hrabstwo adresu. |
|
|
Źródło informacji
|
information_source | string |
Źródło informacji dla adresu. |
|
|
Region
|
region | string |
Region adresu. |
|
|
WÓZEK
|
cart | string |
Trasa przewoźnika (CART) dla adresu. |
|
|
WIELE
|
lot | string |
Linia podróży (LOT) dla adresu. |
|
|
DPC
|
dpc | string |
Kod punktu dostawy (DPC) dla adresu. |
|
|
Prawidłowy od
|
start | date |
Data rozpoczęcia pobytu składnika pod tym adresem (np. "2005-09-18"). |
|
|
Prawidłowa wartość
|
end | date |
Data, w którym składnik przestał znajdować się pod tym adresem (np. "2005-09-18"). |
|
|
Podstawowy?
|
preferred | boolean |
Czy jest to preferowany adres składnika? |
|
|
Nie wyślij wiadomości e-mail?
|
do_not_mail | boolean |
Czy wyborca może się skontaktować pod tym adresem? |
|
|
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. |
Zwraca
Utworzony adres składowy
Tworzenie akcji składowej
Tworzy nową akcję składową.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemu składnika skojarzonego z akcją. |
|
Kategoria
|
category | True | string |
Kanał lub intencja interakcji składowej. |
|
Zakończone?
|
completed | boolean |
Czy akcja została ukończona? Jeśli system jest skonfigurowany do używania niestandardowych stanów akcji, ta wartość jest oparta na wartości stanu akcji. |
|
|
Ukończono
|
completed_date | date-time |
Data zakończenia akcji (np. "2020-09-18T04:13:56Z"). |
|
|
Date
|
date | True | date-time |
Data akcji (np. "2020-09-18T04:13:56Z"). |
|
Uwaga / Notatka
|
description | string |
Szczegółowe wyjaśnienie, które zawiera podsumowanie akcji. |
|
|
Direction
|
direction | string |
Kierunek akcji. |
|
|
Fundraiser(s)
|
fundraisers | array of string |
Zestaw identyfikatorów rekordów systemowych dla fundraisers skojarzonych z akcją. |
|
|
Lokalizacja
|
location | string |
Lokalizacja akcji. |
|
|
Identyfikator szansy sprzedaży
|
opportunity_id | string |
Identyfikator rekordu systemu szansy sprzedaży skojarzonej z akcją. |
|
|
Outcome
|
outcome | string |
Wynik akcji. |
|
|
Priority
|
priority | string |
Priorytet akcji. |
|
|
Godzina rozpoczęcia
|
start_time | string |
Godzina rozpoczęcia akcji. Używa 24-godzinnego czasu w formacie HH:mm. |
|
|
Godzina zakończenia
|
end_time | string |
Godzina zakończenia akcji. Używa 24-godzinnego czasu w formacie HH:mm. |
|
|
Status
|
status | string |
Stan akcji. |
|
|
Podsumowanie
|
summary | string |
Krótki opis akcji, która jest wyświetlana w górnej części rekordu. Limit znaków: 255. |
|
|
Typ
|
type | string |
Dodatkowy opis akcji w celu uzupełnienia kategorii. |
Zwraca
Utworzona akcja
Tworzenie aliasu składowego
Tworzy nowy alias składowy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemu składnika skojarzonego z aliasem. |
|
Pseudonim
|
name | True | string |
Nazwa, która ma być używana jako alias składnika. Limit znaków: 100. |
|
Typ
|
type | string |
Typ aliasu. |
Zwraca
Utworzony alias składowy
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 edukacji składowej
Tworzy nową edukację składową.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemu składnika skojarzonego z wykształceniem. |
|
Szkoła
|
school | True | string |
Nazwa szkoły/placówki. |
|
Typ
|
type | string |
Typ edukacji. |
|
|
Klasa klasy
|
class_of | string |
Rok, w ramach których składnik ukończył. |
|
|
Status
|
status | string |
Status edukacji. |
|
|
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. |
|
|
day
|
d | integer |
Dzień w dacie rozmytej. |
|
|
miesiąca
|
m | integer |
Miesiąc w dacie rozmytej. |
|
|
rok
|
y | integer |
Rok w dacie rozmytej. |
|
|
Stopień
|
degree | string |
Stopień otrzymany. |
|
|
GpA
|
gpa | double |
Średnia punktu oceny. |
|
|
Temat badania
|
subject_of_study | string |
Temat badania. |
|
|
Podstawowy?
|
primary | boolean |
Czy jest to stowarzyszenie szkoły podstawowej składowej? |
|
|
Majors
|
majors | array of string |
Główne kursy studiów. |
|
|
Nieletnich
|
minors | array of string |
Drobne kursy studiów. |
|
|
Campus
|
campus | string |
Kampus. Limit znaków: 50. |
|
|
Organizacja społeczna
|
social_organization | string |
Organizacja społeczna. Limit znaków: 50. |
|
|
Znana nazwa
|
known_name | string |
Znana nazwa. Limit znaków: 50. |
|
|
Klasa stopnia
|
class_of_degree | string |
Klasa stopnia (dotyczy tylko wersji brytyjskich). |
|
|
Dział
|
department | string |
Nazwa departamentu edukacji (dotyczy tylko wersji brytyjskich). |
|
|
Wydział
|
faculty | string |
Nazwa wydziału (dotyczy tylko wersji brytyjskich). |
|
|
Numer rejestracji
|
registration_number | string |
Numer rejestracji (dotyczy tylko wersji brytyjskich). Limit znaków: 50. |
Zwraca
Utworzono edukację składową
Tworzenie klasyfikacji składowej
Tworzy nową ocenę składową.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
Obiekt reprezentujący ocenę do utworzenia. |
Zwraca
Utworzono klasyfikację składową
Tworzenie kodu na żądanie składników
Tworzy nowy kod pozyskiwania składników.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemu składnika skojarzonego z kodem żądania. |
|
Kod na żądanie
|
solicit_code | True | string |
Instrukcje dotyczące komunikacji i/lub ograniczenia dotyczące składników. |
|
Data rozpoczęcia
|
start_date | date |
Data rozpoczęcia kodu na żądanie (np. "2005-09-18"). |
|
|
Data zakończenia
|
end_date | date |
Data zakończenia kodu na żądanie (np. "2005-09-18"). |
Zwraca
Utworzono kod pozyskiwania składników
Tworzenie kodu składowego
Tworzy nowy kod składowy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemu składnika skojarzonego z kodem składowym. |
|
Kod składowy
|
description | True | string |
Kod składowy. |
|
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. |
|
|
Kolejność
|
sequence | integer |
Sekwencja liczbowa skojarzona z kodem składowym. |
Zwraca
Utworzony kod składowy
Tworzenie listy na podstawie zestawu rekordów
Tworzy nową listę przefiltrowaną do określonego zestawu rekordów.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Name
|
name | True | string |
Nazwa listy. Limit znaków: 50. |
|
Description
|
description | True | string |
Opis listy. |
|
Typ listy
|
list_type | True | string |
Określa typ listy do utworzenia. |
|
Permissions
|
list_permissions | True | string |
Określa, czy inni użytkownicy mogą uzyskiwać dostęp do listy. |
|
Identyfikatory
|
ids | True | array of string |
Unikatowe identyfikatory rekordów zawartych na liście (maksymalnie 100 000 wartości). |
Zwraca
Utworzona lista
- Body
- ListApi.CreatedList
Tworzenie lokalizacji dokumentu
Tworzy nowy unikatowy identyfikator dokumentu i lokalizację przekazywania do użycia z załącznikami fizycznymi. Odpowiedź będzie zawierać instrukcje dotyczące miejsca i sposobu przekazywania zawartości dokumentu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa pliku
|
file_name | string |
Nazwa pliku dokumentu, który ma zostać przekazany. |
|
|
Dołącz miniaturę?
|
upload_thumbnail | boolean |
Czy dołączyć lokalizację dokumentu miniatury? |
Zwraca
Definicja pliku
Tworzenie notatki składowej
Tworzy nową notatkę składową.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemu składnika skojarzonego z notatką. |
|
Typ
|
type | True | string |
Typ notatki. |
|
day
|
d | integer |
Dzień w dacie rozmytej. |
|
|
miesiąca
|
m | integer |
Miesiąc w dacie rozmytej. |
|
|
rok
|
y | integer |
Rok w dacie rozmytej. |
|
|
Podsumowanie
|
summary | string |
Podsumowanie notatki. Limit znaków: 50. |
|
|
Uwaga / Notatka
|
text | string |
Tekst notatki. |
Zwraca
Utworzono notatkę składową
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 partii prezentów
Tworzy nową partię prezentów.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Description
|
batch_description | string |
Opis partii. |
|
|
Oczekiwana liczba
|
expected_number | integer |
Liczba prezentów oczekiwana w partii. |
|
|
Oczekiwana suma
|
expected_batch_total | double |
Łączna wartość prezentów w partii. |
|
|
Numer partii
|
batch_number | string |
Unikatowy identyfikator specyficzny dla partii. |
Zwraca
Utworzono partię prezentów
Tworzenie pojedynczego składnika
Tworzy nowy składnik indywidualny.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Title
|
title | string |
Podstawowy tytuł składnika. |
|
|
Imię
|
first | string |
Imię składnika. Limit znaków: 50. |
|
|
Nazwisko
|
last | True | string |
Nazwisko składnika. Limit znaków: 100. |
|
Sufiks
|
suffix | string |
Sufiks podstawowy składnika. |
|
|
Identyfikator odnośnika
|
lookup_id | string |
Identyfikator zdefiniowany przez użytkownika dla składnika. |
|
|
typ
|
type | True | string |
Typ adresu. |
|
country
|
country | string |
Kraj adresu (może to być identyfikator, nazwa lub skrót). |
|
|
Linie
|
address_lines | string |
Wiersze adresu. Limit znaków: 150. |
|
|
city
|
city | string |
Miasto adresu (nie należy używać w połączeniu z polem Suburb). |
|
|
stan
|
state | string |
Stan adresu. |
|
|
kod pocztowy
|
postal_code | string |
Kod pocztowy adresu. Limit znaków: 12. |
|
|
przedmieście
|
suburb | string |
Przedmieścia adresu (nie należy używać w połączeniu z polem Miasto). |
|
|
hrabstwo
|
county | string |
Hrabstwo adresu. |
|
|
start
|
start | date |
Data rozpoczęcia pobytu składnika pod tym adresem (np. "2005-09-18"). |
|
|
koniec
|
end | date |
Data, w którym składnik przestał znajdować się pod tym adresem (np. "2005-09-18"). |
|
|
typ
|
type | True | string |
Typ telefonu. |
|
Liczba
|
number | True | string |
Numer telefonu. |
|
czy jest podstawowy?
|
primary | boolean |
Czy jest to podstawowy numer telefonu składnika? |
|
|
typ
|
type | True | string |
Typ adresu e-mail. |
|
address
|
address | True | string |
Adres e-mail. |
|
czy jest podstawowy?
|
primary | boolean |
Czy jest to podstawowy adres e-mail składnika? |
|
|
typ
|
type | True | string |
Typ obecności online. |
|
address
|
address | True | string |
Adres internetowy dla obecności online. |
|
czy jest podstawowy?
|
primary | boolean |
Czy jest to podstawowa obecność online składnika? |
|
|
Preferowana nazwa
|
preferred_name | string |
Preferowana nazwa składnika. Limit znaków: 50. |
|
|
Drugie imię
|
middle | string |
Środkowe imię wyborcy. Limit znaków: 50. |
|
|
Była nazwa
|
former_name | string |
Była nazwa składnika. Limit znaków: 100. |
|
|
Tytuł 2
|
title_2 | string |
Pomocniczy tytuł składnika. |
|
|
Sufiks 2
|
suffix_2 | string |
Sufiks pomocniczy składnika. |
|
|
Gender
|
gender | string |
Płeć składnika. |
|
|
Stan cywilny
|
marital_status | string |
Stan cywilny wyborcy. |
|
|
Daje anonimowo?
|
gives_anonymously | boolean |
Czy składnik daje anonimowo? |
|
|
day
|
d | integer |
Dzień w dacie rozmytej. |
|
|
miesiąca
|
m | integer |
Miesiąc w dacie rozmytej. |
|
|
rok
|
y | integer |
Rok w dacie rozmytej. |
|
|
Miejsce narodzin
|
birthplace | string |
Miejsce urodzenia składnika. |
|
|
Pochodzenie etniczne
|
ethnicity | string |
Pochodzenie etniczne wyborców. |
|
|
Dochód
|
income | string |
Dochód dla wyborców. |
|
|
Religia
|
religion | string |
Religia wyborców. |
|
|
Adres niestandardowy?
|
custom_format | boolean |
Czy adres podstawowy jest formatem niestandardowym? |
|
|
Format adresu
|
configuration_id | string |
Konfiguracja adresu podstawowego (wymagana, chyba że jest używany format niestandardowy). |
|
|
Nazwa niestandardowa adresu
|
formatted_name | string |
Nazwa sformatowana adresu podstawowego (wymagana w przypadku użycia formatu niestandardowego). Limit znaków: 255. |
|
|
Pozdrawiam niestandardowym?
|
custom_format | boolean |
Czy podstawowy salutacja jest formatem niestandardowym? |
|
|
Format salutacji
|
configuration_id | string |
Podstawowa konfiguracja salutacji (wymagana, chyba że jest używany format niestandardowy). |
|
|
Nazwa niestandardowa salutacji
|
formatted_name | string |
Podstawowa nazwa sformatowana salutacji (wymagana w przypadku użycia formatu niestandardowego). Limit znaków: 255. |
Zwraca
Utworzono pojedynczy składnik
Tworzenie pojedynczej relacji
Tworzy nową relację indywidualną. Jeśli relacja jest z innym składnikiem, zostanie utworzona relacja wzajemne dla tego składnika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemu składnika skojarzonego z relacją. |
|
Identyfikator relacji
|
relation_id | True | string |
Identyfikator rekordu systemu powiązanej osoby. |
|
Typ
|
type | string |
Typ relacji reprezentowanej przez relację. |
|
|
Typ wzajemny
|
reciprocal_type | string |
Opisuje relację składnika z powiązanym składnikiem. Na przykład w związku między męskim składnikiem a rodzeństwem kobiet typ relacji wzajemnej będzie bratem. |
|
|
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. |
|
|
Czy współmałżonek?
|
is_spouse | boolean |
Czy powiązana osoba jest współmałżonka wyborcy? |
|
|
Czy wyborca jest szefem gospodarstwa domowego?
|
is_constituent_head_of_household | boolean |
Czy składnik jest głową gospodarstwa domowego? |
|
|
Czy współmałżonek gospodarstwa domowego?
|
is_spouse_head_of_household | boolean |
Czy współmałżonek jest głową gospodarstwa domowego? |
|
|
Notatki
|
comment | string |
Dodatkowe uwagi dotyczące relacji. |
Zwraca
Utworzono pojedynczą relację
Tworzenie pola niestandardowego akcji
Tworzy nowe pole niestandardowe akcji.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
Obiekt reprezentujący pole niestandardowe do utworzenia. |
Zwraca
Pole niestandardowe utworzonej akcji
Tworzenie pola niestandardowego funduszu
Tworzy nowe pole niestandardowe funduszu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
Obiekt reprezentujący pole niestandardowe do utworzenia. |
Zwraca
Utworzono pole niestandardowe funduszu
Tworzenie pola niestandardowego kampanii
Tworzy nowe pole niestandardowe kampanii.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
Obiekt reprezentujący pole niestandardowe do utworzenia. |
Zwraca
Utworzone pole niestandardowe kampanii
Tworzenie pola niestandardowego odwołania
Tworzy nowe pole niestandardowe odwołania.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
Obiekt reprezentujący pole niestandardowe do utworzenia. |
Zwraca
Utworzono pole niestandardowe odwołania
Tworzenie pola niestandardowego prezentu
Tworzy nowe pole niestandardowe prezentu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
Obiekt reprezentujący pole niestandardowe do utworzenia. |
Zwraca
Utworzone pole niestandardowe prezentu
Tworzenie pola niestandardowego składowego
Tworzy nowe pole niestandardowe składowe.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
Obiekt reprezentujący pole niestandardowe do utworzenia. |
Zwraca
Utworzono pole niestandardowe składowe
Tworzenie pola niestandardowego szansy sprzedaży
Tworzy nowe pole niestandardowe szans sprzedaży.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
Obiekt reprezentujący pole niestandardowe do utworzenia. |
Zwraca
Utworzono załącznik szans sprzedaży
Tworzenie prezentu
Tworzy nowy prezent.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemowego składnika skojarzonego z prezentem. |
|
Kwota
|
value | True | double |
Kwota pieniężna prezentu. |
|
Date
|
date | True | date |
Data prezentu (np. "2020-09-18"). |
|
Typ
|
type | True | string |
Typ prezentu. |
|
identyfikator kampanii
|
campaign_id | string |
Identyfikator rekordu systemowego kampanii skojarzonej z podziałem prezentu. |
|
|
identyfikator funduszu
|
fund_id | True | string |
Identyfikator rejestru systemu funduszu skojarzonego z podziałem prezentu. |
|
identyfikator odwołania
|
appeal_id | string |
Identyfikator rekordu systemowego odwołania skojarzonego z podziałem prezentu. |
|
|
identyfikator pakietu
|
package_id | string |
Identyfikator rekordu systemowego pakietu skojarzonego z podziałem prezentu. |
|
|
kwota
|
value | True | double |
Kwota pieniężna podziału prezentu. |
|
Forma płatności
|
payment_method | True | string |
Forma płatności. |
|
Numer kontrolny
|
check_number | string |
Numer kontrolny (dotyczy tylko wtedy, gdy forma płatności to "PersonalCheck"). |
|
|
day
|
d | integer |
Dzień w dacie rozmytej. |
|
|
miesiąca
|
m | integer |
Miesiąc w dacie rozmytej. |
|
|
rok
|
y | integer |
Rok w dacie rozmytej. |
|
|
Reference
|
reference | string |
Odwołanie do płatności (dotyczy tylko wtedy, gdy forma płatności to "Inne"). |
|
|
day
|
d | integer |
Dzień w dacie rozmytej. |
|
|
miesiąca
|
m | integer |
Miesiąc w dacie rozmytej. |
|
|
rok
|
y | integer |
Rok w dacie rozmytej. |
|
|
Czy jest anonimowy?
|
is_anonymous | boolean |
Czy prezent jest anonimowy? Jeśli nie zostanie podana żadna wartość, zostanie użyta domyślna anonimowość dawcy. |
|
|
Podtyp
|
subtype | string |
Podtyp daru. |
|
|
Comment
|
reference | string |
Uwagi do śledzenia specjalnych szczegółów dotyczących prezentu, takich jak motywacja za nim lub szczegółowy opis prezentu. |
|
|
Identyfikator odnośnika
|
lookup_id | string |
Identyfikator zdefiniowany przez użytkownika dla prezentu. |
|
|
Czy używać środków pozyskiwania funduszy?
|
default_fundraiser_credits | boolean |
Czy użyć domyślnych środków pozyskiwania funduszy? |
|
|
Czy używać środków nietrwałych?
|
default_soft_credits | boolean |
Czy używać domyślnych środków nietrwałych? |
|
|
Okręg wyborczy
|
constituency | string |
Okręg wyborczy daru. |
|
|
Prefiks usługi Batch
|
batch_prefix | string |
Prefiks do użycia dla prezentów wsadowych. Musi ona zawierać co najmniej jedną literę i jest wymagana, gdy wartość ma wartość "Numer partii". |
|
|
Numer partii
|
batch_number | string |
Numer partii. Limit znaków: 50 (w tym prefiks partii). |
|
|
Stan wpisu
|
post_status | string |
Status post prezentu. |
|
|
Data pośmiertna
|
post_date | date |
Data opublikowania prezentu (np. "2020-09-18"). |
|
|
Stan potwierdzenia
|
status | True | string |
Status odbioru prezentu. |
|
Kwota paragonu
|
value | True | double |
Kwota pieniężna otrzymania prezentu. |
|
Data przyjęcia
|
date | date |
Data otrzymania prezentu (np. "2020-09-18"). |
Zwraca
Utworzony prezent
- Body
- GiftApi.CreatedGift
Tworzenie przypisania zbiórki pieniędzy
Tworzy nowe przypisanie zbiórki pieniędzy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator zbiórki pieniędzy
|
fundraiser_id | True | string |
Identyfikator rekordu systemu zbiórki pieniędzy. |
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemu przypisanego składnika. |
|
Typ
|
type | string |
Typ zbiórki pieniędzy. |
|
|
Rozpoczynanie przypisywania
|
start | date-time |
Data rozpoczęcia przypisania. |
|
|
Końce przydziału
|
end | date-time |
Data zakończenia przydziału. |
|
|
Kwota
|
value | True | double |
Kwota celu dla zbiórki pieniędzy na prośbę od przypisanego wyborcy. |
|
Identyfikator kampanii
|
campaign_id | string |
Identyfikator rekordu systemu kampanii, do której zostaną zastosowane otrzymane prezenty. |
|
|
Identyfikator funduszu
|
fund_id | string |
System rejestruje identyfikator funduszu, do którego zostaną zastosowane otrzymane prezenty. |
|
|
Identyfikator odwołania
|
appeal_id | string |
Identyfikator rejestru systemowego odwołania, do którego zostaną zastosowane otrzymane prezenty. |
Zwraca
Utworzono przypisanie zbiórki pieniędzy
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 rekordu zgody składników
Tworzy nowy rekord zgody składników.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemu składnika skojarzonego z rekordem zgody. |
|
Channel
|
channel | True | string |
Kanał, do którego ma zastosowanie odpowiedź na zgodę. |
|
Kategoria
|
category | string |
Kategoria, do którego ma zastosowanie odpowiedź na zgodę. |
|
|
Źródło
|
source | string |
Źródło odpowiedzi zgody ze składnika. |
|
|
Odpowiedź
|
constituent_consent_response | True | string |
Sposób, w jaki składnik odpowiedział na zgodę dla określonego kanału/kategorii. |
|
Date
|
consent_date | True | date-time |
Data odebrania odpowiedzi na zgodę (np. "2020-09-18T04:13:56Z"). |
|
Instrukcja zgody
|
consent_statement | string |
Oświadczenie, na które odpowiedział składnik podczas udzielania zgody. |
|
|
Oświadczenie o ochronie prywatności
|
privacy_notice | string |
Powiadomienie o ochronie prywatności udostępniane składnikom. |
Zwraca
Utworzono zgodę składników
Tworzenie relacji organizacji
Tworzy nową relację organizacji. Jeśli relacja jest z innym składnikiem, zostanie utworzona relacja wzajemne dla tego składnika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemu składnika skojarzonego z relacją. |
|
Identyfikator relacji
|
relation_id | True | string |
Identyfikator rekordu systemu powiązanej organizacji. |
|
Typ
|
type | string |
Typ relacji reprezentowanej przez relację. |
|
|
Typ wzajemny
|
reciprocal_type | string |
Opisuje relację składnika z powiązaną organizacją. |
|
|
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. |
|
|
Czy kontakt?
|
is_organization_contact | boolean |
Czy składnik reprezentuje tę organizację jako kontakt? |
|
|
Typ kontaktu
|
organization_contact_type | string |
Udostępnia kontekst interakcji z powiązaną osobą, która reprezentuje organizację jako kontakt. |
|
|
Position
|
position | string |
Stanowisko osoby w organizacji. Limit znaków: 50. |
|
|
Czy podstawowa firma?
|
is_primary_business | boolean |
Czy jest to podstawowa działalność składnika? |
|
|
Notatki
|
comment | string |
Dodatkowe uwagi dotyczące relacji. |
Zwraca
Utworzono relację organizacji
Tworzenie składnika organizacji
Tworzy nowy składnik organizacji.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Name
|
name | True | string |
Nazwa organizacji. Limit znaków: 100. |
|
Identyfikator odnośnika
|
lookup_id | string |
Identyfikator zdefiniowany przez użytkownika dla składnika. |
|
|
typ
|
type | True | string |
Typ adresu. |
|
country
|
country | string |
Kraj adresu (może to być identyfikator, nazwa lub skrót). |
|
|
Linie
|
address_lines | string |
Wiersze adresu. Limit znaków: 150. |
|
|
city
|
city | string |
Miasto adresu (nie należy używać w połączeniu z polem Suburb). |
|
|
stan
|
state | string |
Stan adresu. |
|
|
kod pocztowy
|
postal_code | string |
Kod pocztowy adresu. Limit znaków: 12. |
|
|
przedmieście
|
suburb | string |
Przedmieścia adresu (nie należy używać w połączeniu z polem Miasto). |
|
|
hrabstwo
|
county | string |
Hrabstwo adresu. |
|
|
start
|
start | date |
Data rozpoczęcia pobytu składnika pod tym adresem (np. "2005-09-18"). |
|
|
koniec
|
end | date |
Data, w którym składnik przestał znajdować się pod tym adresem (np. "2005-09-18"). |
|
|
typ
|
type | True | string |
Typ telefonu. |
|
Liczba
|
number | True | string |
Numer telefonu. |
|
czy jest podstawowy?
|
primary | boolean |
Czy jest to podstawowy numer telefonu składnika? |
|
|
typ
|
type | True | string |
Typ adresu e-mail. |
|
address
|
address | True | string |
Adres e-mail. |
|
czy jest podstawowy?
|
primary | boolean |
Czy jest to podstawowy adres e-mail składnika? |
|
|
typ
|
type | True | string |
Typ obecności online. |
|
address
|
address | True | string |
Adres internetowy dla obecności online. |
|
czy jest podstawowy?
|
primary | boolean |
Czy jest to podstawowa obecność online składnika? |
|
|
Daje anonimowo?
|
gives_anonymously | boolean |
Czy składnik daje anonimowo? |
|
|
Przemysł
|
industry | string |
Przemysł składników. |
|
|
Liczba pracowników
|
num_employees | integer |
Liczba pracowników w organizacji. |
|
|
Pasuje do prezentów?
|
matches_gifts | boolean |
Czy organizacja jest zgodna z prezentami? |
|
|
Dopasowywanie współczynnika prezentów
|
matching_gift_factor | double |
Pasujący czynnik prezentu. |
|
|
Minimalne dopasowanie na prezent
|
value | double |
Minimalna kwota dopasowania na prezent dla składnika. |
|
|
Maksymalna liczba dopasowań na prezent
|
value | double |
Maksymalna kwota dopasowania na prezent dla składnika. |
|
|
Minimalne dopasowanie na okręg wyborczy
|
value | double |
Minimalna suma dopasowań dla składnika. |
|
|
Maksymalne dopasowanie na okręg wyborczy
|
value | double |
Maksymalna suma dopasowań dla składnika. |
|
|
Pasujące notatki prezentowe
|
matching_gift_notes | string |
Pasujące notatki prezentowe dla składnika. |
Zwraca
Utworzony składnik organizacji
Tworzenie składowego adresu e-mail
Tworzy nowy składnikowy adres e-mail.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemowego składnika skojarzonego z adresem e-mail. |
|
Typ wiadomości e-mail
|
type | True | string |
Typ adresu e-mail. |
|
Adres e-mail
|
address | True | string |
Adres e-mail. |
|
Podstawowy?
|
primary | boolean |
Czy jest to podstawowy adres e-mail składnika? |
|
|
Nie wysyłaj wiadomości e-mail?
|
do_not_email | boolean |
Czy można skontaktować się z składnikiem pod tym adresem e-mail? |
|
|
Nieaktywny?
|
inactive | boolean |
Czy ten adres e-mail jest nieaktywny? |
Zwraca
Utworzony adres e-mail składowy
Tworzenie składowej obecności online
Tworzy nową składową obecność online.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemu składnika skojarzonego z obecnością online. |
|
Typ
|
type | True | string |
Typ obecności online. |
|
Link
|
address | True | string |
Adres internetowy dla obecności online. |
|
Podstawowy?
|
primary | boolean |
Czy jest to podstawowa obecność online składnika? |
|
|
Nieaktywny?
|
inactive | boolean |
Czy ta obecność online jest nieaktywna? |
Zwraca
Utworzono składową obecność w trybie online
Tworzenie szansy sprzedaży
Tworzy nową szansę sprzedaży.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemu składnika skojarzonego z szansą sprzedaży. |
|
Przeznaczenie
|
purpose | True | string |
Zamierzone wykorzystanie wszelkich pieniędzy zebranych w wyniku szansy sprzedaży. |
|
Name
|
name | True | string |
Nazwa identyfikująca szansę sprzedaży w całym programie, na przykład na listach lub na rekordach składowych. Limit znaków: 255. |
|
Status
|
status | string |
Stan wskazujący, gdzie jest szansa sprzedaży w procesie pozyskiwania. |
|
|
Deadline
|
deadline | date-time |
Data celu okazji do uzyskania prezentu (np. "2020-09-18T04:13:56Z"). |
|
|
Data pytania
|
ask_date | date-time |
Data wykonania wezwania (np. "2020-09-18T04:13:56Z"). |
|
|
value
|
value | double |
Wartość pieniężna. |
|
|
Oczekiwana data
|
expected_date | date-time |
Data, kiedy oczekuje się, że perspektywa zostanie wyrażona w odpowiedzi na szansę sprzedaży (np. "2020-09-18T04:13:56Z"). |
|
|
value
|
value | double |
Wartość pieniężna. |
|
|
Data finansowania
|
funded_date | date-time |
Data, kiedy perspektywa udzieliła odpowiedzi na szansę sprzedaży (np. "2020-09-18T04:13:56Z"). |
|
|
value
|
value | double |
Wartość pieniężna. |
|
|
Identyfikator kampanii
|
campaign_id | string |
Identyfikator rekordu systemu kampanii skojarzonej z szansą sprzedaży. Kampania określa ogólne cele zbierania pieniędzy. |
|
|
Identyfikator funduszu
|
fund_id | string |
System rejestruje identyfikator funduszu skojarzonego z szansą sprzedaży. Fundusz wyznacza konkretny cel finansowy prezentu i identyfikuje konto finansowe dla tego prezentu. |
|
|
Identyfikator składowy
|
constituent_id | string |
Identyfikator rekordu systemu składnika skojarzonego z zbiórką pieniędzy. |
|
|
value
|
value | double |
Wartość pieniężna. |
|
|
Nieaktywny?
|
inactive | boolean |
Czy szansa jest nieaktywna? |
Zwraca
Utworzono szansę sprzedaży
Tworzenie telefonu składowego
Tworzy nowy telefon składowy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemowego składnika skojarzonego z telefonem. |
|
Typ
|
type | True | string |
Typ telefonu. |
|
Number
|
number | True | string |
Numer telefonu. |
|
Podstawowy?
|
primary | boolean |
Czy jest to podstawowy telefon wyborcy? |
|
|
Nie dzwonisz?
|
do_not_call | boolean |
Czy można skontaktować się z składnikiem pod tym numerem? |
|
|
Nieaktywny?
|
inactive | boolean |
Czy ten numer telefonu jest nieaktywny? |
Zwraca
Utworzony telefon składowy
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. |
Zwraca
Utworzony uczestnik
Tworzenie załącznika akcji
Tworzy nowy załącznik akcji.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator akcji
|
parent_id | True | string |
Identyfikator rekordu systemu akcji skojarzonej z załącznikiem. |
|
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. |
Zwraca
Utworzony załącznik akcji
Tworzenie załącznika funduszu
Tworzy nowy załącznik funduszu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator funduszu
|
parent_id | True | string |
Identyfikator rekordu systemu funduszu skojarzonego z załącznikiem. |
|
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. |
Zwraca
Utworzono załącznik funduszu
Tworzenie załącznika kampanii
Tworzy nowy załącznik kampanii.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator kampanii
|
parent_id | True | string |
Identyfikator rekordu systemu kampanii skojarzonej z załącznikiem. |
|
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. |
Zwraca
Utworzono załącznik kampanii
Tworzenie załącznika odwołania
Tworzy nowy załącznik odwołania.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator odwołania
|
parent_id | True | string |
Identyfikator rekordu systemu odwołania skojarzonego z załącznikiem. |
|
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. |
Zwraca
Utworzono załącznik odwołania
Tworzenie załącznika prezentu
Tworzy nowy załącznik prezentu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator prezentu
|
parent_id | True | string |
Identyfikator rekordu systemowego prezentu skojarzonego z załącznikiem. |
|
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. |
Zwraca
Utworzono załącznik prezentu
Tworzenie załącznika składowego
Tworzy nowy załącznik składowy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
parent_id | True | string |
Identyfikator rekordu systemowego składnika skojarzonego z załącznikiem. |
|
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. |
Zwraca
Utworzono załącznik składowy
Tworzenie załącznika szansy sprzedaży
Tworzy nowy załącznik szans sprzedaży.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator szansy sprzedaży
|
parent_id | True | string |
Identyfikator rekordu systemu szansy sprzedaży skojarzonej z załącznikiem. |
|
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. |
Zwraca
Utworzono załącznik szans sprzedaży
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
Usuwanie kodu składowego
Usuwa kod składowy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator kodu składowego
|
constituent_code_id | True | string |
Identyfikator rekordu systemu kodu składowego do usunięcia. |
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
Uzyskaj pierwszy prezent składników
Zwraca pierwszy prezent dla składnika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemu składnika. |
Zwraca
Podawanie podsumowania
Uzyskiwanie funduszu
Zwraca informacje o funduszu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator funduszu
|
fund_id | True | string |
Identyfikator rekordu systemu funduszu, aby uzyskać. |
Zwraca
Fundusz
Uzyskiwanie kampanii
Zwraca informacje o kampanii.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator kampanii
|
campaign_id | True | string |
Identyfikator rekordu systemu kampanii do pobrania. |
Zwraca
Campaign
Uzyskiwanie odwołania
Zwraca informacje o odwołaniu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator odwołania
|
appeal_id | True | string |
Identyfikator rekordu systemu odwołania, aby uzyskać. |
Zwraca
Appeal
Uzyskiwanie składowego okresu istnienia dającego
Zwraca okres istnienia dając podsumowanie dla składnika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemu składnika. |
Zwraca
Okres istnienia dający
Uzyskiwanie stanu potencjalnych składników
Zwraca bieżący stan perspektywy dla składnika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemu składnika, dla którego ma zostać pobrany stan perspektywy. |
Zwraca
Stan perspektywy
Uzyskiwanie szansy sprzedaży
Zwraca informacje o szansie sprzedaży. Uwaga: ten punkt końcowy zwraca właściwość statusu z opóźnieniem około 10 minut.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator szansy sprzedaży
|
opportunity_id | True | string |
Identyfikator rekordu systemu szansy uzyskania. |
Zwraca
Szansa
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
Uzyskuj prezent najwspanialszy
Zwraca największy prezent dla składnika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemu składnika. |
Zwraca
Podawanie podsumowania
Wyszukiwanie składnika
Wykonuje wyszukiwanie składowe na podstawie podanego tekstu wyszukiwania. Obsługuje imię, nazwisko, preferowaną nazwę, byłą nazwę, alias, adres e-mail, numer telefonu, adres lub identyfikator odnośnika. Kombinacje nazw, takie jak imię i nazwisko lub preferowane imię i nazwisko, są prawidłowe, ale w przeciwnym razie wyszukiwanie obsługuje tylko jeden parametr jednocześnie. Domyślnie wyszukiwania obejmują wyniki, które brzmią podobnie do kryteriów. Na przykład wyszukiwanie "Smith" obejmuje dopasowania dla "Smyth" i innych alternatywnych pisowni. To wyszukiwanie nie obsługuje symboli wieloznacznych, takich jak * lub ?. Wyniki wyszukiwania są ograniczone do 500 rekordów.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Tekst wyszukiwania
|
search_text | True | string |
Tekst wyszukiwania. Obsługuje imię, nazwisko, preferowaną nazwę, byłą nazwę, alias, adres e-mail, numer telefonu, adres lub identyfikator odnośnika. Kombinacje nazw, takie jak imię i nazwisko lub preferowane imię i nazwisko, są prawidłowe, ale w przeciwnym razie wyszukiwanie obsługuje tylko jeden parametr jednocześnie. Domyślnie wyszukiwania obejmują wyniki, które brzmią podobnie do kryteriów. Na przykład wyszukiwanie "Smith" obejmuje dopasowania dla "Smyth" i innych alternatywnych pisowni. To wyszukiwanie nie obsługuje symboli wieloznacznych, takich jak * lub ?. Wyniki wyszukiwania są ograniczone do 500 rekordów. |
|
Statusy zbiórki pieniędzy
|
fundraiser_status | string |
Reprezentuje rozdzielaną przecinkami listę stanów zbiórki funduszy w celu filtrowania wyników. Na przykład wartość "Aktywna,Brak" zwraca tylko składniki, których stan zbiórki pieniędzy to Aktywny lub Brak. Prawidłowe wartości tego filtru to Aktywne, Nieaktywne i Brak. |
|
|
Uwzględnij nieaktywne?
|
include_inactive | boolean |
Uwzględnij nieaktywne składniki w odpowiedzi? |
|
|
Pole wyszukiwania
|
search_field | string |
Reprezentuje pole do wyszukania. Obecnie obsługuje tylko lookup_id. Jeśli jest on dostarczany z search_text, składnik z lookup_id, który pasuje do search_text zostanie zwrócony. |
|
|
Czy używać ścisłego wyszukiwania?
|
strict_search | boolean |
Wykluczanie składników, których nazwy brzmią jak tekst wyszukiwania, ale są napisane inaczej? |
|
|
Ograniczenie
|
limit | integer |
Reprezentuje liczbę rekordów do zwrócenia. Wartość domyślna to 500. Wartość maksymalna to 5000. |
|
|
Przesunięcie
|
offset | integer |
Reprezentuje liczbę rekordów do pominięcia. Do użycia z podziałem na strony. |
Zwraca
Wyniki wyszukiwania
Wyświetlanie listy adresów e-mail składowych
Wyświetla listę adresów e-mail dla składnika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemu składnika. |
|
Uwzględnij nieaktywne?
|
include_inactive | boolean |
Uwzględnij nieaktywne adresy e-mail? |
Zwraca
Adresy e-mail
Wyświetlanie listy adresów składowych
Wyświetla listę adresów składników.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemu składnika. |
|
Uwzględnij nieaktywne?
|
include_inactive | boolean |
Uwzględnij nieaktywne adresy? |
Zwraca
Adresy
Wyświetlanie listy akcji składowych
Wyświetla listę akcji dla składnika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemu składnika. |
Zwraca
Czynności
Wyświetlanie listy aliasów składowych
Wyświetla aliasy składników.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemu składnika. |
Zwraca
Aliases
Wyświetlanie listy funduszy
Zwraca listę funduszy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Ograniczenie
|
limit | integer |
Reprezentuje liczbę rekordów do zwrócenia. Wartość domyślna to 500. Wartość maksymalna to 5000. |
|
|
Przesunięcie
|
offset | integer |
Reprezentuje liczbę rekordów do pominięcia. Do użycia z podziałem na strony. |
|
|
Uwzględnij nieaktywne?
|
include_inactive | boolean |
Uwzględnij nieaktywne fundusze? |
|
|
Dodano polecenie lub po
|
date_added | date-time |
Przefiltruj wyniki do funduszy 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, aby fundusze zmodyfikowane w dniu lub po określonej dacie (np. "2020-09-18T04:13:56Z"). |
Zwraca
Funduszy
Wyświetlanie listy kampanii
Zwraca listę kampanii.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Ograniczenie
|
limit | integer |
Reprezentuje liczbę rekordów do zwrócenia. Wartość domyślna to 500. Wartość maksymalna to 5000. |
|
|
Przesunięcie
|
offset | integer |
Reprezentuje liczbę rekordów do pominięcia. Do użycia z podziałem na strony. |
|
|
Uwzględnij nieaktywne?
|
include_inactive | boolean |
Uwzględnij nieaktywne kampanie? |
|
|
Dodano polecenie lub po
|
date_added | date-time |
Przefiltruj wyniki do kampanii 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 kampanii zmodyfikowanych w określonym dniu lub po określonej dacie (np. "2020-09-18T04:13:56Z"). |
Zwraca
Campaigns
Wyświetlanie listy kodów składowych
Wyświetla listę kodów składowych dla składnika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemu składnika. |
Zwraca
Kody składowe
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 pakietów
Zwraca listę pakietów.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator odwołania
|
appeal_id | string |
Reprezentuje rozdzielaną przecinkami listę identyfikatorów odwołania w celu filtrowania wyników. Na przykład "506 918" zwraca tylko pakiety odwołania 506 lub odwołania 918. |
|
|
Ograniczenie
|
limit | integer |
Reprezentuje liczbę rekordów do zwrócenia. Wartość domyślna to 500. Wartość maksymalna to 5000. |
|
|
Przesunięcie
|
offset | integer |
Reprezentuje liczbę rekordów do pominięcia. Do użycia z podziałem na strony. |
|
|
Uwzględnij nieaktywne?
|
include_inactive | boolean |
Uwzględnij nieaktywne pakiety? |
|
|
Dodano polecenie lub po
|
date_added | date-time |
Przefiltruj wyniki do pakietó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 pakietów zmodyfikowanych w określonym dniu lub po określonej dacie (np. "2020-09-18T04:13:56Z"). |
Zwraca
Packages
Wyświetlanie listy przypisań fundraiser
Wyświetl listę przypisań do zbiórki pieniędzy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator zbiórki pieniędzy
|
fundraiser_id | True | string |
Identyfikator rekordu systemu zbiórki pieniędzy, dla którego mają zostać zwrócone przydziały. |
|
Ograniczenie
|
limit | integer |
Reprezentuje liczbę rekordów do zwrócenia. Wartość domyślna to 500. Wartość maksymalna to 5000. |
|
|
Przesunięcie
|
offset | integer |
Reprezentuje liczbę rekordów do pominięcia. Do użycia z podziałem na strony. |
Zwraca
Assignments
Wyświetlanie listy pól niestandardowych funduszu
Wyświetla listę pól niestandardowych dla funduszu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator funduszu
|
fund_id | True | string |
Identyfikator rejestru systemu funduszu. |
Zwraca
Pola niestandardowe
Wyświetlanie listy pól niestandardowych kampanii
Wyświetla listę pól niestandardowych dla kampanii.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator kampanii
|
campaign_id | True | string |
Identyfikator rekordu systemu kampanii. |
Zwraca
Pola niestandardowe
Wyświetlanie listy pól niestandardowych odwołania
Wyświetla listę pól niestandardowych dla odwołania.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator odwołania
|
appeal_id | True | string |
Identyfikator rejestru systemowego odwołania. |
Zwraca
Pola niestandardowe
Wyświetlanie listy pól niestandardowych prezentów
Wyświetla listę pól niestandardowych dla prezentu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator prezentu
|
gift_id | True | string |
Identyfikator rekordu systemowego prezentu. |
Zwraca
Pola niestandardowe
Wyświetlanie listy pól niestandardowych składowych
Wyświetla listę pól niestandardowych dla składnika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemu składnika. |
Zwraca
Pola niestandardowe
Wyświetlanie listy pól niestandardowych szans sprzedaży
Wyświetla listę pól niestandardowych dla szansy sprzedaży.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator szansy sprzedaży
|
opportunity_id | True | string |
Identyfikator rekordu systemu szansy sprzedaży. |
Zwraca
Pola niestandardowe
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 rekordów zgody składników
Wyświetla listę rekordów zgody dla składnika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemu składnika. |
|
Tylko najnowsze?
|
most_recent_only | boolean |
Uwzględnij tylko najnowsze rekordy zgody dla każdej kombinacji kategorii kanału w odpowiedzi? |
Zwraca
Rekordy zgody
Wyświetlanie listy relacji składowych
Wyświetla listę relacji dla składnika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemu składnika. |
|
Ograniczenie
|
limit | integer |
Reprezentuje liczbę rekordów do zwrócenia. Wartość domyślna to 500. Nie ma maksymalnej wartości. |
|
|
Przesunięcie
|
offset | integer |
Reprezentuje liczbę rekordów do pominięcia. Do użycia z podziałem na strony. |
Zwraca
Relacje
Wyświetlanie listy składników obecności online
Wyświetla listę obecności online dla składnika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemu składnika. |
|
Uwzględnij nieaktywne?
|
include_inactive | boolean |
Uwzględnij nieaktywne obecności online? |
Zwraca
Obecność online
Wyświetlanie listy szans sprzedaży
Zwraca listę szans sprzedaży.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
List
|
list_id | string |
Definiuje identyfikator listy używany do filtrowania zestawu szans sprzedaży dla osób znajdujących się na określonej liście. Jeśli ta wartość zostanie ustawiona, inne określone filtry zostaną zignorowane. |
|
|
Identyfikator składowy
|
constituent_id | string |
Reprezentuje rozdzielaną przecinkami listę identyfikatorów składowych w celu filtrowania wyników. Na przykład wartość "280,1232" zwraca tylko możliwości ze składowych 280 lub składowych 1232. |
|
|
Ograniczenie
|
limit | integer |
Reprezentuje liczbę rekordów do zwrócenia. Wartość domyślna to 500. Wartość maksymalna to 5000. |
|
|
Przesunięcie
|
offset | integer |
Reprezentuje liczbę rekordów do pominięcia. Do użycia z podziałem na strony. |
|
|
Uwzględnij nieaktywne?
|
include_inactive | boolean |
Uwzględnij nieaktywne szanse sprzedaży? |
|
|
Dodano polecenie lub po
|
date_added | date-time |
Przefiltruj wyniki do szans sprzedaży 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 szans sprzedaży zmodyfikowanych w określonym dniu lub po określonej dacie (np. "2020-09-18T04:13:56Z"). |
Zwraca
Szanse sprzedaży
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
Participants
Wyświetlanie listy załączników funduszu
Zawiera listę załączników dla funduszu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator funduszu
|
fund_id | True | string |
Identyfikator rejestru systemu funduszu. |
Zwraca
Załączniki
Wyświetlanie listy załączników kampanii
Wyświetla listę załączników kampanii.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator kampanii
|
campaign_id | True | string |
Identyfikator rekordu systemu kampanii. |
Zwraca
Załączniki
Wyświetlanie listy załączników szans sprzedaży
Wyświetla listę załączników dla szansy sprzedaży.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator szansy sprzedaży
|
opportunity_id | True | string |
Identyfikator rekordu systemu szansy sprzedaży. |
Zwraca
Załączniki
Wyświetlanie listy zdarzeń
Zwraca listę zdarzeń.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Kategoria
|
category | string |
Filtruj na podstawie kategorii zdarzeń. |
|
|
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
CommPrefApi.ConstituentConsentRead
Reprezentuje jednostkę zgody dla składnika.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemowego rekordu zgody. |
|
Channel
|
channel | string |
Kanał, do którego ma zastosowanie odpowiedź na zgodę. |
|
Kategoria
|
category | string |
Kategoria, do którego ma zastosowanie odpowiedź na zgodę. |
|
Źródło
|
source | string |
Źródło odpowiedzi zgody ze składnika. |
|
Odpowiedź
|
constituent_consent_response | string |
Sposób, w jaki składnik odpowiedział na zgodę dla określonego kanału/kategorii. |
|
Date
|
consent_date | date-time |
Data odebrania odpowiedzi na zgodę. |
|
Instrukcja zgody
|
consent_statement | string |
Oświadczenie, na które odpowiedział składnik podczas udzielania zgody. |
|
Oświadczenie o ochronie prywatności
|
privacy_notice | string |
Powiadomienie o ochronie prywatności udostępniane składnikom. |
|
Data dodania
|
date_added | date-time |
Data dodania odpowiedzi na zgodę. |
|
Dodane przez
|
user_name | string |
Użytkownik, który dodał odpowiedź na zgodę. |
CommPrefApi.ConstituentConsentReadCollection
Rekordy zgody
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba
|
count | integer |
Liczba rekordów zgody na liście. |
|
value
|
value | array of CommPrefApi.ConstituentConsentRead |
Zestaw rekordów zgody uwzględnionych w odpowiedzi. |
CommPrefApi.ConstituentSolicitCodeRead
Kod na żądanie
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemu kodu żądania składników. |
|
Kod na żądanie
|
solicit_code | string |
Instrukcje dotyczące komunikacji i/lub ograniczenia dotyczące składników. |
|
Data rozpoczęcia
|
start_date | date |
Data rozpoczęcia kodu na żądanie (np. "2005-09-18"). |
|
Data zakończenia
|
end_date | date |
Data zakończenia kodu na żądanie (np. "2005-09-18"). |
CommPrefApi.ConstituentSolicitCodeReadCollection
Kody żądań
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba
|
count | integer |
Liczba kodów pozyskiwania składników na liście. |
|
value
|
value | array of CommPrefApi.ConstituentSolicitCodeRead |
Zestaw kodów pozyskiwania składników uwzględnionych w odpowiedzi. |
CommPrefApi.CreatedConstituentConsent
Utworzono zgodę składników
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonego rekordu zgody. |
CommPrefApi.CreatedConstituentSolicitCode
Utworzono kod pozyskiwania składników
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonego kodu na żądanie składników. |
SkładnikApi.ActionAttachmentRead
Attachment
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemu załącznika. |
|
Identyfikator akcji
|
parent_id | string |
Identyfikator rekordu systemu akcji skojarzonej 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. |
ConstituentApi.ActionCustomFieldRead
Pole niestandardowe
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemowego pola niestandardowego. |
|
Identyfikator akcji
|
parent_id | string |
Identyfikator rekordu systemu akcji skojarzonej z polem niestandardowym. |
|
Kategoria
|
category | string |
Kategoria pola niestandardowego. |
|
Typ
|
type | string |
Typ danych reprezentowanych przez pole niestandardowe. |
|
Wartość
|
value |
Wartość pola niestandardowego. |
|
|
Date
|
date | date |
Data w polu niestandardowym. |
|
Comment
|
comment | string |
Komentarz do pola niestandardowego. Limit znaków: 50. |
|
Data dodania
|
date_added | date-time |
Data utworzenia pola niestandardowego. |
|
Data modyfikacji
|
date_modified | date-time |
Data ostatniej modyfikacji pola niestandardowego. |
SkładnikApi.ActionRead
Akcja
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemu akcji. |
|
Identyfikator składowy
|
constituent_id | string |
Identyfikator rekordu systemu składnika skojarzonego z akcją. |
|
Kategoria
|
category | string |
Kanał lub intencja interakcji składowej. |
|
Zakończone?
|
completed | boolean |
Czy akcja została ukończona? Jeśli system jest skonfigurowany do używania niestandardowych stanów akcji, ta wartość jest oparta na wartości stanu akcji. |
|
Ukończono
|
completed_date | date-time |
Data zakończenia akcji. |
|
Date
|
date | date-time |
Data akcji. |
|
Uwaga / Notatka
|
description | string |
Szczegółowe wyjaśnienie, które zawiera podsumowanie akcji. |
|
Direction
|
direction | string |
Kierunek akcji. |
|
Fundraiser(s)
|
fundraisers | array of string |
Zestaw identyfikatorów rekordów systemowych dla fundraisers skojarzonych z akcją. |
|
Lokalizacja
|
location | string |
Lokalizacja akcji. |
|
Identyfikator szansy sprzedaży
|
opportunity_id | string |
Identyfikator rekordu systemu szansy sprzedaży skojarzonej z akcją. |
|
Outcome
|
outcome | string |
Wynik akcji. |
|
Priority
|
priority | string |
Priorytet akcji. |
|
Godzina rozpoczęcia
|
start_time | string |
Godzina rozpoczęcia akcji. Używa 24-godzinnego czasu w formacie HH:mm. |
|
Godzina zakończenia
|
end_time | string |
Godzina zakończenia akcji. Używa 24-godzinnego czasu w formacie HH:mm. |
|
Status
|
status | string |
Stan akcji. |
|
Kod stanu
|
status_code | string |
Kod stanu akcji. Ta właściwość jest zwracana tylko wtedy, gdy system jest skonfigurowany do używania niestandardowych stanów akcji. |
|
Stan obliczony
|
computed_status | string |
Stan obliczonej akcji. Jeśli system nie jest skonfigurowany do używania niestandardowych stanów akcji, to pole oblicza stan na podstawie właściwości ukończonych i daty. Jeśli nie, pole oblicza stan na podstawie właściwości date akcji i czy właściwość Stan akcji jest skonfigurowana jako ukończona. |
|
Podsumowanie
|
summary | string |
Krótki opis akcji, która jest wyświetlana w górnej części rekordu. Limit znaków: 255. |
|
Typ
|
type | string |
Dodatkowy opis akcji w celu uzupełnienia kategorii. |
|
Data dodania
|
date_added | date-time |
Data utworzenia akcji. |
|
Data modyfikacji
|
date_modified | date-time |
Data ostatniej modyfikacji akcji. |
SkładnikApi.AddressRead
Address
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemu adresu. |
|
Typ
|
type | string |
Typ adresu. |
|
Country
|
country | string |
Kraj adresu (może to być identyfikator, nazwa lub skrót). |
|
Wiersze adresów
|
address_lines | string |
Wiersze adresu. |
|
Miejscowość
|
city | string |
Miasto adresu (nie należy używać w połączeniu z polem Suburb). |
|
State
|
state | string |
Stan adresu. |
|
Kod pocztowy
|
postal_code | string |
Kod pocztowy adresu. |
|
Przedmieście
|
suburb | string |
Przedmieścia adresu (nie należy używać w połączeniu z polem Miasto). |
|
Powiat
|
county | string |
Hrabstwo adresu. |
|
Sformatowany adres
|
formatted_address | string |
Sformatowany adres w skonfigurowanym formacie kraju. |
|
Źródło informacji
|
information_source | string |
Źródło informacji dla adresu. |
|
Region
|
region | string |
Region adresu. |
|
WÓZEK
|
cart | string |
Trasa przewoźnika (CART) dla adresu. |
|
WIELE
|
lot | string |
Linia podróży (LOT) dla adresu. |
|
DPC
|
dpc | string |
Kod punktu dostawy (DPC) dla adresu. |
|
Prawidłowy od
|
start | date-time |
Data rozpoczęcia pobytu składnika pod tym adresem. |
|
Prawidłowa wartość
|
end | date-time |
Data, w którym składnik przestał znajdować się pod tym adresem. |
|
Podstawowy?
|
preferred | boolean |
Czy jest to preferowany adres składnika? |
|
Nieaktywny?
|
inactive | boolean |
Czy adres jest nieaktywny (co oznacza, że bieżąca data przypada przed datą zakończenia)? |
|
Nie wyślij wiadomości e-mail?
|
do_not_mail | boolean |
Czy wyborca może się skontaktować pod tym adresem? |
|
day
|
seasonal_start.d | integer |
Dzień w dacie rozmytej. |
|
miesiąca
|
seasonal_start.m | integer |
Miesiąc w dacie rozmytej. |
|
rok
|
seasonal_start.y | integer |
Rok w dacie rozmytej. |
|
day
|
seasonal_end.d | integer |
Dzień w dacie rozmytej. |
|
miesiąca
|
seasonal_end.m | integer |
Miesiąc w dacie rozmytej. |
|
rok
|
seasonal_end.y | integer |
Rok w dacie rozmytej. |
|
Data dodania
|
date_added | date-time |
Data utworzenia adresu. |
|
Data modyfikacji
|
date_modified | date-time |
Data ostatniej modyfikacji adresu. |
SkładnikApi.AliasRead
Pseudonim
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemu aliasu. |
|
Pseudonim
|
name | string |
Nazwa, która ma być używana jako alias składnika. |
|
Typ
|
type | string |
Typ aliasu. |
SkładnikApi.ApiCollectionOfAddressRead
Adresy
| 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 ConstituentApi.AddressRead |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
ConstituentApi.ApiCollectionOfActionAttachmentRead
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 ConstituentApi.ActionAttachmentRead |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
ConstituentApi.ApiCollectionOfActionCustomFieldRead
Pola niestandardowe
| 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 ConstituentApi.ActionCustomFieldRead |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
ConstituentApi.ApiCollectionOfActionRead
Czynności
| 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 ConstituentApi.ActionRead |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
ConstituentApi.ApiCollectionOfAliasRead
Aliases
| 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 ConstituentApi.AliasRead |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
ConstituentApi.ApiCollectionOfConstituentAttachmentRead
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 ConstituentApi.ConstituentAttachmentRead |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
SkładnikApi.ApiCollectionOfConstituentCodeRead
Kody składowe
| 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 ConstituentApi.ConstituentCodeRead |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
ConstituentApi.ApiCollectionOfConstituentCustomFieldRead
Pola niestandardowe
| 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 ConstituentApi.ConstituentCustomFieldRead |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
ConstituentApi.ApiCollectionOfConstituentRead
Składników
| 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 ConstituentApi.ConstituentRead |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
SkładnikApi.ApiCollectionOfEducationRead
Wykształcenie
| 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 ConstituentApi.EducationRead |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
ConstituentApi.ApiCollectionOfEmailAddressRead
Adresy e-mail
| 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 ConstituentApi.EmailAddressRead |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
ConstituentApi.ApiCollectionOfFundraiserAssignmentRead
Przydziały fundraiser
| 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 ConstituentApi.FundraiserAssignmentRead |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
SkładnikApi.ApiCollectionOfNoteRead
Notatki
| 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 ConstituentApi.NoteRead |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
ConstituentApi.ApiCollectionOfOnlinePresenceRead
Obecność online
| 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 ConstituentApi.OnlinePresenceRead |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
ConstituentApi.ApiCollectionOfPhoneRead
Telefony
| 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 ConstituentApi.PhoneRead |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
ConstituentApi.ApiCollectionOfRatingRead
Oceny
| 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 ConstituentApi.RatingRead |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
ConstituentApi.ApiCollectionOfRelationshipRead
Relacje
| 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 ConstituentApi.RelationshipRead |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
ConstituentApi.ApiCollectionOfSearchResultRead
Wyniki wyszukiwania
| 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 ConstituentApi.SearchResultRead |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
ConstituentApi.AppealRead
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rejestru systemowego odwołania. |
|
opis
|
description | string |
Opis odwołania. |
ConstituentApi.CampaignRead
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemu kampanii. |
|
opis
|
description | string |
Opis kampanii. |
SkładnikApi.ConstituentAttachmentRead
Attachment
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemu załącznika. |
|
Identyfikator składowy
|
parent_id | string |
Identyfikator rekordu systemowego składnika 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. |
ConstituentApi.ConstituentCodeRead
Kod składowy
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemu kodu składowego. |
|
Identyfikator składowy
|
constituent_id | string |
Identyfikator rekordu systemu składnika skojarzonego z kodem składowym. |
|
Kod składowy
|
description | string |
Kod składowy. |
|
day
|
start.d | integer |
Dzień w dacie rozmytej. |
|
miesiąca
|
start.m | integer |
Miesiąc w dacie rozmytej. |
|
rok
|
start.y | integer |
Rok w dacie rozmytej. |
|
day
|
end.d | integer |
Dzień w dacie rozmytej. |
|
miesiąca
|
end.m | integer |
Miesiąc w dacie rozmytej. |
|
rok
|
end.y | integer |
Rok w dacie rozmytej. |
|
Nieaktywny?
|
inactive | boolean |
Czy kod składowy jest nieaktywny? |
|
Kolejność
|
sequence | integer |
Sekwencja liczbowa skojarzona z kodem składowym. |
|
Data dodania
|
date_added | date-time |
Data utworzenia kodu składowego. |
|
Data modyfikacji
|
date_modified | date-time |
Data ostatniej modyfikacji kodu składowego. |
ConstituentApi.ConstituentCustomFieldRead
Pole niestandardowe
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemowego pola niestandardowego. |
|
Identyfikator składowy
|
parent_id | string |
Identyfikator rekordu systemu składnika skojarzonego z polem niestandardowym. |
|
Kategoria
|
category | string |
Kategoria pola niestandardowego. |
|
Typ
|
type | string |
Typ danych reprezentowanych przez pole niestandardowe. |
|
Wartość
|
value |
Wartość pola niestandardowego. |
|
|
Date
|
date | date |
Data w polu niestandardowym. |
|
Comment
|
comment | string |
Komentarz do pola niestandardowego. Limit znaków: 50. |
|
Data dodania
|
date_added | date-time |
Data utworzenia pola niestandardowego. |
|
Data modyfikacji
|
date_modified | date-time |
Data ostatniej modyfikacji pola niestandardowego. |
SkładnikApi.ConstituentRead
Składnik
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemu dla składnika. Nie jest to takie samo, jak identyfikator składowy, który można definiować przez użytkownika, który jest przechowywany w lookup_id. |
|
Typ
|
type | string |
Typ składnika. |
|
Title
|
title | string |
Podstawowy tytuł składnika (tylko dla osób). |
|
Imię
|
first | string |
Imię składnika (tylko dla osób). |
|
Nazwisko
|
last | string |
Nazwisko składnika (tylko dla osób). |
|
Name
|
name | string |
W przypadku użytkowników to pole jest pełną nazwą składnika na podstawie ustawień nazwy wyświetlanej organizacji docelowej. W przypadku organizacji jest to nazwa organizacji. |
|
Preferowana nazwa
|
preferred_name | string |
Preferowana nazwa składnika (tylko dla osób). |
|
Sufiks
|
suffix | string |
Sufiks podstawowy składnika (tylko dla osób). |
|
Identyfikator odnośnika
|
lookup_id | string |
Identyfikator zdefiniowany przez użytkownika dla składnika. |
|
identyfikator
|
email.id | string |
Identyfikator rekordu systemu adresu e-mail. |
|
typ
|
email.type | string |
Typ adresu e-mail. |
|
address
|
email.address | string |
Adres e-mail. |
|
nie wysyłaj wiadomości e-mail?
|
email.do_not_email | boolean |
Czy można skontaktować się z składnikiem pod tym adresem e-mail? |
|
nieaktywny?
|
email.inactive | boolean |
Czy ten adres e-mail jest nieaktywny? |
|
data dodania
|
email.date_added | date-time |
Data utworzenia adresu e-mail. |
|
data modyfikacji
|
email.date_modified | date-time |
Data ostatniej modyfikacji adresu e-mail. |
|
identyfikator
|
phone.id | string |
Identyfikator rekordu systemowego telefonu. |
|
typ
|
phone.type | string |
Typ telefonu. |
|
Liczba
|
phone.number | string |
Numer telefonu. |
|
nie dzwonić?
|
phone.do_not_call | boolean |
Czy można skontaktować się z składnikiem pod tym numerem? |
|
nieaktywny?
|
phone.inactive | boolean |
Czy ten numer telefonu jest nieaktywny? |
|
data dodania
|
phone.date_added | date-time |
Data utworzenia telefonu. |
|
data modyfikacji
|
phone.date_modified | date-time |
Data ostatniej modyfikacji telefonu. |
|
identyfikator
|
online_presence.id | string |
Identyfikator rekordu systemu obecności online. |
|
typ
|
online_presence.type | string |
Typ obecności online. |
|
łącze
|
online_presence.address | string |
Adres internetowy dla obecności online. |
|
nieaktywny?
|
online_presence.inactive | boolean |
Czy ta obecność online jest nieaktywna? |
|
data dodania
|
online_presence.date_added | date-time |
Data utworzenia obecności online. |
|
data modyfikacji
|
online_presence.date_modified | date-time |
Data ostatniej modyfikacji obecności online. |
|
identyfikator
|
address.id | string |
Identyfikator rekordu systemu adresu. |
|
typ
|
address.type | string |
Typ adresu. |
|
country
|
address.country | string |
Kraj adresu (może to być identyfikator, nazwa lub skrót). |
|
Linie
|
address.address_lines | string |
Wiersze adresu. |
|
city
|
address.city | string |
Miasto adresu (nie należy używać w połączeniu z polem Suburb). |
|
stan
|
address.state | string |
Stan adresu. |
|
kod pocztowy
|
address.postal_code | string |
Kod pocztowy adresu. |
|
przedmieście
|
address.suburb | string |
Przedmieścia adresu (nie należy używać w połączeniu z polem Miasto). |
|
hrabstwo
|
address.county | string |
Hrabstwo adresu. |
|
Sformatowany
|
address.formatted_address | string |
Sformatowany adres w skonfigurowanym formacie kraju. |
|
prawidłowy od
|
address.start | date-time |
Data rozpoczęcia pobytu składnika pod tym adresem. |
|
prawidłowy do
|
address.end | date-time |
Data, w którym składnik przestał znajdować się pod tym adresem. |
|
nieaktywny?
|
address.inactive | boolean |
Czy adres jest nieaktywny (co oznacza, że bieżąca data przypada przed datą zakończenia)? |
|
nie e-mail?
|
address.do_not_mail | boolean |
Czy wyborca może się skontaktować pod tym adresem? |
|
day
|
address.seasonal_start.d | integer |
Dzień w dacie rozmytej. |
|
miesiąca
|
address.seasonal_start.m | integer |
Miesiąc w dacie rozmytej. |
|
rok
|
address.seasonal_start.y | integer |
Rok w dacie rozmytej. |
|
day
|
address.seasonal_end.d | integer |
Dzień w dacie rozmytej. |
|
miesiąca
|
address.seasonal_end.m | integer |
Miesiąc w dacie rozmytej. |
|
rok
|
address.seasonal_end.y | integer |
Rok w dacie rozmytej. |
|
data dodania
|
address.date_added | date-time |
Data utworzenia adresu. |
|
data modyfikacji
|
address.date_modified | date-time |
Data ostatniej modyfikacji adresu. |
|
Gender
|
gender | string |
Płeć składnika (tylko dla osób). |
|
Drugie imię
|
middle | string |
Drugie imię składnika (tylko dla osób). |
|
Była nazwa
|
former_name | string |
Była nazwa składnika (tylko dla osób). |
|
Tytuł 2
|
title_2 | string |
Tytuł pomocniczy składnika (tylko dla osób fizycznych). |
|
Sufiks 2
|
suffix_2 | string |
Sufiks pomocniczy składnika (tylko dla osób). |
|
Staus małżeński
|
marital_status | string |
Stan cywilny składnika (tylko dla osób fizycznych). |
|
Daje anonimowo?
|
gives_anonymously | boolean |
Czy składnik daje anonimowo? |
|
Nieaktywny?
|
inactive | boolean |
Czy składnik jest nieaktywny? |
|
day
|
birthdate.d | integer |
Dzień w dacie rozmytej. |
|
miesiąca
|
birthdate.m | integer |
Miesiąc w dacie rozmytej. |
|
rok
|
birthdate.y | integer |
Rok w dacie rozmytej. |
|
Miejsce narodzin
|
birthplace | string |
Miejsce urodzenia składnika (tylko dla osób). |
|
Pochodzenie etniczne
|
ethnicity | string |
Pochodzenie etniczne wyborców (tylko dla osób). |
|
Dochód
|
income | string |
Dochód dla składnika (tylko dla osób fizycznych). |
|
Religia
|
religion | string |
Religia wyborców (tylko dla osób). |
|
Przemysł
|
industry | string |
Przemysł składników (tylko dla organizacji). |
|
Liczba pracowników
|
num_employees | integer |
Liczba pracowników w organizacji. |
|
Pasuje do prezentów?
|
matches_gifts | boolean |
Czy organizacja jest zgodna z prezentami? |
|
Dopasowywanie współczynnika prezentów
|
matching_gift_factor | double |
Pasujący współczynnik prezentów (tylko dla organizacji). |
|
Minimalne dopasowanie na prezent
|
matching_gift_per_gift_min.value | double |
Minimalna kwota dopasowania na prezent dla składnika (tylko dla organizacji). |
|
Maksymalna liczba dopasowań na prezent
|
matching_gift_per_gift_max.value | double |
Maksymalna kwota dopasowań na prezent dla składnika (tylko dla organizacji). |
|
Minimalne dopasowanie na okręg wyborczy
|
matching_gift_total_min.value | double |
Minimalna suma dopasowań dla składnika (tylko dla organizacji). |
|
Maksymalne dopasowanie na okręg wyborczy
|
matching_gift_total_max.value | double |
Maksymalna suma dopasowań dla składnika (tylko dla organizacji). |
|
Pasujące notatki prezentowe
|
matching_gift_notes | string |
Pasujące notatki prezentowe dla składnika (tylko dla organizacji). |
|
Wiek
|
age | integer |
Wiek składnika, obliczony na podstawie właściwości urodzenia (tylko dla osób). |
|
Zmarły?
|
deceased | boolean |
Czy składnik zmarły (tylko dla osób)? |
|
day
|
deceased_date.d | integer |
Dzień w dacie rozmytej. |
|
miesiąca
|
deceased_date.m | integer |
Miesiąc w dacie rozmytej. |
|
rok
|
deceased_date.y | integer |
Rok w dacie rozmytej. |
|
Status zbiórki pieniędzy
|
fundraiser_status | string |
Wskazuje, czy składnik jest zbiórką pieniędzy (tylko dla osób fizycznych). |
|
identyfikator
|
spouse.id | string |
Identyfikator rejestru systemowego współmałżonka. |
|
imię
|
spouse.first | string |
Imię współmałżonka. |
|
nazwisko
|
spouse.last | string |
Nazwisko małżonka. |
|
czy szef gospodarstwa domowego?
|
spouse.is_head_of_household | boolean |
Czy współmałżonek jest głową gospodarstwa domowego? |
|
Data dodania
|
date_added | date-time |
Data utworzenia składnika. |
|
Data modyfikacji
|
date_modified | date-time |
Data ostatniej modyfikacji składnika. |
SkładnikApi.CreatedAction
Utworzona akcja
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonej akcji. |
SkładnikApi.CreatedActionAttachment
Utworzony załącznik akcji
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonego załącznika akcji. |
ConstituentApi.CreatedActionCustomField
Pole niestandardowe utworzonej akcji
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonego pola niestandardowego akcji. |
SkładnikApi.CreatedConstituentAddress
Utworzony adres składowy
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonego adresu składowego. |
SkładnikApi.CreatedConstituentAlias
Utworzony alias składowy
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonego aliasu składowego. |
SkładnikApi.CreatedConstituentAttachment
Utworzono załącznik składowy
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonego załącznika składowego. |
SkładnikApi.CreatedConstituentCode
Utworzony kod składowy
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonego kodu składowego. |
ConstituentApi.CreatedConstituentCustomField
Utworzono pole niestandardowe składowe
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonego pola niestandardowego składowego. |
SkładnikApi.CreatedConstituentEducation
Utworzono edukację składową
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonej edukacji składowej. |
ConstituentApi.CreatedConstituentEmailAddress
Utworzony adres e-mail składowy
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonego składowego adresu e-mail. |
SkładnikApi.CreatedConstituentNote
Utworzono notatkę składową
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonej notatki składowej. |
SkładnikApi.CreatedConstituentOnlinePresence
Utworzono składową obecność w trybie online
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonej obecności online. |
SkładnikApi.CreatedConstituentPhone
Utworzony telefon składowy
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonego telefonu składowego. |
SkładnikApi.CreatedConstituentRating
Utworzono klasyfikację składową
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonej klasyfikacji składowej. |
SkładnikApi.CreatedIndividualConstituent
Utworzono pojedynczy składnik
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonego składnika. |
ConstituentApi.CreatedIndividualRelationship
Utworzono pojedynczą relację
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonej relacji indywidualnej. |
SkładnikApi.CreatedOrganizationConstituent
Utworzony składnik organizacji
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonej organizacji składowej. |
ConstituentApi.CreatedOrganizationRelationship
Utworzono relację organizacji
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonej relacji organizacji. |
ConstituentApi.EducationRead
Education
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemu edukacji. |
|
Identyfikator składowy
|
constituent_id | string |
Identyfikator rekordu systemu składnika skojarzonego z wykształceniem. |
|
Szkoła
|
school | string |
Nazwa szkoły/placówki. |
|
Typ
|
type | string |
Typ edukacji. |
|
Klasa klasy
|
class_of | string |
Rok, w ramach których składnik ukończył. |
|
Status
|
status | string |
Status edukacji. |
|
day
|
date_entered.d | integer |
Dzień w dacie rozmytej. |
|
miesiąca
|
date_entered.m | integer |
Miesiąc w dacie rozmytej. |
|
rok
|
date_entered.y | integer |
Rok w dacie rozmytej. |
|
day
|
date_left.d | integer |
Dzień w dacie rozmytej. |
|
miesiąca
|
date_left.m | integer |
Miesiąc w dacie rozmytej. |
|
rok
|
date_left.y | integer |
Rok w dacie rozmytej. |
|
day
|
date_graduated.d | integer |
Dzień w dacie rozmytej. |
|
miesiąca
|
date_graduated.m | integer |
Miesiąc w dacie rozmytej. |
|
rok
|
date_graduated.y | integer |
Rok w dacie rozmytej. |
|
Stopień
|
degree | string |
Stopień otrzymany. |
|
GpA
|
gpa | double |
Średnia punktu oceny. |
|
Majors
|
majors | array of string |
Główne kursy studiów. |
|
Nieletnich
|
minors | array of string |
Drobne kursy studiów. |
|
Czy edukacja podstawowa?
|
primary | boolean |
Czy jest to stowarzyszenie szkoły podstawowej składowej? |
|
Campus
|
campus | string |
Kampus. |
|
Organizacja społeczna
|
social_organization | string |
Organizacja społeczna. |
|
Znana nazwa
|
known_name | string |
Znana nazwa. |
|
Klasa stopnia
|
class_of_degree | string |
Klasa stopnia. |
|
Dział
|
department | string |
Nazwa departamentu edukacji. |
|
Wydział
|
faculty | string |
Nazwa wydziału. |
|
Numer rejestracji
|
registration_number | string |
Numer rejestracji. |
|
Temat badania
|
subject_of_study | string |
Temat badania. |
|
Data dodania
|
date_added | date-time |
Data utworzenia edukacji. |
|
Data modyfikacji
|
date_modified | date-time |
Data ostatniej modyfikacji edukacji. |
ConstituentApi.EmailAddressRead
Adres e-mail
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemu adresu e-mail. |
|
Identyfikator składowy
|
constituent_id | string |
Identyfikator rekordu systemowego składnika skojarzonego z adresem e-mail. |
|
Typ wiadomości e-mail
|
type | string |
Typ adresu e-mail. |
|
Adres e-mail
|
address | string |
Adres e-mail. |
|
Podstawowy?
|
primary | boolean |
Czy jest to podstawowy adres e-mail składnika? |
|
Nie wysyłaj wiadomości e-mail?
|
do_not_email | boolean |
Czy można skontaktować się z składnikiem pod tym adresem e-mail? |
|
Nieaktywny?
|
inactive | boolean |
Czy ten adres e-mail jest nieaktywny? |
|
Data dodania
|
date_added | date-time |
Data utworzenia adresu e-mail. |
|
Data modyfikacji
|
date_modified | date-time |
Data ostatniej modyfikacji adresu e-mail. |
SkładnikApi.FileDefinition
Definicja pliku
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator pliku
|
file_id | string |
Identyfikator pliku. |
|
adres URL
|
file_upload_request.url | string |
Adres URL do użycia dla żądania przekazania. |
|
metoda
|
file_upload_request.method | string |
Metoda HTTP do użycia z żądaniem przekazywania. |
|
headers
|
file_upload_request.headers | array of ConstituentApi.Header |
Nagłówki, które należy podać podczas tworzenia żądania. |
|
Identyfikator miniatury
|
thumbnail_id | string |
Identyfikator miniatury. |
|
adres URL
|
thumbnail_upload_request.url | string |
Adres URL do użycia dla żądania przekazania. |
|
metoda
|
thumbnail_upload_request.method | string |
Metoda HTTP do użycia z żądaniem przekazywania. |
|
headers
|
thumbnail_upload_request.headers | array of ConstituentApi.Header |
Nagłówki, które należy podać podczas tworzenia żądania. |
ConstituentApi.FundraiserAssignmentRead
Przypisanie fundraiser
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemu przypisania zbiórki pieniędzy. |
|
Identyfikator składowy
|
constituent_id | string |
Identyfikator rekordu systemu składnika przypisanego do zbiórki pieniędzy. |
|
Identyfikator zbiórki pieniędzy
|
fundraiser_id | string |
Identyfikator rekordu systemu zbiórki pieniędzy. |
|
Typ
|
type | string |
Typ zbiórki pieniędzy. |
|
value
|
amount.value | double |
Wartość pieniężna. |
|
Identyfikator kampanii
|
campaign_id | string |
Identyfikator rekordu systemu kampanii, aby zastosować wynikowe prezenty. |
|
Identyfikator funduszu
|
fund_id | string |
Należy zastosować do systemu identyfikator funduszu wszelkie otrzymane prezenty. W przypadku wybrania funduszu ograniczonego można wybrać tylko kampanie i odwołania związane z tym funduszem. |
|
Identyfikator odwołania
|
appeal_id | string |
Identyfikator rejestru systemowego odwołania, którego fundraiser powinien użyć do żądania prezentów. |
|
Data rozpoczęcia
|
start | date-time |
Data rozpoczęcia przypisania zbiórki pieniędzy. |
|
Data zakończenia
|
end | date-time |
Data zakończenia przydziału fundraiser. |
SkładnikApi.FundRead
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rejestru systemu funduszu. |
|
opis
|
description | string |
Opis funduszu. |
ConstituentApi.GivingSummaryRead
Podawanie podsumowania
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemowego prezentu. |
|
Typ
|
type | string |
Typ prezentu. |
|
Date
|
date | date-time |
Data prezentu. |
|
value
|
amount.value | double |
Wartość pieniężna. |
|
Appeal
|
appeals | array of ConstituentApi.AppealRead |
Zestaw odwołań związanych z darem. |
|
Campaign
|
campaigns | array of ConstituentApi.CampaignRead |
Zestaw kampanii związanych z prezentem. |
|
Fundusz
|
funds | array of ConstituentApi.FundRead |
Zestaw funduszy związanych z prezentem. |
SkładnikApi.Header
Nagłówek żądania używany do przekazywania załącznika fizycznego.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
nazwa
|
name | string |
Nazwa nagłówka. |
|
value
|
value | string |
Wartość nagłówka. |
ConstituentApi.LifetimeGivingRead
Okres istnienia dający
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Kolejne lata podane
|
consecutive_years_given | integer |
Liczba kolejnych lat, które podał składnik. |
|
Łączna liczba lat
|
total_years_given | integer |
Całkowita liczba lat, na które podaje się składnik. |
|
value
|
total_giving.value | double |
Wartość pieniężna. |
|
value
|
total_pledge_balance.value | double |
Wartość pieniężna. |
|
value
|
total_received_giving.value | double |
Wartość pieniężna. |
|
value
|
total_committed_matching_gifts.value | double |
Wartość pieniężna. |
|
value
|
total_received_matching_gifts.value | double |
Wartość pieniężna. |
|
value
|
total_soft_credits.value | double |
Wartość pieniężna. |
SkładnikApi.NoteRead
Uwaga / Notatka
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemowego notatki. |
|
Identyfikator składowy
|
constituent_id | string |
Identyfikator rekordu systemu składnika skojarzonego z notatką. |
|
Typ
|
type | string |
Typ notatki. |
|
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. |
|
Podsumowanie
|
summary | string |
Podsumowanie notatki. |
|
Uwaga / Notatka
|
text | string |
Tekst notatki. |
|
Data dodania
|
date_added | date-time |
Data utworzenia notatki. |
|
Data modyfikacji
|
date_modified | date-time |
Data ostatniej modyfikacji notatki. |
ConstituentApi.OnlinePresenceRead
Obecność w trybie online
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemu obecności online. |
|
Identyfikator składowy
|
constituent_id | string |
Identyfikator rekordu systemu składnika skojarzonego z obecnością online. |
|
Typ
|
type | string |
Typ obecności online. |
|
Link
|
address | string |
Adres internetowy dla obecności online. |
|
Podstawowy?
|
primary | boolean |
Czy jest to podstawowa obecność online składnika? |
|
Nieaktywny?
|
inactive | boolean |
Czy ta obecność online jest nieaktywna? |
|
Data dodania
|
date_added | date-time |
Data utworzenia obecności online. |
|
Data modyfikacji
|
date_modified | date-time |
Data ostatniej modyfikacji obecności online. |
SkładnikApi.PhoneRead
Telefon
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemowego telefonu. |
|
Identyfikator składowy
|
constituent_id | string |
Identyfikator rekordu systemowego składnika skojarzonego z telefonem. |
|
Typ
|
type | string |
Typ telefonu. |
|
Number
|
number | string |
Numer telefonu. |
|
Podstawowy?
|
primary | boolean |
Czy jest to podstawowy telefon wyborcy? |
|
Nie dzwonisz?
|
do_not_call | boolean |
Czy można skontaktować się z składnikiem pod tym numerem? |
|
Nieaktywny?
|
inactive | boolean |
Czy ten numer telefonu jest nieaktywny? |
|
Data dodania
|
date_added | date-time |
Data utworzenia telefonu. |
|
Data modyfikacji
|
date_modified | date-time |
Data ostatniej modyfikacji telefonu. |
ConstituentApi.ProfilePictureRead
Obraz profilu
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | string |
Identyfikator rekordu systemu składnika skojarzonego z obrazem profilu. |
|
adres URL
|
url | string |
Adres URL obrazu profilu. Adres URL zawiera sygnaturę związaną z czasem, która ogranicza dostęp do 60 minut. |
|
Adres URL miniatury
|
thumbnail_url | string |
Adres URL miniatury obrazu profilu. Zawiera sygnaturę związaną z czasem, która ogranicza dostęp do 60 minut. |
SkładnikApi.ProspectStatusRead
Stan perspektywy
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Status
|
status | string |
Obecny status perspektywi wyborcy. |
|
Liczba dni, które upłynęły
|
days_elapsed | integer |
Łączna liczba dni w bieżącym stanie perspektywy na podstawie daty rozpoczęcia. |
|
Data rozpoczęcia
|
start | date-time |
Data rozpoczęcia stanu perspektywy. |
|
Comments
|
comments | string |
Komentarze dotyczące stanu perspektywy. |
ConstituentApi.RatingRead
Rating
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemu oceny. |
|
Identyfikator składowy
|
constituent_id | string |
Identyfikator rekordu systemu składnika skojarzonego z klasyfikacją. |
|
Źródło
|
source | string |
Źródło nowej oceny. |
|
Kategoria
|
category | string |
Kategoria klasyfikacji. |
|
Date
|
date | date-time |
Data oceny. |
|
Description
|
value |
Wartość klasyfikacji. |
|
|
Comments
|
comment | string |
Komentarz dotyczący oceny. |
|
Nieaktywny?
|
inactive | boolean |
Czy ocena jest nieaktywna? |
|
Typ
|
type | string |
To obliczone pole wskazuje typ danych, które ocena reprezentuje na podstawie właściwości kategorii. |
SkładnikApi.RelationshipRead
Relacja
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemu relacji. |
|
Identyfikator składowy
|
constituent_id | string |
Identyfikator rekordu systemu składnika skojarzonego z relacją. |
|
Identyfikator relacji
|
relation_id | string |
Identyfikator rekordu systemu powiązanej osoby lub organizacji. |
|
Identyfikator relacji wzajemnej
|
reciprocal_relationship_id | string |
Identyfikator rekordu relacji wzajemnej. Ta wartość jest tylko do odczytu i jest generowana automatycznie podczas tworzenia relacji. Zmiany wprowadzone w tym rekordzie zostaną również odzwierciedlone na wzajemnej stronie, z wyjątkiem właściwości komentarze. |
|
Name
|
name | string |
Nazwa powiązanego składnika. Jeśli powiązany składnik jest osobą indywidualną, będzie to pełna nazwa składnika na podstawie ustawień nazwy wyświetlanej organizacji docelowej. |
|
Typ
|
type | string |
Typ relacji reprezentowanej przez relację. |
|
Typ wzajemny
|
reciprocal_type | string |
Opisuje relację składnika z powiązanym składnikiem. Na przykład w związku między męskim składnikiem a rodzeństwem kobiet typ relacji wzajemnej będzie bratem. |
|
day
|
start.d | integer |
Dzień w dacie rozmytej. |
|
miesiąca
|
start.m | integer |
Miesiąc w dacie rozmytej. |
|
rok
|
start.y | integer |
Rok w dacie rozmytej. |
|
day
|
end.d | integer |
Dzień w dacie rozmytej. |
|
miesiąca
|
end.m | integer |
Miesiąc w dacie rozmytej. |
|
rok
|
end.y | integer |
Rok w dacie rozmytej. |
|
Czy współmałżonek?
|
is_spouse | boolean |
Czy powiązana osoba współmałżonka składnika (dotyczy tylko relacji między osobami)? |
|
Czy wyborca jest szefem gospodarstwa domowego?
|
is_constituent_head_of_household | boolean |
Czy składnik jest głową gospodarstwa domowego? |
|
Czy współmałżonek gospodarstwa domowego?
|
is_spouse_head_of_household | boolean |
Czy współmałżonek jest głową gospodarstwa domowego? |
|
Notatki
|
comment | string |
Komentarz do relacji. |
|
Czy kontakt?
|
is_organization_contact | boolean |
Czy składnik reprezentuje tę organizację jako kontakt (dotyczy tylko relacji między organizacjami i osobami)? |
|
Czy podstawowa firma?
|
is_primary_business | boolean |
Czy jest to podstawowa działalność składnika (dotyczy tylko relacji między organizacjami i osobami)? |
|
Typ kontaktu
|
organization_contact_type | string |
Udostępnia kontekst interakcji z powiązaną osobą, która reprezentuje organizację jako kontakt. Dotyczy tylko relacji między organizacjami i osobami fizycznymi. |
|
Position
|
position | string |
Stanowisko osoby w organizacji. Dotyczy tylko relacji między organizacjami i osobami fizycznymi. |
|
Data dodania
|
date_added | date-time |
Data utworzenia relacji. |
|
Data modyfikacji
|
date_modified | date-time |
Data ostatniej modyfikacji relacji. |
SkładnikApi.SearchResultRead
Wynik wyszukiwania
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemu składnika. |
|
Name
|
name | string |
Nazwa składowa. W przypadku użytkowników to obliczone pole wskazuje pełną nazwę składnika na podstawie ustawień nazwy wyświetlanej organizacji docelowej. |
|
Address
|
address | string |
Preferowany adres wyborcy. |
|
Zmarły?
|
deceased | boolean |
Czy składnik nie żyje? |
|
Email
|
string |
Adres e-mail składnika. |
|
|
Status zbiórki pieniędzy
|
fundraiser_status | string |
Status zbiórki pieniędzy wyborcy. W przypadku osób to obliczone pole wskazuje, czy składnik jest aktywny, nieaktywny czy brak. W przypadku organizacji ta wartość będzie zawsze mieć wartość Brak. |
|
Nieaktywny?
|
inactive | boolean |
Czy składnik jest nieaktywny? |
|
Identyfikator odnośnika
|
lookup_id | string |
Identyfikator zdefiniowany przez użytkownika dla składnika. |
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
Participants
| 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.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.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. |
|
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. |
|
Siedzenie
|
seat | string |
Przypisanie miejsca dla uczestnika. |
|
Tag nazwy
|
name_tag | string |
Tag nazwy 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. |
FundraisingApi.ApiCollectionOfAppealAttachmentRead
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 FundraisingApi.AppealAttachmentRead |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
FundraisingApi.ApiCollectionOfAppealCustomFieldRead
Pola niestandardowe
| 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 FundraisingApi.AppealCustomFieldRead |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
FundraisingApi.ApiCollectionOfAppealRead
Odwołania
| 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 FundraisingApi.AppealRead |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
FundraisingApi.ApiCollectionOfCampaignAttachmentRead
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 FundraisingApi.CampaignAttachmentRead |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
FundraisingApi.ApiCollectionOfCampaignCustomFieldRead
Pola niestandardowe
| 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 FundraisingApi.CampaignCustomFieldRead |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
FundraisingApi.ApiCollectionOfCampaignRead
Campaigns
| 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 FundraisingApi.CampaignRead |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
FundraisingApi.ApiCollectionOfFundAttachmentRead
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 FundraisingApi.FundAttachmentRead |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
FundraisingApi.ApiCollectionOfFundCustomFieldRead
Pola niestandardowe
| 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 FundraisingApi.FundCustomFieldRead |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
FundraisingApi.ApiCollectionOfFundRead
Funduszy
| 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 FundraisingApi.FundRead |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
FundraisingApi.ApiCollectionOfFundraiserAssignmentRead
Assignments
| 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 FundraisingApi.FundraiserAssignmentRead |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
FundraisingApi.ApiCollectionOfPackageRead
Packages
| 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 FundraisingApi.PackageRead |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
FundraisingApi.AppealAttachmentRead
Attachment
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemu załącznika. |
|
Identyfikator odwołania
|
parent_id | string |
Identyfikator rekordu systemu odwołania 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. |
FundraisingApi.AppealCustomFieldRead
Pole niestandardowe
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemowego pola niestandardowego. |
|
Identyfikator odwołania
|
parent_id | string |
Identyfikator rekordu systemu odwołania skojarzonego z polem niestandardowym. |
|
Kategoria
|
category | string |
Kategoria pola niestandardowego. |
|
Typ
|
type | string |
Typ danych reprezentowanych przez pole niestandardowe. |
|
Wartość
|
value |
Wartość pola niestandardowego. |
|
|
Date
|
date | date |
Data w polu niestandardowym. |
|
Comment
|
comment | string |
Komentarz do pola niestandardowego. Limit znaków: 50. |
|
Data dodania
|
date_added | date-time |
Data utworzenia pola niestandardowego. |
|
Data modyfikacji
|
date_modified | date-time |
Data ostatniej modyfikacji pola niestandardowego. |
FundraisingApi.AppealRead
Appeal
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rejestru systemowego odwołania. |
|
Kategoria
|
category | string |
Kategoria odwołania. |
|
Data dodania
|
date_added | date-time |
Data utworzenia odwołania. |
|
Data modyfikacji
|
date_modified | date-time |
Data ostatniej modyfikacji odwołania. |
|
Description
|
description | string |
Nazwa wyświetlana odwołania. |
|
Data zakończenia
|
end_date | date-time |
Data zakończenia odwołania. |
|
value
|
goal.value | double |
Wartość pieniężna. |
|
Nieaktywny?
|
inactive | boolean |
Czy odwołanie jest aktywne (co oznacza, że bieżąca data przypada po jakiejkolwiek dacie rozpoczęcia i przed datą zakończenia)? |
|
Identyfikator odnośnika
|
lookup_id | string |
Identyfikator zdefiniowany przez użytkownika dla odwołania. |
|
Data rozpoczęcia
|
start_date | date-time |
Data rozpoczęcia odwołania. |
FundraisingApi.CampaignAttachmentRead
Attachment
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemu załącznika. |
|
Identyfikator kampanii
|
parent_id | string |
Identyfikator rekordu systemu kampanii skojarzonej 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. |
FundraisingApi.CampaignCustomFieldRead
Pole niestandardowe
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemowego pola niestandardowego. |
|
Identyfikator kampanii
|
parent_id | string |
Identyfikator rekordu systemowego kampanii skojarzonej z polem niestandardowym. |
|
Kategoria
|
category | string |
Kategoria pola niestandardowego. |
|
Typ
|
type | string |
Typ danych reprezentowanych przez pole niestandardowe. |
|
Wartość
|
value |
Wartość pola niestandardowego. |
|
|
Date
|
date | date |
Data w polu niestandardowym. |
|
Comment
|
comment | string |
Komentarz do pola niestandardowego. Limit znaków: 50. |
|
Data dodania
|
date_added | date-time |
Data utworzenia pola niestandardowego. |
|
Data modyfikacji
|
date_modified | date-time |
Data ostatniej modyfikacji pola niestandardowego. |
FundraisingApi.CampaignRead
Campaign
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemu kampanii. |
|
Kategoria
|
category | string |
Kategoria kampanii. |
|
Data dodania
|
date_added | date-time |
Data utworzenia kampanii. |
|
Data modyfikacji
|
date_modified | date-time |
Data ostatniej modyfikacji kampanii. |
|
Description
|
description | string |
Nazwa wyświetlana kampanii. |
|
Data zakończenia
|
end_date | date-time |
Data zakończenia kampanii. |
|
value
|
goal.value | double |
Wartość pieniężna. |
|
Nieaktywny?
|
inactive | boolean |
Czy kampania jest nieaktywna (co oznacza, że bieżąca data przypada po jakiejkolwiek dacie rozpoczęcia i przed datą zakończenia)? |
|
Identyfikator odnośnika
|
lookup_id | string |
Identyfikator zdefiniowany przez użytkownika dla kampanii. |
|
Data rozpoczęcia
|
start_date | date-time |
Data rozpoczęcia kampanii. |
FundraisingApi.CreatedAppealAttachment
Utworzono załącznik odwołania
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonego załącznika odwołania. |
FundraisingApi.CreatedAppealCustomField
Utworzono pole niestandardowe odwołania
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonego pola niestandardowego odwołania. |
FundraisingApi.CreatedCampaignAttachment
Utworzono załącznik kampanii
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonego załącznika kampanii. |
FundraisingApi.CreatedCampaignCustomField
Utworzone pole niestandardowe kampanii
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonego pola niestandardowego kampanii. |
FundraisingApi.CreatedFundraiserAssignment
Utworzono przypisanie zbiórki pieniędzy
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonego przypisania zbiórki pieniędzy. |
FundraisingApi.CreatedFundAttachment
Utworzono załącznik funduszu
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonego załącznika funduszu. |
FundraisingApi.CreatedFundCustomField
Utworzono pole niestandardowe funduszu
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonego pola niestandardowego funduszu. |
FundraisingApi.FundraiserAssignmentRead
Assignment
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemu przypisania zbiórki pieniędzy. |
|
Identyfikator składowy
|
constituent_id | string |
Identyfikator rekordu systemu przypisanego składnika. |
|
Typ
|
type | string |
Typ zbiórki pieniędzy. |
|
Rozpoczynanie przypisywania
|
start | date-time |
Data rozpoczęcia przypisania. |
|
Końce przydziału
|
end | date-time |
Data zakończenia przydziału. |
|
value
|
amount.value | double |
Wartość pieniężna. |
|
Identyfikator kampanii
|
campaign_id | string |
Identyfikator rekordu systemu kampanii, do której zostaną zastosowane otrzymane prezenty. |
|
Identyfikator funduszu
|
fund_id | string |
System rejestruje identyfikator funduszu, do którego zostaną zastosowane otrzymane prezenty. |
|
Identyfikator odwołania
|
appeal_id | string |
Identyfikator rejestru systemowego odwołania, do którego zostaną zastosowane otrzymane prezenty. |
FundraisingApi.FundAttachmentRead
Attachment
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemu załącznika. |
|
Identyfikator funduszu
|
parent_id | string |
Identyfikator rekordu systemu funduszu 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. |
FundraisingApi.FundCustomFieldRead
Pole niestandardowe
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemowego pola niestandardowego. |
|
Identyfikator funduszu
|
parent_id | string |
Identyfikator rekordu systemu funduszu skojarzonego z polem niestandardowym. |
|
Kategoria
|
category | string |
Kategoria pola niestandardowego. |
|
Typ
|
type | string |
Typ danych reprezentowanych przez pole niestandardowe. |
|
Wartość
|
value |
Wartość pola niestandardowego. |
|
|
Date
|
date | date |
Data w polu niestandardowym. |
|
Comment
|
comment | string |
Komentarz do pola niestandardowego. Limit znaków: 50. |
|
Data dodania
|
date_added | date-time |
Data utworzenia pola niestandardowego. |
|
Data modyfikacji
|
date_modified | date-time |
Data ostatniej modyfikacji pola niestandardowego. |
FundraisingApi.FundRead
Fundusz
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rejestru systemu funduszu. |
|
Kategoria
|
category | string |
Kategoria funduszu. |
|
Data dodania
|
date_added | date-time |
Data utworzenia funduszu. |
|
Data modyfikacji
|
date_modified | date-time |
Data ostatniej modyfikacji funduszu. |
|
Description
|
description | string |
Nazwa wyświetlana funduszu. |
|
Data zakończenia
|
end_date | date-time |
Data zakończenia funduszu. |
|
value
|
goal.value | double |
Wartość pieniężna. |
|
Nieaktywny?
|
inactive | boolean |
Czy fundusz jest nieaktywny (co oznacza, że bieżąca data przypada po jakiejkolwiek dacie rozpoczęcia i przed datą zakończenia)? |
|
Identyfikator odnośnika
|
lookup_id | string |
Identyfikator zdefiniowany przez użytkownika dla funduszu. |
|
Data rozpoczęcia
|
start_date | date-time |
Data rozpoczęcia funduszu. |
|
Typ
|
type | string |
Typ funduszu. |
FundraisingApi.PackageRead
Package
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemowego pakietu. |
|
Identyfikator odwołania
|
appeal_id | string |
Identyfikator rekordu systemu odwołania skojarzonego z tym pakietem. |
|
Kategoria
|
category | string |
Kategoria pakietu. |
|
Data dodania
|
date_added | date-time |
Data utworzenia pakietu. |
|
Data modyfikacji
|
date_modified | date-time |
Data ostatniej modyfikacji pakietu. |
|
value
|
default_gift_amount.value | double |
Wartość pieniężna. |
|
Description
|
description | string |
Nazwa wyświetlana pakietu. |
|
Data zakończenia
|
end | date-time |
Data zakończenia pakietu. |
|
value
|
goal.value | double |
Wartość pieniężna. |
|
Nieaktywny?
|
inactive | boolean |
Czy pakiet jest nieaktywny (co oznacza, że bieżąca data przypada po jakiejkolwiek dacie rozpoczęcia i przed datą zakończenia)? |
|
Identyfikator odnośnika
|
lookup_id | string |
Identyfikator zdefiniowany przez użytkownika dla pakietu. |
|
Notatki
|
notes | string |
Uwagi dotyczące pakietu. |
|
Liczba adresatów
|
recipient_count | integer |
Liczba adresatów pakietu. |
|
Data rozpoczęcia
|
start | date-time |
Data rozpoczęcia pakietu. |
GiftApi.AcknowledgementRead
Uznanie
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
date
|
date | date-time |
Data skojarzona z potwierdzeniem. |
|
litera
|
letter | string |
List skojarzony z potwierdzeniem. |
|
stan
|
status | string |
Stan potwierdzenia. Dostępne wartości to: ACKNOWLEDGED, NEEDSACKNOWLEDGEMENT i DONOTACKNOWLEDGE. |
GiftApi.ApiCollectionOfGiftAttachmentRead
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 GiftApi.GiftAttachmentRead |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
GiftApi.ApiCollectionOfGiftCustomFieldRead
Pola niestandardowe
| 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 GiftApi.GiftCustomFieldRead |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
GiftApi.ApiCollectionOfGiftRead
Prezenty
| 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 GiftApi.GiftRead |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
GiftApi.BatchGiftAddResults
Zawiera kolekcję rekordów błędów prezentów wsadowych i prezentów wsadowych dodanych przez operację
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Błędy
|
errors | array of GiftApi.GiftBatchGiftError |
Błędy prezentu wsadowego skojarzone z operacją dodawania prezentu wsadowego |
|
Prezenty
|
gifts | array of GiftApi.BatchGiftRead |
Kolekcja prezentów wsadowych, które zostały dodane przez operację dodawania prezentu wsadowego |
GiftApi.GiftBatchGiftError
Reprezentuje wyjątki uniemożliwiające dodawanie elementów do partii.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
pole, którego dotyczy problem
|
affected_field | string |
Pole, którego dotyczy błąd |
|
identyfikator partii
|
batch_id | string |
Identyfikator rekordu systemu partii |
|
kod błędu wyjątku
|
exception_error_code | integer |
Kod błędu wyjątku |
|
komunikat o błędzie wyjątku
|
exception_error_message | string |
Komunikat o błędzie wyjątku |
|
nazwa błędu wyjątku
|
exception_error_name | string |
Nazwa błędu wyjątku |
|
identyfikator prezentu
|
gift_id | string |
Identyfikator rekordu systemowego prezentu |
|
identyfikator odnośnika
|
lookup_id | string |
Identyfikator zdefiniowany przez użytkownika dla prezentu. |
GiftApi.BatchGiftRead
Prezent wsadowy
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator partii
|
batch_id | string |
Identyfikator partii, do której dodano prezent. |
|
Błędy
|
errors | array of GiftApi.GiftBatchGiftError |
Błędy związane z prezentem wsadowym. |
|
identyfikator
|
id | string |
Identyfikator rekordu systemowego prezentu wsadowego. |
|
identyfikator składnika
|
constituent_id | string |
Identyfikator rekordu systemowego składnika skojarzonego z prezentem. |
|
typ
|
type | string |
Typ prezentu. |
|
Podtypu
|
subtype | string |
Podtyp daru. |
|
date
|
date | date-time |
Data prezentu. |
|
value
|
amount.value | double |
Wartość pieniężna. |
|
value
|
balance.value | double |
Wartość pieniężna. |
|
numer partii
|
batch_number | string |
Numer partii skojarzony z tym prezentem. |
|
stan
|
gift_status | string |
Status prezentu. |
|
anonimowy?
|
is_anonymous | boolean |
Czy prezent jest anonimowy? |
|
grupa
|
constituency | string |
Okręg wyborczy daru. |
|
identyfikator odnośnika
|
lookup_id | string |
Identyfikator zdefiniowany przez użytkownika dla prezentu. |
|
źródło
|
origin | string |
Początek daru. |
|
stan wpisu
|
post_status | string |
Ogólny rejestr po statusie prezentu. Dostępne wartości to Wysłana, NotPosted i DoNotPost. Jeśli post_status jest ustawiona na DoNotPost>, post_date powinna mieć wartość null. Gdy jest ustawiona wartość NotPosted, post_date jest wymagana, ale pozostaje edytowalna. Po ustawieniu opcji Wysłana post_date jest wymagana i nie jest już edytowalna. |
|
data zakończenia
|
post_date | date-time |
Data opublikowania prezentu w rejestrze ogólnym. |
|
odwołanie
|
reference | string |
Uwagi do śledzenia specjalnych szczegółów dotyczących prezentu, takich jak motywacja za nim lub szczegółowy opis prezentu. |
|
day
|
recurring_gift_status_date.d | integer |
Dzień w dacie rozmytej. |
|
miesiąca
|
recurring_gift_status_date.m | integer |
Miesiąc w dacie rozmytej. |
|
rok
|
recurring_gift_status_date.y | integer |
Rok w dacie rozmytej. |
|
częstotliwość
|
recurring_gift_schedule.frequency | string |
Częstotliwość raty cyklicznego prezentu do wyświetlenia. Dostępne wartości to COTYGODNIOWE, EVERY_TWO_WEEKS, EVERY_FOUR_WEEKS, MIESIĘCZNE, KWARTALNE, ROCZNIE. |
|
start
|
recurring_gift_schedule.start_date | date-time |
Data rozpoczęcia prezentu cyklicznego. |
|
koniec
|
recurring_gift_schedule.end_date | date-time |
Data zakończenia prezentu cyklicznego. |
|
value
|
gift_aid_amount.value | double |
Wartość pieniężna. |
|
status kwalifikacji pomocy prezentowej
|
gift_aid_qualification_status | string |
To obliczone pole określa stan kwalifikacji pomocy prezentowej na podstawie informacji podatkowych i formatu bazy danych. Dostępne wartości to: Kwalifikowana, NotQualified i CzęściowoKwalifikowana. Tylko dla Wielkiej Brytanii. |
|
kod prezentu
|
gift_code | string |
Wartość kodu prezentu skojarzona z prezentem. |
|
podziały prezentów
|
gift_splits | array of GiftApi.GiftSplitRead |
Zestaw prezentów dzieli się z darem. |
|
zbiórki pieniędzy
|
fundraisers | array of GiftApi.GiftFundraiserRead |
Zestaw fundraisers, którzy otrzymują kredyt na prezent. |
|
Środki nietrwałe
|
soft_credits | array of GiftApi.SoftCreditRead |
Zestaw kredytów miękkich związanych z prezentem. |
|
Rachunki
|
receipts | array of GiftApi.ReceiptRead |
Zestaw wpływów związanych z prezentem. |
|
Potwierdzenia
|
acknowledgements | array of GiftApi.AcknowledgementRead |
Zestaw potwierdzeń związanych z darem. |
|
Payments
|
payments | array of GiftApi.PaymentRead |
Płatności na prezent. |
|
Połączone prezenty
|
linked_gifts | array of string |
Identyfikatory innych prezentów, które są związane z tym darem. |
|
Data dodania
|
date_added | date-time |
Data utworzenia prezentu. |
|
Data modyfikacji
|
date_modified | date-time |
Data ostatniej modyfikacji prezentu. |
GiftApi.CreatedGift
Utworzony prezent
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonego prezentu. |
GiftApi.CreatedGiftAttachment
Utworzono załącznik prezentu
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonego załącznika prezentu. |
GiftApi.CreatedGiftCustomField
Utworzone pole niestandardowe prezentu
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonego pola niestandardowego prezentu. |
GiftApi.GiftAttachmentRead
Attachment
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemu załącznika. |
|
Identyfikator prezentu
|
parent_id | string |
Identyfikator rekordu systemowego prezentu 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. |
GiftApi.GiftCustomFieldRead
Pole niestandardowe
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemowego pola niestandardowego. |
|
Identyfikator prezentu
|
parent_id | string |
Identyfikator rekordu systemowego prezentu skojarzonego z polem niestandardowym. |
|
Kategoria
|
category | string |
Kategoria pola niestandardowego. |
|
Typ
|
type | string |
Typ danych reprezentowanych przez pole niestandardowe. |
|
Wartość
|
value |
Wartość pola niestandardowego. |
|
|
Date
|
date | date |
Data w polu niestandardowym. |
|
Comment
|
comment | string |
Komentarz do pola niestandardowego. Limit znaków: 50. |
|
Data dodania
|
date_added | date-time |
Data utworzenia pola niestandardowego. |
|
Data modyfikacji
|
date_modified | date-time |
Data ostatniej modyfikacji pola niestandardowego. |
GiftApi.GiftFundraiserRead
Fundraiser prezentów
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
value
|
amount.value | double |
Wartość pieniężna. |
|
identyfikator zbiórki pieniędzy
|
constituent_id | string |
Identyfikator rekordu systemu składowego dla zbiórki pieniędzy skojarzonej z prezentem. |
GiftApi.GiftRead
Prezent
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemowego prezentu. |
|
Identyfikator składowy
|
constituent_id | string |
Identyfikator rekordu systemowego składnika skojarzonego z prezentem. |
|
Typ
|
type | string |
Typ prezentu. |
|
Podtyp
|
subtype | string |
Podtyp daru. |
|
Date
|
date | date-time |
Data prezentu. |
|
value
|
amount.value | double |
Wartość pieniężna. |
|
value
|
balance.value | double |
Wartość pieniężna. |
|
Numer partii
|
batch_number | string |
Numer partii skojarzony z tym prezentem. |
|
Status
|
gift_status | string |
Status prezentu. |
|
Anonimowy?
|
is_anonymous | boolean |
Czy prezent jest anonimowy? |
|
Okręg wyborczy
|
constituency | string |
Okręg wyborczy daru. |
|
Identyfikator odnośnika
|
lookup_id | string |
Identyfikator zdefiniowany przez użytkownika dla prezentu. |
|
Pochodzenie
|
origin | string |
Początek daru. |
|
Stan wpisu
|
post_status | string |
Ogólny rejestr po statusie prezentu. Dostępne wartości to Wysłana, NotPosted i DoNotPost. Jeśli post_status jest ustawiona na DoNotPost>, post_date powinna mieć wartość null. Gdy jest ustawiona wartość NotPosted, post_date jest wymagana, ale pozostaje edytowalna. Po ustawieniu opcji Wysłana post_date jest wymagana i nie jest już edytowalna. |
|
Data pośmiertna
|
post_date | date-time |
Data opublikowania prezentu w rejestrze ogólnym. |
|
Reference
|
reference | string |
Uwagi do śledzenia specjalnych szczegółów dotyczących prezentu, takich jak motywacja za nim lub szczegółowy opis prezentu. |
|
day
|
recurring_gift_status_date.d | integer |
Dzień w dacie rozmytej. |
|
miesiąca
|
recurring_gift_status_date.m | integer |
Miesiąc w dacie rozmytej. |
|
rok
|
recurring_gift_status_date.y | integer |
Rok w dacie rozmytej. |
|
częstotliwość
|
recurring_gift_schedule.frequency | string |
Częstotliwość raty cyklicznego prezentu do wyświetlenia. Dostępne wartości to COTYGODNIOWE, EVERY_TWO_WEEKS, EVERY_FOUR_WEEKS, MIESIĘCZNE, KWARTALNE, ROCZNIE. |
|
start
|
recurring_gift_schedule.start_date | date-time |
Data rozpoczęcia prezentu cyklicznego. |
|
koniec
|
recurring_gift_schedule.end_date | date-time |
Data zakończenia prezentu cyklicznego. |
|
value
|
gift_aid_amount.value | double |
Wartość pieniężna. |
|
Status kwalifikacji pomocy prezentowej
|
gift_aid_qualification_status | string |
To obliczone pole określa stan kwalifikacji pomocy prezentowej na podstawie informacji podatkowych i formatu bazy danych. Dostępne wartości to: Kwalifikowana, NotQualified i CzęściowoKwalifikowana. Tylko dla Wielkiej Brytanii. |
|
Kod prezentu
|
gift_code | string |
Wartość kodu prezentu skojarzona z prezentem. |
|
Podziały prezentów
|
gift_splits | array of GiftApi.GiftSplitRead |
Zestaw prezentów dzieli się z darem. |
|
Zbiórki pieniędzy
|
fundraisers | array of GiftApi.GiftFundraiserRead |
Zestaw fundraisers, którzy otrzymują kredyt na prezent. |
|
Środki nietrwałe
|
soft_credits | array of GiftApi.SoftCreditRead |
Zestaw kredytów miękkich związanych z prezentem. |
|
Rachunki
|
receipts | array of GiftApi.ReceiptRead |
Zestaw wpływów związanych z prezentem. |
|
Potwierdzenia
|
acknowledgements | array of GiftApi.AcknowledgementRead |
Zestaw potwierdzeń związanych z darem. |
|
Payments
|
payments | array of GiftApi.PaymentRead |
Płatności na prezent. |
|
Połączone prezenty
|
linked_gifts | array of string |
Identyfikatory innych prezentów, które są związane z tym darem. |
|
Data dodania
|
date_added | date-time |
Data utworzenia prezentu. |
|
Data modyfikacji
|
date_modified | date-time |
Data ostatniej modyfikacji prezentu. |
GiftApi.GiftSplitRead
Podział prezentu
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemowego podzielonego prezentu. |
|
value
|
amount.value | double |
Wartość pieniężna. |
|
identyfikator odwołania
|
appeal_id | string |
Identyfikator rekordu systemowego odwołania skojarzonego z podziałem prezentu. |
|
identyfikator kampanii
|
campaign_id | string |
Identyfikator rekordu systemowego kampanii skojarzonej z podziałem prezentu. |
|
identyfikator funduszu
|
fund_id | string |
Identyfikator rejestru systemu funduszu skojarzonego z podziałem prezentu. |
|
value
|
gift_aid_amount.value | double |
Wartość pieniężna. |
|
status kwalifikacji pomocy prezentowej
|
gift_aid_qualification_status | string |
Status kwalifikacji pomocy prezentowej podziału. Dostępne wartości to: Kwalifikowane i NotQualified. Tylko dla Wielkiej Brytanii. |
|
identyfikator pakietu
|
package_id | string |
Identyfikator rekordu systemowego pakietu skojarzonego z podziałem prezentu. |
GiftApi.ReceiptRead
Receipt
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
value
|
amount.value | double |
Wartość pieniężna. |
|
date
|
date | date-time |
Data odbioru. |
|
Liczba
|
number | integer |
Liczba paragonów. |
|
stan
|
status | string |
Stan paragonu. Dostępne wartości to: RECEIPTED, NEEDSRECEIPT i DONOTRECEIPT. |
GiftApi.PaymentRead
Płatność
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
token konta
|
account_token | string |
Tokenizowane informacje o koncie (np. karta kredytowa) od zewnętrznego dostawcy płatności. Dotyczy tylko form płatności "CreditCard" i "DirectDebit". |
|
Identyfikator konfiguracji programu BBPS
|
bbps_configuration_id | string |
Identyfikator konfiguracji programu BBPS. Dotyczy tylko form płatności "CreditCard" i "DirectDebit". |
|
Identyfikator transakcji BBPS
|
bbps_transaction_id | string |
Identyfikator transakcji BBPS. Dotyczy tylko form płatności "CreditCard" i "DirectDebit". |
|
day
|
check_date.d | integer |
Dzień w dacie rozmytej. |
|
miesiąca
|
check_date.m | integer |
Miesiąc w dacie rozmytej. |
|
rok
|
check_date.y | integer |
Rok w dacie rozmytej. |
|
numer kontrolny
|
check_number | string |
Numer kontrolny. Dotyczy tylko formy płatności "PersonalCheck". |
|
identyfikator transakcji wyewidencjonowania
|
checkout_transaction_id | string |
Identyfikator transakcji wyewidencjonowania. Dotyczy tylko form płatności "CreditCard" i "DirectDebit". |
|
forma płatności
|
payment_method | string |
Forma płatności. Dostępne wartości są wymienione poniżej. |
|
odwołanie
|
reference | string |
Odwołanie. Dotyczy tylko formy płatności "Inne". |
|
day
|
reference_date.d | integer |
Dzień w dacie rozmytej. |
|
miesiąca
|
reference_date.m | integer |
Miesiąc w dacie rozmytej. |
|
rok
|
reference_date.y | integer |
Rok w dacie rozmytej. |
GiftApi.SoftCreditRead
Środki nietrwałe
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemu środków nietrwałych. |
|
value
|
amount.value | double |
Wartość pieniężna. |
|
identyfikator składnika
|
constituent_id | string |
Identyfikator rekordu systemu składnika skojarzonego z kredytem miękkim. |
|
identyfikator prezentu
|
gift_id | string |
Identyfikator rekordu systemowego prezentu skojarzonego z kredytem miękkim. |
GiftBatchApi.ApiCollectionOfGiftBatch
Partie prezentów
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba
|
count | integer |
Całkowita liczba partii prezentów w odpowiedzi. |
|
value
|
value | array of GiftBatchApi.GiftBatch |
Zestaw elementów uwzględnionych w odpowiedzi. |
GiftBatchApi.CreatedBatch
Utworzono partię prezentów
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
batch_id | string |
Identyfikator rekordu systemowego nowo utworzonej partii prezentów. |
GiftBatchApi.GiftBatch
Reprezentuje obiekt wsadowy prezentu
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemu partii. |
|
opis
|
batch_description | string |
Opis partii. |
|
numer partii
|
batch_number | string |
Numer partii |
|
przewidywany numer
|
projected_number_of_gifts | integer |
Przewidywana liczba prezentów w partii. |
|
rzeczywista liczba
|
number_of_gifts | integer |
Rzeczywista liczba prezentów w partii. |
|
przewidywanych kwot
|
projected_amount | double |
Przewidywana wartość prezentów w partii. |
|
rzeczywista kwota
|
actual_amount | double |
Rzeczywista wartość prezentów w partii. |
|
ma wyjątki?
|
has_exceptions | boolean |
Czy partia ma wyjątki? |
|
zatwierdzony?
|
is_approved | boolean |
Czy partia jest zatwierdzona? |
|
Utworzone przez
|
created_by | string |
Nazwa użytkownika, który utworzył partię. |
|
Utworzono:
|
created_on | date-time |
Data utworzenia partii. |
ListApi.CreatedList
Utworzona lista
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonej listy. |
OpportunityApi.ApiCollectionOfOpportunityAttachmentRead
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 OpportunityApi.OpportunityAttachmentRead |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
OpportunityApi.ApiCollectionOfOpportunityCustomFieldRead
Pola niestandardowe
| 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 OpportunityApi.OpportunityCustomFieldRead |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
OpportunityApi.ApiCollectionOfOpportunityRead
Szanse sprzedaży
| 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 OpportunityApi.OpportunityRead |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
OpportunityApi.CreatedOpportunity
Utworzono szansę sprzedaży
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonej szansy sprzedaży. |
OpportunityApi.CreatedOpportunityAttachment
Utworzono załącznik szans sprzedaży
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonego załącznika szansy sprzedaży. |
OpportunityApi.CreatedOpportunityCustomField
Utworzono załącznik szans sprzedaży
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonego załącznika szansy sprzedaży. |
OpportunityApi.Fundraiser
Fundraiser
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | string |
Identyfikator rekordu systemu składnika skojarzonego z zbiórką pieniędzy. |
|
value
|
credit_amount.value | double |
Wartość pieniężna. |
OpportunityApi.OpportunityAttachmentRead
Attachment
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemu załącznika. |
|
Identyfikator szansy sprzedaży
|
parent_id | string |
Identyfikator rekordu systemu szansy sprzedaży skojarzonej 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. |
OpportunityApi.OpportunityCustomFieldRead
Pole niestandardowe
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemowego pola niestandardowego. |
|
Identyfikator szansy sprzedaży
|
parent_id | string |
Identyfikator rekordu systemu szansy sprzedaży skojarzonej z polem niestandardowym. |
|
Kategoria
|
category | string |
Kategoria pola niestandardowego. |
|
Typ
|
type | string |
Typ danych reprezentowanych przez pole niestandardowe. |
|
Wartość
|
value |
Wartość pola niestandardowego. |
|
|
Date
|
date | date |
Data w polu niestandardowym. |
|
Comment
|
comment | string |
Komentarz do pola niestandardowego. Limit znaków: 50. |
|
Data dodania
|
date_added | date-time |
Data utworzenia pola niestandardowego. |
|
Data modyfikacji
|
date_modified | date-time |
Data ostatniej modyfikacji pola niestandardowego. |
OpportunityApi.OpportunityRead
Szansa
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemu szansy sprzedaży. |
|
Identyfikator składowy
|
constituent_id | string |
Identyfikator rekordu systemu składnika skojarzonego z szansą sprzedaży. |
|
Przeznaczenie
|
purpose | string |
Zamierzone wykorzystanie wszelkich pieniędzy zebranych w wyniku szansy sprzedaży. |
|
Name
|
name | string |
Nazwa identyfikująca szansę sprzedaży w całym programie, na przykład na listach lub na rekordach składowych. Limit znaków: 255. |
|
Status
|
status | string |
Stan wskazujący, gdzie jest szansa sprzedaży w procesie pozyskiwania. |
|
Deadline
|
deadline | date-time |
Data bramki dla okazji, aby doprowadzić do prezentu. |
|
Data pytania
|
ask_date | date-time |
Data wykonania prośby. |
|
value
|
ask_amount.value | double |
Wartość pieniężna. |
|
Oczekiwana data
|
expected_date | date-time |
Data, w których oczekuje się, że perspektywa zostanie wyrażona w odpowiedzi na szansę sprzedaży. |
|
value
|
expected_amount.value | double |
Wartość pieniężna. |
|
Data finansowania
|
funded_date | date-time |
Data, kiedy perspektywa dała w odpowiedzi na szansę sprzedaży. |
|
value
|
funded_amount.value | double |
Wartość pieniężna. |
|
Identyfikator kampanii
|
campaign_id | string |
Identyfikator rekordu systemu kampanii skojarzonej z szansą sprzedaży. Kampania określa ogólne cele zbierania pieniędzy. |
|
Identyfikator funduszu
|
fund_id | string |
System rejestruje identyfikator funduszu skojarzonego z szansą sprzedaży. Fundusz wyznacza konkretny cel finansowy prezentu i identyfikuje konto finansowe dla tego prezentu. |
|
Fundraiser(s)
|
fundraisers | array of OpportunityApi.Fundraiser |
Zestaw identyfikatorów rekordów systemowych dla fundraisers przypisanych do szansy. |
|
Nieaktywny?
|
inactive | boolean |
Czy szansa jest nieaktywna? |
|
linked_gifts
|
linked_gifts | array of string |
System rejestruje identyfikatory prezentów związanych z szansą sprzedaży. |
|
Data dodania
|
date_added | date-time |
Data utworzenia szansy sprzedaży. |
|
Data modyfikacji
|
date_modified | date-time |
Data ostatniej modyfikacji szansy sprzedaży. |