Almabase (Preview)

Almabase je svět nejvíce milovaný alumni management software k vytváření alumni-orientovaných programů pro zvýšení účasti, dárců a hostování zapojení online komunit.

Tento konektor je dostupný v následujících produktech a oblastech:

Service	Class	Regions
Copilot Studio	Premium	Všechny oblasti Power Automate s výjimkou následujících:      – státní správa USA (GCC)      – státní správa USA (GCC High)      - China Cloud provozovaný společností 21Vianet      - Ministerstvo obrany USA (DoD)
Logic Apps	Standard	Všechny oblasti Logic Apps s výjimkou následujících:      – Oblasti Azure Government      – Oblasti Azure China      - Ministerstvo obrany USA (DoD)
Power Apps	Premium	Všechny oblasti Power Apps s výjimkou následujících:      – státní správa USA (GCC)      – státní správa USA (GCC High)      - China Cloud provozovaný společností 21Vianet      - Ministerstvo obrany USA (DoD)
Power Automate	Premium	Všechny oblasti Power Automate s výjimkou následujících:      – státní správa USA (GCC)      – státní správa USA (GCC High)      - China Cloud provozovaný společností 21Vianet      - Ministerstvo obrany USA (DoD)

Kontakt
Název	Podpora pro Almabase
URL	https://docs.almabase.com
Email	help@almabase.com

Metadata konektoru
Vydavatel	Almabase, Inc.
Internetová stránka	https://almabase.com
Zásady ochrany osobních údajů	https://www.almabase.com/ecloud-privacy-policy
Kategorie	Prodej a CRM; Produktivita

Almabase poskytuje softwarovým nástrojům a strategiím pro vzdělávací instituce k vytváření alumni-orientovaných programů, které promění nespravované alumni na podporu pro život.

Tento konektor je založený na rozhraních Almabase API a webhoocích a poskytuje operace, které pomáhají spravovat entity nalezené v Almabase, včetně těchto:

• Záznam (složky)
• Dary
• Events
• Dotykové body zapojení
• Forms
• Fondy
• Dávání stránek
• Peer to Peer Fundraising Kampaně
• a další...

Požadavky

Chcete-li použít tento konektor,

• Musíte mít aktivní předplatné Almabase.
• Musíte mít roli správce webu.

Jak získat přihlašovací údaje

• Přihlaste se k portálu pro správu, který poskytuje Almabase.
• Přejděte do API's & Tokens části Settings.
• Klikněte na Add Auth Tokena vyplňte descriptiona nastavte token expiry date & time.
• Poznamenejte si Workflow Access Token (kliknutím na token zkopírujte do schránky).
• Workflow Access Token Použijte při vytváření nového připojení v Power Automate.

Začínáme s konektorem

Běžné případy použití

• Když se dá dárku vytvořit, pošlete individuální zprávu a potvrzení o dárku.
• Když je aktivita zapojení zaznamenána ve Slacku, Gmailu nebo jiných sociálních médiích, přidejte aktivitu zapojení do Engagement Studia v Almabase pomocí Create Custom Touchpoint akce.
• Když se najde nová e-mailová adresa (ztracená alumni) v registraci daru nebo události nebo odeslání formuláře, přidejte tuto e-mailovou adresu do záznamu o Almabase nebo složky na okraji Raiseru nebo kontaktu v Salesforce.
• Navrhněte obousměrnou synchronizaci dat mezi Almabasem a Edgem Blackbaud Raiser.
• Návrh obousměrné synchronizace dat mezi Almabase a Salesforce

Známé problémy a omezení

• Dárkové aktivační události fungují pouze v případě, že online platba je provedena na Almabase. Ručně přidané dary by neaktivovaly toky.

Vytvoření připojení

Konektor podporuje následující typy ověřování:

výchozí	Parametry pro vytvoření připojení	Všechny oblasti	Nesdílitelné

Výchozí

Použitelné: Všechny oblasti

Parametry pro vytvoření připojení

Toto připojení není možné sdílet. Pokud se power app sdílí s jiným uživatelem, zobrazí se výzva k explicitní vytvoření nového připojení.

Název	Typ	Description	Povinné
Adresa URL domény	řetězec	Zadejte adresu URL domény Almabase, např. https://your.domain.com	Pravdivé
Klíč rozhraní API	securestring	Klíč rozhraní API uživatele	Pravdivé

Limity omezování

Name	Volání	Období obnovení
Volání rozhraní API na připojení	100	60 sekund

Akce

Aktualizace dárku	Aktualizuje dárek.
Aktualizace e-mailové adresy záznamu	Aktualizuje pole e-mailové adresy záznamu.
Aktualizace fondu	Aktualizuje fond.
Aktualizace kontaktní osoby	Aktualizuje kontaktní osobu na události.
Aktualizace události	Aktualizuje událost.
Aktualizace záznamu	Aktualizuje záznam.
Formuláře seznamu	Získejte seznam formulářů.
Odeslání formuláře	Vytvoří pro formulář odeslání nového formuláře.
Odstranění e-mailové adresy záznamu	Odstranění e-mailové adresy záznamu
Přidání kontaktní osoby	Přidá do události kontaktní osobu.
Seznam dárků	Vrátí seznam dárků.
Seznam kontaktních osob	Vrátí seznam všechkontaktních
Seznam se stránkami se seznamem	Vrátí seznam dávání stránek.
Seznam událostí	Vrátí seznam všech událostí.
Vytvoření dotykového bodu	Pošlete do Almabase nový vlastní touchpoint.
Vytvoření dárku	Vytvoří nový dárek.
Vytvoření e-mailové adresy pro záznam	Vytvoří novou e-mailovou adresu záznamu.
Vytvoření fondu	Vytvoří nový fond.
Vytvoření události	Vytvoří novou událost.
Vytvoření záznamu	Vytvoří nový záznam.
Výpis e-mailových adres záznamu	Vrátí seznam e-mailových adres pro záznam.
Výpis finančních prostředků	Vrátí seznam finančních prostředků.
Výpis záznamů	Vrátí seznam záznamů.
Získat dárek	Vrátí informace o daru.
Získání e-mailové adresy záznamu	Vrátí informace o e-mailové adrese záznamu.
Získání fondu	Vrátí informace o fondu.
Získání odeslání formuláře	Vrátí informace o odeslání formuláře.
Získání stránky pro dávání	Vrátí informace o stránce poskytující informace.
Získání události	Vrátí informace o události.
Získání záznamu	Vrátí informace o záznamu.

Aktualizace dárku

ID operace:

UpdateGift

Aktualizuje dárek.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Id dárku	id	True	integer	Systémem vygenerované ID pro jedinečnou identifikaci dárku.
Číslo dávky	batch_number		string	Číslo dávky daru.
Adresa dárce: řádek 1	donor_address_line1		string	Řádek adresy 1 používaný dárcem pro dárek.
Adresa dárce: řádek 2	donor_address_line2		string	Adresní řádek 2 používaný dárcem pro dárek.
Název: Město, Stát, Země	name		string	Město dárce. Formát: Název města, Krátký název státu, Krátký název země
Jméno dárce	donor_name		string	Jméno dárce.
Telefonní číslo dárce	donor_phone_number		string	Telefonní číslo použité dárcem pro dárek.
Adresa dárce: PSČ	donor_zip_code		string	PSČ adresy používané dárcem pro dárek.
Je tabulka výsledků skrytá?	exclude_from_leaderboard		boolean	Je tabulka výsledků skrytá?
ID externí databáze	external_database_id		string	Systém přiřadil jedinečné ID daru externí databází.
Pocta – zpráva	honor_message		string	A message for a gift hold.
Předpona pocty	honor_prefix		string	Předpona daru pocty. Dostupné možnosti jsou in_honor_of, in_memory_of, in_support_of
Je anonymní?	is_anonymous		boolean	Označuje, že přání dárců být anonymní pro ostatní dárci tohoto daru.
Poznámka:	note		string	Text poznámky.
Jiný název fondu	other_fund_name		string	Když dárci vybere fond, který je označený jako is_other_fund, přidá vlastní název fondu pro přiřazení daru.
Dávání stránky	id		integer	Systémem vygenerované ID pro jedinečnou identifikaci předávací stránky.
ID	id		integer	Systémem vygenerované ID pro jedinečnou identifikaci záznamu
Množství	amount	True	string	Množství daru rozdělení.
Fond	id	True	integer	Systémem vygenerované ID pro jedinečnou identifikaci fondu

Návraty

Dar

Body

v1.GivingApi.GiftRead

Aktualizace e-mailové adresy záznamu

ID operace:

UpdateRecordEmailAddress

Aktualizuje pole e-mailové adresy záznamu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID záznamu	record_id	True	integer	Systémem vygenerované ID pro jedinečnou identifikaci záznamu
ID e-mailové adresy	email_id	True	integer	Systémem vygenerované ID pro jedinečnou identifikaci e-mailové adresy záznamu.
Používáte pro přihlášení?	is_login_email		boolean	Určuje, jestli se uživatel může přihlásit k platformě pomocí této e-mailové adresy.
Je primární?	is_primary		boolean	Primární e-mail slouží k odesílání automatizovaných e-mailů aktivovaných systémem. Slouží také k odeslání hromadného e-mailu do profilu. Je povinné, že jako primární je nastavený jenom jeden e-mail.
Stav	status		string	Stav e-mailové adresy
Typ	type		string	Typ e-mailu

Návraty

E-mailová adresa

Body

v1.RecordApi.EmailAddressRead

Aktualizace fondu

ID operace:

UpdateFund

Aktualizuje fond.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID fondu	id	True	integer	Systémem vygenerované ID pro jedinečnou identifikaci fondu
ID externí databáze	external_database_id		string	Systém přiřazené jedinečné ID fondu externí databází. např. ID systémového záznamu pro Raiser Edge NXT, ID objektu pro Salesforce
Je výchozí fond?	is_default		boolean	Označuje, že se všechny rozdělení k tomuto fondu přidružují, pokud nejsou definovány žádné jiné prostředky na stránce Poskytování.
Je jiný fond?	is_other_fund		boolean	Označuje, že dárci tohoto fondu dali název vlastního fondu.
Název fondu	name	True	string	Název fondu

Návraty

Fond spojený s rozdělením daru.

Fond

v1.GivingApi.FundRead

Aktualizace kontaktní osoby

ID operace:

UpdateEventContactPerson

Aktualizuje kontaktní osobu na události.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID události	id	True	integer	Systémové vygenerované ID pro jedinečnou identifikaci události.
ID kontaktní osoby události	person_id	True	integer	Systémem vygenerované ID pro jedinečnou identifikaci kontaktní osoby na události.
Email	email		email	E-mail kontaktní osoby
Název	name		string	Jméno kontaktní osoby
Telefonní číslo	phone_number		string	Telefonní číslo kontaktní osoby

Návraty

Kontaktní osoba události

Body

v1.EventApi.ContactPersonRead

Aktualizace události

ID operace:

UpdateEvent

Aktualizuje událost.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID události	id	True	integer	Systémové vygenerované ID pro jedinečnou identifikaci události.
Description	description		string	Popis události
Koncový čas	end_datetime		string	Čas ukončení události
ID externí databáze	external_database_id		string	Externí databáze přiřadil jedinečné ID záznamu systému. např. ID záznamu systému pro Raiser Edge NXT, ID kontaktu pro Salesforce
Adresa URL externí registrace	external_registration_url		string	Adresa URL registrace události na externím webu
Název	name		string	Název události
Čas zahájení	start_datetime		string	Čas zahájení události
Timezone	timezone		string	Časové pásmo události
Název	display_name		string	Město,Stát,Země místa konání

Návraty

Event

Body

v1.EventApi.EventRead

Aktualizace záznamu

ID operace:

UpdateRecord

Aktualizuje záznam.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID záznamu	id	True	integer	Systémem vygenerované ID pro jedinečnou identifikaci záznamu
ID externí databáze	external_database_id		string	Externí databáze přiřadil jedinečné ID záznamu systému. např. ID záznamu systému pro Raiser Edge NXT, ID kontaktu pro Salesforce
ID vyhledávání externí databáze	external_database_lookup_id		string	Vlastní uživatelem definované ID vyhledávání pro záznam v externí databázi. např. ID součásti
Křestní jméno	first_name		string	Jméno záznamu.
Příjmení	last_name		string	Příjmení záznamu.

Návraty

záznam

Body

v1.RecordApi.RecordRead

Formuláře seznamu

ID operace:

ListForms

Získejte seznam formulářů.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Fields	fields		array	Čárka se seznamem polí v odpovědi.

Návraty

response

array of v1.FormApi.FormRead

Odeslání formuláře

ID operace:

CreateFormEntry

Vytvoří pro formulář odeslání nového formuláře.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Formulář	form_id	True	integer	Systémové vygenerované ID pro jedinečnou identifikaci formuláře
body	body		dynamic	Vytvoření nového odeslání formuláře

Návraty

Name	Cesta	Typ	Description
ID odpovědi	id	integer	Systémové vygenerované ID pro jedinečnou identifikaci odeslání formuláře

Odstranění e-mailové adresy záznamu

ID operace:

DeleteRecordEmailAddress

Odstranění e-mailové adresy záznamu

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID záznamu	record_id	True	integer	Systémem vygenerované ID pro jedinečnou identifikaci záznamu
ID	email_id	True	integer	Systémem vygenerované ID pro jedinečnou identifikaci e-mailové adresy záznamu.

Přidání kontaktní osoby

ID operace:

AddEventContactPerson

Přidá do události kontaktní osobu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID události	id	True	integer	Systémové vygenerované ID pro jedinečnou identifikaci události.
Email	email		email	E-mail kontaktní osoby
Název	name		string	Jméno kontaktní osoby
Telefonní číslo	phone_number		string	Telefonní číslo kontaktní osoby

Návraty

Kontaktní osoba události

Body

v1.EventApi.ContactPersonRead

Seznam dárků

ID operace:

ListGifts

Vrátí seznam dárků.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Stav	status	True	string	Vyfiltrujte dary podle stavu.
Dávání stránky	campaign		integer	Systémem vygenerované ID pro jedinečnou identifikaci předávací stránky.
Filtrovat podle ID dárkové skupiny	group_id		uuid	Systémem vygenerované ID pro jedinečnou identifikaci dárkové skupiny nebo seznamu
Mělo by být prázdné číslo dávky?	batch_number__isnull		boolean	Vyfiltrujte dary podle toho, že mají číslo dávky nebo ne.
Má být prázdné ID externí databáze?	external_database_id__isnull		boolean	Vyfiltrujte dary na základě toho, že už mají ID externí databáze nebo ne. POZNÁMKA: Dary, které mají ID externí databáze, jsou již vloženy do externí databáze.
Filtrovat podle ID externí databáze	external_database_id		string	Filtrování dárků na základě ID externí databáze
Filtrovat podle e-mailu dárců	donor_email		string	Filtrování dárků na základě e-mailové adresy dárce
Hledat podle	search		string	Vyhledejte dary podle jména nebo e-mailové adresy.
Fields	fields		array	Čárka se seznamem polí v odpovědi.
Velikost stránky	page_size		integer	Představuje počet záznamů, které se mají vrátit. Výchozí hodnota je 10. Maximum je 50.
Číslo stránky	page		integer	Představuje čísla stránek (posun). Pro použití se stránkováním.
Order by	ordering		string	Definujte pořadí darů v odpovědi. Předpona "-" představuje sestupné pořadí a absence předpony by vrátila výsledky ve vzestupném pořadí.

Návraty

Name	Cesta	Typ	Description
Adresa URL dalších výsledků	nextlink	uri	Adresa URL pro další sadu výsledků stránky Pro použití se stránkováním.
Adresa URL předchozích výsledků	previouslink	uri	Adresa URL pro předchozí sadu výsledků Pro použití se stránkováním.
Total Gifts	total	integer	Celkový počet dárků pro dané filtry
Dary	value	array of v1.GivingApi.GiftRead	Seznam dárků vrácených pro dané filtry Výsledky jsou stránkované.

Seznam kontaktních osob

ID operace:

ListEventContactPersons

Vrátí seznam všechkontaktních

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID události	id	True	integer	Systémové vygenerované ID pro jedinečnou identifikaci události.

Návraty

response

array of v1.EventApi.ContactPersonRead

Seznam se stránkami se seznamem

ID operace:

ListGivingPages

Vrátí seznam dávání stránek.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Fields	fields		array	Čárka se seznamem polí v odpovědi.

Návraty

response

array of v1.GivingApi.GivingPageRead

Seznam událostí

ID operace:

ListEvents

Vrátí seznam všech událostí.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Hledat podle ID externí databáze	external_database_id		string	Vyhledejte události podle ID externí databáze.
Fields	fields		array	Čárka se seznamem polí v odpovědi.

Návraty

response

array of v1.EventApi.EventRead

Vytvoření dotykového bodu

ID operace:

createTouchpointCustomObject

Pošlete do Almabase nový vlastní touchpoint.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Program	touchpoint_program	True	integer	Filtruje typy podle touchpointových programů.
Email	email		email	ID e-mailu použitého pro aktivitu
ID	id		integer	Systémem vygenerované ID pro jedinečnou identifikaci záznamu
Zaznamenáno na	recorded_at	True	date-time	Časové razítko aktivity.
Typ	id	True	integer

Návraty

Text touchpointu pro vytvoření nového touchpointu

Body

v1.AlmasightsApi.TouchpointCustomObjectAdd

Vytvoření dárku

ID operace:

CreateGift

Vytvoří nový dárek.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Částka daru	amount	True	string	Částka daru se dvěma desetinnými místy.
Číslo dávky	batch_number		string	Číslo dávky daru.
Datum dárku	completed_at	True	date-time	Datum, kdy je stav daru označen jako dokončený.
Měna	currency	True	integer	Měna použitá dárcem pro dar.
Adresa dárce: řádek 1	donor_address_line1		string	Řádek adresy 1 používaný dárcem pro dárek.
Adresa dárce: řádek 2	donor_address_line2		string	Adresní řádek 2 používaný dárcem pro dárek.
Název: Město, Stát, Země	name		string	Město dárce. Formát: Název města, Krátký název státu, Krátký název země
E-mail dárce	donor_email	True	email	E-mailové ID používané dárcem pro dárek.
Jméno dárce	donor_name	True	string	Jméno dárce.
Telefonní číslo dárce	donor_phone_number		string	Telefonní číslo použité dárcem pro dárek.
Adresa dárce: PSČ	donor_zip_code		string	PSČ adresy používané dárcem pro dárek.
Je tabulka výsledků skrytá?	exclude_from_leaderboard		boolean	Je tabulka výsledků skrytá?
ID externí databáze	external_database_id		string	Systém přiřadil jedinečné ID daru externí databází.
Pocta – zpráva	honor_message		string	A message for a gift hold.
Předpona pocty	honor_prefix		string	Předpona daru pocty. Dostupné možnosti jsou in_honor_of, in_memory_of, in_support_of
Je anonymní?	is_anonymous		boolean	Označuje, že přání dárců být anonymní pro ostatní dárci tohoto daru.
Způsob platby	mode	True	string	Režim platby, online nebo offline.
Poznámka:	note		string	Text poznámky.
Jiný název fondu	other_fund_name		string	Když dárci vybere fond, který je označený jako is_other_fund, přidá vlastní název fondu pro přiřazení daru.
Dávání stránky	id		integer	Systémem vygenerované ID pro jedinečnou identifikaci předávací stránky.
ID	id		integer	Systémem vygenerované ID pro jedinečnou identifikaci záznamu
Množství	amount	True	string	Množství daru rozdělení.
Fond	id	True	integer	Systémem vygenerované ID pro jedinečnou identifikaci fondu
Stav	status	True	string	Stav daru.

Návraty

Dar

Body

v1.GivingApi.GiftRead

Vytvoření e-mailové adresy pro záznam

ID operace:

CreateRecordEmailAddress

Vytvoří novou e-mailovou adresu záznamu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID záznamu	record_id	True	integer	Systémem vygenerované ID pro jedinečnou identifikaci záznamu
Address	address		email	E-mailová adresa
Používáte pro přihlášení?	is_login_email		boolean	Určuje, jestli se uživatel může přihlásit k platformě pomocí této e-mailové adresy.
Je primární?	is_primary		boolean	Primární e-mail slouží k odesílání automatizovaných e-mailů aktivovaných systémem. Slouží také k odeslání hromadného e-mailu do profilu. Je povinné, že jako primární je nastavený jenom jeden e-mail.
Zdroj	source		string	Zdroj označuje, jak se e-mail přidá do databáze.
Stav	status		string	Stav e-mailové adresy
Typ	type		string	Typ e-mailu

Návraty

E-mailová adresa

Body

v1.RecordApi.EmailAddressRead

Vytvoření fondu

ID operace:

CreateFund

Vytvoří nový fond.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID externí databáze	external_database_id		string	Systém přiřazené jedinečné ID fondu externí databází. např. ID systémového záznamu pro Raiser Edge NXT, ID objektu pro Salesforce
Je výchozí fond?	is_default		boolean	Označuje, že se všechny rozdělení k tomuto fondu přidružují, pokud nejsou definovány žádné jiné prostředky na stránce Poskytování.
Je jiný fond?	is_other_fund		boolean	Označuje, že dárci tohoto fondu dali název vlastního fondu.
Název fondu	name	True	string	Název fondu

Návraty

Fond spojený s rozdělením daru.

Fond

v1.GivingApi.FundRead

Vytvoření události

ID operace:

CreateEvent

Vytvoří novou událost.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Description	description		string	Popis události
Koncový čas	end_datetime		string	Čas ukončení události
ID externí databáze	external_database_id		string	Externí databáze přiřadil jedinečné ID záznamu systému. např. ID záznamu systému pro Raiser Edge NXT, ID kontaktu pro Salesforce
Adresa URL externí registrace	external_registration_url		string	Adresa URL registrace události na externím webu
Název	name	True	string	Název události
Čas zahájení	start_datetime		string	Čas zahájení události
Timezone	timezone		string	Časové pásmo události
Název	display_name		string	Město,Stát,Země místa konání

Návraty

Event

Body

v1.EventApi.EventRead

Vytvoření záznamu

ID operace:

CreateRecord

Vytvoří nový záznam.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Řádek 1	line1	True	string	Řádek 1 adresy
Řádek 2	line2		string	Řádek 2 adresy
Název	name		string	město, stát, země umístění
Ochrana osobních údajů	privacy		string	ochrana osobních údajů
Typ	type	True	string	Typ čísla
PSČ	zip_code		string	PSČ adresy
Datum narození	date_of_birth		string	Datum narození.
Zesnulý	deceased		boolean	Zesnulý.
Address	address		email	E-mailová adresa
Používáte pro přihlášení?	is_login_email		boolean	Určuje, jestli se uživatel může přihlásit k platformě pomocí této e-mailové adresy.
Je primární?	is_primary		boolean	Primární e-mail slouží k odesílání automatizovaných e-mailů aktivovaných systémem. Slouží také k odeslání hromadného e-mailu do profilu. Je povinné, že jako primární je nastavený jenom jeden e-mail.
Zdroj	source		string	Zdroj označuje, jak se e-mail přidá do databáze.
Stav	status		string	Stav e-mailové adresy
Typ	type		string	Typ e-mailu
ID externí databáze	external_database_id		string	Externí databáze přiřadil jedinečné ID záznamu systému. např. ID záznamu systému pro Raiser Edge NXT, ID kontaktu pro Salesforce
ID vyhledávání externí databáze	external_database_lookup_id		string	Vlastní uživatelem definované ID vyhledávání pro záznam v externí databázi. např. ID součásti
Křestní jméno	first_name	True	string	Jméno záznamu.
Příjmení	last_name	True	string	Příjmení záznamu.
Druhé jméno	middle_name		string	Prostřední název záznamu.
Number	number	True	string	Number
Ochrana osobních údajů	privacy		string	ochrana osobních údajů
Typ	type	True	string	Typ čísla

Návraty

záznam

Body

v1.RecordApi.RecordRead

Výpis e-mailových adres záznamu

ID operace:

ListRecordEmailAddresses

Vrátí seznam e-mailových adres pro záznam.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID záznamu	record_id	True	integer	Systémem vygenerované ID pro jedinečnou identifikaci záznamu
Je primární?	is_primary		boolean	Vyhledejte primární e-mail.
Fields	fields		array	Čárka se seznamem polí v odpovědi.
Velikost stránky	page_size		integer	Představuje počet záznamů, které se mají vrátit. Výchozí hodnota je 10. Maximum je 50.
Číslo stránky	page		integer	Představuje čísla stránek (posun). Pro použití se stránkováním.

Návraty

Name	Cesta	Typ	Description
Adresa URL dalších výsledků	nextlink	uri	Adresa URL pro další sadu výsledků stránky Pro použití se stránkováním.
Adresa URL předchozích výsledků	previouslink	uri	Adresa URL pro předchozí sadu výsledků Pro použití se stránkováním.
Celkový počet e-mailových adres	total	integer	Celkový počet e-mailových adres pro dané filtry
E-mailová adresa	value	array of v1.RecordApi.EmailAddressRead	Seznam e-mailových adres záznamu vráceného pro dané filtry Výsledky jsou stránkované.

Výpis finančních prostředků

ID operace:

ListFunds

Vrátí seznam finančních prostředků.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Fields	fields		array	Čárka se seznamem polí v odpovědi.

Návraty

response

array of v1.GivingApi.FundRead

Výpis záznamů

ID operace:

ListRecords

Vrátí seznam záznamů.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Hledat podle názvu	search		string	Vyhledejte záznamy podle názvu.
Hledat podle e-mailové adresy	email_addresses__address		string	Vyhledejte záznamy podle e-mailové adresy.
Hledat podle ID externí databáze	external_database_id		string	Vyhledejte záznamy podle ID externí databáze.
Fields	fields		array	Čárka se seznamem polí v odpovědi.
Aktualizováno dne nebo po	updated_at__gte		date-time	Aktualizováno dne nebo po datu.
Vytvořeno dne nebo po	created_at__gte		date-time	Vytvořeno dne nebo po datu.
Velikost stránky	page_size		integer	Představuje počet záznamů, které se mají vrátit. Výchozí hodnota je 10. Maximum je 50.
Číslo stránky	page		integer	Představuje čísla stránek (posun). Pro použití se stránkováním.

Návraty

Name	Cesta	Typ	Description
Adresa URL dalších výsledků	nextlink	uri	Adresa URL pro další sadu výsledků stránky Pro použití se stránkováním.
Adresa URL předchozích výsledků	previouslink	uri	Adresa URL pro předchozí sadu výsledků Pro použití se stránkováním.
Celkový počet záznamů	total	integer	Celkový počet záznamů pro dané filtry
Záznamy	value	array of v1.RecordApi.RecordRead	Seznam záznamů záznamu vráceného pro dané filtry

Získat dárek

ID operace:

GetGift

Vrátí informace o daru.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Id dárku	id	True	integer	Systémem vygenerované ID pro jedinečnou identifikaci dárku.
Fields	fields		array	Čárka se seznamem polí v odpovědi.

Návraty

Dar

Body

v1.GivingApi.GiftRead

Získání e-mailové adresy záznamu

ID operace:

GetRecordEmailAddress

Vrátí informace o e-mailové adrese záznamu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID záznamu	record_id	True	integer	Systémem vygenerované ID pro jedinečnou identifikaci záznamu
ID	email_id	True	integer	Systémem vygenerované ID pro jedinečnou identifikaci e-mailové adresy záznamu.

Návraty

E-mailová adresa

Body

v1.RecordApi.EmailAddressRead

Získání fondu

ID operace:

GetFund

Vrátí informace o fondu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID fondu	id	True	integer	Systémem vygenerované ID pro jedinečnou identifikaci fondu
Fields	fields		array	Čárka se seznamem polí v odpovědi.

Návraty

Fond spojený s rozdělením daru.

Fond

v1.GivingApi.FundRead

Získání odeslání formuláře

ID operace:

GetFormEntry

Vrátí informace o odeslání formuláře.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Formulář	form_id	True	integer	Systémové vygenerované ID pro jedinečnou identifikaci formuláře
ID odpovědi	entry_id	True	string	Systémové vygenerované ID pro jedinečnou identifikaci odeslání formuláře

Návraty

Výstupy této operace jsou dynamické.

Získání stránky pro dávání

ID operace:

GetGivingPage

Vrátí informace o stránce poskytující informace.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Dávání ID stránky	id	True	integer	Systémem vygenerované ID pro jedinečnou identifikaci předávací stránky.
Fields	fields		array	Čárka se seznamem polí v odpovědi.

Návraty

Dávání stránky

Body

v1.GivingApi.GivingPageRead

Získání události

ID operace:

GetEvent

Vrátí informace o události.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID události	id	True	integer	Systémem vygenerované ID pro jedinečnou identifikaci události
Fields	fields		array	Čárka se seznamem polí v odpovědi.

Návraty

Event

Body

v1.EventApi.EventRead

Získání záznamu

ID operace:

GetRecord

Vrátí informace o záznamu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID záznamu	id	True	integer	Systémem vygenerované ID pro jedinečnou identifikaci záznamu
Fields	fields		array	Čárka se seznamem polí v odpovědi.

Návraty

záznam

Body

v1.RecordApi.RecordRead

Aktivační události

Pokud je nový dárek úspěšný nebo online platba dárku selhala	Aktivuje se, když se na stránce s dárkem úspěšně zaznamená nový dárek nebo se nezdaří platba daru.
Při odeslání formuláře nebo aktualizaci existujícího odeslání formuláře	Aktivuje se při odeslání formuláře nebo aktualizaci existujícího odeslání formuláře.
Při vytvoření, aktualizaci nebo odstranění e-mailu u záznamu	Aktivuje se při vytvoření nového e-mailu u záznamu nebo při aktualizaci nebo odstranění existujícího e-mailu ze záznamu.
Při vytvoření nebo aktualizaci záznamu v Almabase	Aktivuje se při vytvoření nového záznamu v Almabase nebo při aktualizaci existujícího záznamu.

Pokud je nový dárek úspěšný nebo online platba dárku selhala

ID operace:

GiftSucceededOrFailedWebhook

Aktivuje se, když se na stránce s dárkem úspěšně zaznamená nový dárek nebo se nezdaří platba daru.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Když	events	True	string	Seznam událostí pro aktivaci toku
Dávání stránky	object_id		integer	Systémem vygenerované ID pro jedinečnou identifikaci předávací stránky.

Návraty

Body

v1.GivingApi.GiftWebhookResponse

Při odeslání formuláře nebo aktualizaci existujícího odeslání formuláře

ID operace:

FormEntryCreateOrUpdateWebhook

Aktivuje se při odeslání formuláře nebo aktualizaci existujícího odeslání formuláře.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Když	events	True	string	Seznam událostí pro aktivaci toku
Formulář	object_id	True	integer	Systémové vygenerované ID pro jedinečnou identifikaci formuláře

Návraty

Výstupy této operace jsou dynamické.

Při vytvoření, aktualizaci nebo odstranění e-mailu u záznamu

ID operace:

EmailChangedWebhook

Aktivuje se při vytvoření nového e-mailu u záznamu nebo při aktualizaci nebo odstranění existujícího e-mailu ze záznamu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Když	events	True	string	Seznam událostí pro aktivaci toku

Návraty

Body

v1.RecordApi.EmailWebhookResponse

Při vytvoření nebo aktualizaci záznamu v Almabase

ID operace:

RecordChangedWebhook

Aktivuje se při vytvoření nového záznamu v Almabase nebo při aktualizaci existujícího záznamu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Když	events	True	string	Seznam událostí pro aktivaci toku

Návraty

Body

v1.RecordApi.RecordWebhookResponse

Definice

v1. FormApi.FormRead

Formulář

Name	Cesta	Typ	Description
ID	id	integer	Systémové vygenerované ID pro jedinečnou identifikaci formuláře
Název formuláře	title	string	Název formuláře

v1. GivingApi.GiftWebhookRecordRead

Záznam

Name	Cesta	Typ	Description
ID externí databáze	external_database_id	string	Externí databáze přiřadil jedinečné ID záznamu systému. např. ID záznamu systému pro Raiser Edge NXT, ID kontaktu pro Salesforce
Křestní jméno	first_name	string	Jméno mapovaného záznamu
ID	id	integer	Systémem vygenerované ID pro jedinečnou identifikaci záznamu
Je dárci zaregistrovaní na Almabase?	is_registered	boolean	Uveďte, zda mapovaný záznam nebo dárci zaregistrovaný na Almabase
Příjmení	last_name	string	Příjmení mapovaného záznamu

v1. GivingApi.GiftWebhookResponse

Name	Cesta	Typ	Description
Množství	data.amount	string	Částka daru se dvěma desetinnými místy.
Date	data.completed_at	date-time	Datum, kdy je stav daru označen jako dokončený.
E-mail dárce	data.email	email	E-mailové ID používané dárcem pro dárek.
ID externí databáze	data.external_database_id	string	Systém přiřadil jedinečné ID daru externí databází.
ID	data.id	integer	Systémem vygenerované ID pro jedinečnou identifikaci dárku.
Je nový e-mail?	data.is_email_new	boolean	Označuje, jestli e-mail poskytnutý dárcem již existuje v záznamech Almabase.
schéma	data.mapped_profile.schema	v1.GivingApi.GiftWebhookRecordRead	Záznam
Mode	data.mode	string	Režim daru.
Jméno dárce	data.name	string	Jméno dárce.
ID	data.page.id	integer	Systémem vygenerované ID pro jedinečnou identifikaci předávací stránky.
Dávání názvu stránky	data.page.name	string	Název přidružené stránky pro dávání
Stav	data.status	string	Stav daru.
Událost aktivovaná na adrese	time	string	Čas události.
Typ události	type	string	Typ události.

v1. GivingApi.LocationRead

Město používané dárcem k daru.

Name	Cesta	Typ	Description
City	city	string	Město dárce
Krátký název města	city_short_name	string	Krátká reprezentace města, např. SF
Zeměpisná šířka	coordinates.latitude	string	Zeměpisná šířka umístění
Zeměpisná délka	coordinates.longitude	string	Zeměpisná délka umístění
Country	country	string	Země dárce
Krátký název země	country_short_name	string	Krátká reprezentace země, např. USA
ID místa Google	gpid	string	ID místa získané od Googlu
Město, Stát, Země	name	string	Město dárce. Formát: Název města, Krátký název státu, Krátký název země
Stát	state	string	Stav dárce
Krátký název státu	state_short_name	string	Krátká reprezentace státu, např. CA

v1. GivingApi.FormFieldRead

Pole formuláře

Name	Cesta	Typ	Description
Hodnota	display_value	string	Formátovaná hodnota zadaná respondenty. například název nahrání souboru.
Název pole otázky nebo formuláře	label	string	Název pole otázky nebo formuláře ve formuláři

v1. GivingApi.FundRead

Fond spojený s rozdělením daru.

Name	Cesta	Typ	Description
ID externí databáze	external_database_id	string	Systém přiřazené jedinečné ID fondu externí databází. např. ID systémového záznamu pro Raiser Edge NXT, ID objektu pro Salesforce
ID	id	integer	Systémem vygenerované ID pro jedinečnou identifikaci fondu
Je výchozí fond?	is_default	boolean	Označuje, že se všechny rozdělení k tomuto fondu přidružují, pokud nejsou definovány žádné jiné prostředky na stránce Poskytování.
Je jiný fond?	is_other_fund	boolean	Označuje, že dárci tohoto fondu dali název vlastního fondu.
Název	name	string	Název fondu

v1. GivingApi.GiftRead

Dar

Name	Cesta	Typ	Description
Částka daru	amount	string	Částka daru se dvěma desetinnými místy.
Číslo dávky	batch_number	string	Číslo dávky daru.
Datum dárku	completed_at	date-time	Datum, kdy je stav daru označen jako dokončený.
Měna	currency	integer	Měna použitá dárcem pro dar.
Zařízení	device	string	Identifikujte zařízení použité k vytvoření dárku, např. počítače, mobilního zařízení nebo tabletu.
Adresa dárce: řádek 1	donor_address_line1	string	Řádek adresy 1 používaný dárcem pro dárek.
Adresa dárce: řádek 2	donor_address_line2	string	Adresní řádek 2 používaný dárcem pro dárek.
Adresa dárce: Umístění	donor_city_place	v1.GivingApi.LocationRead	Město používané dárcem k daru.
E-mail dárce	donor_email	email	E-mailové ID používané dárcem pro dárek.
Jméno dárce	donor_name	string	Jméno dárce.
Telefonní číslo dárce	donor_phone_number	string	Telefonní číslo použité dárcem pro dárek.
Adresa dárce: PSČ	donor_zip_code	string	PSČ adresy používané dárcem pro dárek.
Je tabulka výsledků skrytá?	exclude_from_leaderboard	boolean	Je tabulka výsledků skrytá?
ID externí databáze	external_database_id	string	Systém přiřadil jedinečné ID daru externí databází.
Pocta – zpráva	honor_message	string	A message for a gift hold.
Předpona pocty	honor_prefix	string	Předpona daru pocty. Dostupné možnosti jsou in_honor_of, in_memory_of, in_support_of
ID	id	integer	Systémem vygenerované ID pro jedinečnou identifikaci dárku.
Ovlivňuje	influencer	v1.GivingApi.InfluencerRead	Odkaz na veřejnou sdílenou složku a odkaz na privátní řídicí panel
Je anonymní?	is_anonymous	boolean	Označuje, že přání dárců být anonymní pro ostatní dárci tohoto daru.
Pokryl dárci poplatky za platební bránu?	is_donor_covered_charges	boolean	Označuje, jestli se dárci rozhodli pokrýt poplatky za platební bránu při provádění tohoto daru?
Je e-mail přidán do záznamu v Almabase?	is_email_added_to_profile	boolean	Označuje, zda je e-mail poskytnutý dárcem přidán do záznamu Almabase (bez ohledu na is_email_new stav).
Je nový e-mail?	is_email_new	boolean	Označuje, jestli e-mail poskytnutý dárcem již existuje v záznamech Almabase.
Je mapování na záznam v Almabase ignorováno?	is_profile_mapping_ignored	boolean	Označuje, jestli se má mapování záznamů ignorovat.
Způsob platby	mode	string	Režim platby, online nebo offline.
Poznámka:	note	string	Text poznámky.
Jiný název fondu	other_fund_name	string	Když dárci vybere fond, který je označený jako is_other_fund, přidá vlastní název fondu pro přiřazení daru.
Dávání stránky	page	v1.GivingApi.GivingPageAssociatedWithGift	Stránka s dárkem spojená.
Fields	post_payment_form_entry.fields	array of v1.GivingApi.FormFieldRead
ID odpovědi	post_payment_form_entry.id	integer	Systémové vygenerované ID pro jedinečnou identifikaci odeslání formuláře
Fields	pre_payment_form_entry.fields	array of v1.GivingApi.FormFieldRead
ID odpovědi	pre_payment_form_entry.id	integer	Systémové vygenerované ID pro jedinečnou identifikaci odeslání formuláře
Mapovaný záznam	profile	v1.GivingApi.RecordRead	Mapped Record on Almabase
Odkaz referreru	referrer_link	string	Odkaz na web, který identifikuje zdroj toho, jak dárci navštíví. Např. Dárci navštívili kampaň Darování z Facebooku, Googlu atd.
Refundace – částka	refund_amount	string	Částka vrácená dárci. Pokud se vrátí celá částka, stav daru by se vrátil místo dokončení.
Rozděluje	splits	array of v1.GivingApi.GiftSplitRead	Rozdělení spojené s darem.
Stav	status	string	Stav daru.
Online transakce	transaction	v1.GivingApi.TransactionRead	Online platební transakce přidružená k dárku.
Kampaň UTM	utm_campaign	string	Používá se pro analýzu klíčových slov. utm_campaign identifikovat konkrétní propagační nebo strategickou kampaň produktu. např. annual_fund_2020
UTM Medium	utm_medium	string	utm_medium identifikovat médium, jako je e-mail nebo cena za kliknutí. např. cpc
Zdroj UTM	utm_source	string	utm_source identifikovat vyhledávací web, název bulletinu nebo jiný zdroj. např. Google

v1. GivingApi.GiftSplitRead

Dar Split

Name	Cesta	Typ	Description
Množství	amount	string	Množství daru rozdělení.
Fond	fund	v1.GivingApi.FundRead	Fond spojený s rozdělením daru.
ID	id	integer	Systémem vygenerované ID pro jedinečnou identifikaci dárkového rozdělení.

v1. GivingApi.GivingPageAssociatedWithGift

Stránka s dárkem spojená.

Name	Cesta	Typ	Description
ID	id	integer	Systémem vygenerované ID pro jedinečnou identifikaci předávací stránky.
Název	name	string	Název přidružené stránky Pro dávání.

v1. GivingApi.GivingPageRead

Dávání stránky

Name	Cesta	Typ	Description
ID	id	integer	Systémem vygenerované ID pro jedinečnou identifikaci předávací stránky.
Název	name	string	Název předávací stránky

v1. GivingApi.InfluencerRead

Odkaz na veřejnou sdílenou složku a odkaz na privátní řídicí panel

Name	Cesta	Typ	Description
Odkaz na řídicí panel privátních vlivových faktory	dashboard_url	uri	Soukromý řídicí panel dárce, který monitoruje počet návštěv stránek a dárků ovlivněných nimi
Odkaz na veřejnou sdílenou složku	page_share_url	uri	Veřejný odkaz na poskytování stránky/kampaně dárců, aby sledoval vliv na návštěvy na stránku Darování a dary.

v1. GivingApi.PaymentAccountRead

Platební účet přidružený k transakci, např. BBMS, Stripe, PayPal atd.

Name	Cesta	Typ	Description
ID	id	integer	Systémem vygenerované ID pro jedinečnou identifikaci platebního účtu
Název	name	string	Název platebního účtu.
Gateway	type	string	Název platební brány.

v1. GivingApi.RecordRead

Mapped Record on Almabase

Name	Cesta	Typ	Description
ID externí databáze	external_database_id	string	Externí databáze přiřadil jedinečné ID záznamu systému. např. ID záznamu systému pro Raiser Edge NXT, ID kontaktu pro Salesforce
Křestní jméno	first_name	string	Jméno mapovaného záznamu
Jméno a příjmení	formatted_name	string	Úplný název mapovaného záznamu
ID	id	integer	Systémem vygenerované ID pro jedinečnou identifikaci záznamu
Je dárci zaregistrovaní na Almabase?	is_registered	boolean	Uveďte, zda mapovaný záznam nebo dárci zaregistrovaný na Almabase
Příjmení	last_name	string	Příjmení mapovaného záznamu
Adresa URL obrázku	present_picture	uri	Adresa URL obrázku záznamu
Link	profile_url	uri	Odkaz na záznam na Almabase

v1. GivingApi.TransactionRead

Online platební transakce přidružená k dárku.

Name	Cesta	Typ	Description
Platební účet	account	v1.GivingApi.PaymentAccountRead	Platební účet přidružený k transakci, např. BBMS, Stripe, PayPal atd.
Vytvořeno v	created_at	date-time	Čas vytvoření této transakce.
Důvod selhání	failure_reason	string	Důvod selhání transakce vrácený platební bránou.
ID	id	uuid	Systémem vygenerované ID pro jedinečnou identifikaci transakce.
Stav	status	integer	Stav transakce. - 1 (nezpracované) – 2 (úspěšné) – 3 (neúspěšné) – 4 (Čeká na vyřízení) – 5 (Chyba) POZNÁMKA: Tento stav je přidružený ke stavu transakce platební bránou.
Referenční ID platební brány	transaction_id	string	Jedinečné ID vygenerované platební bránou k identifikaci transakce. např. ID transakce Blackbaud Merchant Services (BBMS) nebo ID poplatku za stripe PayPal ID transakce

v1. AlmasightsApi.RecordAddOrEdit

Záznam o Almabase.

Name	Cesta	Typ	Description
ID	id	integer	Systémem vygenerované ID pro jedinečnou identifikaci záznamu

v1. AlmasightsApi.TouchpointCustomObjectAdd

Text touchpointu pro vytvoření nového touchpointu

Name	Cesta	Typ	Description
Email	email	email	ID e-mailu použitého pro aktivitu
Záznam	mapped_profile	v1.AlmasightsApi.RecordAddOrEdit	Záznam o Almabase.
Zaznamenáno na	recorded_at	date-time	Časové razítko aktivity.
Typ	touchpoint_type.id	integer

v1. RecordApi.LocationRead

Umístění adresy

Name	Cesta	Typ	Description
City	city	string	Název města umístění
Country	country	string	Název země umístění
Zeměpisná šířka	latitude	double	Zeměpisná šířka umístění
Zeměpisná délka	longitude	double	Zeměpisná délka umístění
Stát	state	string	Název státu umístění

v1. RecordApi.AddressRead

Address

Name	Cesta	Typ	Description
Řádek1	line1	string	Řádek 1 adresy
Line2	line2	string	Řádek 2 adresy
schéma	location.schema	v1.RecordApi.LocationRead	Umístění adresy
PSČ	zipcode	string	PSČ adresy

v1. RecordApi.EmailWebhookRecordRead

Záznam

Name	Cesta	Typ	Description
ID externí databáze	external_database_id	string	Externí databáze přiřadil jedinečné ID záznamu systému. např. ID záznamu systému pro Raiser Edge NXT, ID kontaktu pro Salesforce
Křestní jméno	first_name	string	Jméno mapovaného záznamu
ID	id	integer	Systémem vygenerované ID pro jedinečnou identifikaci záznamu
Je záznam registrován na Almabase?	is_registered	boolean	Označuje, zda mapovaný záznam zaregistrovaný v Almabase
Příjmení	last_name	string	Příjmení mapovaného záznamu

v1. RecordApi.EmailWebhookResponse

Name	Cesta	Typ	Description
E-mailová adresa	data.address	email	E-mailová adresa.
ID	data.id	integer	Systémem vygenerované ID pro jedinečnou identifikaci e-mailu
Je primární	data.is_primary	boolean	Určuje, jestli je e-mail primární, nebo ne.
schéma	data.profile.schema	v1.RecordApi.EmailWebhookRecordRead	Záznam
Typ e-mailu	data.type	string	Typ e-mailové adresy (primární, osobní, pracovní atd.).
Událost aktivovaná na adrese	time	string	Čas události.
Typ události	type	string	Typ události.

v1. RecordApi.RecordWebhookResponse

Name	Cesta	Typ	Description
Přidružení	data.affiliations	array of string
Rok předmětu	data.class_year	string	Rok předmětu záznamu
E-mailová adresa	data.email	email	E-mailová adresa.
ID externí databáze	data.external_database_id	string	Externí databáze přiřadil jedinečné ID záznamu systému. např. ID záznamu systému pro Raiser Edge NXT, ID kontaktu pro Salesforce
Křestní jméno	data.first_name	string	Jméno mapovaného záznamu
schéma	data.home_address.schema	v1.RecordApi.AddressRead	Address
ID	data.id	integer	Systémem vygenerované ID pro jedinečnou identifikaci záznamu
Příjmení	data.last_name	string	Příjmení mapovaného záznamu
Datum vypršení platnosti členství	data.membership_expiry_date	date-time	Datum vypršení platnosti členství záznamu
Název typu členství	data.membership_type_name	string	Název typu členství záznamu
Číslo mobilního zařízení	data.mobile_number	string	Číslo mobilního záznamu
schéma	data.office_address.schema	v1.RecordApi.AddressRead	Address
Telefonní číslo kanceláře	data.office_phone_number	string	Telefonní číslo kanceláře záznamu
Telefonní číslo rezidence	data.residence_phone_number	string	Telefonní číslo bydliště záznamu
Událost aktivovaná na adrese	time	string	Čas události.
Typ události	type	string	Typ události.

v1. RecordApi.EmailAddressRead

E-mailová adresa

Name	Cesta	Typ	Description
Address	address	email	E-mailová adresa
ID	id	integer	Systémem vygenerované ID pro jedinečnou identifikaci e-mailové adresy záznamu.
Je zasnoubeno?	is_engaged	boolean	Označuje, jestli je hromadný e-mail kliknout nebo otevřít, nebo uživatel odpoví na jeden e-mail.
Používáte pro přihlášení?	is_login_email	boolean	Určuje, jestli se uživatel může přihlásit k platformě pomocí této e-mailové adresy.
Je primární?	is_primary	boolean	Primární e-mail slouží k odesílání automatizovaných e-mailů aktivovaných systémem. Slouží také k odeslání hromadného e-mailu do záznamu. Je povinné, že jako primární je nastavený jenom jeden e-mail.
Ověřuje se uživatel?	is_verified	boolean	Uveďte, jestli uživatel ověřil, že e-mail vlastní.
odeslat k provedení	source	string	Zdroj označuje, jak se e-mail přidá do databáze.
stav	status	string
Typ	type	string	Typ e-mailu

v1. RecordApi.RecordRead

záznam

Name	Cesta	Typ	Description
E-mailové adresy	email_addresses	array of v1.RecordApi.EmailAddressRead	Seznam e-mailových adres profilu
ID externí databáze	external_database_id	string	Externí databáze přiřadil jedinečné ID záznamu systému. např. ID záznamu systému pro Raiser Edge NXT, ID kontaktu pro Salesforce
Křestní jméno	first_name	string	Jméno záznamu.
Jméno a příjmení	formatted_name	string	Úplný název záznamu.
ID	id	integer	Systémem vygenerované ID pro jedinečnou identifikaci záznamu
Je zaregistrovaný v Almabase?	is_registered	boolean	Uveďte, zda záznam nebo dárci zaregistrovaný na Almabase
Příjmení	last_name	string	Příjmení záznamu.
Adresa URL obrázku	present_picture	uri	Adresa URL obrázku záznamu
Link	record_url	uri	Odkaz na záznam na Almabase

v1. EventApi.ContactPersonRead

Kontaktní osoba události

Name	Cesta	Typ	Description
Email	email	email	E-mail kontaktní osoby
ID	id	integer	Systémem vygenerované ID pro jedinečnou identifikaci kontaktní osoby.
Název	name	string	Jméno kontaktní osoby
Telefonní číslo	phone_number	string	Telefonní číslo kontaktní osoby

v1. EventApi.EventRead

Event

Name	Cesta	Typ	Description
Description	description	string	Popis události
Koncový čas	end_datetime	string	Čas ukončení události
ID externí databáze	external_database_id	string	Externí databáze přiřadil jedinečné ID záznamu systému. např. ID záznamu systému pro Raiser Edge NXT, ID kontaktu pro Salesforce
Adresa URL externí registrace	external_registration_url	string	Adresa URL registrace události na externím webu
ID	id	integer	Systémové vygenerované ID pro jedinečnou identifikaci události.
Název	name	string	Název události
Čas zahájení	start_datetime	string	Čas zahájení události
Timezone	timezone	string	Časové pásmo události