Blackbaud Raisers Edge NXT Składniki
Blackbaud Raiser's Edge NXT to kompleksowe oparte na chmurze rozwiązanie do zbierania funduszy i zarządzania darczyńcami opracowane specjalnie dla organizacji non-profit i całej dobrej społeczności społecznej. Łącznik Składniki umożliwia zarządzanie danymi biograficznymi, informacjami kontaktowymi i relacjami.
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 | - | Niedostępne |
| 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 składnikami i powiązanymi jednostkami znajdującymi się w narzędziu NXT aplikacji Raiser Edge, w tym:
- Składników
- Adresy
- Telefony i wiadomości e-mail
- Aliases
- Pola niestandardowe
- Notatki
- Załączniki
- Relacje
- i nie tylko...
Aby uzyskać więcej informacji, zapoznaj się z dokumentacją.
Wymagania wstępne
Aby korzystać z tego łącznika, musisz mieć konto identyfikatora Blackbaud z dostępem do co najmniej jednego środowiska Blackbaud.
Ponadto administrator organizacji musi również wykonać akcję na poziomie administratora w systemie, aby umożliwić temu łącznikowi dostęp do środowiska Blackbaud. Więcej informacji na temat tych wymagań wstępnych można znaleźć w dokumentacji początkowej konfiguracji .
Jak uzyskać poświadczenia?
Administrator organizacji wyśle Ci zaproszenie do środowiska NXT aplikacji Raiser's Edge i skonfiguruje uprawnienia konta użytkownika w środowisku. Do korzystania z tego łącznika nie są wymagane żadne dodatkowe poświadczenia.
Znane problemy i ograniczenia
Łącznik będzie działać w kontekście konta użytkownika i w związku z tym będzie podlegać uprawnieniam użytkownika w środowisku.
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
| Aktualizowanie adresu składowego |
Aktualizuje adres składowy. |
| Aktualizowanie aliasu składowego |
Aktualizuje alias składowy. |
| Aktualizowanie edukacji składowej |
Aktualizuje edukację składową. |
| Aktualizowanie formatu nazwy składowej |
Aktualizuje format nazwy składowej. |
| 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 podstawowego formatu nazwy składowej |
Aktualizuje format nazwy podstawowej dla składnika. |
| Aktualizowanie pola niestandardowego składników |
Aktualizuje pole niestandardowe składników. |
| 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 telefonu składowego |
Aktualizuje telefon składowy. |
| Aktualizowanie załącznika składowego |
Aktualizuje załącznik składowy. |
| Konwertowanie na składnik |
Konwertuje nieskładniki na składnik. |
| Lista edukacji składowych |
Wyświetla listę rekordów edukacyjnych dla składnika. |
| Lista hołdów przyznaje |
Wyświetla listę uznanie dla hołdu. |
| Lista hołdów składowych |
Wymienia hołdy dla wyborców. |
| 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 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 składowych |
Wyświetla listę załączników dla składnika. |
| Pobieranie obrazu profilu składowego |
Zwraca bieżący obraz profilu dla składnika. |
| Pobieranie podsumowania formatu nazwy składowej |
Zwraca podsumowanie formatu nazwy dla składnika. |
| Pobieranie składnika |
Zwraca informacje o składniku. |
| Pobieranie składnika według identyfikatora odnośnika |
Zwraca identyfikator rekordu systemowego składnika z określonego identyfikatora odnośnika. |
| Tworzenie adresu składowego |
Tworzy nowy adres składowy. |
| Tworzenie aliasu składowego |
Tworzy nowy alias składowy. |
| Tworzenie edukacji składowej |
Tworzy nową edukację składową. |
| Tworzenie formatu nazwy składowej |
Tworzy nowy format nazwy składowej. |
| Tworzenie hołdu składowego |
Tworzy nowy hołd składowy. |
| Tworzenie kodu na żądanie składników |
Tworzy nowy kod pozyskiwania składników. |
| Tworzenie kodu składowego |
Tworzy nowy kod składowy. |
| Tworzenie notatki składowej |
Tworzy nową notatkę składową. |
| Tworzenie podstawowego formatu nazwy składowej |
Tworzy podstawowy format nazwy dla składnika. |
| 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 składowego |
Tworzy nowe pole niestandardowe składowe. |
| Tworzenie potwierdzenia hołdu |
Tworzy nowy hołd. |
| Tworzenie przypisania zbiórki pieniędzy |
Tworzy nowe przypisanie zbiórki pieniędzy. |
| 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 telefonu składowego |
Tworzy nowy telefon składowy. |
| Tworzenie załącznika składowego |
Tworzy nowy załącznik składowy. |
| Usuwanie kodu składowego |
Usuwa kod składowy. |
| Uzyskiwanie hołdu składowego |
Zwraca szczegóły dotyczące hołdu składowego. |
| Wyszukaj składnik (ulepszony) |
Wyszukuje rekordy składowe przy użyciu podanych kryteriów filtrowania. |
| 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. |
| Wyszukiwanie zduplikowanych składników |
Wyszukuje pojedyncze, organizacyjne i powiązane rekordy kontaktów oraz klasyfikuje potencjalne duplikaty na podstawie określonych filtrów wyszukiwania. Rekordy pasujące do wielu filtrów są wyższe niż potencjalne duplikaty. |
| 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 aliasów składowych |
Wyświetla aliasy składników. |
| Wyświetlanie listy członkostw składowych |
Wyświetla listę członkostw dla składnika. |
| Wyświetlanie listy kodów składowych |
Wyświetla listę kodów składowych dla składnika. |
| Wyświetlanie listy przypisań fundraiser |
Wyświetl listę przypisań do zbiórki pieniędzy. |
| Wyświetlanie listy pól niestandardowych składowych |
Wyświetla listę pól niestandardowych dla składnika. |
| 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. |
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 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 formatu nazwy składowej
Aktualizuje format nazwy składowej.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator formatu nazwy
|
name_format_id | True | string |
Identyfikator rekordu systemu w formacie nazwy do zaktualizowania. |
|
Typ
|
type | string |
Typ formatu nazwy. |
|
|
Niestandardowy format nazwy?
|
custom_format | boolean |
Czy format niestandardowy? |
|
|
Format
|
configuration_id | string |
Konfiguracja formatu nazwy (wymagana, chyba że jest używany format niestandardowy). |
|
|
Nazwa niestandardowa
|
formatted_name | string |
Sformatowana nazwa (wymagana w przypadku użycia formatu niestandardowego). Limit znaków: 255. |
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 podstawowego formatu nazwy składowej
Aktualizuje format nazwy podstawowej dla składnika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator formatu nazwy
|
primary_name_format_id | True | string |
Identyfikator rekordu systemu w formacie nazwy podstawowej do zaktualizowania. |
|
Niestandardowy format nazwy?
|
custom_format | boolean |
Czy format niestandardowy? |
|
|
Format
|
configuration_id | string |
Konfiguracja formatu nazwy (wymagana, chyba że jest używany format niestandardowy). |
|
|
Nazwa niestandardowa
|
formatted_name | string |
Sformatowana nazwa (wymagana w przypadku użycia formatu niestandardowego). Limit znaków: 255. |
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 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? |
|
|
Nie chcesz wysyłać żadnych wiadomości e-mail?
|
requests_no_email | boolean |
Czy żądanie składowe nie zawiera wiadomości e-mail? |
|
|
Czy adwokat?
|
is_solicitor | boolean |
Czy wyborca jest radcą prawnym? |
|
|
Brak prawidłowych adresów?
|
no_valid_address | boolean |
Czy składnik nie ma prawidłowych adresów? |
|
|
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). |
|
|
Target
|
target | string |
Cel składnika. |
|
|
Dochód
|
income | string |
Dochód dla składnika (tylko dla osób fizycznych). |
|
|
Typ potwierdzenia
|
receipt_type | string |
Typ paragonu składnika. |
|
|
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. |
|
|
Czy pomnik?
|
is_memorial | boolean |
Czy wyborca jest honorem/pomnikiem? |
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 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 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. |
|
|
Etykiety
|
tags | array of string |
Tagi skojarzone z załącznikiem. |
Konwertowanie na składnik
Konwertuje nieskładniki na składnik.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator nieskładantowy
|
non_constituent_id | True | string |
Identyfikator rekordu systemowego rekordu innego niż składnik do konwersji. |
|
identyfikator
|
id | string |
Identyfikator rekordu systemu kodu składowego. |
|
|
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. |
|
|
sekwencja
|
sequence | integer |
Sekwencja kodu składowego. |
Zwraca
Przekonwertowany składnik
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 hołdów przyznaje
Wyświetla listę uznanie dla hołdu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator hołdu
|
tributeId | True | integer |
Identyfikator rekordu systemu hołdu. |
Zwraca
Hołd potwierdza
Lista hołdów składowych
Wymienia hołdy dla wyborców.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituentId | True | integer |
Identyfikator rekordu systemu składnika. |
Zwraca
Danin
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 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 rekordów systemu składowego 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 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
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 podsumowania formatu nazwy składowej
Zwraca podsumowanie formatu nazwy dla składnika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemu składnika. |
Zwraca
Podsumowanie formatu nazwy
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 składnika według identyfikatora odnośnika
Zwraca identyfikator rekordu systemowego składnika z określonego identyfikatora odnośnika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator odnośnika
|
constituent_id | True | string |
Identyfikator odnośnika składowego. |
Zwraca
Mapa identyfikatorów składowych
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 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 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 formatu nazwy składowej
Tworzy nowy format nazwy składowej.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemu składnika. |
|
Typ
|
type | True | string |
Typ formatu nazwy. |
|
Niestandardowy format nazwy?
|
custom_format | boolean |
Czy format niestandardowy? |
|
|
Format
|
configuration_id | string |
Konfiguracja formatu nazwy (wymagana, chyba że jest używany format niestandardowy). |
|
|
Nazwa niestandardowa
|
formatted_name | string |
Sformatowana nazwa (wymagana w przypadku użycia formatu niestandardowego). Limit znaków: 255. |
Zwraca
Format nazwy utworzonej
Tworzenie hołdu składowego
Tworzy nowy hołd składowy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_record_id | True | integer |
Identyfikator rekordu systemu składnika skojarzonego z hołdem. |
|
Typ hołdu
|
tribute_type_id | True | integer |
Typ hołdu. |
|
Description
|
description | string |
Opis hołdu. |
|
|
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. |
|
|
Domyślny identyfikator funduszu
|
default_fund_id | integer |
Identyfikator rekordu systemu domyślnego funduszu skojarzonego z hołdem. |
|
|
Notatki
|
notes | string |
Notatki z hołdu. |
|
|
Aktywny?
|
is_active | boolean |
Czy ten hołd jest aktywny? |
Zwraca
Utworzono hołd składowy
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 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. |
|
|
Author
|
author | string |
Autor notatki. Jeśli nie zostanie podany, zostanie ustawiony domyślny zestaw na podstawie konta użytkownika. Limit znaków: 50. |
Zwraca
Utworzono notatkę składową
Tworzenie podstawowego formatu nazwy składowej
Tworzy podstawowy format nazwy dla składnika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemu składnika. |
|
Typ
|
primary_type | True | string |
Typ formatu nazwy podstawowej. |
|
Niestandardowy format nazwy?
|
custom_format | boolean |
Czy format niestandardowy? |
|
|
Format
|
configuration_id | string |
Konfiguracja formatu nazwy (wymagana, chyba że jest używany format niestandardowy). |
|
|
Nazwa niestandardowa
|
formatted_name | string |
Sformatowana nazwa (wymagana w przypadku użycia formatu niestandardowego). Limit znaków: 255. |
Zwraca
Format nazwy utworzonej
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? |
|
|
Nie chcesz wysyłać żadnych wiadomości e-mail?
|
requests_no_email | boolean |
Czy żądanie składowe nie zawiera wiadomości e-mail? |
|
|
Czy adwokat?
|
is_solicitor | boolean |
Czy wyborca jest radcą prawnym? |
|
|
Brak prawidłowych adresów?
|
no_valid_address | boolean |
Czy składnik nie ma prawidłowych adresów? |
|
|
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. |
|
|
Target
|
target | string |
Cel składnika. |
|
|
Dochód
|
income | string |
Dochód dla wyborców. |
|
|
Typ potwierdzenia
|
receipt_type | string |
Typ paragonu składnika. |
|
|
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. |
|
|
Czy pomnik?
|
is_memorial | boolean |
Czy wyborca jest honorem/pomnikiem? |
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 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 potwierdzenia hołdu
Tworzy nowy hołd.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator hołdu
|
tribute_id | True | integer |
Identyfikator rekordu systemu hołdu skojarzonego z potwierdzeniem. |
|
Identyfikator relacji
|
relationship_id | integer |
Identyfikator rekordu systemu relacji (jeśli ma wartość null, reprezentuje to samozwańcze potwierdzenie). |
|
|
Identyfikator litery
|
letter_id | integer |
Identyfikator litery. |
Zwraca
Utworzono potwierdzenie hołdu
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 (np. "2020-09-18T04:13:56Z"). |
|
|
Końce przydziału
|
end | date-time |
Data zakończenia przydziału (np. "2020-09-18T04:13:56Z"). |
|
|
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 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? |
|
|
Nie chcesz wysyłać żadnych wiadomości e-mail?
|
requests_no_email | boolean |
Czy żądanie składowe nie zawiera wiadomości e-mail? |
|
|
Czy adwokat?
|
is_solicitor | boolean |
Czy wyborca jest radcą prawnym? |
|
|
Brak prawidłowych adresów?
|
no_valid_address | boolean |
Czy składnik nie ma prawidłowych adresów? |
|
|
Target
|
target | string |
Cel składnika. |
|
|
Dochód
|
income | string |
Dochód dla wyborców. |
|
|
Typ potwierdzenia
|
receipt_type | string |
Typ paragonu składnika. |
|
|
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. |
|
|
Czy pomnik?
|
is_memorial | boolean |
Czy wyborca jest honorem/pomnikiem? |
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 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 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. |
|
|
Etykiety
|
tags | array of string |
Tagi skojarzone z załącznikiem. |
Zwraca
Utworzono załącznik składowy
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. |
Uzyskiwanie hołdu składowego
Zwraca szczegóły dotyczące hołdu składowego.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator hołdu
|
tribute_id | True | string |
Identyfikator hołdu. |
Zwraca
Danina
Wyszukaj składnik (ulepszony)
Wyszukuje rekordy składowe przy użyciu podanych kryteriów filtrowania.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Imię
|
first_name | string |
Imię składowe. |
|
|
Nazwisko
|
last_name | string |
Nazwisko składowe. |
|
|
Identyfikator odnośnika
|
lookup_id | string |
Identyfikator odnośnika składowego. |
|
|
Adres e-mail
|
string |
Adres e-mail składowy. |
||
|
Numer telefonu
|
phone_number | string |
Numer. |
|
|
Ograniczenie
|
limit | integer |
Reprezentuje liczbę rekordów do zwrócenia. Wartość domyślna to 500. Maksymalna wartość to 1000. |
|
|
Wiersze adresów
|
address_lines | string |
Wiersze adresów. |
|
|
Miejscowość
|
city | string |
Miasto adresowe. |
|
|
State
|
state | string |
Stan adresu. |
|
|
Kod pocztowy
|
post_code | string |
Adres kodu pocztowego. |
|
|
Uwzględnij alias?
|
include_alias | boolean |
Czy uwzględnić alias podczas wyszukiwania na nazwisko? |
|
|
Typ aliasu
|
alias_type | string |
Typ aliasu. |
|
|
Czy dołączyć nazwęidena?
|
include_maiden_name | boolean |
Czy dołączyć nazwę panienną podczas wyszukiwania na nazwisko? |
Zwraca
Składników
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
Wyszukiwanie zduplikowanych składników
Wyszukuje pojedyncze, organizacyjne i powiązane rekordy kontaktów oraz klasyfikuje potencjalne duplikaty na podstawie określonych filtrów wyszukiwania. Rekordy pasujące do wielu filtrów są wyższe niż potencjalne duplikaty.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwisko/nazwa organizacji
|
last_org_name | True | string |
Filtr rekordów pasujących do określonego nazwiska lub nazwy organizacji. |
|
Imię
|
first_name | string |
Filtr dla poszczególnych rekordów, które są zgodne z określoną nazwą. |
|
|
Drugie imię
|
middle_name | string |
Filtr dla poszczególnych rekordów, które są zgodne z określoną nazwą środkową. |
|
|
Sufiks
|
suffix | string |
Filtr dla poszczególnych rekordów pasujących do określonego sufiksu. |
|
|
Blok adresu
|
address_block | string |
Filtr rekordów pasujących do określonego bloku adresów. |
|
|
Miejscowość
|
city | string |
Filtr rekordów pasujących do określonego miasta. |
|
|
State
|
state | string |
Filtr rekordów pasujących do określonego stanu. |
|
|
Kod pocztowy
|
post_code | string |
Filtr rekordów pasujących do określonego kodu pocztowego. |
|
|
Email
|
array |
Filtr rekordów pasujących do określonych adresów e-mail. |
||
|
Telefon
|
phone | array |
Filtr rekordów pasujących do określonych numerów telefonów. |
|
|
Przeszukaj osoby?
|
search_individuals | boolean |
Szukasz zduplikowanych pojedynczych rekordów? |
|
|
Wyszukaj aliasy?
|
search_aliases | boolean |
Wyszukaj według aliasu, jak określono w parametrze Last/org name? |
|
|
Przeszukaj kontakty?
|
search_contacts | boolean |
Przeszukiwanie rekordów kontaktów relacji? |
|
|
Ograniczenie
|
limit | integer |
Liczba rekordów, które mają być zwracane podczas stronicowania wyników (wartość domyślna = 3). |
|
|
Przesunięcie
|
offset | integer |
Liczba rekordów do pominięcia podczas stronicowania wyników. |
Zwraca
Zduplikowane 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 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 członkostw składowych
Wyświetla listę członkostw dla składnika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemu składnika. |
Zwraca
Członkostwa
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 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 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 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
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.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.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.ApiCollectionOfMembershipRead
Członkostwa
| 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.MembershipRead |
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.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. |
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. |
|
Etykiety
|
tags | array of string |
Tagi skojarzone z załącznikiem. |
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. |
|
|
Wartość tekstowa
|
text_value | string |
Wartość tekstowa pola niestandardowego. |
|
Wartość liczbowa
|
number_value | integer |
Wartość liczbowa pola niestandardowego. |
|
Wartość daty
|
date_value | date |
Wartość daty pola niestandardowego. |
|
Wartość waluty
|
currency_value | double |
Wartość waluty pola niestandardowego. |
|
Wartość logiczna
|
boolean_value | boolean |
Wartość logiczna pola niestandardowego. |
|
Wartość wpisu tabeli
|
codetableentry_value | string |
Wartość wpisu tabeli pola niestandardowego. |
|
Wartość identyfikatora składnika
|
constituentid_value | string |
Wartość identyfikatora składowego pola niestandardowego. |
|
day
|
fuzzydate_value.d | integer |
Dzień w dacie rozmytej. |
|
miesiąca
|
fuzzydate_value.m | integer |
Miesiąc w dacie rozmytej. |
|
rok
|
fuzzydate_value.y | integer |
Rok w dacie rozmytej. |
|
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? |
|
Nie chcesz wysyłać żadnych wiadomości e-mail?
|
requests_no_email | boolean |
Czy żądanie składowe nie zawiera wiadomości e-mail? |
|
Czy adwokat?
|
is_solicitor | boolean |
Czy wyborca jest radcą prawnym? |
|
Brak prawidłowych adresów?
|
no_valid_address | boolean |
Czy składnik nie ma prawidłowych adresów? |
|
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). |
|
Target
|
target | string |
Cel składnika. |
|
Dochód
|
income | string |
Dochód dla składnika (tylko dla osób fizycznych). |
|
Typ potwierdzenia
|
receipt_type | string |
Typ paragonu składnika. |
|
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). |
|
value
|
matching_gift_per_gift_min.value | double |
Wartość kwoty. |
|
value
|
matching_gift_per_gift_max.value | double |
Wartość kwoty. |
|
value
|
matching_gift_total_min.value | double |
Wartość kwoty. |
|
value
|
matching_gift_total_max.value | double |
Wartość kwoty. |
|
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). |
|
Czy pomnik?
|
is_memorial | boolean |
Czy wyborca jest honorem/pomnikiem? |
|
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.ConvertedConstituent
Przekonwertowany składnik
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator przekonwertowanego składnika. |
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.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.CreatedNameFormat
Format nazwy utworzonej
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonego formatu nazwy. |
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.DuplicateSearchResult
Zduplikowany wynik wyszukiwania
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemu dla 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. |
|
nazwa wyświetlana
|
display_name | string |
Nazwa wyświetlana składnika. |
|
Address
|
formatted_address | string |
Sformatowany adres podstawowy składnika. |
|
Zmarły?
|
deceased | boolean |
Czy składnik nie żyje? |
|
Czy składnik?
|
is_constituent | boolean |
Czy rekord jest składnikiem? |
|
Identyfikator odnośnika
|
constituent_id | string |
Identyfikator zdefiniowany przez użytkownika dla składnika. |
|
Data dodania
|
date_added | date-time |
Data dodania składnika. |
|
Ranga
|
rank | string |
Ranga wyszukiwania wskazująca, na co dopasowano składnik. |
ConstituentApi.DuplicateSearchResultCollection
Zduplikowane 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.DuplicateSearchResult |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
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. |
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.MembershipMemberRead
Członek
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemu elementu członkowskiego. |
|
Identyfikator składowy
|
constituent_id | string |
Identyfikator rekordu systemu składnika skojarzonego z elementem członkowskim. |
|
Czy element podstawowy jest członkiem?
|
primary | boolean |
Czy jest to podstawowy element członkowski? |
SkładnikApi.MembershipRead
Membership
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemu członkostwa. |
|
Identyfikator składowy
|
constituent_id | string |
Identyfikator rekordu systemowego składnika skojarzonego z członkostwem. |
|
Program
|
program | string |
Program członkostwa. |
|
Kategoria
|
category | string |
Kategoria członkostwa. |
|
Podkategoria
|
subcategory | string |
Podkategoria członkostwa. |
|
Stojący
|
standing | string |
Stan członkostwa. |
|
Wygasa
|
expires | date-time |
Data wygaśnięcia członkostwa. |
|
Połączone
|
joined | date-time |
Data, kiedy członkostwo stanie się aktywne. |
|
value
|
dues.value | double |
Wartość pieniężna. |
|
Członkowie
|
members | array of ConstituentApi.MembershipMemberRead |
Zestaw członków, którzy należą do członkostwa. |
|
Data dodania
|
date_added | date-time |
Data utworzenia członkostwa. |
|
Data modyfikacji
|
date_modified | date-time |
Data ostatniej modyfikacji członkostwa. |
SkładnikApi.NameFormatRead
Formaty nazw definiują sposób adresowania składników w komunikacji. Sposób odwoływania się do poszczególnych osób określa ton komunikacji z nimi i sposób ich odbierania interakcji.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemu w formacie nazwy. |
|
typ
|
type | string |
Typ formatu nazwy. |
|
format niestandardowy?
|
custom_format | boolean |
Czy jest to format niestandardowy? |
|
identyfikator konfiguracji
|
configuration_id | string |
Identyfikator konfiguracji formatu nazwy (dla formatów innych niż niestandardowe). |
|
nazwa sformatowana
|
formatted_name | string |
Sformatowana nazwa (dla formatów niestandardowych). |
ConstituentApi.NameFormatSummaryRead
Podsumowanie formatu nazwy
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
primary_addressee.id | string |
Identyfikator rekordu systemu w formacie nazwy. |
|
typ
|
primary_addressee.primary_type | string |
Typ formatu nazwy. |
|
format niestandardowy?
|
primary_addressee.custom_format | boolean |
Czy jest to format niestandardowy? |
|
identyfikator konfiguracji
|
primary_addressee.configuration_id | string |
Identyfikator konfiguracji formatu nazwy (dla formatów innych niż niestandardowe). |
|
nazwa sformatowana
|
primary_addressee.formatted_name | string |
Sformatowana nazwa (dla formatów niestandardowych). |
|
identyfikator
|
primary_salutation.id | string |
Identyfikator rekordu systemu w formacie nazwy. |
|
typ
|
primary_salutation.primary_type | string |
Typ formatu nazwy. |
|
format niestandardowy?
|
primary_salutation.custom_format | boolean |
Czy jest to format niestandardowy? |
|
identyfikator konfiguracji
|
primary_salutation.configuration_id | string |
Identyfikator konfiguracji formatu nazwy (dla formatów innych niż niestandardowe). |
|
nazwa sformatowana
|
primary_salutation.formatted_name | string |
Sformatowana nazwa (dla formatów niestandardowych). |
|
Dodatkowe formaty nazw
|
additional_name_formats | array of ConstituentApi.NameFormatRead |
Dodatkowe formaty nazw składników. |
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.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. |
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.CreatedFundraiserAssignment
Utworzono przypisanie zbiórki pieniędzy
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonego przypisania zbiórki pieniędzy. |
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. |
NXTDataIntegrationApi.ConstituentIdMap
Mapa identyfikatorów składowych
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
system_record_id | integer |
Identyfikator rekordu systemu składowego. |
NXTDataIntegrationApi.ConstituentSearchResult
Wynik wyszukiwania
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
record_id | integer |
Identyfikator rekordu systemu składnika. |
|
Identyfikator odnośnika
|
constituent_id | string |
Identyfikator składowy. |
|
Kluczowy wskaźnik
|
key_indicator | string |
Kluczowy wskaźnik rekordu. |
|
Imię
|
first_name | string |
Imię (tylko osoby). |
|
Nazwisko
|
last_name | string |
Nazwisko (tylko osoby). |
|
Drugie imię
|
middle_name | string |
Imię i nazwisko (tylko osoby). |
|
Preferowana nazwa
|
preferred_name | string |
Preferowana nazwa (tylko osoby). |
|
Była nazwa
|
maiden_name | string |
Była nazwa (tylko osoby). |
|
Tytuł 1
|
title1 | string |
Tytuł 1 (tylko osoby). |
|
Sufiks 1
|
suffix1 | string |
Sufiks 1 (tylko osoby). |
|
Gender
|
gender | string |
Płeć składowa (tylko osoby). |
|
day
|
birth_date.d | integer |
Dzień w dacie rozmytej. |
|
miesiąca
|
birth_date.m | integer |
Miesiąc w dacie rozmytej. |
|
rok
|
birth_date.y | integer |
Rok w dacie rozmytej. |
|
Imię małżonka
|
spouse_first_name | string |
Imię współmałżonka (tylko osoby). |
|
Nazwisko małżonka
|
spouse_last_name | string |
Nazwisko małżonka (tylko osoby). |
|
Nazwa organizacji
|
org_name | string |
Nazwa organizacji (tylko organizacje). |
|
Blok adresu
|
address_block | string |
Blok adresu. |
|
Miasto i stan
|
address_city_state | string |
Miasto i stan adresu. |
|
Kod pocztowy
|
address_post_code | string |
Kod pocztowy adresu. |
|
Podstawowy adres e-mail
|
primary_email | string |
Podstawowa wiadomość e-mail. |
|
Podstawowy numer telefonu
|
primary_phone | string |
Telefon podstawowy. |
|
Dopasowany alias
|
matched_alias | string |
Dopasowana nazwa aliasu (tylko osoby). |
|
Dopasowana wiadomość e-mail
|
matched_email | string |
Dopasowany adres e-mail. |
|
Dopasowany telefon
|
matched_phone | string |
Dopasowany numer telefonu. |
|
Czy składnik?
|
is_constituent | boolean |
Czy rekord jest składnikiem? |
|
Czy zmarł?
|
is_deceased | boolean |
Czy rekord zmarł? |
|
Czy nieaktywne?
|
is_inactive | boolean |
Czy rekord jest nieaktywny? |
NXTDataIntegrationApi.ConstituentSearchResultCollection
Składników
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
results
|
results | array of NXTDataIntegrationApi.ConstituentSearchResult |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
NXTDataIntegrationApi.CreatedConstituentTribute
Utworzono hołd składowy
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonego hołdu składowego. |
NXTDataIntegrationApi.CreatedTributeAcknowledgee
Utworzono potwierdzenie hołdu
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonego hołdu potwierdza. |
NXTDataIntegrationApi.Tribute
Danina
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | integer |
Identyfikator rekordu systemu hołdu. |
|
Identyfikator składowy
|
constituent_record_id | integer |
Identyfikator rekordu systemu składnika skojarzonego z hołdem. |
|
Typ hołdu
|
tribute_type_name | string |
Typ hołdu. |
|
Identyfikator typu hołdu
|
tribute_type_id | integer |
Identyfikator typu hołdu. |
|
Description
|
description | string |
Opis hołdu. |
|
day
|
start_date.d | integer |
Dzień w dacie rozmytej. |
|
miesiąca
|
start_date.m | integer |
Miesiąc w dacie rozmytej. |
|
rok
|
start_date.y | integer |
Rok w dacie rozmytej. |
|
day
|
end_date.d | integer |
Dzień w dacie rozmytej. |
|
miesiąca
|
end_date.m | integer |
Miesiąc w dacie rozmytej. |
|
rok
|
end_date.y | integer |
Rok w dacie rozmytej. |
|
Domyślny identyfikator funduszu
|
default_fund_id | integer |
Identyfikator rekordu systemu domyślnego funduszu skojarzonego z hołdem. |
|
Notatki
|
notes | string |
Notatki z hołdu. |
|
Aktywny?
|
is_active | boolean |
Czy ten hołd jest aktywny? |
|
Kolejność
|
sequence | integer |
Sekwencja hołdu. |
|
Data dodania
|
date_added | date-time |
Data utworzenia hołdu. |
|
Data modyfikacji
|
date_modified | date-time |
Data ostatniej modyfikacji hołdu. |
NXTDataIntegrationApi.TributeAcknowledgee
Uznanie hołdu
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | integer |
Identyfikator rekordu systemu potwierdzenia hołdu. |
|
Identyfikator hołdu
|
tribute_id | integer |
Identyfikator rekordu systemu hołdu skojarzonego z potwierdzeniem. |
|
Identyfikator relacji
|
relationships_id | integer |
Identyfikator rekordu systemu relacji (jeśli ma wartość null, reprezentuje to samozwańcze potwierdzenie). |
|
Identyfikator litery
|
letter | integer |
Identyfikator litery. |
|
Kolejność
|
sequence | integer |
Hołd potwierdza sekwencję. |
NXTDataIntegrationApi.TributeAcknowledgeeCollection
Hołd potwierdza
| 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 NXTDataIntegrationApi.TributeAcknowledgee |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
NXTDataIntegrationApi.TributeCollection
Danin
| 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 NXTDataIntegrationApi.Tribute |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |