Almabase (előzetes verzió)

Az Almabase a világ legkedveltebb öregdiák-felügyeleti szoftvere, amely az öregdiák-központú programok létrehozására alkalmas, hogy növelje a részvételt, az adományozók bevonását és a vonzó online közösségek üzemeltetését.

Ez az összekötő a következő termékekben és régiókban érhető el:

Service	Class	Régiók
Copilot Studio	prémium	Az összes Power Automate-régió, kivéve a következőket:      - USA kormánya (GCC)      - Amerikai kormány (GCC High)      - A 21Vianet által üzemeltetett China Cloud      - Amerikai Védelmi Minisztérium (DoD)
Logikai alkalmazások	Standard	Az összes Logic Apps-régió , kivéve a következőket:      - Azure Government-régiók      - Azure China-régiók      - Amerikai Védelmi Minisztérium (DoD)
Power Alkalmazások	prémium	Az összes Power Apps-régió , kivéve a következőket:      - USA kormánya (GCC)      - Amerikai kormány (GCC High)      - A 21Vianet által üzemeltetett China Cloud      - Amerikai Védelmi Minisztérium (DoD)
Power Automate	prémium	Az összes Power Automate-régió, kivéve a következőket:      - USA kormánya (GCC)      - Amerikai kormány (GCC High)      - A 21Vianet által üzemeltetett China Cloud      - Amerikai Védelmi Minisztérium (DoD)

Érintkezés
Név	Almabase-támogatás
URL	https://docs.almabase.com
Email	help@almabase.com

Összekötő metaadatai
Kiadó	Almabase, Inc.
Webhely	https://almabase.com
Adatvédelmi irányelvek	https://www.almabase.com/ecloud-privacy-policy
Kategóriák	Értékesítés és CRM; Termelékenység

Az Almabase szoftvereszközöket és stratégiákat biztosít az oktatási intézmények számára, hogy olyan, öregdiákközpontú programokat építsenek ki, amelyek a nem működő öregdiákokat egy életre támogatóvá alakítják.

Ez az összekötő az Almabase API-k & webhookokra épül, és műveleteket biztosít az Almabase-ben található entitások kezeléséhez, beleértve a következőket:

• Rekord (összetevők)
• Ajándékok
• Events
• Engagement Touchpoints
• Forms
• Pénzalap
• Oldalak megadása
• Társközi adománygyűjtési kampányok
• és még sok más...

Előfeltételek

Az összekötő használatához

• Aktív Almabase-előfizetéssel kell rendelkeznie.
• Rendelkeznie kell a webhely-rendszergazdai szerepkörével.

Hitelesítő adatok lekérése

• Jelentkezzen be az Almabase által biztosított felügyeleti portálra.
• Navigáljon a API's & Tokens következőhöz Settings: .
• Kattintson a gombra Add Auth Token, és töltse ki a descriptionelemet, és állítsa be a jogkivonatot expiry date & time.
• Jegyezze fel a Workflow Access Token (a vágólapra másoláshoz kattintson a jogkivonatra).
• Használja az Workflow Access Token új kapcsolatot a Power Automate-ben.

Ismerkedés az összekötővel

Gyakori használati esetek

• Ha ajándék készül, küldjön személyre szabott üzenetet > ajándékutalványt.
• Ha egy előjegyzési tevékenységet rögzít a Slackben, a Gmailben vagy bármely más közösségi médiában, műveletekkel Create Custom Touchpoint vegye fel az előjegyzési tevékenységet az Almabase Engagement Studióba.
• Ha új e-mail-címet (elveszett öregdiákot) talál egy ajándékban, eseményregisztrációban vagy űrlapbeküldésben, adja hozzá ezt az e-mail-címet egy Almabase-rekordhoz, vagy a Raiser's Edge rendszereleméhez vagy egy Salesforce-partnerhez.
• Tervezzen kétirányú adatszinkronizálást az Almabase és a Blackbaud Raiser's Edge között.
• Tervezzen kétirányú adatszinkronizálást az Almabase és a Salesforce között.

Ismert problémák és korlátozások

• Az ajándék eseményindítók csak akkor működnek, ha az online fizetés az Almabase-en történik. A manuálisan hozzáadott ajándékok nem aktiválják a folyamatokat.

Kapcsolat létrehozása

Az összekötő a következő hitelesítési típusokat támogatja:

Alapértelmezett	A kapcsolat létrehozásának paraméterei.	Minden régió	Nem osztható meg

Alapértelmezett

Alkalmazható: Minden régió

A kapcsolat létrehozásának paraméterei.

Ez nem megosztható kapcsolat. Ha a power app meg van osztva egy másik felhasználóval, a rendszer kérni fogja, hogy hozzon létre új kapcsolatot.

Név	Típus	Description	Kötelező
Tartomány URL-je	karakterlánc	Adja meg az Almabase-tartomány URL-címét, például: https://your.domain.com	True
API-kulcs	securestring	A felhasználó API-kulcsa	True

Szabályozási korlátok

Name	Hívások	Megújítási időszak
API-hívások kapcsolatonként	100	60 másodperc

Műveletek

Adakozási oldal lekérése	Egy adott oldal adatait adja vissza.
Ajándék	Információt ad vissza egy ajándékról.
Ajándék frissítése	Ajándék frissítése
Ajándék létrehozása	Új ajándékot hoz létre.
Ajándékok listázása	Visszaadja az ajándékok listáját.
Alap frissítése	Egy alap frissítése.
Alap lekérése	Egy alap adatait adja vissza.
Alap létrehozása	Létrehoz egy új alapot.
Alapok listázása	A pénzalapok listáját adja vissza
Esemény frissítése	Esemény frissítése.
Esemény lekérése	Egy esemény adatait adja vissza.
Esemény létrehozása	Új eseményt hoz létre.
Események listázása	Az összes esemény listáját adja vissza.
Kapcsolattartó frissítése	Frissít egy partnert egy eseményen.
Kapcsolattartó hozzáadása	Partnert vesz fel egy eseménybe.
Kapcsolattartók listázása	Egy esemény összes kapcsolattartójának listáját adja vissza.
Oldalak listázása	Az adások listáját adja vissza.
Rekord e-mail-címeinek listázása	Egy rekord e-mail-címeinek listáját adja vissza.
Rekord e-mail-címének frissítése	Egy rekord e-mail-címének mezőinek frissítése
Rekord e-mail-címének lekérése	Egy rekord e-mail-címére vonatkozó adatokat ad vissza.
Rekord e-mail-címének létrehozása	Új e-mail-címet hoz létre egy rekordhoz.
Rekord e-mail-címének törlése	Rekord e-mail-címének törlése.
Rekord frissítése	Rekord frissítése.
Rekord lekérése	Egy rekord adatait adja vissza.
Rekord létrehozása	Új rekordot hoz létre.
Rekordok listázása	Rekordlistát ad vissza.
Touchpoint létrehozása	Küldjön egy új egyéni érintőpontot az Almabase-nek.
Űrlap beküldésének lekérése	Egy űrlap beküldésével kapcsolatos információkat ad vissza.
Űrlap elküldése	Új űrlapbeküldés létrehozása űrlaphoz
Űrlapok listázása	Űrlapok listájának lekérése.

Adakozási oldal lekérése

Műveletazonosító:

GetGivingPage

Egy adott oldal adatait adja vissza.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Oldalazonosító megadása	id	True	integer	A rendszer által létrehozott azonosító egy adott oldal egyedi azonosításához.
Fields	fields		array	A válasz mezőinek vesszővel tagolt listája.

Válaszok

Oldal megadása

Törzs

v1.GivingApi.GivingPageRead

Ajándék

Műveletazonosító:

GetGift

Információt ad vissza egy ajándékról.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Ajándékazonosító	id	True	integer	A rendszer által létrehozott azonosító egy ajándék egyedi azonosításához.
Fields	fields		array	A válasz mezőinek vesszővel tagolt listája.

Válaszok

Ajándék

Törzs

v1.GivingApi.GiftRead

Ajándék frissítése

Műveletazonosító:

UpdateGift

Ajándék frissítése

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Ajándékazonosító	id	True	integer	A rendszer által létrehozott azonosító egy ajándék egyedi azonosításához.
Kötegszám	batch_number		string	Az ajándék kötegszáma.
Donor címe: 1. sor	donor_address_line1		string	Az 1. címsor, amelyet a donor használ az ajándékhoz.
Donor címe: 2. sor	donor_address_line2		string	A 2. címsor, amelyet az adományozó használ az ajándékhoz.
Név: Város, Állam, Ország	name		string	A donor városa. Formátum: Városnév, Rövid államnév, Rövid országnév
Donor neve	donor_name		string	A donor teljes neve.
Donor telefonszáma	donor_phone_number		string	A donor által az ajándékhoz használt telefonszám.
Donor címe: Irányítószám	donor_zip_code		string	Az ajándékozó által az ajándékhoz használt cím irányítószáma.
Rejtve van a Ranglista elől?	exclude_from_leaderboard		boolean	Rejtve van a Ranglista elől?
Külső adatbázis azonosítója	external_database_id		string	A külső adatbázis által az ajándékhoz rendelt egyedi azonosító.
Megemlékezés üzenete	honor_message		string	Egy üzenet egy ajándék tisztelgésért.
Tribute előtag	honor_prefix		string	Egy ajándék emléke előtagja. Az elérhető lehetőségek a következők: in_honor_of, in_memory_of, in_support_of
Névtelen?	is_anonymous		boolean	Azt jelzi, hogy a donor kívánsága névtelen legyen más adományozók számára az ajándékhoz.
Megjegyzés:	note		string	A jegyzet szövege.
Egyéb alap neve	other_fund_name		string	Amikor az adományozó kiválaszt egy is_other_fund megjelölt alapot, egy egyéni alapnevet adnak hozzá az ajándék attribútumához.
Oldal megadása	id		integer	A rendszer által létrehozott azonosító egy adott oldal egyedi azonosításához.
azonosító	id		integer	A rendszer által létrehozott azonosító egy rekord egyedi azonosításához.
Mennyiség	amount	True	string	Az ajándék felosztásának összege.
Alap	id	True	integer	A rendszer által létrehozott azonosító egy alap egyedi azonosításához.

Válaszok

Ajándék

Törzs

v1.GivingApi.GiftRead

Ajándék létrehozása

Műveletazonosító:

CreateGift

Új ajándékot hoz létre.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Ajándék összege	amount	True	string	Az ajándék összege két tizedes törttel.
Kötegszám	batch_number		string	Az ajándék kötegszáma.
Ajándék dátuma	completed_at	True	date-time	Az a dátum, amikor az ajándék állapota befejezettként van megjelölve.
Valuta	currency	True	integer	A donor által az ajándékhoz használt pénznem.
Donor címe: 1. sor	donor_address_line1		string	Az 1. címsor, amelyet a donor használ az ajándékhoz.
Donor címe: 2. sor	donor_address_line2		string	A 2. címsor, amelyet az adományozó használ az ajándékhoz.
Név: Város, Állam, Ország	name		string	A donor városa. Formátum: Városnév, Rövid államnév, Rövid országnév
Donor e-mail	donor_email	True	email	Az ajándékozó által használt e-mail-azonosító.
Donor neve	donor_name	True	string	A donor teljes neve.
Donor telefonszáma	donor_phone_number		string	A donor által az ajándékhoz használt telefonszám.
Donor címe: Irányítószám	donor_zip_code		string	Az ajándékozó által az ajándékhoz használt cím irányítószáma.
Rejtve van a Ranglista elől?	exclude_from_leaderboard		boolean	Rejtve van a Ranglista elől?
Külső adatbázis azonosítója	external_database_id		string	A külső adatbázis által az ajándékhoz rendelt egyedi azonosító.
Megemlékezés üzenete	honor_message		string	Egy üzenet egy ajándék tisztelgésért.
Tribute előtag	honor_prefix		string	Egy ajándék emléke előtagja. Az elérhető lehetőségek a következők: in_honor_of, in_memory_of, in_support_of
Névtelen?	is_anonymous		boolean	Azt jelzi, hogy a donor kívánsága névtelen legyen más adományozók számára az ajándékhoz.
Fizetési mód	mode	True	string	Fizetési mód online vagy offline.
Megjegyzés:	note		string	A jegyzet szövege.
Egyéb alap neve	other_fund_name		string	Amikor az adományozó kiválaszt egy is_other_fund megjelölt alapot, egy egyéni alapnevet adnak hozzá az ajándék attribútumához.
Oldal megadása	id		integer	A rendszer által létrehozott azonosító egy adott oldal egyedi azonosításához.
azonosító	id		integer	A rendszer által létrehozott azonosító egy rekord egyedi azonosításához.
Mennyiség	amount	True	string	Az ajándék felosztásának összege.
Alap	id	True	integer	A rendszer által létrehozott azonosító egy alap egyedi azonosításához.
Státusz	status	True	string	Az ajándék állapota.

Válaszok

Ajándék

Törzs

v1.GivingApi.GiftRead

Ajándékok listázása

Műveletazonosító:

ListGifts

Visszaadja az ajándékok listáját.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Státusz	status	True	string	Az állapot alapján szűrheti az ajándékokat.
Oldal megadása	campaign		integer	A rendszer által létrehozott azonosító egy adott oldal egyedi azonosításához.
Szűrés ajándékcsoport-azonosító szerint	group_id		uuid	Rendszer által létrehozott azonosító egy ajándékcsoport vagy lista egyedi azonosításához.
Üres kötegszámnak kell lennie?	batch_number__isnull		boolean	Az ajándékok szűrése attól függően, hogy van-e kötegszámuk, vagy sem.
Üres külső adatbázis-azonosítóval kell rendelkeznie?	external_database_id__isnull		boolean	Az ajándékok szűrése annak alapján, hogy már rendelkezik külső adatbázis-azonosítóval vagy sem. MEGJEGYZÉS: A külső adatbázis-azonosítóval rendelkező ajándékok már le vannak küldve a külső adatbázisba.
Szűrés külső adatbázis-azonosító szerint	external_database_id		string	Ajándékok szűrése külső adatbázis-azonosító alapján.
Szűrés donor e-mail alapján	donor_email		string	Ajándékok szűrése donor e-mail-címe alapján
Keresés a következő szerint:	search		string	Keresse meg az ajándékokat név vagy e-mail-cím alapján.
Fields	fields		array	A válasz mezőinek vesszővel tagolt listája.
Oldalméret	page_size		integer	A visszaadni kívánt rekordok számát jelöli. Az alapértelmezett érték 10. A maximális érték 50.
Oldalszám	page		integer	Az oldalszámokat (eltolást) jelöli. Lapozáshoz.
Megrendelés a következő szerint:	ordering		string	Adja meg az ajándékok sorrendjét a válaszban. A "-" előtag csökkenő sorrendet jelöl, az előtag hiánya pedig növekvő sorrendben adja vissza az eredményeket.

Válaszok

Name	Elérési út	Típus	Description
Következő találatOK URL-címe	nextlink	uri	A következő oldal eredményhalmazának URL-címe. Lapozáshoz.
Korábbi találatok URL-címe	previouslink	uri	Az előző találatkészlet URL-címe. Lapozáshoz.
Összes ajándék	total	integer	Az adott szűrőkhöz tartozó összes ajándék
Ajándékok	value	array of v1.GivingApi.GiftRead	Az adott szűrőkhöz visszaadott ajándékok listája. Az eredmények lapszámozottak.

Alap frissítése

Műveletazonosító:

UpdateFund

Egy alap frissítése.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Alap azonosítója	id	True	integer	A rendszer által létrehozott azonosító egy alap egyedi azonosításához.
Külső adatbázis azonosítója	external_database_id		string	Az alaphoz a külső adatbázis által hozzárendelt egyedi azonosító. Például a Raiser Edge NXT rendszerrekord-azonosítója, a Salesforce objektumazonosítója
Az alapértelmezett alap?	is_default		boolean	Azt jelzi, hogy az összes felosztást társítja ehhez az alaphoz, ha nincs más alap definiálva az Átadás oldalon.
Más alap?	is_other_fund		boolean	Azt jelzi, hogy az alap adományozói egyéni alapnevet adtak.
Alap neve	name	True	string	Az alap neve

Válaszok

Az ajándék felosztásához kapcsolódó alap.

Alap

v1.GivingApi.FundRead

Alap lekérése

Műveletazonosító:

GetFund

Egy alap adatait adja vissza.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Alap azonosítója	id	True	integer	A rendszer által létrehozott azonosító egy alap egyedi azonosításához.
Fields	fields		array	A válasz mezőinek vesszővel tagolt listája.

Válaszok

Az ajándék felosztásához kapcsolódó alap.

Alap

v1.GivingApi.FundRead

Alap létrehozása

Műveletazonosító:

CreateFund

Létrehoz egy új alapot.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Külső adatbázis azonosítója	external_database_id		string	Az alaphoz a külső adatbázis által hozzárendelt egyedi azonosító. Például a Raiser Edge NXT rendszerrekord-azonosítója, a Salesforce objektumazonosítója
Az alapértelmezett alap?	is_default		boolean	Azt jelzi, hogy az összes felosztást társítja ehhez az alaphoz, ha nincs más alap definiálva az Átadás oldalon.
Más alap?	is_other_fund		boolean	Azt jelzi, hogy az alap adományozói egyéni alapnevet adtak.
Alap neve	name	True	string	Az alap neve

Válaszok

Az ajándék felosztásához kapcsolódó alap.

Alap

v1.GivingApi.FundRead

Alapok listázása

Műveletazonosító:

ListFunds

A pénzalapok listáját adja vissza

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Fields	fields		array	A válasz mezőinek vesszővel tagolt listája.

Válaszok

response

array of v1.GivingApi.FundRead

Esemény frissítése

Műveletazonosító:

UpdateEvent

Esemény frissítése.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Eseményazonosító	id	True	integer	Rendszer által létrehozott azonosító egy esemény egyedi azonosításához.
Description	description		string	Az esemény leírása
Befejezési idő	end_datetime		string	Az esemény befejezési ideje
Külső adatbázis azonosítója	external_database_id		string	A külső adatbázis által a rekordhoz hozzárendelt egyedi azonosító. Pl. System Record ID for Raiser Edge NXT, Contact Id for Salesforce
Külső regisztrációs URL-cím	external_registration_url		string	Az esemény regisztrációs URL-címe egy külső webhelyen
Név	name		string	Az esemény neve
Kezdési időpont	start_datetime		string	Az esemény kezdési időpontja
Timezone	timezone		string	Az esemény időzónája
Név	display_name		string	Város,Állam,Helyszín országa

Válaszok

Event

Törzs

v1.EventApi.EventRead

Esemény lekérése

Műveletazonosító:

GetEvent

Egy esemény adatait adja vissza.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Eseményazonosító	id	True	integer	Rendszer által létrehozott azonosító egy esemény egyedi azonosításához.
Fields	fields		array	A válasz mezőinek vesszővel tagolt listája.

Válaszok

Event

Törzs

v1.EventApi.EventRead

Esemény létrehozása

Műveletazonosító:

CreateEvent

Új eseményt hoz létre.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Description	description		string	Az esemény leírása
Befejezési idő	end_datetime		string	Az esemény befejezési ideje
Külső adatbázis azonosítója	external_database_id		string	A külső adatbázis által a rekordhoz hozzárendelt egyedi azonosító. Pl. System Record ID for Raiser Edge NXT, Contact Id for Salesforce
Külső regisztrációs URL-cím	external_registration_url		string	Az esemény regisztrációs URL-címe egy külső webhelyen
Név	name	True	string	Az esemény neve
Kezdési időpont	start_datetime		string	Az esemény kezdési időpontja
Timezone	timezone		string	Az esemény időzónája
Név	display_name		string	Város,Állam,Helyszín országa

Válaszok

Event

Törzs

v1.EventApi.EventRead

Események listázása

Műveletazonosító:

ListEvents

Az összes esemény listáját adja vissza.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Keresés külső adatbázis-azonosító szerint	external_database_id		string	Események keresése külső adatbázis-azonosító alapján.
Fields	fields		array	A válasz mezőinek vesszővel tagolt listája.

Válaszok

response

array of v1.EventApi.EventRead

Kapcsolattartó frissítése

Műveletazonosító:

UpdateEventContactPerson

Frissít egy partnert egy eseményen.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Eseményazonosító	id	True	integer	Rendszer által létrehozott azonosító egy esemény egyedi azonosításához.
Esemény kapcsolattartó-azonosítója	person_id	True	integer	A rendszer által létrehozott azonosító egyedileg azonosít egy kapcsolattartót egy eseményen.
Email	email		email	A kapcsolattartó e-mail-címe
Név	name		string	A kapcsolattartó neve
Telefonszám	phone_number		string	A kapcsolattartó telefonszáma

Válaszok

Esemény kapcsolattartója

Törzs

v1.EventApi.ContactPersonRead

Kapcsolattartó hozzáadása

Műveletazonosító:

AddEventContactPerson

Partnert vesz fel egy eseménybe.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Eseményazonosító	id	True	integer	Rendszer által létrehozott azonosító egy esemény egyedi azonosításához.
Email	email		email	A kapcsolattartó e-mail-címe
Név	name		string	A kapcsolattartó neve
Telefonszám	phone_number		string	A kapcsolattartó telefonszáma

Válaszok

Esemény kapcsolattartója

Törzs

v1.EventApi.ContactPersonRead

Kapcsolattartók listázása

Műveletazonosító:

ListEventContactPersons

Egy esemény összes kapcsolattartójának listáját adja vissza.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Eseményazonosító	id	True	integer	Rendszer által létrehozott azonosító egy esemény egyedi azonosításához.

Válaszok

response

array of v1.EventApi.ContactPersonRead

Oldalak listázása

Műveletazonosító:

ListGivingPages

Az adások listáját adja vissza.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Fields	fields		array	A válasz mezőinek vesszővel tagolt listája.

Válaszok

response

array of v1.GivingApi.GivingPageRead

Rekord e-mail-címeinek listázása

Műveletazonosító:

ListRecordEmailAddresses

Egy rekord e-mail-címeinek listáját adja vissza.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Rekordazonosító	record_id	True	integer	A rendszer által létrehozott azonosító egy rekord egyedi azonosításához.
Elsődleges?	is_primary		boolean	Elsődleges e-mail keresése.
Fields	fields		array	A válasz mezőinek vesszővel tagolt listája.
Oldalméret	page_size		integer	A visszaadni kívánt rekordok számát jelöli. Az alapértelmezett érték 10. A maximális érték 50.
Oldalszám	page		integer	Az oldalszámokat (eltolást) jelöli. Lapozáshoz.

Válaszok

Name	Elérési út	Típus	Description
Következő találatOK URL-címe	nextlink	uri	A következő oldal eredményhalmazának URL-címe. Lapozáshoz.
Korábbi találatok URL-címe	previouslink	uri	Az előző találatkészlet URL-címe. Lapozáshoz.
Összes e-mail-cím	total	integer	A megadott szűrők összes e-mail-címe
E-mail cím	value	array of v1.RecordApi.EmailAddressRead	A megadott szűrőkhöz visszaadott rekord e-mail-címének listája. Az eredmények lapszámozottak.

Rekord e-mail-címének frissítése

Műveletazonosító:

UpdateRecordEmailAddress

Egy rekord e-mail-címének mezőinek frissítése

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Rekordazonosító	record_id	True	integer	A rendszer által létrehozott azonosító egy rekord egyedi azonosításához.
E-mail-cím azonosítója	email_id	True	integer	A rendszer által létrehozott azonosító egy rekord e-mail-címének egyedi azonosításához.
Bejelentkezéshez használható?	is_login_email		boolean	Jelzi, hogy a felhasználó bejelentkezhet-e a platformra ezzel az e-mail-címmel.
Elsődleges?	is_primary		boolean	A rendszer által aktivált automatikus e-mailek küldéséhez elsődleges e-maileket használunk. Arra is használható, hogy tömeges e-mailt küldjön a profilnak. Kötelező, hogy csak egy e-mail legyen elsődlegesként beállítva.
Státusz	status		string	Az e-mail-cím állapota
Típus	type		string	Az e-mail típusa

Válaszok

E-mail cím

Törzs

v1.RecordApi.EmailAddressRead

Rekord e-mail-címének lekérése

Műveletazonosító:

GetRecordEmailAddress

Egy rekord e-mail-címére vonatkozó adatokat ad vissza.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Rekordazonosító	record_id	True	integer	A rendszer által létrehozott azonosító egy rekord egyedi azonosításához.
azonosító	email_id	True	integer	A rendszer által létrehozott azonosító egy rekord e-mail-címének egyedi azonosításához.

Válaszok

E-mail cím

Törzs

v1.RecordApi.EmailAddressRead

Rekord e-mail-címének létrehozása

Műveletazonosító:

CreateRecordEmailAddress

Új e-mail-címet hoz létre egy rekordhoz.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Rekordazonosító	record_id	True	integer	A rendszer által létrehozott azonosító egy rekord egyedi azonosításához.
Address	address		email	Az e-mail-cím
Bejelentkezéshez használható?	is_login_email		boolean	Jelzi, hogy a felhasználó bejelentkezhet-e a platformra ezzel az e-mail-címmel.
Elsődleges?	is_primary		boolean	A rendszer által aktivált automatikus e-mailek küldéséhez elsődleges e-maileket használunk. Arra is használható, hogy tömeges e-mailt küldjön a profilnak. Kötelező, hogy csak egy e-mail legyen elsődlegesként beállítva.
Forrás	source		string	A forrás jelzi, hogy az e-mail hogyan lesz hozzáadva az adatbázishoz.
Státusz	status		string	Az e-mail-cím állapota
Típus	type		string	Az e-mail típusa

Válaszok

E-mail cím

Törzs

v1.RecordApi.EmailAddressRead

Rekord e-mail-címének törlése

Műveletazonosító:

DeleteRecordEmailAddress

Rekord e-mail-címének törlése.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Rekordazonosító	record_id	True	integer	A rendszer által létrehozott azonosító egy rekord egyedi azonosításához.
azonosító	email_id	True	integer	A rendszer által létrehozott azonosító egy rekord e-mail-címének egyedi azonosításához.

Rekord frissítése

Műveletazonosító:

UpdateRecord

Rekord frissítése.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Rekordazonosító	id	True	integer	A rendszer által létrehozott azonosító egy rekord egyedi azonosításához.
Külső adatbázis azonosítója	external_database_id		string	A külső adatbázis által a rekordhoz hozzárendelt egyedi azonosító. Pl. System Record ID for Raiser Edge NXT, Contact Id for Salesforce
Külső adatbázis keresési azonosítója	external_database_lookup_id		string	A külső adatbázisban lévő rekord egyéni, felhasználó által definiált keresési azonosítója. pl. Rendszerelem azonosítója
Keresztnév	first_name		string	A rekord utóneve.
Vezetéknév	last_name		string	A rekord vezetékneve.

Válaszok

rekord

Törzs

v1.RecordApi.RecordRead

Rekord lekérése

Műveletazonosító:

GetRecord

Egy rekord adatait adja vissza.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Rekordazonosító	id	True	integer	A rendszer által létrehozott azonosító egy rekord egyedi azonosításához.
Fields	fields		array	A válasz mezőinek vesszővel tagolt listája.

Válaszok

rekord

Törzs

v1.RecordApi.RecordRead

Rekord létrehozása

Műveletazonosító:

CreateRecord

Új rekordot hoz létre.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
1. sor	line1	True	string	A cím 1. sora
2. sor	line2		string	A cím 2. sora
Név	name		string	Város,Állam,Hely országa
Adatvédelem	privacy		string	adatvédelem
Típus	type	True	string	A szám típusa
Irányítószám	zip_code		string	A cím irányítószáma
Születési dátum	date_of_birth		string	Születési dátum.
Elhunyt	deceased		boolean	Elhunyt.
Address	address		email	Az e-mail-cím
Bejelentkezéshez használható?	is_login_email		boolean	Jelzi, hogy a felhasználó bejelentkezhet-e a platformra ezzel az e-mail-címmel.
Elsődleges?	is_primary		boolean	A rendszer által aktivált automatikus e-mailek küldéséhez elsődleges e-maileket használunk. Arra is használható, hogy tömeges e-mailt küldjön a profilnak. Kötelező, hogy csak egy e-mail legyen elsődlegesként beállítva.
Forrás	source		string	A forrás jelzi, hogy az e-mail hogyan lesz hozzáadva az adatbázishoz.
Státusz	status		string	Az e-mail-cím állapota
Típus	type		string	Az e-mail típusa
Külső adatbázis azonosítója	external_database_id		string	A külső adatbázis által a rekordhoz hozzárendelt egyedi azonosító. Pl. System Record ID for Raiser Edge NXT, Contact Id for Salesforce
Külső adatbázis keresési azonosítója	external_database_lookup_id		string	A külső adatbázisban lévő rekord egyéni, felhasználó által definiált keresési azonosítója. pl. Rendszerelem azonosítója
Keresztnév	first_name	True	string	A rekord utóneve.
Vezetéknév	last_name	True	string	A rekord vezetékneve.
Középső név	middle_name		string	A rekord középső neve.
Szám	number	True	string	Szám
Adatvédelem	privacy		string	adatvédelem
Típus	type	True	string	A szám típusa

Válaszok

rekord

Törzs

v1.RecordApi.RecordRead

Rekordok listázása

Műveletazonosító:

ListRecords

Rekordlistát ad vissza.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Keresés név szerint	search		string	Rekordok keresése név szerint.
Keresés e-mail-cím alapján	email_addresses__address		string	Rekordok keresése e-mail-cím alapján.
Keresés külső adatbázis-azonosító szerint	external_database_id		string	Rekordok keresése külső adatbázis-azonosító alapján.
Fields	fields		array	A válasz mezőinek vesszővel tagolt listája.
Frissítés be- vagy után	updated_at__gte		date-time	Dátumon vagy után frissítve.
Létrehozás dátuma:	created_at__gte		date-time	Dátumon vagy után jön létre.
Oldalméret	page_size		integer	A visszaadni kívánt rekordok számát jelöli. Az alapértelmezett érték 10. A maximális érték 50.
Oldalszám	page		integer	Az oldalszámokat (eltolást) jelöli. Lapozáshoz.

Válaszok

Name	Elérési út	Típus	Description
Következő találatOK URL-címe	nextlink	uri	A következő oldal eredményhalmazának URL-címe. Lapozáshoz.
Korábbi találatok URL-címe	previouslink	uri	Az előző találatkészlet URL-címe. Lapozáshoz.
Összes rekord	total	integer	Az adott szűrők összes rekordja
Feljegyzések	value	array of v1.RecordApi.RecordRead	Az adott szűrőkhöz visszaadott rekord rekordjainak listája.

Touchpoint létrehozása

Műveletazonosító:

createTouchpointCustomObject

Küldjön egy új egyéni érintőpontot az Almabase-nek.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Műsor	touchpoint_program	True	integer	A típusokat touchpoint-programokkal szűri.
Email	email		email	A tevékenységhez használt e-mail-azonosító.
azonosító	id		integer	A rendszer által létrehozott azonosító egy rekord egyedi azonosításához.
Rögzítés:	recorded_at	True	date-time	A tevékenység időbélyege.
Típus	id	True	integer

Válaszok

Touchpoint-törzs új touchpoint létrehozásához

Törzs

v1.AlmasightsApi.TouchpointCustomObjectAdd

Űrlap beküldésének lekérése

Műveletazonosító:

GetFormEntry

Egy űrlap beküldésével kapcsolatos információkat ad vissza.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Form	form_id	True	integer	A rendszer által létrehozott azonosító egy űrlap egyedi azonosításához.
Válaszazonosító	entry_id	True	string	A rendszer által létrehozott azonosító egyedileg azonosítja az űrlapbeküldést.

Válaszok

Ennek a műveletnek a kimenetei dinamikusak.

Űrlap elküldése

Műveletazonosító:

CreateFormEntry

Új űrlapbeküldés létrehozása űrlaphoz

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Form	form_id	True	integer	A rendszer által létrehozott azonosító egy űrlap egyedi azonosításához.
body	body		dynamic	Új űrlapbeküldés létrehozása

Válaszok

Name	Elérési út	Típus	Description
Válaszazonosító	id	integer	A rendszer által létrehozott azonosító egyedileg azonosítja az űrlapbeküldést.

Űrlapok listázása

Műveletazonosító:

ListForms

Űrlapok listájának lekérése.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Fields	fields		array	A válasz mezőinek vesszővel tagolt listája.

Válaszok

response

array of v1.FormApi.FormRead

Triggerek

E-mail létrehozása, frissítése vagy törlésekor egy rekordon	Eseményindítók, ha új e-mail jön létre egy rekordon, vagy egy meglévő e-mail frissül vagy töröl egy rekordból.
Ha egy új ajándék sikeres, vagy egy online ajándék kifizetése sikertelen	Eseményindítók, ha egy donor sikeresen rögzít egy új ajándékot az ajándékozási oldalon, vagy az ajándék kifizetése sikertelen.
Rekord létrehozásakor vagy frissítésekor az Almabase-en	Eseményindítók, amikor új rekord jön létre az Almabase-en, vagy egy meglévő rekord frissül.
Űrlap elküldésekor vagy meglévő űrlapbeküldés frissítésekor	Eseményindítók egy űrlap elküldésekor vagy egy meglévő űrlap beküldésekor.

E-mail létrehozása, frissítése vagy törlésekor egy rekordon

Műveletazonosító:

EmailChangedWebhook

Eseményindítók, ha új e-mail jön létre egy rekordon, vagy egy meglévő e-mail frissül vagy töröl egy rekordból.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Mikor	events	True	string	A folyamatot aktiváló események listája.

Válaszok

Törzs

v1.RecordApi.EmailWebhookResponse

Ha egy új ajándék sikeres, vagy egy online ajándék kifizetése sikertelen

Műveletazonosító:

GiftSucceededOrFailedWebhook

Eseményindítók, ha egy donor sikeresen rögzít egy új ajándékot az ajándékozási oldalon, vagy az ajándék kifizetése sikertelen.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Mikor	events	True	string	A folyamatot aktiváló események listája.
Oldal megadása	object_id		integer	A rendszer által létrehozott azonosító egy adott oldal egyedi azonosításához.

Válaszok

Törzs

v1.GivingApi.GiftWebhookResponse

Rekord létrehozásakor vagy frissítésekor az Almabase-en

Műveletazonosító:

RecordChangedWebhook

Eseményindítók, amikor új rekord jön létre az Almabase-en, vagy egy meglévő rekord frissül.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Mikor	events	True	string	A folyamatot aktiváló események listája.

Válaszok

Törzs

v1.RecordApi.RecordWebhookResponse

Űrlap elküldésekor vagy meglévő űrlapbeküldés frissítésekor

Műveletazonosító:

FormEntryCreateOrUpdateWebhook

Eseményindítók egy űrlap elküldésekor vagy egy meglévő űrlap beküldésekor.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Mikor	events	True	string	A folyamatot aktiváló események listája.
Form	object_id	True	integer	A rendszer által létrehozott azonosító egy űrlap egyedi azonosításához.

Válaszok

Ennek a műveletnek a kimenetei dinamikusak.

Definíciók

v1. FormApi.FormRead

Form

Name	Elérési út	Típus	Description
azonosító	id	integer	A rendszer által létrehozott azonosító egy űrlap egyedi azonosításához.
Űrlap neve	title	string	Az űrlap neve

v1. GivingApi.GiftWebhookRecordRead

Rekord

Name	Elérési út	Típus	Description
Külső adatbázis azonosítója	external_database_id	string	A külső adatbázis által a rekordhoz hozzárendelt egyedi azonosító. Pl. System Record ID for Raiser Edge NXT, Contact Id for Salesforce
Keresztnév	first_name	string	A megfeleltetett rekord utóneve
azonosító	id	integer	A rendszer által létrehozott azonosító egy rekord egyedi azonosításához.
Regisztrálva van a donor az Almabase-en?	is_registered	boolean	Annak jelzése, hogy a leképezett rekord vagy donor regisztrálva van-e az Almabase-en
Vezetéknév	last_name	string	A megfeleltetett rekord vezetékneve

v1. GivingApi.GiftWebhookResponse

Name	Elérési út	Típus	Description
Mennyiség	data.amount	string	Az ajándék összege két tizedes törttel.
Date	data.completed_at	date-time	Az a dátum, amikor az ajándék állapota befejezettként van megjelölve.
Donor e-mail	data.email	email	Az ajándékozó által használt e-mail-azonosító.
Külső adatbázis azonosítója	data.external_database_id	string	A külső adatbázis által az ajándékhoz rendelt egyedi azonosító.
azonosító	data.id	integer	A rendszer által létrehozott azonosító egy ajándék egyedi azonosításához.
Új e-mail?	data.is_email_new	boolean	Jelzi, hogy a donor által megadott e-mail már létezik-e az Almabase-rekordokban.
séma	data.mapped_profile.schema	v1.GivingApi.GiftWebhookRecordRead	Rekord
Üzemmód	data.mode	string	Az ajándék módja.
Donor neve	data.name	string	A donor teljes neve.
azonosító	data.page.id	integer	A rendszer által létrehozott azonosító egy adott oldal egyedi azonosításához.
Oldalnév megadása	data.page.name	string	A társított ajándékozási oldal neve
Státusz	data.status	string	Az ajándék állapota.
Esemény aktiválva:	time	string	Az esemény ideje.
Esemény típusa	type	string	Az esemény típusa.

v1. GivingApi.LocationRead

A város, amit az adományozó használt az ajándékhoz.

Name	Elérési út	Típus	Description
City	city	string	A donor városa
Város rövid neve	city_short_name	string	A város rövid ábrázolása, pl. SF
Szélesség	coordinates.latitude	string	A hely szélessége
Hosszúság	coordinates.longitude	string	A hely hosszúsága
Country	country	string	A donor országa
Ország rövid neve	country_short_name	string	Az ország rövid reprezentációja, például az USA
Google Helyazonosító	gpid	string	A Google-tól beszerzett helyazonosító
Város, Állam, Ország	name	string	A donor városa. Formátum: Városnév, Rövid államnév, Rövid országnév
Állam	state	string	A donor állapota
Rövid állapot neve	state_short_name	string	Az állam rövid ábrázolása, pl. CA

v1. GivingApi.FormFieldRead

Űrlapmező

Name	Elérési út	Típus	Description
Érték	display_value	string	A válaszadók által megadott formázott érték. például a fájlfeltöltés neve.
Kérdés/űrlap mező neve	label	string	A kérdés/űrlap mező neve az űrlapon

v1. GivingApi.FundRead

Az ajándék felosztásához kapcsolódó alap.

Name	Elérési út	Típus	Description
Külső adatbázis azonosítója	external_database_id	string	Az alaphoz a külső adatbázis által hozzárendelt egyedi azonosító. Például a Raiser Edge NXT rendszerrekord-azonosítója, a Salesforce objektumazonosítója
azonosító	id	integer	A rendszer által létrehozott azonosító egy alap egyedi azonosításához.
Az alapértelmezett alap?	is_default	boolean	Azt jelzi, hogy az összes felosztást társítja ehhez az alaphoz, ha nincs más alap definiálva az Átadás oldalon.
Más alap?	is_other_fund	boolean	Azt jelzi, hogy az alap adományozói egyéni alapnevet adtak.
Név	name	string	Az alap neve

v1. GivingApi.GiftRead

Ajándék

Name	Elérési út	Típus	Description
Ajándék összege	amount	string	Az ajándék összege két tizedes törttel.
Kötegszám	batch_number	string	Az ajándék kötegszáma.
Ajándék dátuma	completed_at	date-time	Az a dátum, amikor az ajándék állapota befejezettként van megjelölve.
Valuta	currency	integer	A donor által az ajándékhoz használt pénznem.
Device	device	string	Azonosítsa az ajándék készítéséhez használt eszközt, például pc-t, mobilt vagy táblagépet.
Donor címe: 1. sor	donor_address_line1	string	Az 1. címsor, amelyet a donor használ az ajándékhoz.
Donor címe: 2. sor	donor_address_line2	string	A 2. címsor, amelyet az adományozó használ az ajándékhoz.
Donor címe: Hely	donor_city_place	v1.GivingApi.LocationRead	A város, amit az adományozó használt az ajándékhoz.
Donor e-mail	donor_email	email	Az ajándékozó által használt e-mail-azonosító.
Donor neve	donor_name	string	A donor teljes neve.
Donor telefonszáma	donor_phone_number	string	A donor által az ajándékhoz használt telefonszám.
Donor címe: Irányítószám	donor_zip_code	string	Az ajándékozó által az ajándékhoz használt cím irányítószáma.
Rejtve van a Ranglista elől?	exclude_from_leaderboard	boolean	Rejtve van a Ranglista elől?
Külső adatbázis azonosítója	external_database_id	string	A külső adatbázis által az ajándékhoz rendelt egyedi azonosító.
Megemlékezés üzenete	honor_message	string	Egy üzenet egy ajándék tisztelgésért.
Tribute előtag	honor_prefix	string	Egy ajándék emléke előtagja. Az elérhető lehetőségek a következők: in_honor_of, in_memory_of, in_support_of
azonosító	id	integer	A rendszer által létrehozott azonosító egy ajándék egyedi azonosításához.
Influencer	influencer	v1.GivingApi.InfluencerRead	A nyilvános megosztási hivatkozás és a privát irányítópult hivatkozása
Névtelen?	is_anonymous	boolean	Azt jelzi, hogy a donor kívánsága névtelen legyen más adományozók számára az ajándékhoz.
A donor fedezi a fizetési átjáró költségeit?	is_donor_covered_charges	boolean	Jelzi, hogy az adományozó úgy döntött-e, hogy fedezi a fizetési átjáró költségeit az ajándék készítésekor?
Az e-mail hozzáadva van egy Almabase-rekordhoz?	is_email_added_to_profile	boolean	Jelzi, hogy a donor által megadott e-mail hozzá van-e adva az Almabase rekordhoz (is_email_new állapotától függetlenül)
Új e-mail?	is_email_new	boolean	Jelzi, hogy a donor által megadott e-mail már létezik-e az Almabase-rekordokban.
Figyelmen kívül hagyja az Almabase-rekordra való leképezést?	is_profile_mapping_ignored	boolean	Azt jelzi, hogy a rekordleképezést figyelmen kívül kell-e hagyni.
Fizetési mód	mode	string	Fizetési mód online vagy offline.
Megjegyzés:	note	string	A jegyzet szövege.
Egyéb alap neve	other_fund_name	string	Amikor az adományozó kiválaszt egy is_other_fund megjelölt alapot, egy egyéni alapnevet adnak hozzá az ajándék attribútumához.
Oldal megadása	page	v1.GivingApi.GivingPageAssociatedWithGift	Az ajándékhoz társított ajándékozási oldal.
Fields	post_payment_form_entry.fields	array of v1.GivingApi.FormFieldRead
Válaszazonosító	post_payment_form_entry.id	integer	A rendszer által létrehozott azonosító egyedileg azonosítja az űrlapbeküldést.
Fields	pre_payment_form_entry.fields	array of v1.GivingApi.FormFieldRead
Válaszazonosító	pre_payment_form_entry.id	integer	A rendszer által létrehozott azonosító egyedileg azonosítja az űrlapbeküldést.
Leképezett rekord	profile	v1.GivingApi.RecordRead	Leképezett rekord az Almabase-en
Hivatkozó hivatkozás	referrer_link	string	A honlap hivatkozása, amely azonosítja a donor látogatásának forrását. Pl. Donor látogatott a Giving kampány a Facebook, Google, stb.
Visszatérítés összege	refund_amount	string	A donornak visszautalt összeg. Ha a teljes összeget visszautalják, az ajándék állapota a befejezés helyett visszatérítésre kerül.
Spárga	splits	array of v1.GivingApi.GiftSplitRead	Az ajándékhoz társított felosztások.
Státusz	status	string	Az ajándék állapota.
Online tranzakció	transaction	v1.GivingApi.TransactionRead	Az ajándékhoz társított online fizetési tranzakció.
UTM-kampány	utm_campaign	string	Kulcsszóelemzéshez használatos. utm_campaign egy adott termékfejlesztési vagy stratégiai kampány azonosítására. például annual_fund_2020
UTM Medium	utm_medium	string	utm_medium azonosítsa az olyan adathordozókat, mint az e-mail vagy a kattintásonkénti költség. pl. cpc
UTM-forrás	utm_source	string	utm_source a keresőmotor, a hírlevél neve vagy más forrás azonosítása. pl. Google

v1. GivingApi.GiftSplitRead

Ajándék felosztása

Name	Elérési út	Típus	Description
Mennyiség	amount	string	Az ajándék felosztásának összege.
Alap	fund	v1.GivingApi.FundRead	Az ajándék felosztásához kapcsolódó alap.
azonosító	id	integer	A rendszer által létrehozott azonosító egyedileg azonosítja az ajándék felosztását.

v1. GivingApi.GivingPageAssociatedWithGift

Az ajándékhoz társított ajándékozási oldal.

Name	Elérési út	Típus	Description
azonosító	id	integer	A rendszer által létrehozott azonosító egy adott oldal egyedi azonosításához.
Név	name	string	A társított adólap neve.

v1. GivingApi.GivingPageRead

Oldal megadása

Name	Elérési út	Típus	Description
azonosító	id	integer	A rendszer által létrehozott azonosító egy adott oldal egyedi azonosításához.
Név	name	string	Az adott oldal neve

v1. GivingApi.InfluencerRead

A nyilvános megosztási hivatkozás és a privát irányítópult hivatkozása

Name	Elérési út	Típus	Description
Privát befolyásoló irányítópultjának hivatkozása	dashboard_url	uri	Az adományozó privát irányítópultja az általuk befolyásolt oldallátogatások és ajándékok számának monitorozásához
Nyilvános megosztási hivatkozás	page_share_url	uri	A nyilvános linket, amely az oldal / kampány a donor nyomon követni a befolyást a látogatások, hogy Az oldal és az ajándékok.

v1. GivingApi.PaymentAccountRead

A tranzakcióhoz társított fizetési számla, például BBMS, Stripe, PayPal stb.

Name	Elérési út	Típus	Description
azonosító	id	integer	A rendszer által létrehozott azonosító egy fizetési fiók egyedi azonosításához.
Név	name	string	A fizetési számla neve.
Gateway	type	string	A fizetési átjáró neve.

v1. GivingApi.RecordRead

Leképezett rekord az Almabase-en

Name	Elérési út	Típus	Description
Külső adatbázis azonosítója	external_database_id	string	A külső adatbázis által a rekordhoz hozzárendelt egyedi azonosító. Pl. System Record ID for Raiser Edge NXT, Contact Id for Salesforce
Keresztnév	first_name	string	A megfeleltetett rekord utóneve
Teljes név	formatted_name	string	A megfeleltetett rekord teljes neve
azonosító	id	integer	A rendszer által létrehozott azonosító egy rekord egyedi azonosításához.
Regisztrálva van a donor az Almabase-en?	is_registered	boolean	Annak jelzése, hogy a leképezett rekord vagy donor regisztrálva van-e az Almabase-en
Vezetéknév	last_name	string	A megfeleltetett rekord vezetékneve
Kép URL-címe	present_picture	uri	A rekordkép URL-címe
Link	profile_url	uri	A rekordhivatkozás az Almabase-en

v1. GivingApi.TransactionRead

Az ajándékhoz társított online fizetési tranzakció.

Name	Elérési út	Típus	Description
Fizetési fiók	account	v1.GivingApi.PaymentAccountRead	A tranzakcióhoz társított fizetési számla, például BBMS, Stripe, PayPal stb.
Létrehozás időpontja:	created_at	date-time	A tranzakció létrehozásának időpontja.
Hiba oka	failure_reason	string	A fizetési átjáró által visszaadott tranzakciós hiba oka.
azonosító	id	uuid	A rendszer által létrehozott azonosító egy tranzakció egyedi azonosításához.
Státusz	status	integer	A tranzakció állapota. - 1 (Feldolgozatlan) - 2 (sikeres) - 3 (sikertelen) - 4 (függőben) - 5 (hiba) MEGJEGYZÉS: Ezek az állapotok a fizetési átjáró tranzakciójának állapotához vannak társítva
Fizetési átjáró referencia-azonosítója	transaction_id	string	A fizetési átjáró által a tranzakció azonosításához létrehozott egyedi azonosító. például a Blackbaud Merchant Services (BBMS) tranzakcióazonosítója vagy a stripe charge id, PayPal tranzakcióazonosító

v1. AlmasightsApi.RecordAddOrEdit

Rekord az Almabase-en.

Name	Elérési út	Típus	Description
azonosító	id	integer	A rendszer által létrehozott azonosító egy rekord egyedi azonosításához.

v1. AlmasightsApi.TouchpointCustomObjectAdd

Touchpoint-törzs új touchpoint létrehozásához

Name	Elérési út	Típus	Description
Email	email	email	A tevékenységhez használt e-mail-azonosító.
Rekord	mapped_profile	v1.AlmasightsApi.RecordAddOrEdit	Rekord az Almabase-en.
Rögzítés:	recorded_at	date-time	A tevékenység időbélyege.
Típus	touchpoint_type.id	integer

v1. RecordApi.LocationRead

A cím helye

Name	Elérési út	Típus	Description
City	city	string	A hely városneve
Country	country	string	A hely országneve
Szélesség	latitude	double	A hely szélessége
Hosszúság	longitude	double	A hely hosszúsága
Állam	state	string	A hely állapotneve

v1. RecordApi.AddressRead

Address

Name	Elérési út	Típus	Description
1. sor	line1	string	A cím 1. sora
2. sor	line2	string	A cím 2. sora
séma	location.schema	v1.RecordApi.LocationRead	A cím helye
Irányítószám	zipcode	string	A cím irányítószáma

v1. RecordApi.EmailWebhookRecordRead

Rekord

Name	Elérési út	Típus	Description
Külső adatbázis azonosítója	external_database_id	string	A külső adatbázis által a rekordhoz hozzárendelt egyedi azonosító. Pl. System Record ID for Raiser Edge NXT, Contact Id for Salesforce
Keresztnév	first_name	string	A megfeleltetett rekord utóneve
azonosító	id	integer	A rendszer által létrehozott azonosító egy rekord egyedi azonosításához.
Regisztrálva van a rekord az Almabase-en?	is_registered	boolean	Annak jelzése, hogy a megfeleltetett rekord regisztrálva van-e az Almabase-en
Vezetéknév	last_name	string	A megfeleltetett rekord vezetékneve

v1. RecordApi.EmailWebhookResponse

Name	Elérési út	Típus	Description
E-mail cím	data.address	email	Email cím.
azonosító	data.id	integer	Rendszer által létrehozott azonosító az e-mailek egyedi azonosításához.
Elsődleges	data.is_primary	boolean	Azt jelzi, hogy az e-mail elsődleges-e vagy sem.
séma	data.profile.schema	v1.RecordApi.EmailWebhookRecordRead	Rekord
E-mail típusa	data.type	string	Az e-mail-cím típusa (elsődleges, személyes, munkahelyi stb.).
Esemény aktiválva:	time	string	Az esemény ideje.
Esemény típusa	type	string	Az esemény típusa.

v1. RecordApi.RecordWebhookResponse

Name	Elérési út	Típus	Description
Affiliations	data.affiliations	array of string
Osztály éve	data.class_year	string	A rekord osztályéve
E-mail cím	data.email	email	Email cím.
Külső adatbázis azonosítója	data.external_database_id	string	A külső adatbázis által a rekordhoz hozzárendelt egyedi azonosító. Pl. System Record ID for Raiser Edge NXT, Contact Id for Salesforce
Keresztnév	data.first_name	string	A megfeleltetett rekord utóneve
séma	data.home_address.schema	v1.RecordApi.AddressRead	Address
azonosító	data.id	integer	A rendszer által létrehozott azonosító egy rekord egyedi azonosításához.
Vezetéknév	data.last_name	string	A megfeleltetett rekord vezetékneve
Tagság lejárati dátuma	data.membership_expiry_date	date-time	A rekord tagságának lejárati dátuma
Tagságtípus neve	data.membership_type_name	string	A rekord tagságtípusának neve
Mobilszám	data.mobile_number	string	A rekord mobilszáma
séma	data.office_address.schema	v1.RecordApi.AddressRead	Address
Office-telefonszám	data.office_phone_number	string	A rekord office-telefonszáma
Tartózkodási telefonszám	data.residence_phone_number	string	A rekord tartózkodási telefonszáma
Esemény aktiválva:	time	string	Az esemény ideje.
Esemény típusa	type	string	Az esemény típusa.

v1. RecordApi.EmailAddressRead

E-mail cím

Name	Elérési út	Típus	Description
Address	address	email	Az e-mail-cím
azonosító	id	integer	A rendszer által létrehozott azonosító egy rekord e-mail-címének egyedi azonosításához.
Aktív?	is_engaged	boolean	Azt jelzi, hogy egy tömeges e-mailre kattint vagy meg van-e nyitva, vagy a felhasználó válaszol egy-egy e-mailre
Bejelentkezéshez használható?	is_login_email	boolean	Jelzi, hogy a felhasználó bejelentkezhet-e a platformra ezzel az e-mail-címmel.
Elsődleges?	is_primary	boolean	A rendszer által aktivált automatikus e-mailek küldéséhez elsődleges e-maileket használunk. Arra is használható, hogy tömeges e-mailt küldjön a rekordnak. Kötelező, hogy csak egy e-mail legyen elsődlegesként beállítva.
A felhasználó ellenőrzi?	is_verified	boolean	Jelezze, hogy a felhasználó ellenőrizte-e, hogy az e-mail tulajdonosa-e.
adatforrás	source	string	A forrás jelzi, hogy az e-mail hogyan lesz hozzáadva az adatbázishoz.
állapot	status	string
Típus	type	string	Az e-mail típusa

v1. RecordApi.RecordRead

rekord

Name	Elérési út	Típus	Description
E-mail-címek	email_addresses	array of v1.RecordApi.EmailAddressRead	Profil e-mail-címeinek listája
Külső adatbázis azonosítója	external_database_id	string	A külső adatbázis által a rekordhoz hozzárendelt egyedi azonosító. Pl. System Record ID for Raiser Edge NXT, Contact Id for Salesforce
Keresztnév	first_name	string	A rekord utóneve.
Teljes név	formatted_name	string	A rekord teljes neve.
azonosító	id	integer	A rendszer által létrehozott azonosító egy rekord egyedi azonosításához.
Regisztrálva van az Almabase-en?	is_registered	boolean	Jelezze, hogy az Almabase-en regisztrált rekord vagy donor
Vezetéknév	last_name	string	A rekord vezetékneve.
Kép URL-címe	present_picture	uri	A rekordkép URL-címe
Link	record_url	uri	A rekordhivatkozás az Almabase-en

v1. EventApi.ContactPersonRead

Esemény kapcsolattartója

Name	Elérési út	Típus	Description
Email	email	email	A kapcsolattartó e-mail-címe
azonosító	id	integer	A rendszer által létrehozott azonosító egy kapcsolattartó egyedi azonosításához.
Név	name	string	A kapcsolattartó neve
Telefonszám	phone_number	string	A kapcsolattartó telefonszáma

v1. EventApi.EventRead

Event

Name	Elérési út	Típus	Description
Description	description	string	Az esemény leírása
Befejezési idő	end_datetime	string	Az esemény befejezési ideje
Külső adatbázis azonosítója	external_database_id	string	A külső adatbázis által a rekordhoz hozzárendelt egyedi azonosító. Pl. System Record ID for Raiser Edge NXT, Contact Id for Salesforce
Külső regisztrációs URL-cím	external_registration_url	string	Az esemény regisztrációs URL-címe egy külső webhelyen
azonosító	id	integer	Rendszer által létrehozott azonosító egy esemény egyedi azonosításához.
Név	name	string	Az esemény neve
Kezdési időpont	start_datetime	string	Az esemény kezdési időpontja
Timezone	timezone	string	Az esemény időzónája