Blackbaud Raisers Edge NXT 賽事
Blackbaud Raiser 的 Edge NXT 是一款全面的基於雲的籌款和捐助者管理軟件解決方案，專為非營利組織和整個社會公益社區構建。 使用「事件」聯結器來管理事件和參與者。
此連接器適用於以下產品和區域：
| 服務 | Class | Regions |
|---|---|---|
| 副駕駛工作室 | 進階 | 除下列區域外的所有 Power Automate 區域 ： - 美國政府 （GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部 （DoD） |
| 邏輯應用程式 | 標準 | 所有 Logic Apps 區域， 但下列區域除外： - Azure Government 區域 - Azure 中國區域 - 美國國防部 （DoD） |
| Power Apps | 進階 | 除下列區域外的所有 Power Apps 區域 ： - 美國政府 （GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部 （DoD） |
| Power Automate（自動化服務） | 進階 | 除下列區域外的所有 Power Automate 區域 ： - 美國政府 （GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部 （DoD） |
| 連絡人 | |
|---|---|
| 名稱 | Blackbaud 支持 |
| URL | https://www.blackbaud.com/support |
| skyapi@blackbaud.com |
| 連接器中繼資料 | |
|---|---|
| Publisher | 布萊克博德公司 |
| 網站 | https://www.blackbaud.com/products/blackbaud-raisers-edge-nxt |
| 隱私策略 | https://www.blackbaud.com/privacy-shield |
| 類別 | 銷售和客戶關係管理;生產力 |
Raiser 的 Edge NXT 是一款全面的基於雲的籌款和捐助者管理軟件解決方案，專為非營利組織和整個社會公益社區構建。
該連接器建立在 Blackbaud 的 SKY API 之上，並提供操作來幫助管理 The Raiser's Edge NXT 中的事件和相關實體，包括：
- 活動
- Participants
- 費用和捐款
- 不勝枚舉...
如需詳細資訊，請檢視 文件。
先決條件
若要使用此連接器，您必須擁有 Blackbaud ID 帳戶，才能存取一或多個 Blackbaud 環境。
此外，您組織的管理員還必須在系統內執行管理員層級動作，才能讓此連接器存取您的 Blackbaud 環境。 有關這些先決條件的詳細資訊，請參閱 初始設定 文件。
如何取得憑證？
您組織的管理員將向您發送組織的 Raiser's Edge NXT 環境的邀請，並在環境中配置您的用戶帳戶權限。 使用此連接器不需要其他認證。
已知問題與限制
連接器將在您的使用者帳戶的內容中運作，因此將受限於您在環境中的使用者權限。
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 100 | 60 秒 |
動作
| 列出事件 |
傳回事件清單。 |
| 列出事件附件 |
列出事件的附件。 |
| 列出參與者捐款 |
列出參與者的捐款。 |
| 列出參與者費用 |
列出參與者的費用。 |
| 列出參與者費用支付 |
列出參與者的費用支付。 |
| 列出參與者選項 |
列出參與者的參與者選項。 |
| 列出活動參與者 |
列出活動的參與者。 |
| 列出活動參與者選項 |
列出事件的參與者選項。 |
| 列出活動費用 |
列出活動的費用。 |
| 取得參與者 |
傳回特定事件參與者的相關資訊。 |
| 取得活動 |
傳回事件的相關資訊。 |
| 建立事件 |
建立新事件。 |
| 建立參與者 |
為事件建立新參與者。 |
| 建立參與者捐款 |
為參與者建立新的捐款。 |
| 建立參與者費用 |
為參與者建立新費用。 |
| 建立參與者費用付款 |
為參與者建立新的費用付款。 |
| 建立參與者選項 |
為參與者建立新的參與者選項。 |
| 建立活動參與者選項 |
為事件建立新的參與者選項。 |
| 建立活動費用 |
為事件建立新費用。 |
| 建立活動附件 |
建立新的事件附件。 |
| 更新事件附件 |
更新事件附件。 |
| 更新參與者 |
更新參與者的詳細資料。 |
| 更新參與者選項 |
更新參與者選項的詳細資料。 |
| 更新活動 |
更新事件的詳細資料。 |
列出事件
傳回事件清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
類別
|
category | string |
根據事件類別進行篩選。 |
|
|
查詢標識碼
|
lookup_id | string |
符合事件記錄自訂識別碼之結果的篩選器。 |
|
|
開始日期
|
start_date_from | date |
將結果篩選為開始日期在指定日期或之後的事件 （例如：「2020-09-18」）。 |
|
|
開始日期為
|
start_date_to | date |
將結果篩選為開始日期在指定日期或之前的事件 （例如：「2020-09-18」）。 |
|
|
包括不活躍？
|
include_inactive | boolean |
包括非活動事件？ |
|
|
限制
|
limit | integer |
代表要傳回的記錄數目。 預設值為 500。 最大值為 10000。 |
|
|
Offset
|
offset | integer |
代表要略過的記錄數。 用於分頁。 |
|
|
事件識別碼
|
event_id | string |
篩選符合指定系統記錄 ID 的事件。 |
|
|
名稱
|
name | string |
篩選符合指定名稱的事件。 |
|
|
添加日期或之後
|
date_added | date-time |
將結果篩選為在指定日期或之後建立的事件 （例如：「2020-09-18T04：13：56Z」）。 |
|
|
修改日期或之後
|
last_modified | date-time |
將結果篩選為在指定日期或之後修改的事件 （例如：「2020-09-18T04：13：56Z」）。 |
傳回
活動
列出事件附件
列出事件的附件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
事件識別碼
|
event_id | True | string |
事件的系統記錄 ID。 |
傳回
Attachments
列出參與者捐款
列出參與者的捐款。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
參與者 ID
|
participant_id | True | string |
參與者的系統記錄 ID。 |
|
限制
|
limit | integer |
代表要傳回的記錄數目。 預設值為 500。 最大值為 10000。 |
|
|
Offset
|
offset | integer |
代表要略過的記錄數。 用於分頁。 預設值為 0。 |
傳回
捐款
列出參與者費用
列出參與者的費用。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
參與者 ID
|
participant_id | True | string |
參與者的系統記錄 ID。 |
|
限制
|
limit | integer |
代表要傳回的記錄數目。 預設值為 500。 最大值為 10000。 |
|
|
Offset
|
offset | integer |
代表要略過的記錄數。 用於分頁。 預設值為 0。 |
傳回
費用
列出參與者費用支付
列出參與者的費用支付。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
參與者 ID
|
participant_id | True | string |
參與者的系統記錄 ID。 |
|
限制
|
limit | integer |
代表要傳回的記錄數目。 預設值為 500。 最大值為 10000。 |
|
|
Offset
|
offset | integer |
代表要略過的記錄數。 用於分頁。 預設值為 0。 |
傳回
費用支付
列出參與者選項
列出參與者的參與者選項。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
參與者 ID
|
participant_id | True | string |
參與者的系統記錄 ID。 |
傳回
參與者選項
列出活動參與者
列出活動的參與者。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
事件識別碼
|
event_id | True | string |
事件的系統記錄 ID。 |
|
回覆狀態
|
rsvp_status | string |
根據 RSVP 狀態過濾參與者。 |
|
|
邀請狀態
|
invitation_status | string |
根據邀請狀態篩選參與者。 |
|
|
參與程度
|
participation_level | string |
根據參與程度篩選參與者。 |
|
|
參加過嗎？
|
attended_filter | boolean |
篩選以包含或排除標示為已出席的參與者。 |
|
|
支付的費用？
|
fees_paid_filter | boolean |
篩選以包含或排除已支付費用的參與者。 |
|
|
限制
|
limit | integer |
代表要傳回的記錄數目。 預設值為 500。 最大值為 10000。 |
|
|
Offset
|
offset | integer |
代表要略過的記錄數。 用於分頁。 |
|
|
是選民嗎？
|
is_constituent_filter | boolean |
篩選以包含或排除作為選件的參與者。 |
|
|
有符合條件的電子郵件嗎？
|
email_eligible_filter | boolean |
根據參與者的主要電子郵件地址是否未標示為「不傳送電子郵件？」來篩選包含或排除參與者？ |
|
|
有符合條件的手機嗎？
|
phone_call_eligible_filter | boolean |
根據參與者是否有未標示為「請勿撥打電話」的主要電話號碼，篩選是否包含或排除參與者。 |
|
|
名稱
|
name | string |
篩選符合指定名稱的參與者。 |
|
|
添加日期或之後
|
date_added | date-time |
將結果篩選為在指定日期或之後建立的參與者 （例如：「2020-09-18T04：13：56Z」）。 |
|
|
修改日期或之後
|
last_modified | date-time |
將結果篩選為在指定日期或之後修改的參與者 （例如：「2020-09-18T04：13：56Z」）。 |
傳回
Participants
列出活動參與者選項
列出事件的參與者選項。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
事件識別碼
|
event_id | True | string |
事件的標識碼。 |
傳回
活動參與者選項
列出活動費用
列出活動的費用。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
事件識別碼
|
event_id | True | string |
事件的系統記錄 ID。 |
傳回
費用
取得參與者
傳回特定事件參與者的相關資訊。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
參與者 ID
|
participant_id | True | string |
參與者的系統記錄 ID。 |
傳回
參與者
取得活動
傳回事件的相關資訊。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
事件識別碼
|
event_id | True | string |
要取得之事件的系統記錄識別碼。 |
傳回
Event
建立事件
建立新事件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
事件名稱
|
name | True | string |
事件的名稱。 |
|
Description
|
description | string |
事件的描述。 |
|
|
類別
|
name | True | string |
類別名稱。 |
|
開始日期
|
start_date | True | date |
活動的開始日期 （例如：「2020-09-18」）。 |
|
開始時間
|
start_time | string |
活動的開始時間 （例如：「07：30」）。 |
|
|
結束日期
|
end_date | date |
活動的結束日期 （例如：「2020-09-18」）。 |
|
|
結束時間
|
end_time | string |
活動結束時間 （例如：「07：30）」。 |
|
|
查詢標識碼
|
lookup_id | string |
事件的查閱 ID。 |
|
|
容量
|
capacity | integer |
可以參加活動的人數。 |
|
|
Goal
|
goal | double |
活動的金錢目標。 |
|
|
行銷活動ID
|
campaign_id | string |
與事件相關聯之行銷活動的系統記錄 ID。 |
|
|
基金編號
|
fund_id | string |
與事件相關聯之基金的系統記錄 ID。 |
|
|
㥩？
|
inactive | boolean |
活動是否活躍？ |
傳回
已建立事件
建立參與者
為事件建立新參與者。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
事件識別碼
|
event_id | True | string |
事件的系統記錄 ID。 |
|
選區 ID
|
constituent_id | True | string |
參與者的組成 ID。 |
|
主機 ID
|
host_id | string |
主持人參與者記錄的識別碼。 |
|
|
回覆狀態
|
rsvp_status | string |
參與者參與活動的狀態。 |
|
|
參加過嗎？
|
attended | boolean |
參與者是否參加了活動？ |
|
|
邀請狀態
|
invitation_status | string |
參與者邀請的狀態。 |
|
|
天
|
d | integer |
模糊約會中的一天。 |
|
|
個月
|
m | integer |
模糊日期中的月份。 |
|
|
年
|
y | integer |
模糊日期中的年份。 |
|
|
天
|
d | integer |
模糊約會中的一天。 |
|
|
個月
|
m | integer |
模糊日期中的月份。 |
|
|
年
|
y | integer |
模糊日期中的年份。 |
|
|
參與程度
|
name | True | string |
參與層級的名稱。 |
|
摘要說明
|
summary_note | string |
釘選到參與者記錄的快速參考資訊。 |
傳回
已建立的參與者
建立參與者捐款
為參與者建立新的捐款。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
參與者 ID
|
participant_id | True | string |
參與者的系統記錄 ID。 |
|
禮品 ID
|
gift_id | True | string |
參與者捐贈所鏈結之禮物的系統記錄 ID。 |
傳回
創建的參與者捐款
建立參與者費用
為參與者建立新費用。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
參與者 ID
|
participant_id | True | string |
參與者的系統記錄 ID。 |
|
事件識別碼
|
event_id | True | string |
事件的系統記錄 ID。 |
|
費用
|
event_fee_id | True | string |
活動費用。 |
|
數量
|
quantity | True | integer |
購買的數量。 |
|
費用金額
|
fee_amount | True | double |
與費用相關的金額。 |
|
供款金額
|
contribution_amount | True | double |
高於活動費用的捐贈費用金額。 這是通常出現在收據上的金額。 |
|
天
|
d | integer |
模糊約會中的一天。 |
|
|
個月
|
m | integer |
模糊日期中的月份。 |
|
|
年
|
y | integer |
模糊日期中的年份。 |
傳回
創建的參與者費用
建立參與者費用付款
為參與者建立新的費用付款。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
參與者 ID
|
participant_id | True | string |
參與者的系統記錄 ID。 |
|
禮品 ID
|
gift_id | True | string |
參與者費用所連結之禮物的系統記錄 ID。 |
|
應用金額
|
applied_amount | True | double |
適用於參與者費用的付款金額。 |
傳回
已建立參與者費用支付
建立參與者選項
為參與者建立新的參與者選項。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
參與者 ID
|
participant_id | True | string |
參與者的 ID。 |
|
body
|
body | True | dynamic |
代表要建立的參與者選項的物件。 |
傳回
已建立參與者選項
建立活動參與者選項
為事件建立新的參與者選項。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
事件識別碼
|
event_id | True | string |
事件的標識碼。 |
|
名稱
|
name | True | string |
活動參與者選項的名稱。 |
|
輸入類型
|
input_type | True | string |
參與者可用來提供回應的值類型。 |
|
允許多選？
|
multi_select | boolean |
允許清單使用多個值嗎？ |
|
|
名稱
|
name | string |
清單選項的名稱。 |
|
|
序列
|
sequence | integer |
用於排序的從 0 開始的序列。 |
傳回
已建立的活動參與者選項
建立活動費用
為事件建立新費用。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
事件識別碼
|
event_id | True | string |
事件的系統記錄 ID。 |
|
名稱
|
name | True | string |
費用的名稱。 |
|
費用金額
|
cost | True | double |
與費用相關的金額。 |
|
供款金額
|
contribution_amount | True | double |
高於活動費用的捐贈費用金額。 |
傳回
創建活動費用
建立活動附件
建立新的事件附件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
事件識別碼
|
event_id | True | string |
事件的系統記錄 ID。 |
|
類型
|
type | True | string |
附件類型。 實體附件是儲存在本機或網路上的上傳檔案，例如影像、PDF 或 Word 文件。 它們在系統中儲存和管理。 連結附件是指向線上或雲端儲存帳戶中的檔案（例如圖像、部落格文章或 YouTube 影片）的連結。 它們在外部儲存和管理。 |
|
名稱
|
name | string |
附件的名稱。 字元限制：150。 |
|
|
Date
|
date | date-time |
附件的日期 （例如：「2020-09-18T04：13：56Z」）。 如果未提供，此欄位預設為目前日期和時間。 |
|
|
URL
|
url | string |
附件的 URL。 這是連結附件所必需的，不適用於實體附件。 |
|
|
檔案名稱
|
file_name | string |
檔案的檔名。 字元限制：36 個。 僅適用於實體附件。 |
|
|
檔案 ID
|
file_id | string |
檔案的識別碼。 字元限制：36 個。 僅適用於實體附件。 |
|
|
縮圖 ID
|
thumbnail_id | string |
縮圖的識別碼。 字元限制：36 個。 僅適用於實體附件。 |
|
|
Tags
|
tags | array of string |
與附件相關聯的標籤。 |
傳回
已建立的事件附件
更新事件附件
更新事件附件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
事件識別碼
|
event_id | True | string |
事件的系統記錄 ID。 |
|
附件 ID
|
attachment_id | True | string |
要更新之附件的系統記錄 ID。 |
|
名稱
|
name | string |
附件的名稱。 字元限制：150。 |
|
|
Date
|
date | date-time |
附件的日期 （例如：「2020-09-18T04：13：56Z」）。 |
|
|
URL
|
url | string |
附件的 URL。 這是連結附件所必需的，不適用於實體附件。 |
|
|
Tags
|
tags | array of string |
與附件相關聯的標籤。 |
更新參與者
更新參與者的詳細資料。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
參與者 ID
|
participant_id | True | string |
要更新之參與者的系統記錄 ID。 |
|
選區 ID
|
constituent_id | string |
參與者的組成 ID。 |
|
|
主機 ID
|
host_id | string |
主持人參與者記錄的識別碼。 |
|
|
回覆狀態
|
rsvp_status | string |
參與者參與活動的狀態。 |
|
|
參加過嗎？
|
attended | boolean |
參與者是否參加了活動？ |
|
|
邀請狀態
|
invitation_status | string |
參與者邀請的狀態。 |
|
|
天
|
d | integer |
模糊約會中的一天。 |
|
|
個月
|
m | integer |
模糊日期中的月份。 |
|
|
年
|
y | integer |
模糊日期中的年份。 |
|
|
天
|
d | integer |
模糊約會中的一天。 |
|
|
個月
|
m | integer |
模糊日期中的月份。 |
|
|
年
|
y | integer |
模糊日期中的年份。 |
|
|
參與程度
|
name | True | string |
參與層級的名稱。 |
|
摘要說明
|
summary_note | string |
釘選到參與者記錄的快速參考資訊。 |
更新參與者選項
更新參與者選項的詳細資料。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
參與者選項 ID
|
option_id | True | string |
要更新的參與者選項的系統記錄 ID。 |
|
價值觀
|
option_value | True | string |
參與者對選項的回應。 |
更新活動
更新事件的詳細資料。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
事件識別碼
|
event_id | True | string |
要更新之事件的系統記錄識別碼。 |
|
事件名稱
|
name | string |
事件的名稱。 |
|
|
Description
|
description | string |
事件的描述。 |
|
|
類別
|
name | True | string |
類別名稱。 |
|
開始日期
|
start_date | date |
活動的開始日期 （例如：「2020-09-18」）。 |
|
|
開始時間
|
start_time | string |
活動的開始時間 （例如：「07：30」）。 |
|
|
結束日期
|
end_date | date |
活動的結束日期 （例如：「2020-09-18」）。 |
|
|
結束時間
|
end_time | string |
活動的結束時間 （例如：「07：30」）。 |
|
|
查詢標識碼
|
lookup_id | string |
事件的查閱 ID。 |
|
|
容量
|
capacity | integer |
可以參加活動的人數。 |
|
|
Goal
|
goal | double |
活動的金錢目標。 |
|
|
行銷活動ID
|
campaign_id | string |
與事件相關聯之行銷活動的系統記錄 ID。 |
|
|
基金編號
|
fund_id | string |
與事件相關聯之基金的系統記錄 ID。 |
|
|
㥩？
|
inactive | boolean |
活動是否活躍？ |
定義
EventApi.AdministrativeArea
定義用於地址行政區域的資料模型 （例如：美國的州）。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
行政區域的記錄 ID。 |
|
名稱
|
name | string |
行政區域的名稱。 |
|
簡短說明
|
short_description | string |
行政區域的簡短描述。 |
EventApi.ApiCollectionOfEventFee
費用
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後，可擷取到集合中的項目數目。 limit和offset參數不會影響計數，但為了方便分頁，它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of EventApi.EventFee |
回應中包含的專案集。 這可能是集合中項目的子集。 |
EventApi.ApiCollectionOfEventListEntry
活動
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後，可擷取到集合中的項目數目。 limit和offset參數不會影響計數，但為了方便分頁，它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of EventApi.EventListEntry |
回應中包含的專案集。 這可能是集合中項目的子集。 |
EventApi.ApiCollectionOfEventParticipant選項
活動參與者選項
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後，可擷取到集合中的項目數目。 limit和offset參數不會影響計數，但為了方便分頁，它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of EventApi.EventParticipantOption |
回應中包含的專案集。 這可能是集合中項目的子集。 |
EventApi.ApiCollectionOfParticipant捐贈
捐款
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後，可擷取到集合中的項目數目。 limit和offset參數不會影響計數，但為了方便分頁，它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of EventApi.ParticipantDonation |
回應中包含的專案集。 這可能是集合中項目的子集。 |
EventApi.ApiCollectionOfParticipantFee
費用
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後，可擷取到集合中的項目數目。 limit和offset參數不會影響計數，但為了方便分頁，它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of EventApi.ParticipantFee |
回應中包含的專案集。 這可能是集合中項目的子集。 |
EventApi.ApiCollectionOfParticipantFeePayment
費用支付
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後，可擷取到集合中的項目數目。 limit和offset參數不會影響計數，但為了方便分頁，它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of EventApi.ParticipantFeePayment |
回應中包含的專案集。 這可能是集合中項目的子集。 |
EventApi.ApiCollectionOfParticipantListEntry
Participants
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後，可擷取到集合中的項目數目。 limit和offset參數不會影響計數，但為了方便分頁，它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of EventApi.ParticipantListEntry |
回應中包含的專案集。 這可能是集合中項目的子集。 |
EventApi.ApiCollectionOfParticipant選項
參與者選項
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後，可擷取到集合中的項目數目。 limit和offset參數不會影響計數，但為了方便分頁，它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of EventApi.ParticipantOption |
回應中包含的專案集。 這可能是集合中項目的子集。 |
EventApi.國家/地區
定義用於地址國家/地區的資料模型。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
國家/地區記錄的識別碼。 |
|
顯示名稱
|
display_name | string |
國家/地區的顯示名稱。 |
|
ISO代碼
|
iso_alpha2_code | string |
該國的 ISO 3166-1 alpha-2 代碼。 |
EventApi.CreatedEvent
已建立事件
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立事件的ID。 |
EventApi.CreatedEventAttachment
已建立的事件附件
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立的事件附件的ID。 |
EventApi.CreatedEventFee
創建活動費用
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立的事件費用的 ID。 |
EventApi.CreatedEventParticipant選項
已建立的活動參與者選項
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立的事件參與者選項的 ID。 |
EventApi.CreatedParticipant
已建立的參與者
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立參與者的識別碼。 |
EventApi.CreatedParticipant捐贈
創建的參與者捐款
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立的參與者捐款的ID。 |
EventApi.CreatedParticipantFee
創建的參與者費用
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立的參與者費用的 ID。 |
EventApi.CreatedParticipantFeePayment
已建立參與者費用支付
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立的參與者費用付款的 ID。 |
EventApi.CreatedParticipant選項
已建立參與者選項
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立的參與者選項的 ID。 |
EventApi.Event
Event
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
事件的系統記錄 ID。 這與儲存在lookup_id中的使用者可定義事件識別碼不同。 |
|
名稱
|
name | string |
事件的名稱。 |
|
Description
|
description | string |
事件的描述。 |
|
開始日期
|
start_date | date |
事件的開始日期。 |
|
開始時間
|
start_time | string |
事件的開始時間。 |
|
結束日期
|
end_date | date |
事件的結束日期。 |
|
結束時間
|
end_time | string |
事件的結束時間。 |
|
類別
|
category | EventApi.EventCategory |
事件類別是事件的自訂分類。 |
|
查詢標識碼
|
lookup_id | string |
事件的查閱 ID。 |
|
地點
|
location | EventApi.Location |
定義用於位置的資料模型。 |
|
容量
|
capacity | integer |
可以參加活動的人數。 |
|
Goal
|
goal | double |
活動的金錢目標。 |
|
行銷活動ID
|
campaign_id | string |
與事件相關聯之行銷活動的系統記錄 ID。 |
|
基金編號
|
fund_id | string |
與事件相關聯之基金的系統記錄 ID。 |
|
㥩？
|
inactive | boolean |
活動是否處於非活動狀態？ |
|
新增日期
|
date_added | date-time |
建立事件的日期。 |
|
修改日期
|
date_modified | date-time |
上次修改事件的日期。 |
EventApi.EventAttachment
Attachment
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
附件的系統記錄 ID。 |
|
事件識別碼
|
parent_id | string |
與附件相關聯之事件的系統記錄 ID。 |
|
類型
|
type | string |
附件類型。 實體附件是儲存在本機或網路上的上傳檔案，例如影像、PDF 或 Word 文件。 它們在系統中儲存和管理。 連結附件是指向線上或雲端儲存帳戶中的檔案（例如圖像、部落格文章或 YouTube 影片）的連結。 它們在外部儲存和管理。 |
|
名稱
|
name | string |
附件的名稱。 字元限制：150。 |
|
Date
|
date | date-time |
附件的日期。 |
|
URL
|
url | string |
附件的 URL。 這是連結附件所必需的，不適用於實體附件。 |
|
檔案名稱
|
file_name | string |
檔案的檔名。 字元限制：36 個。 僅適用於實體附件。 |
|
檔案 ID
|
file_id | string |
檔案的識別碼。 字元限制：36 個。 僅適用於實體附件。 |
|
縮圖 ID
|
thumbnail_id | string |
縮圖的識別碼。 字元限制：36 個。 僅適用於實體附件。 |
|
縮圖網址
|
thumbnail_url | string |
縮圖的 URL。 適用於僅影像的實體附件。 包含限制存取時間限制為 60 分鐘的限時簽名。 |
|
內容類型
|
content_type | string |
內容類型。 僅適用於實體附件。 |
|
檔案大小
|
file_size | integer |
檔案大小 （以位元組為單位）。 僅適用於實體附件。 |
|
Tags
|
tags | array of string |
與附件相關聯的標籤。 |
EventApi.EventAttachment集合
Attachments
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後，可擷取到集合中的項目數目。 limit和offset參數不會影響計數，但為了方便分頁，它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of EventApi.EventAttachment |
回應中包含的專案集。 這可能是集合中項目的子集。 |
EventApi.Event類別
事件類別是事件的自訂分類。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
事件類別的系統記錄 ID。 |
|
名稱
|
name | string |
事件類別的名稱。 |
|
㥩？
|
inactive | boolean |
此類別是否處於非活動狀態？ |
EventApi.EventFee
活動費用是組織對個人或組織參加或參加活動收取的費用。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
事件費用的系統記錄 ID。 |
|
名稱
|
name | string |
活動費用的名稱。 |
|
金額
|
cost | double |
費用的成本。 |
|
供款金額
|
contribution_amount | double |
此費用的免稅金額。 |
|
已售出數量
|
number_sold | integer |
已售出的費用數量。 |
EventApi.EventListEntry
Event
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
事件的系統記錄 ID。 |
|
名稱
|
name | string |
事件的名稱。 |
|
開始日期
|
start_date | date |
事件的開始日期。 |
|
開始時間
|
start_time | string |
事件的開始時間。 |
|
結束日期
|
end_date | date |
事件的結束日期。 |
|
結束時間
|
end_time | string |
事件的結束時間。 |
|
類別
|
category | EventApi.EventCategory |
事件類別是事件的自訂分類。 |
|
查詢標識碼
|
lookup_id | string |
事件的查閱 ID。 |
|
容量
|
capacity | integer |
可以參加活動的人數。 |
|
出席
|
attending_count | integer |
計劃參加的活動參與者人數。 |
|
手動
|
attended_count | integer |
活動出席者人數。 |
|
邀請
|
invited_count | integer |
活動受邀者人數。 |
|
營收
|
revenue | double |
活動的已實現收入。 |
|
Goal
|
goal | double |
活動的金錢目標。 |
|
目標百分比
|
percent_of_goal | integer |
已實現的收入佔目標收入的百分比。 |
|
㥩？
|
inactive | boolean |
活動是否處於非活動狀態？ |
|
新增日期
|
date_added | date-time |
建立事件的日期。 |
|
修改日期
|
date_modified | date-time |
上次修改事件的日期。 |
EventApi.EventParticipant選項
活動參與者選項是收集參與者詳細資訊的欄位，例如 T 恤尺寸、膳食偏好或座位要求。 設定事件的選項及其值，然後為每個參與者新增回應。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
事件參與者選項的系統記錄 ID。 |
|
名稱
|
name | string |
活動參與者選項的名稱。 |
|
輸入類型
|
input_type | string |
活動參與者選項的類型。 |
|
允許多選？
|
multi_select | boolean |
允許清單使用多個值嗎？ |
|
list_options
|
list_options | array of EventApi.EventParticipantOptionListOption |
可用的清單選項。 |
|
由用戶添加
|
added_by_user | string |
新增選項的使用者識別碼。 |
|
由用戶修改
|
updated_by_user | string |
修改選項的使用者識別碼。 |
|
由服務添加
|
added_by_service | string |
新增此選項的服務名稱。 |
|
由服務修改
|
updated_by_service | string |
修改此選項的服務名稱。 |
|
添加日期
|
date_added | date-time |
建立選項的日期。 |
|
修改日期
|
date_updated | date-time |
上次修改選項的日期。 |
|
版本
|
version | integer |
選項的版本號碼。 |
EventApi.EventParticipantOptionList選項
活動參與者選項清單選項
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
清單選項的識別碼 |
|
名稱
|
name | string |
清單選項的名稱 |
|
序列
|
sequence | integer |
用來排序清單選項的順序 |
EventApi.Locality
定義用於地址位置的資料模型。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
當地記錄的記錄 ID。 |
|
名稱
|
name | string |
當地名稱。 |
EventApi.位置
定義用於位置的資料模型。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
名稱
|
name | string |
位置的名稱。 |
|
地址行
|
address_lines | string |
該位置的地址行。 |
|
郵遞區號
|
postal_code | string |
該位置的郵遞區號。 |
|
地區
|
locality | EventApi.Locality |
定義用於地址位置的資料模型。 |
|
行政區域
|
administrative_area | EventApi.AdministrativeArea |
定義用於地址行政區域的資料模型 （例如：美國的州）。 |
|
次行政區
|
sub_administrative_area | EventApi.SubAdministrativeArea |
定義用於地址子行政區域的資料模型 （例如：美國的城市）。 |
|
country
|
country | EventApi.Country |
定義用於地址國家/地區的資料模型。 |
|
格式化地址
|
formatted_address | string |
位置的格式化地址 |
EventApi.成員資格
參與者的會員信息。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
會員類別
|
category | EventApi.MembershipCategory |
個人的成員資格類別。 |
EventApi.Membership類別
個人的成員資格類別。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
成員資格類別的系統記錄 ID。 |
|
名稱
|
name | string |
成員資格類別的名稱。 |
EventApi.參與者
參與者
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
參與者的系統記錄 ID。 |
|
選區 ID
|
constituent_id | string |
參與者的組成 ID。 |
|
事件識別碼
|
event_id | string |
正在參加之事件的系統記錄 ID。 |
|
主機 ID
|
host_id | string |
主持人參與者記錄的識別碼。 |
|
回覆狀態
|
rsvp_status | string |
參與者參與活動的狀態。 |
|
參加過嗎？
|
attended | boolean |
參與者是否參加了活動？ |
|
邀請狀態
|
invitation_status | string |
參與者邀請的狀態。 |
|
天
|
rsvp_date.d | integer |
模糊約會中的一天。 |
|
個月
|
rsvp_date.m | integer |
模糊日期中的月份。 |
|
年
|
rsvp_date.y | integer |
模糊日期中的年份。 |
|
天
|
invitation_date.d | integer |
模糊約會中的一天。 |
|
個月
|
invitation_date.m | integer |
模糊日期中的月份。 |
|
年
|
invitation_date.y | integer |
模糊日期中的年份。 |
|
摘要說明
|
summary_note | string |
釘選到參與者記錄的快速參考資訊。 |
|
參與程度
|
participation_level | EventApi.ParticipationLevel |
參與程度是參與者對活動的參與程度。 |
|
新增日期
|
date_added | date-time |
建立參與者的日期。 |
|
修改日期
|
date_modified | date-time |
上次修改參與者的日期。 |
EventApi.Participant捐贈
定義參與者捐贈的資料模型
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
參與者捐贈的系統記錄 ID。 |
|
禮品編號
|
gift_id | string |
參與者捐贈連結之禮物的系統記錄 ID。 |
EventApi.參與者費用
定義參與者費用的資料模型
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
參與者費用的 ID。 |
|
參與者 ID
|
participant_id | string |
參與者費用所連結的記錄識別碼。 |
|
數量
|
quantity | integer |
購買的數量。 |
|
費用金額
|
fee_amount | double |
參與者費用的金額。 |
|
供款金額
|
tax_receiptable_amount | double |
此費用的免稅金額。 |
|
天
|
date.d | integer |
模糊約會中的一天。 |
|
個月
|
date.m | integer |
模糊日期中的月份。 |
|
年
|
date.y | integer |
模糊日期中的年份。 |
|
活動費用
|
event_fee | EventApi.EventFee |
活動費用是組織對個人或組織參加或參加活動收取的費用。 |
EventApi.ParticipantFee支付
定義參與者費用支付的資料模型
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
參與者費用支付的系統記錄 ID。 |
|
參與者 ID
|
participant_id | string |
參與者費用付款連結至的參與者的系統記錄 ID。 |
|
禮品編號
|
gift_id | string |
參與者費用付款連結至的禮物的系統記錄 ID。 |
|
申請金額
|
applied_amount | double |
參與者費用支付的適用金額。 |
EventApi.ParticipantListEntry
參與者
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
參與者的系統記錄 ID。 |
|
連絡人識別碼
|
contact_id | string |
參加活動的連絡人的 ID。 |
|
回覆狀態
|
rsvp_status | string |
參與者參與活動的狀態。 |
|
參加過嗎？
|
attended | boolean |
參與者是否參加了活動？ |
|
邀請狀態
|
invitation_status | string |
參與者邀請的狀態。 |
|
天
|
rsvp_date.d | integer |
模糊約會中的一天。 |
|
個月
|
rsvp_date.m | integer |
模糊日期中的月份。 |
|
年
|
rsvp_date.y | integer |
模糊日期中的年份。 |
|
參與程度
|
participation_level | EventApi.ParticipationLevel |
參與程度是參與者對活動的參與程度。 |
|
Title
|
title | string |
參與者的頭銜。 |
|
名字
|
first_name | string |
參與者的名字。 |
|
姓氏
|
last_name | string |
參與者的姓氏。 |
|
名稱
|
name | string |
參與者的全名。 |
|
偏好名稱
|
preferred_name | string |
參與者的偏好名稱。 |
|
後綴
|
suffix | string |
參與者的尾碼。 |
|
查詢標識碼
|
lookup_id | string |
參與者的 LookupId。 |
|
Email
|
string |
參與者的電子郵件地址。 |
|
|
不發電子郵件？
|
do_not_email | boolean |
可以透過此電子郵件地址聯絡參與者嗎？ |
|
電話
|
phone | string |
參與者的電話號碼。 |
|
不打電話？
|
do_not_call | boolean |
可以通過此電話號碼聯繫參與者嗎？ |
|
中間名
|
middle_name | string |
參與者的中間名。 |
|
以前的名字
|
former_name | string |
參與者的舊名。 |
|
是選民嗎？
|
is_constituent | boolean |
參與者是選民嗎？ |
|
類別
|
class_of | string |
參與者的畢業班。 |
|
註冊費總額
|
total_registration_fees | double |
參與者的費用金額總和。 |
|
已付款總額
|
total_paid | double |
參與者支付的禮物與某種註冊費的總和。 |
|
捐款
|
donations | double |
參與者支付的禮物與某種捐贈的總和。 |
|
營收
|
revenue | double |
參與者在所有類型中支付的禮物總和。 |
|
座
|
seat | string |
參與者的座位分配。 |
|
名稱標籤
|
name_tag | string |
參與者的名稱標籤 |
|
摘要說明
|
summary_note | string |
釘選到參與者記錄的快速參考資訊。 |
|
新增日期
|
date_added | date-time |
建立參與者的日期。 |
|
修改日期
|
date_modified | date-time |
上次修改參與者的日期。 |
|
聯絡人 ID
|
host.contact_id | string |
參加活動的連絡人的 ID。 |
|
參與者 ID
|
host.participant_id | string |
參與者的 ID。 |
|
名稱
|
host.name | string |
參與者的全名。 |
|
嘉賓
|
guests | array of EventApi.ParticipantListParticipantSummary |
參與者的客人。 |
|
會員資格
|
memberships | array of EventApi.Membership |
參與者的成員資格資訊。 |
EventApi.ParticipantListParticipant摘要
參與者的基本摘要資訊。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
聯絡人 ID
|
contact_id | string |
參加活動的連絡人的 ID。 |
|
參與者 ID
|
participant_id | string |
參與者的 ID。 |
|
名稱
|
name | string |
參與者的全名。 |
EventApi.Participant選項
與指定參與者相關聯的參與者選項
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
參與者選項的系統記錄 ID。 |
|
參與者 ID
|
participant_id | string |
參與者的系統記錄 ID。 |
|
事件標識碼
|
event_id | string |
事件的系統記錄 ID。 |
|
活動參與者選項 ID
|
event_participant_option_id | string |
事件參與者選項的系統記錄 ID。 |
|
value
|
option_value | string |
參與者對選項的回應。 |
|
由用戶添加
|
added_by_user | string |
新增參與者選項的使用者識別碼。 |
|
由用戶修改
|
updated_by_user | string |
修改參與者選項的使用者識別碼。 |
|
由服務添加
|
added_by_service | string |
新增此參與者選項的服務名稱。 |
|
由服務修改
|
updated_by_service | string |
修改此參與者選項的服務名稱。 |
|
添加日期
|
date_added | date-time |
建立參與者選項的日期。 |
|
修改日期
|
date_updated | date-time |
上次修改參與者選項的日期。 |
EventApi.ParticipationLevel
參與程度是參與者對活動的參與程度。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
參與層級的系統記錄 ID。 |
|
名稱
|
name | string |
參與層級的名稱。 |
|
㥩？
|
is_inactive | boolean |
參與等級是否處於非活動狀態？ |
EventApi.SubAdministrativeArea
定義用於地址子行政區域的資料模型 （例如：美國的城市）。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
子行政區域的識別碼。 |
|
名稱
|
name | string |
子行政區域的名稱。 |