Almabase (Önizleme)
Almabase, katılımı, bağışçı katılımını artırmak ve ilgi çekici çevrimiçi topluluklara ev sahipliği yapmak için mezun merkezli programlar oluşturmaya yönelik dünyanın en sevilen mezun yönetim yazılımıdır.
Bu bağlayıcı aşağıdaki ürün ve bölgelerde kullanılabilir:
| Hizmet | Class | Bölgeler |
|---|---|---|
| Copilot Studio | Premium | Aşağıdakiler dışında tüm Power Automate bölgeleri : - ABD Kamu (GCC) - US Government (GCC High) - 21Vianet tarafından işletilen Çin Bulutu - ABD Savunma Bakanlığı (DoD) |
| Logic Apps | Standart | Aşağıdakiler dışında tüm Logic Apps bölgeleri : - Azure Kamu bölgeleri - Azure Çin bölgeleri - ABD Savunma Bakanlığı (DoD) |
| Power Apps | Premium | Aşağıdakiler dışında tüm Power Apps bölgeleri : - ABD Kamu (GCC) - US Government (GCC High) - 21Vianet tarafından işletilen Çin Bulutu - ABD Savunma Bakanlığı (DoD) |
| Power Automate | Premium | Aşağıdakiler dışında tüm Power Automate bölgeleri : - ABD Kamu (GCC) - US Government (GCC High) - 21Vianet tarafından işletilen Çin Bulutu - ABD Savunma Bakanlığı (DoD) |
| İletişim | |
|---|---|
| İsim | Almabase Desteği |
| URL | https://docs.almabase.com |
| E-posta | help@almabase.com |
| Bağlayıcı Meta Verileri | |
|---|---|
| Publisher | Almabase, Inc. |
| Web sitesi | https://almabase.com |
| Gizlilik ilkesi | https://www.almabase.com/ecloud-privacy-policy |
| Kategoriler | Satış ve CRM; Verimli -lik |
Almabase , eğitim kurumları için eğitim kurumlarına, eğitimsiz mezunları yaşam için destekçilere dönüştüren mezun merkezli programlar oluşturmak için yazılım araçları ve stratejileri sağlar.
Bu bağlayıcı Almabase API'leri ve Web kancaları üzerine kurulmuştur ve Almabase'de bulunan varlıkları yönetmeye yardımcı olmak için aşağıdakiler dahil olmak üzere işlemler sağlar:
- Kayıt (Bileşenler)
- Hediye
- Events
- Görevlendirme Dokunma Noktaları
- Formlar
- Fon
- Sayfaları Verme
- Eşler Arası Bağış Toplama Kampanyaları
- ve daha fazlası...
Önkoşullar
Bu bağlayıcıyı kullanmak için
- Etkin bir Almabase Aboneliğiniz olmalıdır.
- Site yöneticisi rolüne sahip olmanız gerekir.
Kimlik bilgilerini alma
- Almabase tarafından sağlanan Yönetici Portalınızda oturum açın.
- altında
SettingsadresineAPI's & Tokensgidin. - öğesine
Add Auth Tokentıklayın ve öğesini doldurundescriptionve belirteciexpiry date & timeayarlayın. - (panoya
Workflow Access Tokenkopyalamak için belirteci tıklatın) not edin. - Power Automate'te yeni bağlantı oluştururken öğesini
Workflow Access Tokenkullanın.
Bağlayıcınızı kullanmaya başlama
Yaygın Kullanım örnekleri
- Bir hediye yapıldığında kişiselleştirilmiş bir ileti ve hediye makbuzu gönderin.
- Slack, Gmail veya başka bir sosyal medyada bir görevlendirme etkinliği kaydedildiğinde, eylem kullanarak
Create Custom Touchpointgörevlendirme etkinliğini Almabase'de Engagement Studio'ya ekleyin. - Hediyede veya etkinlik kaydında veya form gönderiminde yeni bir e-posta adresi (kayıp mezunlar) bulunduğunda, bu e-posta adresini Almabase'deki bir kayda veya Yükseltici'nin Edge'deki Bir Temsilcisine ya da Salesforce'taki bir Kişi'ye ekleyin.
- Almabase ile Blackbaud Raiser Edge arasında çift yönlü veri eşitlemesi tasarla.
- Almabase ile Salesforce arasında çift yönlü veri eşitlemesi tasarlama.
Bilinen sorunlar ve sınırlamalar
- Hediye tetikleyicileri yalnızca Almabase'de çevrimiçi ödeme yapıldığında çalışır. El ile eklenen Hediyeler akışları tetiklemez.
Bağlantı oluşturma
Bağlayıcı aşağıdaki kimlik doğrulama türlerini destekler:
| Varsayılan | Bağlantı oluşturmak için parametreler. | Tüm bölgeler | Paylaşılamaz |
Temerrüt
Geçerli: Tüm bölgeler
Bağlantı oluşturmak için parametreler.
Bu, paylaşılabilir bir bağlantı değildir. Power app başka bir kullanıcıyla paylaşılıyorsa, başka bir kullanıcıdan açıkça yeni bağlantı oluşturması istenir.
| İsim | Türü | Description | Gerekli |
|---|---|---|---|
| Etki alanı URL'si | String | Almabase etki alanı url'nizi belirtin; örneğin https://your.domain.com | Doğru |
| API Anahtarı | securestring | Kullanıcının API Anahtarı | Doğru |
Azaltma Sınırları
| Name | Çağrılar | Yenileme Dönemi |
|---|---|---|
| Bağlantı başına API çağrıları | 100 | 60 saniye |
Eylemler
| Bir fon alın |
Bir fon hakkındaki bilgileri döndürür. |
| Dokunmatik nokta oluşturma |
Almabase'e yeni bir özel dokunma noktası gönderin. |
| Etkinlik oluşturma |
Yeni bir olay oluşturur. |
| Etkinlikleri Listele |
Tüm olayların listesini döndürür. |
| Fon güncelleştirme |
Bir fonu güncelleştirir. |
| Fon oluşturma |
Yeni bir fon oluşturur. |
| Fonları listeleme |
Fon listesini verir |
| Form gönderme |
Form için yeni form gönderimi oluşturur |
| Formları listeleme |
Form listesini alın. |
| Formun gönderimini alma |
Form gönderimi hakkındaki bilgileri döndürür. |
| Hediye alın |
Hediye hakkındaki bilgileri döndürür. |
| Hediye oluşturma |
Yeni bir hediye oluşturur. |
| Hediyeleri listeleme |
Hediye listesini döndürür. |
| Hediyeyi güncelleştirme |
Hediyeyi güncelleştirir |
| İlgili Kişileri Listele |
Bir olaydaki tüm ilgili kişilerin listesini döndürür. |
| Kaydı güncelleştirme |
Kaydı güncelleştirir. |
| Kaydın e-posta adresini alma |
Kaydın e-posta adresi hakkındaki bilgileri döndürür. |
| Kaydın e-posta adresini güncelleştirme |
Alanları bir kaydın e-posta adresini güncelleştirir |
| Kaydın e-posta adresini silme |
Kaydın e-posta adresini silin. |
| Kaydın e-posta adreslerini listeleme |
Kaydın e-posta adreslerinin listesini döndürür. |
| Kayıt alma |
Kayıt hakkındaki bilgileri döndürür. |
| Kayıt için e-posta adresi oluşturma |
Kayıt için yeni bir e-posta adresi oluşturur. |
| Kayıt oluşturma |
Yeni bir kayıt oluşturur. |
| Kayıtları listeleme |
Kayıtların listesini döndürür. |
| Kişi ekleme |
Bir etkinliğe kişi ekler. |
| Kişi kişisini güncelleştirme |
Bir etkinlikte ilgili kişiyi güncelleştirir. |
| Olay alma |
Bir olay hakkındaki bilgileri döndürür. |
| Olayı güncelleştirme |
Bir olayı güncelleştirir. |
| Veren sayfaları listeleme |
Veren sayfaların listesini döndürür. |
| Verme sayfası alma |
Veren sayfa hakkındaki bilgileri döndürür. |
Bir fon alın
Bir fon hakkındaki bilgileri döndürür.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Fon Kimliği
|
id | True | integer |
Bir fonu benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
|
Fields
|
fields | array |
Yanıttaki alanların virgülle ayrılmış listesi. |
Döndürülenler
Hediye bölmesiyle ilişkili fon.
Dokunmatik nokta oluşturma
Almabase'e yeni bir özel dokunma noktası gönderin.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Program
|
touchpoint_program | True | integer |
Türleri dokunmatik nokta programlarına göre filtreler. |
|
E-posta
|
Etkinlik için kullanılan e-posta kimliği. |
|||
|
Kimlik
|
id | integer |
Bir kaydı benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
|
|
Kayıt Tarihi:
|
recorded_at | True | date-time |
Etkinliğin zaman damgası. |
|
Türü
|
id | True | integer |
Döndürülenler
Yeni bir dokunma noktası oluşturmak için dokunmatik nokta gövdesi
Etkinlik oluşturma
Yeni bir olay oluşturur.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Description
|
description | string |
Olayın açıklaması |
|
|
Bitiş Saati
|
end_datetime | string |
Olayın bitiş saati |
|
|
Dış Veritabanı Kimliği
|
external_database_id | string |
Dış veritabanı tarafından kayıt için sistem tarafından atanan benzersiz kimlik. Örneğin Raiser Edge NXT için Sistem Kayıt Kimliği, Salesforce için Kişi Kimliği |
|
|
Dış Kayıt Url'si
|
external_registration_url | string |
Dış web sitesindeki etkinliğin kayıt url'si |
|
|
İsim
|
name | True | string |
Etkinliğin adı |
|
Başlangıç Saati
|
start_datetime | string |
Olayın başlangıç saati |
|
|
Timezone
|
timezone | string |
Olayın saat dilimi |
|
|
İsim
|
display_name | string |
City,State,Country of the Venue |
Döndürülenler
Event
Etkinlikleri Listele
Tüm olayların listesini döndürür.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Dış Veritabanı Kimliğine Göre Ara
|
external_database_id | string |
Dış veritabanı kimliğine göre olayları arayın. |
|
|
Fields
|
fields | array |
Yanıttaki alanların virgülle ayrılmış listesi. |
Döndürülenler
- response
- array of v1.EventApi.EventRead
Fon güncelleştirme
Bir fonu güncelleştirir.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Fon Kimliği
|
id | True | integer |
Bir fonu benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
|
Dış Veritabanı Kimliği
|
external_database_id | string |
Dış veritabanı tarafından fon için benzersiz kimlik atanmış bir sistem. Örneğin Raiser Edge NXT için Sistem Kayıt Kimliği, Salesforce için Nesne Kimliği |
|
|
Varsayılan fon mu?
|
is_default | boolean |
Verme Sayfasında başka bir fon tanımlanmadıysa, bu fonla ilişkili tüm bölmeleri gösterir. |
|
|
Diğer Fon mu?
|
is_other_fund | boolean |
Bu fonun bağışçılarının özel fon adı verdiğini gösterir. |
|
|
Fon Adı
|
name | True | string |
Fonun adı |
Döndürülenler
Hediye bölmesiyle ilişkili fon.
Fon oluşturma
Yeni bir fon oluşturur.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Dış Veritabanı Kimliği
|
external_database_id | string |
Dış veritabanı tarafından fon için benzersiz kimlik atanmış bir sistem. Örneğin Raiser Edge NXT için Sistem Kayıt Kimliği, Salesforce için Nesne Kimliği |
|
|
Varsayılan fon mu?
|
is_default | boolean |
Verme Sayfasında başka bir fon tanımlanmadıysa, bu fonla ilişkili tüm bölmeleri gösterir. |
|
|
Diğer Fon mu?
|
is_other_fund | boolean |
Bu fonun bağışçılarının özel fon adı verdiğini gösterir. |
|
|
Fon Adı
|
name | True | string |
Fonun adı |
Döndürülenler
Hediye bölmesiyle ilişkili fon.
Fonları listeleme
Fon listesini verir
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Fields
|
fields | array |
Yanıttaki alanların virgülle ayrılmış listesi. |
Döndürülenler
- response
- array of v1.GivingApi.FundRead
Form gönderme
Form için yeni form gönderimi oluşturur
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Form
|
form_id | True | integer |
Formu benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
|
body
|
body | dynamic |
Yeni form gönderimi oluşturma |
Döndürülenler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Yanıt Kimliği
|
id | integer |
Form gönderimini benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
Formları listeleme
Form listesini alın.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Fields
|
fields | array |
Yanıttaki alanların virgülle ayrılmış listesi. |
Döndürülenler
- response
- array of v1.FormApi.FormRead
Formun gönderimini alma
Form gönderimi hakkındaki bilgileri döndürür.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Form
|
form_id | True | integer |
Formu benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
|
Yanıt Kimliği
|
entry_id | True | string |
Form gönderimini benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
Döndürülenler
Hediye alın
Hediye hakkındaki bilgileri döndürür.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Hediye Kimliği
|
id | True | integer |
Bir hediyeyi benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
|
Fields
|
fields | array |
Yanıttaki alanların virgülle ayrılmış listesi. |
Döndürülenler
Armağan
Hediye oluşturma
Yeni bir hediye oluşturur.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Hediye Tutarı
|
amount | True | string |
İki ondalık içeren hediye tutarı. |
|
Toplu İş Numarası
|
batch_number | string |
Hediyenin toplu iş numarası. |
|
|
Hediye Tarihi
|
completed_at | True | date-time |
Hediyenin durumunun tamamlandı olarak işaretleneceği tarih. |
|
Para birimi
|
currency | True | integer |
Bağışta bulunan tarafından hediye için kullanılan para birimi. |
|
Bağış Adresi: 1. Satır
|
donor_address_line1 | string |
Bağışta bulunanın hediye için kullandığı 1. adres satırı. |
|
|
Bağış Adresi: 2. Satır
|
donor_address_line2 | string |
Bağışta bulunanın hediye için kullandığı 2. adres satırı. |
|
|
Ad: Şehir, Eyalet, Ülke
|
name | string |
Donörün şehri. Biçim: Şehir Adı, Kısa Eyalet Adı, Kısa Ülke Adı |
|
|
Bağış e-postası
|
donor_email | True |
Hediye için bağışta bulunan tarafından kullanılan e-posta kimliği. |
|
|
Donör Adı
|
donor_name | True | string |
Donörün tam adı. |
|
Donör Telefon Numarası
|
donor_phone_number | string |
Hediye için bağışta bulunanın kullandığı Telefon Numarası. |
|
|
Bağış Adresi: Posta Kodu
|
donor_zip_code | string |
Hediye için bağışta bulunanın kullandığı adresin posta kodu. |
|
|
Puan Tablosu'ndan gizlenir mi?
|
exclude_from_leaderboard | boolean |
Puan Tablosu'ndan gizlenir mi? |
|
|
Dış Veritabanı Kimliği
|
external_database_id | string |
Dış veritabanı tarafından hediye için sistem tarafından atanan benzersiz kimlik. |
|
|
Haraç İletisi
|
honor_message | string |
Hediye hediye için bir mesaj. |
|
|
Haraç Ön Eki
|
honor_prefix | string |
Hediye haraç için bir ön ek. Kullanılabilir seçenekler in_honor_of, in_memory_of in_support_of |
|
|
Anonim mi?
|
is_anonymous | boolean |
Bu hediye için bağışçının diğer bağışçılara anonim olmasını isteği gösterir. |
|
|
Ödeme Modu
|
mode | True | string |
Çevrimiçi veya çevrimdışı ödeme modu. |
|
Uyarı
|
note | string |
Not metni. |
|
|
Diğer Fon Adı
|
other_fund_name | string |
Donör is_other_fund olarak işaretlenmiş bir fon seçtiğinde hediyeyi ilişkilendirmek için özel bir fon adı ekler. |
|
|
Sayfa Verme
|
id | integer |
Veren bir sayfayı benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
|
|
Kimlik
|
id | integer |
Bir kaydı benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
|
|
Miktar
|
amount | True | string |
Hediyenin bölündüğü miktar. |
|
Fonu
|
id | True | integer |
Bir fonu benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
|
Statü
|
status | True | string |
Hediyenin durumu. |
Döndürülenler
Armağan
Hediyeleri listeleme
Hediye listesini döndürür.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Statü
|
status | True | string |
Duruma göre hediyeleri filtreleyin. |
|
Sayfa Verme
|
campaign | integer |
Veren bir sayfayı benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
|
|
Hediye Grubu Kimliğine Göre Filtrele
|
group_id | uuid |
Bir hediye grubunu veya listeyi benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
|
|
Boş toplu iş numarası mı olmalıdır?
|
batch_number__isnull | boolean |
Hediyeleri toplu iş numarası olup olmadığı temelinde filtreleyin. |
|
|
Boş dış veritabanı kimliği mi olmalıdır?
|
external_database_id__isnull | boolean |
Hediyeleri, dış veritabanı kimliğine sahip olup olmadığını temel alarak filtreleyin. NOT: Dış veritabanı kimliğine sahip Hediyeler zaten dış veritabanına gönderiliyor. |
|
|
Dış Veritabanı Kimliğine Göre Filtrele
|
external_database_id | string |
Dış veritabanı kimliğine göre hediyeleri filtreleyin. |
|
|
Donör E-postaya Göre Filtrele
|
donor_email | string |
Hediyeleri donör e-posta adresine göre filtreleme |
|
|
Arama Ölçütü
|
search | string |
Ada veya e-posta adresine göre hediyeler arayın. |
|
|
Fields
|
fields | array |
Yanıttaki alanların virgülle ayrılmış listesi. |
|
|
Sayfa Boyutu
|
page_size | integer |
Döndürülecek kayıt sayısını temsil eder. Varsayılan değer 10'dur. Maksimum değer 50'dir. |
|
|
Sayfa Numarası
|
page | integer |
Sayfa numaralarını (uzaklık) temsil edin. Sayfalandırma ile kullanmak için. |
|
|
Sipariş ölçütü
|
ordering | string |
Yanıttaki hediyelerin sırasını tanımlayın. "-" ön eki azalan düzeni temsil eder ve ön ekin olmaması sonuçları artan düzende döndürür. |
Döndürülenler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Sonraki sonuçlar URL'si
|
nextlink | uri |
Sonraki sonuç sayfası kümesinin URL'si. Sayfalandırma ile kullanmak için. |
|
Önceki sonuçlar URL'si
|
previouslink | uri |
Önceki sonuç kümesinin URL'si. Sayfalandırma ile kullanmak için. |
|
Toplam Hediye Sayısı
|
total | integer |
Verilen filtreler için toplam hediye sayısı |
|
Hediye
|
value | array of v1.GivingApi.GiftRead |
Verilen filtreler için döndürülen hediyelerin listesi. Sonuçlar sayfalandırılmıştır. |
Hediyeyi güncelleştirme
Hediyeyi güncelleştirir
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Hediye Kimliği
|
id | True | integer |
Bir hediyeyi benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
|
Toplu İş Numarası
|
batch_number | string |
Hediyenin toplu iş numarası. |
|
|
Bağış Adresi: 1. Satır
|
donor_address_line1 | string |
Bağışta bulunanın hediye için kullandığı 1. adres satırı. |
|
|
Bağış Adresi: 2. Satır
|
donor_address_line2 | string |
Bağışta bulunanın hediye için kullandığı 2. adres satırı. |
|
|
Ad: Şehir, Eyalet, Ülke
|
name | string |
Donörün şehri. Biçim: Şehir Adı, Kısa Eyalet Adı, Kısa Ülke Adı |
|
|
Donör Adı
|
donor_name | string |
Donörün tam adı. |
|
|
Donör Telefon Numarası
|
donor_phone_number | string |
Hediye için bağışta bulunanın kullandığı Telefon Numarası. |
|
|
Bağış Adresi: Posta Kodu
|
donor_zip_code | string |
Hediye için bağışta bulunanın kullandığı adresin posta kodu. |
|
|
Puan Tablosu'ndan gizlenir mi?
|
exclude_from_leaderboard | boolean |
Puan Tablosu'ndan gizlenir mi? |
|
|
Dış Veritabanı Kimliği
|
external_database_id | string |
Dış veritabanı tarafından hediye için sistem tarafından atanan benzersiz kimlik. |
|
|
Haraç İletisi
|
honor_message | string |
Hediye hediye için bir mesaj. |
|
|
Haraç Ön Eki
|
honor_prefix | string |
Hediye haraç için bir ön ek. Kullanılabilir seçenekler in_honor_of, in_memory_of in_support_of |
|
|
Anonim mi?
|
is_anonymous | boolean |
Bu hediye için bağışçının diğer bağışçılara anonim olmasını isteği gösterir. |
|
|
Uyarı
|
note | string |
Not metni. |
|
|
Diğer Fon Adı
|
other_fund_name | string |
Donör is_other_fund olarak işaretlenmiş bir fon seçtiğinde hediyeyi ilişkilendirmek için özel bir fon adı ekler. |
|
|
Sayfa Verme
|
id | integer |
Veren bir sayfayı benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
|
|
Kimlik
|
id | integer |
Bir kaydı benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
|
|
Miktar
|
amount | True | string |
Hediyenin bölündüğü miktar. |
|
Fonu
|
id | True | integer |
Bir fonu benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
Döndürülenler
Armağan
İlgili Kişileri Listele
Bir olaydaki tüm ilgili kişilerin listesini döndürür.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Olay Kimliği
|
id | True | integer |
Bir olayı benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
Döndürülenler
Kaydı güncelleştirme
Kaydı güncelleştirir.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Kayıt Kimliği
|
id | True | integer |
Bir kaydı benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
|
Dış Veritabanı Kimliği
|
external_database_id | string |
Dış veritabanı tarafından kayıt için sistem tarafından atanan benzersiz kimlik. Örneğin Raiser Edge NXT için Sistem Kayıt Kimliği, Salesforce için Kişi Kimliği |
|
|
Dış Veritabanı Arama Kimliği
|
external_database_lookup_id | string |
Dış veritabanındaki kayıt için kullanıcı tanımlı özel arama kimliği. Örneğin, Kurucu Kimlik |
|
|
İlk İsim
|
first_name | string |
Kaydın adı. |
|
|
Soyadı
|
last_name | string |
Kaydın soyadı. |
Döndürülenler
kayıt
Kaydın e-posta adresini alma
Kaydın e-posta adresi hakkındaki bilgileri döndürür.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Kayıt Kimliği
|
record_id | True | integer |
Bir kaydı benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
|
Kimlik
|
email_id | True | integer |
Bir kaydın e-posta adresini benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
Döndürülenler
E-posta Adresi
Kaydın e-posta adresini güncelleştirme
Alanları bir kaydın e-posta adresini güncelleştirir
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Kayıt Kimliği
|
record_id | True | integer |
Bir kaydı benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
|
E-posta Adresi Kimliği
|
email_id | True | integer |
Bir kaydın e-posta adresini benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
|
Oturum açmak için kullanılasın mı?
|
is_login_email | boolean |
Kullanıcının bu e-posta adresini kullanarak Platform'da oturum açmasına izin verilip verilmediğini gösterir. |
|
|
Birincil mi?
|
is_primary | boolean |
Birincil e-posta, Sistem tarafından tetiklenen otomatik e-postaları göndermek için kullanılır. Toplu e-postayı profile göndermek için de kullanılır. Yalnızca bir e-postanın birincil olarak ayarlanması zorunludur. |
|
|
Statü
|
status | string |
E-posta adresinin durumu |
|
|
Türü
|
type | string |
E-postanın türü |
Döndürülenler
E-posta Adresi
Kaydın e-posta adresini silme
Kaydın e-posta adresini silin.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Kayıt Kimliği
|
record_id | True | integer |
Bir kaydı benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
|
Kimlik
|
email_id | True | integer |
Bir kaydın e-posta adresini benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
Kaydın e-posta adreslerini listeleme
Kaydın e-posta adreslerinin listesini döndürür.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Kayıt Kimliği
|
record_id | True | integer |
Bir kaydı benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
|
Birincil mi?
|
is_primary | boolean |
Birincil e-postayı arayın. |
|
|
Fields
|
fields | array |
Yanıttaki alanların virgülle ayrılmış listesi. |
|
|
Sayfa Boyutu
|
page_size | integer |
Döndürülecek kayıt sayısını temsil eder. Varsayılan değer 10'dur. Maksimum değer 50'dir. |
|
|
Sayfa Numarası
|
page | integer |
Sayfa numaralarını (uzaklık) temsil edin. Sayfalandırma ile kullanmak için. |
Döndürülenler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Sonraki sonuçlar URL'si
|
nextlink | uri |
Sonraki sonuç sayfası kümesinin URL'si. Sayfalandırma ile kullanmak için. |
|
Önceki sonuçlar URL'si
|
previouslink | uri |
Önceki sonuç kümesinin URL'si. Sayfalandırma ile kullanmak için. |
|
Toplam E-posta Adresi
|
total | integer |
Verilen filtreler için toplam e-posta adresi |
|
E-posta Adresi
|
value | array of v1.RecordApi.EmailAddressRead |
Verilen filtreler için döndürülen bir kaydın e-posta adresi listesi. Sonuçlar sayfalandırılmıştır. |
Kayıt alma
Kayıt hakkındaki bilgileri döndürür.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Kayıt Kimliği
|
id | True | integer |
Bir kaydı benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
|
Fields
|
fields | array |
Yanıttaki alanların virgülle ayrılmış listesi. |
Döndürülenler
kayıt
Kayıt için e-posta adresi oluşturma
Kayıt için yeni bir e-posta adresi oluşturur.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Kayıt Kimliği
|
record_id | True | integer |
Bir kaydı benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
|
Adres
|
address |
E-posta adresi |
||
|
Oturum açmak için kullanılasın mı?
|
is_login_email | boolean |
Kullanıcının bu e-posta adresini kullanarak Platform'da oturum açmasına izin verilip verilmediğini gösterir. |
|
|
Birincil mi?
|
is_primary | boolean |
Birincil e-posta, Sistem tarafından tetiklenen otomatik e-postaları göndermek için kullanılır. Toplu e-postayı profile göndermek için de kullanılır. Yalnızca bir e-postanın birincil olarak ayarlanması zorunludur. |
|
|
Kaynak
|
source | string |
Kaynak, e-postanın veritabanına nasıl eklendiğini gösterir. |
|
|
Statü
|
status | string |
E-posta adresinin durumu |
|
|
Türü
|
type | string |
E-postanın türü |
Döndürülenler
E-posta Adresi
Kayıt oluşturma
Yeni bir kayıt oluşturur.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
1. Satır
|
line1 | True | string |
Adresin 1. Satırı |
|
Satır 2
|
line2 | string |
Adresin 2. Satırı |
|
|
İsim
|
name | string |
Şehir,Eyalet,Konumun Ülkesi |
|
|
Gizlilik
|
privacy | string |
gizlilik |
|
|
Türü
|
type | True | string |
Sayının türü |
|
Posta kodu
|
zip_code | string |
Adresin Posta Kodu |
|
|
Doğum Tarihi
|
date_of_birth | string |
Doğum tarihi. |
|
|
Ölen
|
deceased | boolean |
Ölen. |
|
|
Adres
|
address |
E-posta adresi |
||
|
Oturum açmak için kullanılasın mı?
|
is_login_email | boolean |
Kullanıcının bu e-posta adresini kullanarak Platform'da oturum açmasına izin verilip verilmediğini gösterir. |
|
|
Birincil mi?
|
is_primary | boolean |
Birincil e-posta, Sistem tarafından tetiklenen otomatik e-postaları göndermek için kullanılır. Toplu e-postayı profile göndermek için de kullanılır. Yalnızca bir e-postanın birincil olarak ayarlanması zorunludur. |
|
|
Kaynak
|
source | string |
Kaynak, e-postanın veritabanına nasıl eklendiğini gösterir. |
|
|
Statü
|
status | string |
E-posta adresinin durumu |
|
|
Türü
|
type | string |
E-postanın türü |
|
|
Dış Veritabanı Kimliği
|
external_database_id | string |
Dış veritabanı tarafından kayıt için sistem tarafından atanan benzersiz kimlik. Örneğin Raiser Edge NXT için Sistem Kayıt Kimliği, Salesforce için Kişi Kimliği |
|
|
Dış Veritabanı Arama Kimliği
|
external_database_lookup_id | string |
Dış veritabanındaki kayıt için kullanıcı tanımlı özel arama kimliği. Örneğin, Kurucu Kimlik |
|
|
İlk İsim
|
first_name | True | string |
Kaydın adı. |
|
Soyadı
|
last_name | True | string |
Kaydın soyadı. |
|
İkinci Ad
|
middle_name | string |
Kaydın ikinci adı. |
|
|
Sayı
|
number | True | string |
Sayı |
|
Gizlilik
|
privacy | string |
gizlilik |
|
|
Türü
|
type | True | string |
Sayının türü |
Döndürülenler
kayıt
Kayıtları listeleme
Kayıtların listesini döndürür.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Ada Göre Ara
|
search | string |
Kayıtları ada göre arayın. |
|
|
E-posta Adresine Göre Ara
|
email_addresses__address | string |
Kayıtları e-posta adresine göre arayın. |
|
|
Dış Veritabanı Kimliğine Göre Ara
|
external_database_id | string |
Dış veritabanı kimliğine göre kayıtları arayın. |
|
|
Fields
|
fields | array |
Yanıttaki alanların virgülle ayrılmış listesi. |
|
|
Tarihinde veya sonrasında güncelleştirildi
|
updated_at__gte | date-time |
Bir tarihte veya sonra güncelleştirildi. |
|
|
Oluşturma tarihi veya sonrası
|
created_at__gte | date-time |
Bir tarihte veya bir tarihten sonra oluşturulur. |
|
|
Sayfa Boyutu
|
page_size | integer |
Döndürülecek kayıt sayısını temsil eder. Varsayılan değer 10'dur. Maksimum değer 50'dir. |
|
|
Sayfa Numarası
|
page | integer |
Sayfa numaralarını (uzaklık) temsil edin. Sayfalandırma ile kullanmak için. |
Döndürülenler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Sonraki sonuçlar URL'si
|
nextlink | uri |
Sonraki sonuç sayfası kümesinin URL'si. Sayfalandırma ile kullanmak için. |
|
Önceki sonuçlar URL'si
|
previouslink | uri |
Önceki sonuç kümesinin URL'si. Sayfalandırma ile kullanmak için. |
|
Toplam Kayıt Sayısı
|
total | integer |
Verilen filtreler için toplam kayıt sayısı |
|
Kayıtlar
|
value | array of v1.RecordApi.RecordRead |
Verilen filtreler için döndürülen bir kaydın kayıtlarının listesi. |
Kişi ekleme
Bir etkinliğe kişi ekler.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Olay Kimliği
|
id | True | integer |
Bir olayı benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
|
E-posta
|
İlgili kişinin e-postası |
|||
|
İsim
|
name | string |
İlgili kişinin adı |
|
|
Telefon Numarası
|
phone_number | string |
İlgili kişinin telefon numarası |
Döndürülenler
Etkinliğin ilgili kişisi
Kişi kişisini güncelleştirme
Bir etkinlikte ilgili kişiyi güncelleştirir.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Olay Kimliği
|
id | True | integer |
Bir olayı benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
|
Olay İlgili KişiSi Kimliği
|
person_id | True | integer |
Bir olaydaki ilgili kişiyi benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
|
E-posta
|
İlgili kişinin e-postası |
|||
|
İsim
|
name | string |
İlgili kişinin adı |
|
|
Telefon Numarası
|
phone_number | string |
İlgili kişinin telefon numarası |
Döndürülenler
Etkinliğin ilgili kişisi
Olay alma
Bir olay hakkındaki bilgileri döndürür.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Olay Kimliği
|
id | True | integer |
Bir olayı benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
|
Fields
|
fields | array |
Yanıttaki alanların virgülle ayrılmış listesi. |
Döndürülenler
Event
Olayı güncelleştirme
Bir olayı güncelleştirir.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Olay Kimliği
|
id | True | integer |
Bir olayı benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
|
Description
|
description | string |
Olayın açıklaması |
|
|
Bitiş Saati
|
end_datetime | string |
Olayın bitiş saati |
|
|
Dış Veritabanı Kimliği
|
external_database_id | string |
Dış veritabanı tarafından kayıt için sistem tarafından atanan benzersiz kimlik. Örneğin Raiser Edge NXT için Sistem Kayıt Kimliği, Salesforce için Kişi Kimliği |
|
|
Dış Kayıt Url'si
|
external_registration_url | string |
Dış web sitesindeki etkinliğin kayıt url'si |
|
|
İsim
|
name | string |
Etkinliğin adı |
|
|
Başlangıç Saati
|
start_datetime | string |
Olayın başlangıç saati |
|
|
Timezone
|
timezone | string |
Olayın saat dilimi |
|
|
İsim
|
display_name | string |
City,State,Country of the Venue |
Döndürülenler
Event
Veren sayfaları listeleme
Veren sayfaların listesini döndürür.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Fields
|
fields | array |
Yanıttaki alanların virgülle ayrılmış listesi. |
Döndürülenler
- response
- array of v1.GivingApi.GivingPageRead
Verme sayfası alma
Veren sayfa hakkındaki bilgileri döndürür.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Sayfa Kimliği Verme
|
id | True | integer |
Veren bir sayfayı benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
|
Fields
|
fields | array |
Yanıttaki alanların virgülle ayrılmış listesi. |
Döndürülenler
Sayfa Verme
Tetikleyiciler
| Almabase'de bir kayıt oluşturulduğunda veya güncelleştirildiğinde |
Almabase'de yeni bir kayıt oluşturulduğunda veya mevcut bir kayıt güncelleştirildiğinde tetikler. |
| E-posta oluşturulduğunda, bir kayıtta güncelleştirildiğinde veya silindiğinde |
Bir kayıtta yeni bir e-posta oluşturulduğunda veya mevcut bir e-posta bir kayıttan güncelleştirildiğinde veya silindiğinde tetikler. |
| Form gönderildiğinde veya mevcut form gönderimi güncelleştirildiğinde |
Form gönderildiğinde veya mevcut form gönderimi güncelleştirildiğinde tetikler. |
| Yeni bir hediye başarılı olduğunda veya çevrimiçi hediye ödemesi başarısız olduğunda |
Yeni bir hediye, bağışta bulunan bir kişi tarafından Verme Sayfasına başarıyla kaydedildiğinde veya hediyeye yapılan ödeme başarısız olduğunda tetikler. |
Almabase'de bir kayıt oluşturulduğunda veya güncelleştirildiğinde
Almabase'de yeni bir kayıt oluşturulduğunda veya mevcut bir kayıt güncelleştirildiğinde tetikler.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Ne zaman
|
events | True | string |
Akışı tetikleyen olayların listesi. |
Döndürülenler
E-posta oluşturulduğunda, bir kayıtta güncelleştirildiğinde veya silindiğinde
Bir kayıtta yeni bir e-posta oluşturulduğunda veya mevcut bir e-posta bir kayıttan güncelleştirildiğinde veya silindiğinde tetikler.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Ne zaman
|
events | True | string |
Akışı tetikleyen olayların listesi. |
Döndürülenler
Form gönderildiğinde veya mevcut form gönderimi güncelleştirildiğinde
Form gönderildiğinde veya mevcut form gönderimi güncelleştirildiğinde tetikler.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Ne zaman
|
events | True | string |
Akışı tetikleyen olayların listesi. |
|
Form
|
object_id | True | integer |
Formu benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
Döndürülenler
Yeni bir hediye başarılı olduğunda veya çevrimiçi hediye ödemesi başarısız olduğunda
Yeni bir hediye, bağışta bulunan bir kişi tarafından Verme Sayfasına başarıyla kaydedildiğinde veya hediyeye yapılan ödeme başarısız olduğunda tetikler.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Ne zaman
|
events | True | string |
Akışı tetikleyen olayların listesi. |
|
Sayfa Verme
|
object_id | integer |
Veren bir sayfayı benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
Döndürülenler
Tanımlar
v1. FormApi.FormRead
Form
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Kimlik
|
id | integer |
Formu benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
|
Form Adı
|
title | string |
Formun adı |
v1. GivingApi.GiftWebhookRecordRead
Kayıt
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Dış Veritabanı Kimliği
|
external_database_id | string |
Dış veritabanı tarafından kayıt için sistem tarafından atanan benzersiz kimlik. Örneğin Raiser Edge NXT için Sistem Kayıt Kimliği, Salesforce için Kişi Kimliği |
|
İlk İsim
|
first_name | string |
Eşlenen kaydın adı |
|
Kimlik
|
id | integer |
Bir kaydı benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
|
Almabase'de Donör Kayıtlı mı?
|
is_registered | boolean |
Eşleme kaydının veya bağışlayıcının Almabase'de kayıtlı olup olmadığını belirtin |
|
Soyadı
|
last_name | string |
Eşlenen kaydın soyadı |
v1. GivingApi.GiftWebhookResponse
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Miktar
|
data.amount | string |
İki ondalık içeren hediye tutarı. |
|
Date
|
data.completed_at | date-time |
Hediyenin durumunun tamamlandı olarak işaretleneceği tarih. |
|
Bağış e-postası
|
data.email |
Hediye için bağışta bulunan tarafından kullanılan e-posta kimliği. |
|
|
Dış Veritabanı Kimliği
|
data.external_database_id | string |
Dış veritabanı tarafından hediye için sistem tarafından atanan benzersiz kimlik. |
|
Kimlik
|
data.id | integer |
Bir hediyeyi benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
|
Yeni E-posta mı?
|
data.is_email_new | boolean |
Donör tarafından sağlanan e-postanın Almabase kayıtlarında zaten var olup olmadığını gösterir. |
|
şema
|
data.mapped_profile.schema | v1.GivingApi.GiftWebhookRecordRead |
Kayıt |
|
Mode
|
data.mode | string |
Hediye modu. |
|
Donör Adı
|
data.name | string |
Donörün tam adı. |
|
Kimlik
|
data.page.id | integer |
Veren bir sayfayı benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
|
Sayfa Adı Verme
|
data.page.name | string |
İlişkili veren sayfanın adı |
|
Statü
|
data.status | string |
Hediyenin durumu. |
|
Olay Tetiklenen:
|
time | string |
Olay zamanı. |
|
Olay Türü
|
type | string |
Olay türü. |
v1. GivingApi.LocationRead
Bağışta bulunanın hediye için kullandığı şehir.
| Name | Yol | Tür | Description |
|---|---|---|---|
|
City
|
city | string |
Donörün şehri |
|
Şehir Kısa Adı
|
city_short_name | string |
Şehrin kısa temsili, örneğin SF |
|
Enlem
|
coordinates.latitude | string |
Konumun enlemi |
|
Boylam
|
coordinates.longitude | string |
Konumun boylamı |
|
Country
|
country | string |
Donörün ülkesi |
|
Ülke Kısa Adı
|
country_short_name | string |
Ülkenin kısa temsili, örneğin ABD |
|
Google Yer Kimliği
|
gpid | string |
Google'dan alınan yer kimliği |
|
Şehir, Eyalet, Ülke
|
name | string |
Donörün şehri. Biçim: Şehir Adı, Kısa Eyalet Adı, Kısa Ülke Adı |
|
Devlet
|
state | string |
Donörün durumu |
|
Eyalet Kısa Adı
|
state_short_name | string |
Durumun kısa gösterimi, örneğin CA |
v1. GivingApi.FormFieldRead
Form Alanı
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Değer
|
display_value | string |
Yanıtlayanlar tarafından girilen biçimlendirilmiş değer. Örneğin, Dosya Yüklemenin adı. |
|
Soru/Form Alan Adı
|
label | string |
Formdaki soru/form alanı adı |
v1. GivingApi.FundRead
Hediye bölmesiyle ilişkili fon.
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Dış Veritabanı Kimliği
|
external_database_id | string |
Dış veritabanı tarafından fon için benzersiz kimlik atanmış bir sistem. Örneğin Raiser Edge NXT için Sistem Kayıt Kimliği, Salesforce için Nesne Kimliği |
|
Kimlik
|
id | integer |
Bir fonu benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
|
Varsayılan fon mu?
|
is_default | boolean |
Verme Sayfasında başka bir fon tanımlanmadıysa, bu fonla ilişkili tüm bölmeleri gösterir. |
|
Diğer Fon mu?
|
is_other_fund | boolean |
Bu fonun bağışçılarının özel fon adı verdiğini gösterir. |
|
İsim
|
name | string |
Fonun adı |
v1. GivingApi.GiftRead
Armağan
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Hediye Tutarı
|
amount | string |
İki ondalık içeren hediye tutarı. |
|
Toplu İş Numarası
|
batch_number | string |
Hediyenin toplu iş numarası. |
|
Hediye Tarihi
|
completed_at | date-time |
Hediyenin durumunun tamamlandı olarak işaretleneceği tarih. |
|
Para birimi
|
currency | integer |
Bağışta bulunan tarafından hediye için kullanılan para birimi. |
|
Device
|
device | string |
Hediyeyi yapmak için kullanılan cihazı (ör. bilgisayar, mobil veya tablet) tanımlayın. |
|
Bağış Adresi: 1. Satır
|
donor_address_line1 | string |
Bağışta bulunanın hediye için kullandığı 1. adres satırı. |
|
Bağış Adresi: 2. Satır
|
donor_address_line2 | string |
Bağışta bulunanın hediye için kullandığı 2. adres satırı. |
|
Bağış Adresi: Konum
|
donor_city_place | v1.GivingApi.LocationRead |
Bağışta bulunanın hediye için kullandığı şehir. |
|
Bağış e-postası
|
donor_email |
Hediye için bağışta bulunan tarafından kullanılan e-posta kimliği. |
|
|
Donör Adı
|
donor_name | string |
Donörün tam adı. |
|
Donör Telefon Numarası
|
donor_phone_number | string |
Hediye için bağışta bulunanın kullandığı Telefon Numarası. |
|
Bağış Adresi: Posta Kodu
|
donor_zip_code | string |
Hediye için bağışta bulunanın kullandığı adresin posta kodu. |
|
Puan Tablosu'ndan gizlenir mi?
|
exclude_from_leaderboard | boolean |
Puan Tablosu'ndan gizlenir mi? |
|
Dış Veritabanı Kimliği
|
external_database_id | string |
Dış veritabanı tarafından hediye için sistem tarafından atanan benzersiz kimlik. |
|
Haraç İletisi
|
honor_message | string |
Hediye hediye için bir mesaj. |
|
Haraç Ön Eki
|
honor_prefix | string |
Hediye haraç için bir ön ek. Kullanılabilir seçenekler in_honor_of, in_memory_of in_support_of |
|
Kimlik
|
id | integer |
Bir hediyeyi benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
|
Etmen
|
influencer | v1.GivingApi.InfluencerRead |
Ortak paylaşım bağlantısı ve özel pano bağlantısı |
|
Anonim mi?
|
is_anonymous | boolean |
Bu hediye için bağışçının diğer bağışçılara anonim olmasını isteği gösterir. |
|
Bağışlayıcı ödeme ağ geçidi ücretlerini karşılandı mı?
|
is_donor_covered_charges | boolean |
Bağış yapanın bu hediyeyi yaparken ödeme ağ geçidi ücretlerini karşılamayı kabullenip kabul etmediğini gösterir. |
|
Almabase'de Bir Kayda E-posta Eklendi mi?
|
is_email_added_to_profile | boolean |
Bağışçı tarafından sağlanan e-postanın Almabase kaydına eklenip eklenmediğini gösterir (is_email_new durumundan bağımsız olarak) |
|
Yeni E-posta mı?
|
is_email_new | boolean |
Donör tarafından sağlanan e-postanın Almabase kayıtlarında zaten var olup olmadığını gösterir. |
|
Almabase'de Bir Kayda Eşleme Yoksayıldı mı?
|
is_profile_mapping_ignored | boolean |
Kayıt eşlemesinin yoksayılıp yoksayılmaması gerektiğini gösterir. |
|
Ödeme Modu
|
mode | string |
Çevrimiçi veya çevrimdışı ödeme modu. |
|
Uyarı
|
note | string |
Not metni. |
|
Diğer Fon Adı
|
other_fund_name | string |
Donör is_other_fund olarak işaretlenmiş bir fon seçtiğinde hediyeyi ilişkilendirmek için özel bir fon adı ekler. |
|
Sayfa Verme
|
page | v1.GivingApi.GivingPageAssociatedWithGift |
Hediyeyle ilişkili veren sayfa. |
|
Fields
|
post_payment_form_entry.fields | array of v1.GivingApi.FormFieldRead | |
|
Yanıt Kimliği
|
post_payment_form_entry.id | integer |
Form gönderimini benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
|
Fields
|
pre_payment_form_entry.fields | array of v1.GivingApi.FormFieldRead | |
|
Yanıt Kimliği
|
pre_payment_form_entry.id | integer |
Form gönderimini benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
|
Eşlenen Kayıt
|
profile | v1.GivingApi.RecordRead |
Almabase'de Eşlenmiş Kayıt |
|
Başvuran Bağlantısı
|
referrer_link | string |
Bağış sahibinin ziyaret şeklinin kaynağını belirlemek için web sitesi bağlantısı. Örneğin Bağış, Facebook, Google vb. bağış kampanyasını ziyaret etti. |
|
Para İadesi Tutarı
|
refund_amount | string |
Bağışta bulunana iade edilen tutar. Tutarın tamamı iade edilirse hediyenin durumu tamamlanmak yerine iade edilir. |
|
Böler
|
splits | array of v1.GivingApi.GiftSplitRead |
Hediyeyle ilişkili bölmeler. |
|
Statü
|
status | string |
Hediyenin durumu. |
|
Çevrimiçi İşlem
|
transaction | v1.GivingApi.TransactionRead |
Hediyeyle ilişkili çevrimiçi ödeme işlemi. |
|
UTM Kampanyası
|
utm_campaign | string |
Anahtar sözcük analizi için kullanılır. utm_campaign belirli bir ürün promosyonu veya stratejik kampanya tanımlayın. örneğin annual_fund_2020 |
|
UTM Orta
|
utm_medium | string |
utm_medium e-posta veya tıklama başına maliyet gibi bir ortam belirleyin. örneğin cpc |
|
UTM Kaynağı
|
utm_source | string |
utm_source bir arama altyapısını, bülten adını veya başka bir kaynağı tanımlayın. örneğin Google |
v1. GivingApi.GiftSplitRead
Hediye Bölme
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Miktar
|
amount | string |
Hediyenin bölündüğü miktar. |
|
Fonu
|
fund | v1.GivingApi.FundRead |
Hediye bölmesiyle ilişkili fon. |
|
Kimlik
|
id | integer |
Bir hediye bölmeyi benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
v1. GivingApi.GivingPageAssociatedWithGift
Hediyeyle ilişkili veren sayfa.
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Kimlik
|
id | integer |
Veren bir sayfayı benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
|
İsim
|
name | string |
İlişkili Verme Sayfasının adı. |
v1. GivingApi.GivingPageRead
Sayfa Verme
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Kimlik
|
id | integer |
Veren bir sayfayı benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
|
İsim
|
name | string |
Veren sayfanın adı |
v1. GivingApi.InfluencerRead
Ortak paylaşım bağlantısı ve özel pano bağlantısı
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Özel Etmen Panosu Bağlantısı
|
dashboard_url | uri |
Donörün sayfa ziyaretlerinin ve onlardan etkilenen hediyelerin sayısını izlemek için özel panosu |
|
Ortak Paylaşım Bağlantısı
|
page_share_url | uri |
Veren Sayfa'ya ve hediyelere yapılan ziyaretler üzerindeki etkiyi izlemek için bağışta bulunanın sayfayı/kampanyasını vermenin genel bağlantısı. |
v1. GivingApi.PaymentAccountRead
İşlemle ilişkili ödeme hesabı, örneğin BBMS, Stripe, PayPal vb.
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Kimlik
|
id | integer |
Bir ödeme hesabını benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
|
İsim
|
name | string |
Ödeme hesabının adı. |
|
Gateway
|
type | string |
Ödeme ağ geçidinin adı. |
v1. GivingApi.RecordRead
Almabase'de Eşlenmiş Kayıt
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Dış Veritabanı Kimliği
|
external_database_id | string |
Dış veritabanı tarafından kayıt için sistem tarafından atanan benzersiz kimlik. Örneğin Raiser Edge NXT için Sistem Kayıt Kimliği, Salesforce için Kişi Kimliği |
|
İlk İsim
|
first_name | string |
Eşlenen kaydın adı |
|
Adı ve Soyadı
|
formatted_name | string |
Eşlenen kaydın tam adı |
|
Kimlik
|
id | integer |
Bir kaydı benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
|
Almabase'de Donör Kayıtlı mı?
|
is_registered | boolean |
Eşleme kaydının veya bağışlayıcının Almabase'de kayıtlı olup olmadığını belirtin |
|
Soyadı
|
last_name | string |
Eşlenen kaydın soyadı |
|
Resim URL'si
|
present_picture | uri |
Kayıt resminin URL'si |
|
Link
|
profile_url | uri |
Almabase'de kayıt bağlantısı |
v1. GivingApi.TransactionRead
Hediyeyle ilişkili çevrimiçi ödeme işlemi.
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Ödeme Hesabı
|
account | v1.GivingApi.PaymentAccountRead |
İşlemle ilişkili ödeme hesabı, örneğin BBMS, Stripe, PayPal vb. |
|
Oluşturma saati:
|
created_at | date-time |
Bu işlemin oluşturulma zamanı. |
|
Hata Nedeni
|
failure_reason | string |
Ödeme ağ geçidi tarafından döndürülen işlem hatasının nedeni. |
|
Kimlik
|
id | uuid |
Bir işlemi benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
|
Statü
|
status | integer |
İşlemin durumu. - 1 (İşlenmemiş) - 2 (Başarılı) - 3 (Başarısız) - 4 (Beklemede) - 5 (Hata) NOT: Bu durum, Ödeme Ağ Geçidi tarafından işlemin durumuyla ilişkilendirilir |
|
Payment Gateway Başvuru Kimliği
|
transaction_id | string |
İşlemi tanımlamak için ödeme ağ geçidi tarafından oluşturulan benzersiz kimlik. Örneğin Blackbaud Merchant Services (BBMS) işlem kimliği veya Stripe Charge Id, PayPal işlem kimliği |
v1. AlmasightsApi.RecordAddOrEdit
Almabase'de kayıt.
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Kimlik
|
id | integer |
Bir kaydı benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
v1. AlmasightsApi.TouchpointCustomObjectAdd
Yeni bir dokunma noktası oluşturmak için dokunmatik nokta gövdesi
| Name | Yol | Tür | Description |
|---|---|---|---|
|
E-posta
|
Etkinlik için kullanılan e-posta kimliği. |
||
|
Kayıt
|
mapped_profile | v1.AlmasightsApi.RecordAddOrEdit |
Almabase'de kayıt. |
|
Kayıt Tarihi:
|
recorded_at | date-time |
Etkinliğin zaman damgası. |
|
Türü
|
touchpoint_type.id | integer |
v1. RecordApi.LocationRead
Adresin Konumu
| Name | Yol | Tür | Description |
|---|---|---|---|
|
City
|
city | string |
Konumun şehir adı |
|
Country
|
country | string |
Konumun ülke adı |
|
Enlem
|
latitude | double |
Konumun enlemi |
|
Boylam
|
longitude | double |
Konumun boylamı |
|
Devlet
|
state | string |
Konumun durum adı |
v1. RecordApi.AddressRead
Adres
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Line1
|
line1 | string |
Adresin 1. satırı |
|
Satır2
|
line2 | string |
Adresin 2. satırı |
|
şema
|
location.schema | v1.RecordApi.LocationRead |
Adresin Konumu |
|
Posta kodu
|
zipcode | string |
Adresin posta kodu |
v1. RecordApi.EmailWebhookRecordRead
Kayıt
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Dış Veritabanı Kimliği
|
external_database_id | string |
Dış veritabanı tarafından kayıt için sistem tarafından atanan benzersiz kimlik. Örneğin Raiser Edge NXT için Sistem Kayıt Kimliği, Salesforce için Kişi Kimliği |
|
İlk İsim
|
first_name | string |
Eşlenen kaydın adı |
|
Kimlik
|
id | integer |
Bir kaydı benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
|
Kayıt Almabase'de kayıtlı mı?
|
is_registered | boolean |
Eşleme kaydının Almabase'de kaydedilip kaydedilmediğini belirtin |
|
Soyadı
|
last_name | string |
Eşlenen kaydın soyadı |
v1. RecordApi.EmailWebhookResponse
| Name | Yol | Tür | Description |
|---|---|---|---|
|
E-posta Adresi
|
data.address |
E-posta adresi. |
|
|
Kimlik
|
data.id | integer |
Bir e-postayı benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
|
Birincil
|
data.is_primary | boolean |
E-postanın birincil olup olmadığını gösterir. |
|
şema
|
data.profile.schema | v1.RecordApi.EmailWebhookRecordRead |
Kayıt |
|
E-posta Türü
|
data.type | string |
E-posta adresinin türü (birincil, kişisel, iş vb.). |
|
Olay Tetiklenen:
|
time | string |
Olay zamanı. |
|
Olay Türü
|
type | string |
Olay türü. |
v1. RecordApi.RecordWebhookResponse
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Bağlantılar
|
data.affiliations | array of string | |
|
Sınıf Yılı
|
data.class_year | string |
Kaydın sınıf yılı |
|
E-posta Adresi
|
data.email |
E-posta adresi. |
|
|
Dış Veritabanı Kimliği
|
data.external_database_id | string |
Dış veritabanı tarafından kayıt için sistem tarafından atanan benzersiz kimlik. Örneğin Raiser Edge NXT için Sistem Kayıt Kimliği, Salesforce için Kişi Kimliği |
|
İlk İsim
|
data.first_name | string |
Eşlenen kaydın adı |
|
şema
|
data.home_address.schema | v1.RecordApi.AddressRead |
Adres |
|
Kimlik
|
data.id | integer |
Bir kaydı benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
|
Soyadı
|
data.last_name | string |
Eşlenen kaydın soyadı |
|
Üyelik Süre Sonu Tarihi
|
data.membership_expiry_date | date-time |
Kaydın üyeliğinin bitiş tarihi |
|
Üyelik Türü Adı
|
data.membership_type_name | string |
Kaydın üyelik türünün adı |
|
Cep Telefonu Numarası
|
data.mobile_number | string |
Kaydın cep telefonu numarası |
|
şema
|
data.office_address.schema | v1.RecordApi.AddressRead |
Adres |
|
Office Telefon Numarası
|
data.office_phone_number | string |
Kaydın Office telefon numarası |
|
İkamet Telefon Numarası
|
data.residence_phone_number | string |
Kaydın ikamet telefon numarası |
|
Olay Tetiklenen:
|
time | string |
Olay zamanı. |
|
Olay Türü
|
type | string |
Olay türü. |
v1. RecordApi.EmailAddressRead
E-posta Adresi
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Adres
|
address |
E-posta adresi |
|
|
Kimlik
|
id | integer |
Bir kaydın e-posta adresini benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
|
Nişanlandı mı?
|
is_engaged | boolean |
Toplu e-postaya tıklandığında veya açıldığında veya kullanıcının bire bir e-postayı yanıtlayamadığını gösterir |
|
Oturum açmak için kullanılasın mı?
|
is_login_email | boolean |
Kullanıcının bu e-posta adresini kullanarak Platform'da oturum açmasına izin verilip verilmediğini gösterir. |
|
Birincil mi?
|
is_primary | boolean |
Birincil e-posta, Sistem tarafından tetiklenen otomatik e-postaları göndermek için kullanılır. Ayrıca toplu e-postayı kayda göndermek için de kullanılır. Yalnızca bir e-postanın birincil olarak ayarlanması zorunludur. |
|
Kullanıcı Tarafından Doğrulandı mı?
|
is_verified | boolean |
Kullanıcının e-postanın sahibi olduğunu doğrulup doğrulamadığını belirtin. |
|
kaynak
|
source | string |
Kaynak, e-postanın veritabanına nasıl eklendiğini gösterir. |
|
statü
|
status | string | |
|
Türü
|
type | string |
E-postanın türü |
v1. RecordApi.RecordRead
kayıt
| Name | Yol | Tür | Description |
|---|---|---|---|
|
E-posta Adresleri
|
email_addresses | array of v1.RecordApi.EmailAddressRead |
Profilin e-posta adreslerinin listesi |
|
Dış Veritabanı Kimliği
|
external_database_id | string |
Dış veritabanı tarafından kayıt için sistem tarafından atanan benzersiz kimlik. Örneğin Raiser Edge NXT için Sistem Kayıt Kimliği, Salesforce için Kişi Kimliği |
|
İlk İsim
|
first_name | string |
Kaydın adı. |
|
Adı ve Soyadı
|
formatted_name | string |
Kaydın tam adı. |
|
Kimlik
|
id | integer |
Bir kaydı benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
|
Almabase'de kayıtlı mı?
|
is_registered | boolean |
Kaydın veya bağışlayıcının Almabase'de kayıtlı olup olmadığını belirtin |
|
Soyadı
|
last_name | string |
Kaydın soyadı. |
|
Resim URL'si
|
present_picture | uri |
Kayıt resminin URL'si |
|
Link
|
record_url | uri |
Almabase'de kayıt bağlantısı |
v1. EventApi.ContactPersonRead
Etkinliğin ilgili kişisi
| Name | Yol | Tür | Description |
|---|---|---|---|
|
E-posta
|
İlgili kişinin e-postası |
||
|
Kimlik
|
id | integer |
İlgili kişiyi benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
|
İsim
|
name | string |
İlgili kişinin adı |
|
Telefon Numarası
|
phone_number | string |
İlgili kişinin telefon numarası |
v1. EventApi.EventRead
Event
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Description
|
description | string |
Olayın açıklaması |
|
Bitiş Saati
|
end_datetime | string |
Olayın bitiş saati |
|
Dış Veritabanı Kimliği
|
external_database_id | string |
Dış veritabanı tarafından kayıt için sistem tarafından atanan benzersiz kimlik. Örneğin Raiser Edge NXT için Sistem Kayıt Kimliği, Salesforce için Kişi Kimliği |
|
Dış Kayıt Url'si
|
external_registration_url | string |
Dış web sitesindeki etkinliğin kayıt url'si |
|
Kimlik
|
id | integer |
Bir olayı benzersiz olarak tanımlamak için sistem tarafından oluşturulan kimlik. |
|
İsim
|
name | string |
Etkinliğin adı |
|
Başlangıç Saati
|
start_datetime | string |
Olayın başlangıç saati |
|
Timezone
|
timezone | string |
Olayın saat dilimi |