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 中的實體,包括:
- 成分
- 禮物
- 行動
- 註釋
- 自訂欄位
- Campaigns
- 項
- 上訴
- 不勝枚舉...
如需詳細資訊,請檢視 文件。
先決條件
若要使用此連接器,您必須擁有 Blackbaud ID 帳戶,才能存取一或多個 Blackbaud 環境。
此外,您組織的管理員還必須在系統內執行管理員層級動作,才能讓此連接器存取 The Raiser's Edge NXT。 有關這些先決條件的詳細資訊,請參閱 初始設定 文件。
如何取得憑證?
您組織的管理員將向您發送組織的 Raiser's Edge NXT 環境的邀請,並在環境中配置您的用戶帳戶權限。 使用此連接器不需要其他認證。
已知問題與限制
連接器將在您的使用者帳戶的內容中運作,因此將受限於您在環境中的使用者權限。
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 500 | 60 秒 |
動作
| 列出事件 |
傳回事件清單。 |
| 列出動作 |
傳回動作清單。 |
| 列出動作自訂欄位 |
列出動作的自訂欄位。 |
| 列出動作附件 |
列出動作的附件。 |
| 列出參與者捐款 |
列出參與者的捐款。 |
| 列出參與者費用 |
列出參與者的費用。 |
| 列出參與者費用支付 |
列出參與者的費用支付。 |
| 列出參與者選項 |
列出參與者的參與者選項。 |
| 列出商機附件 |
列出商機的附件。 |
| 列出基金 |
傳回資金清單。 |
| 列出基金自訂欄位 |
列出基金的自訂欄位。 |
| 列出套件 |
傳回套件清單。 |
| 列出成分 |
傳回成分清單。 |
| 列出成分代碼 |
列出成分的成分代碼。 |
| 列出成分地址 |
列出選區的地址。 |
| 列出成分票據 |
列出成分的附註。 |
| 列出成分評級 |
傳回選區的評等清單。 |
| 列出成分電話 |
列出選民的電話。 |
| 列出構成教育 |
列出選民的教育記錄。 |
| 列出機會 |
傳回機會清單。 |
| 列出機會自訂欄位 |
列出機會的自訂欄位。 |
| 列出活動參與者 |
列出活動的參與者。 |
| 列出活動參與者選項 |
列出事件的參與者選項。 |
| 列出活動費用 |
列出活動的費用。 |
| 列出申訴 |
傳回申訴清單。 |
| 列出申訴自訂欄位 |
列出申訴的自訂欄位。 |
| 列出申訴附件 |
列出上訴的附件。 |
| 列出禮品批次 |
列出禮品批次。 |
| 列出禮品自訂欄位 |
列出禮物的自訂欄位。 |
| 列出禮物 |
傳回禮物清單。 |
| 列出禮物附件 |
列出禮物的附件。 |
| 列出籌款活動指派 |
列出籌款活動的指派工作。 |
| 列出籌款活動的組成部分 |
列出選民的籌款活動指派。 |
| 列出組成別名 |
列出成分的別名。 |
| 列出組成動作 |
列出選區的動作。 |
| 列出組成自訂欄位 |
列出成分的自訂欄位。 |
| 列出組成關係 |
列出成分的關係。 |
| 列出組成附件 |
列出成分的附件。 |
| 列出行銷活動 |
傳回行銷活動清單。 |
| 列出行銷活動自訂欄位 |
列出行銷活動的自訂欄位。 |
| 列出行銷活動附件 |
列出行銷活動的附件。 |
| 列出資金附件 |
列出基金的附件。 |
| 列出選民同意記錄 |
列出選民的同意記錄。 |
| 列出選民徵集代碼 |
列出選民的徵求代碼。 |
| 列出選民線上狀態 |
列出選民的線上狀態。 |
| 列出選民電子郵件地址 |
列出選民的電子郵件地址。 |
| 刪除成分代碼 |
刪除組成代碼。 |
| 創建選民教育 |
創造新的組成教育。 |
| 取得參與者 |
傳回特定事件參與者的相關資訊。 |
| 取得套件 |
傳回封裝的相關資訊。 |
| 取得成份潛在客戶狀態 |
傳回選區的目前潛在客戶狀態。 |
| 取得活動 |
傳回事件的相關資訊。 |
| 取得行銷活動 |
傳回行銷活動的相關資訊。 |
| 取得選民動作 |
傳回組成動作的相關資訊。 |
| 將禮物添加到批次 |
將禮品新增至指定的禮品批次。 |
| 將記錄新增至清單 |
將一組記錄新增至現有清單。 |
| 建立事件 |
建立新事件。 |
| 建立個人關係 |
建立新的個人關係。 如果關係是與另一個成分的關係,則會為該成分建立互惠關係。 |
| 建立個別選區 |
建立新的個別選區。 |
| 建立動作自訂欄位 |
建立新的動作自訂欄位。 |
| 建立動作附件 |
建立新的動作附件。 |
| 建立募款活動指派 |
建立新的籌款活動指派。 |
| 建立參與者 |
為事件建立新參與者。 |
| 建立參與者捐款 |
為參與者建立新的捐款。 |
| 建立參與者費用 |
為參與者建立新費用。 |
| 建立參與者費用付款 |
為參與者建立新的費用付款。 |
| 建立參與者選項 |
為參與者建立新的參與者選項。 |
| 建立商機 |
創造新的機會。 |
| 建立基金自訂欄位 |
建立新的基金自訂欄位。 |
| 建立基金附件 |
建立新的基金附件。 |
| 建立成分代碼 |
建立新的組成代碼。 |
| 建立成分徵求代碼 |
建立新的選區徵求代碼。 |
| 建立成分評等 |
建立新的成分評等。 |
| 建立成分附註 |
建立新的成分附註。 |
| 建立文件位置 |
建立新的唯一文件識別碼和上傳位置,以與實體附件搭配使用。 回應將包括有關上傳文件內容的位置和方式的說明。 |
| 建立機會自訂欄位 |
建立新的商機自訂欄位。 |
| 建立機會附件 |
建立新的機會附件。 |
| 建立活動參與者選項 |
為事件建立新的參與者選項。 |
| 建立活動費用 |
為事件建立新費用。 |
| 建立申訴自訂欄位 |
建立新的申訴自訂欄位。 |
| 建立申訴附件 |
建立新的上訴附件。 |
| 建立禮品批次 |
建立新的禮品批次。 |
| 建立禮品自訂欄位 |
建立新的禮物自訂欄位。 |
| 建立禮物附件 |
建立新的禮物附件。 |
| 建立組成別名 |
建立新的組成別名。 |
| 建立組成動作 |
建立新的組成動作。 |
| 建立組織組成部分 |
建立新的組織組成部分。 |
| 建立組織關係 |
建立新的組織關係。 如果關係是與另一個成分的關係,則會為該成分建立互惠關係。 |
| 建立行銷活動自訂欄位 |
建立新的行銷活動自訂欄位。 |
| 建立行銷活動附件 |
建立新的行銷活動附件。 |
| 建立選區地址 |
建立新的組成地址。 |
| 建立選區自訂欄位 |
建立新的組成部分自訂欄位。 |
| 建立選區附件 |
建立新的組成附件。 |
| 建立選區電話 |
建立新的組成電話。 |
| 建立選民同意記錄 |
建立新的選民同意記錄。 |
| 建立選民線上形象 |
創建新的選民在線形象。 |
| 建立選民電子郵件地址 |
建立新的選民電子郵件地址。 |
| 從一組記錄建立清單 |
建立篩選為指定記錄集的新清單。 |
| 提出申訴 |
傳回上訴的相關資訊。 |
| 搜尋選民 |
根據提供的搜尋文字執行成分搜尋。 支援名字、姓氏、偏好名稱、以前的名字、別名、電子郵件地址、電話號碼、地址或查找 ID。 名字組合(例如名字和姓氏或偏好的名字和姓氏)是有效的,但除此之外,搜尋一次只支援一個參數。 根據預設,搜尋會包含聽起來與您的條件相似的結果。 例如,搜尋「Smith」會包含「Smyth」和其他替代拼字的相符專案。 此搜尋不支援萬用字元,例如 * 或 ?。 搜尋結果限制為 500 筆記錄。 |
| 更新動作自訂欄位 |
更新動作自訂欄位。 |
| 更新動作附件 |
更新動作附件。 |
| 更新參與者 |
更新參與者的詳細資料。 |
| 更新參與者選項 |
更新參與者選項的詳細資料。 |
| 更新商機 |
更新商機。 |
| 更新基金自訂欄位 |
更新基金自訂欄位。 |
| 更新基金附件 |
更新基金附件。 |
| 更新成分代碼 |
更新成分代碼。 |
| 更新成分地址 |
更新組成地址。 |
| 更新成分附註 |
更新成分票據。 |
| 更新機會自訂欄位 |
更新機會自訂欄位。 |
| 更新機會附件 |
更新機會附件。 |
| 更新活動 |
更新事件的詳細資料。 |
| 更新申訴自訂欄位 |
更新申訴自訂欄位。 |
| 更新申訴附件 |
更新申訴附件。 |
| 更新禮品收據詳情 |
更新禮物的收據詳細資料。 |
| 更新禮物確認詳情 |
更新禮物的通知詳細資料。 |
| 更新禮物自訂欄位 |
更新禮物自訂欄位。 |
| 更新禮物附件 |
更新禮物附件。 |
| 更新組成別名 |
更新組成別名。 |
| 更新組成動作 |
更新組成動作。 |
| 更新組成徵求代碼 |
更新選民徵求代碼。 |
| 更新組成自訂欄位 |
更新組成自訂欄位。 |
| 更新組成關係 |
更新選區的關係。 如果存在互惠關係,也會修改它以反映變更。 這不包括對「comments」屬性的變更,該屬性特定於每筆記錄,並且可以在每筆記錄上獨立修改。 |
| 更新組成附件 |
更新組成附件。 |
| 更新行銷活動自訂欄位 |
更新行銷活動自訂欄位。 |
| 更新行銷活動附件 |
更新行銷活動附件。 |
| 更新選區電話 |
更新組成的電話。 |
| 更新選民 |
更新選區。 |
| 更新選民個人資料相片 |
更新選民的當前個人資料圖片。 |
| 更新選民教育 |
更新選民教育。 |
| 更新選民線上狀態 |
更新選民線上狀態。 |
| 更新選民電子郵件地址 |
更新選民電子郵件地址。 |
| 獲取選民 |
傳回成分的相關資訊。 |
| 獲取選民個人資料圖片 |
傳回選民的目前設定檔圖片。 |
| 獲得基金 |
傳回基金的相關資訊。 |
| 獲得成分股最新禮物 |
傳回選民的最新禮物。 |
| 獲得機會 |
傳回商機的相關資訊。 附註:此端點會傳回延遲約為 10 分鐘的狀態屬性。 |
| 獲得禮物 |
傳回有關禮物的資訊。 |
| 獲得選民最偉大的禮物 |
為選民返回最大的禮物。 |
| 獲得選民第一份禮物 |
為選民退回第一份禮物。 |
| 獲得選民終身捐贈 |
傳回選件的存留期給出摘要。 |
| 製作禮物 |
創造一份新禮物。 |
列出事件
傳回事件清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
類別
|
category | 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 |
|---|---|---|---|---|
|
清單
|
list_id | string |
定義清單識別碼,用來將動作集篩選為指定清單中包含的動作集。 如果設定此值,則會忽略其他指定的篩選器。 |
|
|
計算狀態
|
computed_status | string |
代表根據計算動作狀態的結果篩選器。 可用的值為 Open、Completed 或 PastDue。 |
|
|
地位
|
status_code | string |
代表用於篩選結果的動作狀態碼 (僅適用於系統設定為使用動作狀態碼時)。 例如,「擱置中」會傳回狀態為「擱置中」的動作。 |
|
|
限制
|
limit | integer |
代表要傳回的記錄數目。 預設值為 500。 最大值為 5000。 |
|
|
Offset
|
offset | integer |
代表要略過的記錄數。 用於分頁。 |
|
|
添加日期或之後
|
date_added | date-time |
將結果篩選為在指定日期或之後建立的動作 (例如:「2020-09-18T04:13:56Z」)。 |
|
|
修改日期或之後
|
last_modified | date-time |
將結果篩選為在指定日期或之後修改的動作 (例如:「2020-09-18T04:13:56Z」)。 |
傳回
行動
列出動作自訂欄位
列出動作的自訂欄位。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
作ID
|
action_id | True | string |
動作的系統記錄 ID。 |
傳回
自訂欄位
列出動作附件
列出動作的附件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
作ID
|
action_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 |
|---|---|---|---|---|
|
機會 ID
|
opportunity_id | True | string |
商機的系統記錄識別碼。 |
傳回
Attachments
列出基金
傳回資金清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
限制
|
limit | integer |
代表要傳回的記錄數目。 預設值為 500。 最大值為 5000。 |
|
|
Offset
|
offset | integer |
代表要略過的記錄數。 用於分頁。 |
|
|
包括不活躍?
|
include_inactive | boolean |
包括不活躍的資金? |
|
|
添加日期或之後
|
date_added | date-time |
將結果篩選為在指定日期或之後建立的基金(例如:「2020-09-18T04:13:56Z」)。 |
|
|
修改日期或之後
|
last_modified | date-time |
將結果篩選為在指定日期或之後修改的基金(例如:「2020-09-18T04:13:56Z」)。 |
傳回
項
列出基金自訂欄位
列出基金的自訂欄位。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
基金編號
|
fund_id | True | string |
基金的系統記錄 ID。 |
傳回
自訂欄位
列出套件
傳回套件清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
申訴 ID
|
appeal_id | string |
代表以逗號分隔的申訴識別碼清單,以篩選結果。 例如,「506,918」只會傳回申訴 506 或申訴 918 的包裹。 |
|
|
限制
|
limit | integer |
代表要傳回的記錄數目。 預設值為 500。 最大值為 5000。 |
|
|
Offset
|
offset | integer |
代表要略過的記錄數。 用於分頁。 |
|
|
包括不活躍?
|
include_inactive | boolean |
包含非作用中的套件? |
|
|
添加日期或之後
|
date_added | date-time |
將結果篩選為在指定日期或之後建立的套件 (例如:「2020-09-18T04:13:56Z」)。 |
|
|
修改日期或之後
|
last_modified | date-time |
將結果篩選為在指定日期或之後修改的套件 (例如:「2020-09-18T04:13:56Z」)。 |
傳回
Packages
列出成分
傳回成分清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
清單
|
list_id | string |
定義清單識別碼,用來將成分集篩選為指定清單中包含的成分集。 如果設定此值,則會忽略其他指定的篩選器。 |
|
|
限制
|
limit | integer |
代表要傳回的記錄數目。 預設值為 500。 最大值為 5000。 |
|
|
Offset
|
offset | integer |
代表要略過的記錄數。 用於分頁。 |
|
|
組成代碼
|
constituent_code | string |
代表篩選清單的成分代碼。 例如,「董事會成員」只會傳回具有董事會成員成分代碼的成分。 |
|
|
選區 ID
|
constituent_id | string |
代表以逗點分隔的組成 ID 清單,以篩選結果。 例如,「280,1232」只會傳回成分 280 或成分 1232。 |
|
|
自訂欄位類別
|
custom_field_category | string |
代表用於篩選結果的自訂欄位類別。 例如,「週年紀念日」只會傳回具有作用中週年紀念自訂欄位的選區。 |
|
|
籌款活動狀態
|
fundraiser_status | string |
代表以逗號分隔的籌款活動狀態清單,以篩選結果。 例如,「Active,None」只會傳回籌款活動狀態為「Active」或「None」的選區。 此篩選器的有效值為 Active、Inactive 和 None。 |
|
|
包括死者?
|
include_deceased | boolean |
在回應中包括已故的選民? |
|
|
包括不活躍?
|
include_inactive | boolean |
在回應中包括不活躍的選民? |
|
|
郵遞區號
|
postal_code | string |
代表以逗號分隔的郵遞區號清單,以篩選結果。 例如,「29466,29492」只會傳回偏好地址郵遞區號以 29466 或 29492 開頭的選區,例如 29466、29492 或 29492-0727。 |
|
|
添加日期或之後
|
date_added | date-time |
將結果篩選為在指定日期或之後建立的成分 (例如:「2020-09-18T04:13:56Z」)。 |
|
|
修改日期或之後
|
last_modified | date-time |
將結果篩選為在指定日期或之後修改的成分 (例如:「2020-09-18T04:13:56Z」)。 |
|
|
排序依據
|
sort | string |
代表要排序結果的欄位清單。 默認情況下,結果以升序排列,“-”符號表示降序。 例如,「date_added,-last」會依「date_added」欄位遞增排序成分,然後依「last」欄位遞減排序。 |
傳回
成分
列出成分代碼
列出成分的成分代碼。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
選區 ID
|
constituent_id | True | string |
成分的系統記錄 ID。 |
傳回
組成代碼
列出成分地址
列出選區的地址。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
選區 ID
|
constituent_id | True | string |
成分的系統記錄 ID。 |
|
包括不活躍?
|
include_inactive | boolean |
包括不活躍的地址? |
傳回
Addresses
列出成分票據
列出成分的附註。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
選區 ID
|
constituent_id | True | string |
成分的系統記錄 ID。 |
傳回
註釋
列出成分評級
傳回選區的評等清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
選區 ID
|
constituent_id | True | string |
成分的系統記錄 ID |
|
包括不活躍?
|
include_inactive | boolean |
包括不活躍的評級? |
|
|
只有最近的?
|
most_recent_only | boolean |
只包含最新的評分? |
傳回
評級
列出成分電話
列出選民的電話。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
選區 ID
|
constituent_id | True | string |
成分的系統記錄 ID。 |
|
包括不活躍?
|
include_inactive | boolean |
包括非活動手機? |
傳回
電話
列出構成教育
列出選民的教育記錄。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
選區 ID
|
constituent_id | True | string |
成分的系統記錄 ID。 |
傳回
學歷
列出機會
傳回機會清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
清單
|
list_id | string |
定義用於將機會集篩選為指定清單中包含的機會集的清單識別碼。 如果設定此值,則會忽略其他指定的篩選器。 |
|
|
選區 ID
|
constituent_id | string |
代表以逗點分隔的組成 ID 清單,以篩選結果。 例如,「280,1232」只會傳回成分 280 或成分 1232 的機會。 |
|
|
限制
|
limit | integer |
代表要傳回的記錄數目。 預設值為 500。 最大值為 5000。 |
|
|
Offset
|
offset | integer |
代表要略過的記錄數。 用於分頁。 |
|
|
包括不活躍?
|
include_inactive | boolean |
包括不活躍的機會? |
|
|
添加日期或之後
|
date_added | date-time |
將結果篩選為在指定日期或之後建立的機會 (例如:「2020-09-18T04:13:56Z」)。 |
|
|
修改日期或之後
|
last_modified | date-time |
將結果篩選為在指定日期或之後修改的機會 (例如:「2020-09-18T04:13:56Z」)。 |
傳回
機會
列出機會自訂欄位
列出機會的自訂欄位。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
機會 ID
|
opportunity_id | True | string |
商機的系統記錄識別碼。 |
傳回
自訂欄位
列出活動參與者
列出活動的參與者。
參數
| 名稱 | 機碼 | 必要 | 類型 | 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 |
|---|---|---|---|---|
|
限制
|
limit | integer |
代表要傳回的記錄數目。 預設值為 500。 最大值為 5000。 |
|
|
Offset
|
offset | integer |
代表要略過的記錄數。 用於分頁。 |
|
|
包括不活躍?
|
include_inactive | boolean |
包括不活躍的上訴? |
|
|
添加日期或之後
|
date_added | date-time |
篩選結果為在指定日期或之後建立的申訴 (例如:「2020-09-18T04:13:56Z」)。 |
|
|
修改日期或之後
|
last_modified | date-time |
將結果篩選為在指定日期或之後修改的申訴 (例如:「2020-09-18T04:13:56Z」)。 |
傳回
上訴
列出申訴自訂欄位
列出申訴的自訂欄位。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
申訴 ID
|
appeal_id | True | string |
申訴的系統記錄 ID。 |
傳回
自訂欄位
列出申訴附件
列出上訴的附件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
申訴 ID
|
appeal_id | True | string |
申訴的系統記錄 ID。 |
傳回
Attachments
列出禮品批次
列出禮品批次。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
批號
|
batch_number | string |
代表符合指定數字之結果的篩選器。 |
|
|
批准?
|
approved | boolean |
代表禮品批次狀態的篩選器。 |
|
|
有例外嗎?
|
has_exceptions | boolean |
代表禮品批次是否包含例外狀況的篩選器。 |
|
|
限制
|
limit | integer |
代表要傳回的記錄數目。 預設值為 500。 最大值為 5000。 |
|
|
Offset
|
offset | integer |
代表要略過的記錄數。 用於分頁。 |
|
|
搜尋文字
|
search_text | string |
代表批次描述或批次編號欄位中包含的文字篩選器。 |
|
|
由...創建
|
created_by | string |
代表指定使用者所建立的禮品批次的篩選器。 |
傳回
禮品批次
列出禮品自訂欄位
列出禮物的自訂欄位。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
禮品 ID
|
gift_id | True | string |
禮品的系統記錄 ID。 |
傳回
自訂欄位
列出禮物
傳回禮物清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
清單
|
list_id | string |
定義清單識別碼,用來將禮物集篩選為指定清單中包含的禮物集。 如果設定此值,則會忽略其他指定的篩選器。 |
|
|
類型
|
gift_type | string |
代表以逗號分隔的禮物類型清單,以篩選結果。 例如,「MatchingGiftPledge,RecurringGift」只會傳回 MatchingGiftPledge 或 RecurringGift 類型的禮物。 |
|
|
選區 ID
|
constituent_id | string |
代表以逗點分隔的組成 ID 清單,以篩選結果。 例如,「280,1232」只會傳回來自選區 280 或選區 1232 的禮物。 |
|
|
行銷活動ID
|
campaign_id | string |
代表以逗號分隔的行銷活動識別碼清單,以篩選結果。 例如,「506,918」只會傳回行銷活動 506 或行銷活動 918 的禮物。 |
|
|
基金編號
|
fund_id | string |
代表以逗號分隔的基金識別碼清單,以篩選結果。 例如,「506,918」只會傳回基金 506 或基金 918 的禮物。 |
|
|
申訴 ID
|
appeal_id | string |
代表以逗號分隔的申訴識別碼清單,以篩選結果。 例如,「506,918」只會退回對 506 提出申訴或向 918 提出申訴的禮物。 |
|
|
限制
|
limit | integer |
代表要傳回的記錄數目。 預設值為 500。 最大值為 5000。 |
|
|
Offset
|
offset | integer |
代表要略過的記錄數。 用於分頁。 |
|
|
開始禮物日期
|
start_gift_date | date-time |
代表禮物日期在指定日期或之後的禮物的篩選器 (例如:「2020-09-18T04:13:56Z」)。 |
|
|
結束贈送日期
|
end_gift_date | date-time |
代表禮物日期在指定日期或之前的禮物的篩選器 (例如:「2020-09-18T04:13:56Z」)。 |
|
|
起始贈品金額
|
start_gift_amount | double |
代表金額大於或等於指定金額的禮物篩選器。 |
|
|
結束贈送金額
|
end_gift_amount | double |
代表金額小於或等於指定金額的禮物篩選器。 |
|
|
貼文狀態
|
post_status | string |
代表以逗號分隔的禮品貼文狀態清單,以篩選結果。 例如,「DoNotPost,Posted」只會傳回標示為 DoNotPost 或 Posted 的禮物。 |
|
|
收據狀態
|
receipt_status | string |
代表以逗號分隔的禮品收據狀態清單,以篩選結果。 例如,「DoNotReceipt,Receipted」只會傳回標示為 DoNotReceipt 或 Receipted 的禮物。 |
|
|
通知狀態
|
acknowledgement_status | string |
代表以逗號分隔的禮品確認狀態清單,以篩選結果。 例如,「DoNotAcknowledge,Acknowledged」只會傳回標示為 DoNotAcknowledge 或 Acknowledged 的禮物。 |
|
|
添加日期或之後
|
date_added | date-time |
篩選結果為在指定日期或之後建立的禮物(例如:「2020-09-18T04:13:56Z」)。 |
|
|
修改日期或之後
|
last_modified | date-time |
將結果篩選為在指定日期或之後修改的禮物(例如:「2020-09-18T04:13:56Z」)。 |
傳回
禮物
列出禮物附件
列出禮物的附件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
禮品 ID
|
gift_id | True | string |
禮品的系統記錄 ID。 |
傳回
Attachments
列出籌款活動指派
列出籌款活動的指派工作。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
籌款活動 ID
|
fundraiser_id | True | string |
要傳回其指派之籌款人的系統記錄識別碼。 |
|
限制
|
limit | integer |
代表要傳回的記錄數目。 預設值為 500。 最大值為 5000。 |
|
|
Offset
|
offset | integer |
代表要略過的記錄數。 用於分頁。 |
傳回
Assignments
列出籌款活動的組成部分
列出選民的籌款活動指派。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
選區 ID
|
constituent_id | True | string |
成分的系統記錄 ID。 |
|
包括不活躍?
|
include_inactive | boolean |
包括不活躍的籌款活動任務? |
傳回
籌款活動任務
列出組成別名
列出成分的別名。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
選區 ID
|
constituent_id | True | string |
成分的系統記錄 ID。 |
傳回
Aliases
列出組成動作
列出選區的動作。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
選區 ID
|
constituent_id | True | string |
成分的系統記錄 ID。 |
傳回
行動
列出組成自訂欄位
列出成分的自訂欄位。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
選區 ID
|
constituent_id | True | string |
成分的系統記錄 ID。 |
傳回
自訂欄位
列出組成關係
列出成分的關係。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
選區 ID
|
constituent_id | True | string |
成分的系統記錄 ID。 |
|
限制
|
limit | integer |
代表要傳回的記錄數目。 預設值為 500。 沒有最大值。 |
|
|
Offset
|
offset | integer |
代表要略過的記錄數。 用於分頁。 |
傳回
關係
列出組成附件
列出成分的附件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
選區 ID
|
constituent_id | True | string |
成分的系統記錄 ID。 |
傳回
Attachments
列出行銷活動
傳回行銷活動清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
限制
|
limit | integer |
代表要傳回的記錄數目。 預設值為 500。 最大值為 5000。 |
|
|
Offset
|
offset | integer |
代表要略過的記錄數。 用於分頁。 |
|
|
包括不活躍?
|
include_inactive | boolean |
包括不活躍的活動? |
|
|
添加日期或之後
|
date_added | date-time |
將結果篩選為在指定日期或之後建立的廣告活動 (例如:「2020-09-18T04:13:56Z」)。 |
|
|
修改日期或之後
|
last_modified | date-time |
將結果篩選為在指定日期或之後修改的廣告活動 (例如:「2020-09-18T04:13:56Z」)。 |
傳回
Campaigns
列出行銷活動自訂欄位
列出行銷活動的自訂欄位。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
行銷活動ID
|
campaign_id | True | string |
行銷活動的系統記錄ID。 |
傳回
自訂欄位
列出行銷活動附件
列出行銷活動的附件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
行銷活動ID
|
campaign_id | True | string |
行銷活動的系統記錄ID。 |
傳回
Attachments
列出資金附件
列出基金的附件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
基金編號
|
fund_id | True | string |
基金的系統記錄 ID。 |
傳回
Attachments
列出選民同意記錄
列出選民的同意記錄。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
選區 ID
|
constituent_id | True | string |
成分的系統記錄 ID。 |
|
只有最近的?
|
most_recent_only | boolean |
在回應中只包含每個頻道類別組合的最新同意記錄? |
傳回
同意記錄
列出選民徵集代碼
列出選民的徵求代碼。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
選區 ID
|
constituent_id | True | string |
成分的系統記錄 ID。 |
傳回
徵求代碼
列出選民線上狀態
列出選民的線上狀態。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
選區 ID
|
constituent_id | True | string |
成分的系統記錄 ID。 |
|
包括不活躍?
|
include_inactive | boolean |
包括不活躍的在線狀態? |
傳回
線上狀態
列出選民電子郵件地址
列出選民的電子郵件地址。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
選區 ID
|
constituent_id | True | string |
成分的系統記錄 ID。 |
|
包括不活躍?
|
include_inactive | boolean |
包含非活動電子郵件地址? |
傳回
電子郵件地址
刪除成分代碼
刪除組成代碼。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
組成代碼 ID
|
constituent_code_id | True | string |
要刪除的成分代碼的系統記錄 ID。 |
創建選民教育
創造新的組成教育。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
選區 ID
|
constituent_id | True | string |
與教育相關聯之選件的系統記錄 ID。 |
|
學校
|
school | True | string |
學校/機構名稱。 |
|
類型
|
type | string |
教育類型。 |
|
|
類別
|
class_of | string |
選民畢業的那一年。 |
|
|
地位
|
status | string |
教育狀況。 |
|
|
天
|
d | integer |
模糊約會中的一天。 |
|
|
月
|
m | integer |
模糊日期中的月份。 |
|
|
年
|
y | integer |
模糊日期中的年份。 |
|
|
天
|
d | integer |
模糊約會中的一天。 |
|
|
月
|
m | integer |
模糊日期中的月份。 |
|
|
年
|
y | integer |
模糊日期中的年份。 |
|
|
天
|
d | integer |
模糊約會中的一天。 |
|
|
月
|
m | integer |
模糊日期中的月份。 |
|
|
年
|
y | integer |
模糊日期中的年份。 |
|
|
度
|
degree | string |
獲得的學位。 |
|
|
平均積點
|
gpa | double |
平均績點。 |
|
|
學習主題
|
subject_of_study | string |
研究主題。 |
|
|
初?
|
primary | boolean |
這是選民的小學協會嗎? |
|
|
專業
|
majors | array of string |
主要學習課程。 |
|
|
未成年人
|
minors | array of string |
次要學習課程。 |
|
|
Campus
|
campus | string |
校園。 字元限制:50。 |
|
|
社會組織
|
social_organization | string |
社會組織。 字元限制:50。 |
|
|
已知名稱
|
known_name | string |
已知名稱。 字元限制:50。 |
|
|
學位類別
|
class_of_degree | string |
學位類別(僅適用於英國版本)。 |
|
|
部門
|
department | string |
教育部門的名稱(僅適用於英國版本)。 |
|
|
才能
|
faculty | string |
學院名稱(僅適用於英國版本)。 |
|
|
註冊號碼
|
registration_number | string |
註冊號碼(僅適用於英國版本)。 字元限制:50。 |
傳回
創建選民教育
取得參與者
傳回特定事件參與者的相關資訊。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
參與者 ID
|
participant_id | True | string |
參與者的系統記錄 ID。 |
傳回
參與者
取得套件
傳回封裝的相關資訊。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
封裝識別碼
|
package_id | True | string |
要取得之套件的系統記錄 ID。 |
傳回
Package
取得成份潛在客戶狀態
傳回選區的目前潛在客戶狀態。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
選區 ID
|
constituent_id | True | string |
要擷取潛在客戶狀態之選件的系統記錄 ID。 |
傳回
潛在客戶狀態
取得活動
傳回事件的相關資訊。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
事件識別碼
|
event_id | True | string |
要取得之事件的系統記錄識別碼。 |
傳回
Event
取得行銷活動
傳回行銷活動的相關資訊。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
行銷活動ID
|
campaign_id | True | string |
要取得之行銷活動的系統記錄 ID。 |
傳回
活動
取得選民動作
傳回組成動作的相關資訊。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
作ID
|
action_id | True | string |
要取得之動作的系統記錄 ID。 |
傳回
行動
將禮物添加到批次
將禮品新增至指定的禮品批次。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Batch
|
batch_id | True | string |
將添加禮物的批次。 |
|
選區 ID
|
constituent_id | True | string |
與禮品相關聯之成分的系統記錄 ID。 |
|
總數
|
value | True | double |
禮物的金額。 |
|
Date
|
date | True | date |
贈送日期 (例如:「2020-09-18」)。 |
|
類型
|
type | True | string |
禮物類型。 |
|
行銷活動ID
|
campaign_id | string |
與禮品分割相關聯之行銷活動的系統記錄 ID。 |
|
|
基金編號
|
fund_id | True | string |
與贈與分割相關聯之基金的系統記錄 ID。 |
|
申訴 ID
|
appeal_id | string |
與禮物分割相關聯的上訴的系統記錄 ID。 |
|
|
套件 ID
|
package_id | string |
與禮品分割相關聯之封裝的系統記錄 ID。 |
|
|
金額
|
value | True | double |
禮物分割的金額。 |
|
付款方式
|
payment_method | True | string |
付款方式。 |
|
檢查號碼
|
check_number | string |
支票號碼(僅適用於付款方式為「個人支票」的情況)。 |
|
|
天
|
d | integer |
模糊約會中的一天。 |
|
|
月
|
m | integer |
模糊日期中的月份。 |
|
|
年
|
y | integer |
模糊日期中的年份。 |
|
|
Reference
|
reference | string |
付款編號(僅適用於付款方式為「其他」的情況)。 |
|
|
天
|
d | integer |
模糊約會中的一天。 |
|
|
月
|
m | integer |
模糊日期中的月份。 |
|
|
年
|
y | integer |
模糊日期中的年份。 |
|
|
是匿名的嗎?
|
is_anonymous | boolean |
禮物是匿名的嗎? 如果未提供任何值,則會使用捐贈者的預設匿名性。 |
|
|
子類型
|
subtype | string |
禮物的子類型。 |
|
|
評論
|
reference | string |
追蹤禮物特殊細節的註釋,例如背後的動機或實物禮物的詳細描述。 |
|
|
查詢標識碼
|
lookup_id | string |
禮物的使用者定義識別碼。 |
|
|
使用籌款積分?
|
default_fundraiser_credits | boolean |
使用預設的籌款活動積分? |
|
|
使用軟信用?
|
default_soft_credits | boolean |
使用預設的軟點數? |
|
|
選區
|
constituency | string |
禮物的選區。 |
|
|
貼文狀態
|
post_status | string |
禮物的貼文狀態。 |
|
|
發佈日期
|
post_date | date |
禮物的張貼日期 (例如:「2020-09-18」)。 |
|
|
收據狀態
|
status | True | string |
禮物的接收狀態。 |
|
收據金額
|
value | True | double |
禮物收據的金額。 |
|
收件日期
|
date | date |
收到禮物的日期 (例如:「2020-09-18」)。 |
傳回
包含批次禮品錯誤記錄的集合,以及作業新增的批次禮品
- Results
- GiftApi.BatchGiftAddResults
將記錄新增至清單
將一組記錄新增至現有清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
清單類型
|
list_type | True | string |
清單的類型。 |
|
清單
|
list_id | True | string |
清單的系統記錄 ID。 |
|
編號
|
ids | True | array of string |
要新增至清單之記錄的唯一識別碼 (最多 100,000 個值)。 |
建立事件
建立新事件。
參數
| 名稱 | 機碼 | 必要 | 類型 | 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 |
|---|---|---|---|---|
|
選區 ID
|
constituent_id | True | string |
與關係相關聯之成分的系統記錄 ID。 |
|
關係識別碼
|
relation_id | True | string |
相關個人的系統記錄 ID。 |
|
類型
|
type | string |
關係所代表的關係類型。 |
|
|
倒數型
|
reciprocal_type | string |
描述成分與相關成分的關係。 例如,在男性組成部分和女性兄弟姐妹之間的關係中,互惠關係類型將是兄弟。 |
|
|
天
|
d | integer |
模糊約會中的一天。 |
|
|
月
|
m | integer |
模糊日期中的月份。 |
|
|
年
|
y | integer |
模糊日期中的年份。 |
|
|
天
|
d | integer |
模糊約會中的一天。 |
|
|
月
|
m | integer |
模糊日期中的月份。 |
|
|
年
|
y | integer |
模糊日期中的年份。 |
|
|
是配偶嗎?
|
is_spouse | boolean |
相關個人是否是選民的配偶? |
|
|
選民是戶主嗎?
|
is_constituent_head_of_household | boolean |
選民是戶主嗎? |
|
|
配偶是戶主嗎?
|
is_spouse_head_of_household | boolean |
配偶是一家之主嗎? |
|
|
註釋
|
comment | string |
關於關係的其他說明。 |
傳回
創建的個人關係
建立個別選區
建立新的個別選區。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Title
|
title | string |
選民的主要頭銜。 |
|
|
名字
|
first | string |
選民的名字。 字元限制:50。 |
|
|
姓氏
|
last | True | string |
選民的姓氏。 字元限制:100。 |
|
後綴
|
suffix | string |
選區的主要後綴。 |
|
|
查詢標識碼
|
lookup_id | string |
成分的使用者定義 ID。 |
|
|
型別
|
type | True | string |
位址類型。 |
|
country
|
country | string |
地址的國家/地區(可以是ID、名稱或縮寫)。 |
|
|
䋥
|
address_lines | string |
地址行。 字元限制:150。 |
|
|
city
|
city | string |
地址所在的城市 (請勿與 郊區 欄位結合使用)。 |
|
|
狀態
|
state | string |
位址的狀態。 |
|
|
郵遞區號
|
postal_code | string |
地址的郵遞區號。 字元限制:12。 |
|
|
郊區
|
suburb | string |
地址的郊區(請勿與 City 欄位結合使用)。 |
|
|
縣
|
county | string |
地址的縣。 |
|
|
start
|
start | date |
選民開始居住於該地址的日期(例如:「2005-09-18」)。 |
|
|
結束
|
end | date |
選民不再居住於該地址的日期(例如:「2005-09-18」)。 |
|
|
型別
|
type | True | string |
電話類型。 |
|
數字
|
number | True | string |
電話號碼。 |
|
是主要的嗎?
|
primary | boolean |
這是選民的主要電話號碼嗎? |
|
|
型別
|
type | True | string |
電子郵件地址的類型。 |
|
address
|
address | True | string |
電子郵件地址。 |
|
是主要的嗎?
|
primary | boolean |
這是選民的主要電子郵件地址嗎? |
|
|
型別
|
type | True | string |
線上狀態類型。 |
|
address
|
address | True | string |
線上狀態的網址。 |
|
是主要的嗎?
|
primary | boolean |
這是選民的主要在線形象嗎? |
|
|
偏好名稱
|
preferred_name | string |
選民的首選名稱。 字元限制:50。 |
|
|
中間名
|
middle | string |
選民的中間名。 字元限制:50。 |
|
|
以前的名字
|
former_name | string |
選民的舊名。 字元限制:100。 |
|
|
標題 2
|
title_2 | string |
選民的次要頭銜。 |
|
|
字尾 2
|
suffix_2 | string |
成分的次要後綴。 |
|
|
性別
|
gender | string |
選民的性別。 |
|
|
婚姻狀態
|
marital_status | string |
選民的婚姻狀況。 |
|
|
匿名捐贈?
|
gives_anonymously | boolean |
選民是否匿名捐款? |
|
|
天
|
d | integer |
模糊約會中的一天。 |
|
|
月
|
m | integer |
模糊日期中的月份。 |
|
|
年
|
y | integer |
模糊日期中的年份。 |
|
|
誕生地
|
birthplace | string |
成分的發源地。 |
|
|
種族
|
ethnicity | string |
選民的種族。 |
|
|
收入
|
income | string |
選民的收入。 |
|
|
宗教
|
religion | string |
選民的宗教。 |
|
|
客製化收件人?
|
custom_format | boolean |
主要收件人是自訂格式嗎? |
|
|
收件人格式
|
configuration_id | string |
主要收件人配置(除非使用自定義格式,否則需要)。 |
|
|
收件人自訂名稱
|
formatted_name | string |
主要收件人格式名稱(使用自訂格式時需要)。 字元限制:255。 |
|
|
自定義稱呼?
|
custom_format | boolean |
主要稱呼是自訂格式嗎? |
|
|
稱呼格式
|
configuration_id | string |
主要稱呼設定 (除非使用自訂格式,否則必須) 。 |
|
|
稱呼自訂名稱
|
formatted_name | string |
主要稱呼格式名稱 (使用自訂格式時需要)。 字元限制:255。 |
傳回
創建個人成分
建立動作自訂欄位
建立新的動作自訂欄位。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
代表要建立的自訂欄位的物件。 |
傳回
已建立動作自訂欄位
建立動作附件
建立新的動作附件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
作ID
|
parent_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 個。 僅適用於實體附件。 |
傳回
已建立的動作附件
建立募款活動指派
建立新的籌款活動指派。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
籌款活動 ID
|
fundraiser_id | True | string |
籌款活動的系統記錄識別碼。 |
|
選區 ID
|
constituent_id | True | string |
指派成分的系統記錄 ID。 |
|
類型
|
type | string |
籌款活動的類型。 |
|
|
作業開始
|
start | date-time |
指派的開始日期。 |
|
|
作業結束
|
end | date-time |
指派的結束日期。 |
|
|
總數
|
value | True | double |
籌款人向指定選民募集的目標金額。 |
|
行銷活動ID
|
campaign_id | string |
將套用產生的禮品的行銷活動的系統記錄ID。 |
|
|
基金編號
|
fund_id | string |
將套用所產生禮物的基金的系統記錄 ID。 |
|
|
申訴 ID
|
appeal_id | string |
將套用所得禮物的上訴的系統記錄 ID。 |
傳回
已建立的籌款活動指派
建立參與者
為事件建立新參與者。
參數
| 名稱 | 機碼 | 必要 | 類型 | 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 |
參與層級的名稱。 |
傳回
已建立的參與者
建立參與者捐款
為參與者建立新的捐款。
參數
| 名稱 | 機碼 | 必要 | 類型 | 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 |
|---|---|---|---|---|
|
選區 ID
|
constituent_id | True | string |
與商機相關聯之選件的系統記錄識別碼。 |
|
目標
|
purpose | True | string |
因機會而籌集的任何資金的預期用途。 |
|
名稱
|
name | True | string |
在整個計劃中識別機會的名稱,例如在清單或組成記錄中。 字元限制:255。 |
|
地位
|
status | string |
指出機會在招攬程序中的位置的狀態。 |
|
|
Deadline
|
deadline | date-time |
獲得禮物的機會的目標日期 (例如:「2020-09-18T04:13:56Z」)。 |
|
|
詢問日期
|
ask_date | date-time |
發出招標的日期 (例如:「2020-09-18T04:13:56Z」)。 |
|
|
value
|
value | double |
貨幣價值。 |
|
|
預計日期
|
expected_date | date-time |
潛在客戶預期回應商機的日期 (例如:「2020-09-18T04:13:56Z」)。 |
|
|
value
|
value | double |
貨幣價值。 |
|
|
資助日期
|
funded_date | date-time |
潛在客戶回應商機的日期 (例如:「2020-09-18T04:13:56Z」)。 |
|
|
value
|
value | double |
貨幣價值。 |
|
|
行銷活動ID
|
campaign_id | string |
與商機相關聯之行銷活動的系統記錄 ID。 該活動設定了籌集資金的總體目標。 |
|
|
基金編號
|
fund_id | string |
與商機相關聯之基金的系統記錄識別碼。 該基金指定了禮物的具體財務目的,並確定了該禮物的財務帳戶。 |
|
|
選區 ID
|
constituent_id | string |
與籌款活動相關聯之選民的系統記錄 ID。 |
|
|
value
|
value | double |
貨幣價值。 |
|
|
㥩?
|
inactive | boolean |
商機是否處於非作用中狀態? |
傳回
創造的機會
建立基金自訂欄位
建立新的基金自訂欄位。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
代表要建立的自訂欄位的物件。 |
傳回
已建立基金自訂欄位
建立基金附件
建立新的基金附件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
基金編號
|
parent_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 個。 僅適用於實體附件。 |
傳回
創建了資金附件
建立成分代碼
建立新的組成代碼。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
選區 ID
|
constituent_id | True | string |
與成分代碼相關聯之成分的系統記錄 ID。 |
|
組成代碼
|
description | True | string |
組成守則。 |
|
天
|
d | integer |
模糊約會中的一天。 |
|
|
月
|
m | integer |
模糊日期中的月份。 |
|
|
年
|
y | integer |
模糊日期中的年份。 |
|
|
天
|
d | integer |
模糊約會中的一天。 |
|
|
月
|
m | integer |
模糊日期中的月份。 |
|
|
年
|
y | integer |
模糊日期中的年份。 |
|
|
Sequence
|
sequence | integer |
與組成代碼相關聯的數值序列。 |
傳回
創建成分代碼
建立成分徵求代碼
建立新的選區徵求代碼。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
選區 ID
|
constituent_id | True | string |
與徵求代碼相關聯之成分的系統記錄 ID。 |
|
徵求代碼
|
solicit_code | True | string |
對選民的溝通說明和/或限制。 |
|
開始日期
|
start_date | date |
徵求代碼的開始日期(例如:「2005-09-18」)。 |
|
|
結束日期
|
end_date | date |
徵求代碼的結束日期(例如:「2005-09-18」)。 |
傳回
創建了成分徵集代碼
建立成分評等
建立新的成分評等。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
代表要建立的評等的物件。 |
傳回
創建成分評級
建立成分附註
建立新的成分附註。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
選區 ID
|
constituent_id | True | string |
與附註相關聯之成分的系統記錄 ID。 |
|
類型
|
type | True | string |
註記類型。 |
|
天
|
d | integer |
模糊約會中的一天。 |
|
|
月
|
m | integer |
模糊日期中的月份。 |
|
|
年
|
y | integer |
模糊日期中的年份。 |
|
|
總結
|
summary | string |
註釋摘要。 字元限制:50。 |
|
|
備註
|
text | string |
註釋文字。 |
傳回
創建成分票據
建立文件位置
建立新的唯一文件識別碼和上傳位置,以與實體附件搭配使用。 回應將包括有關上傳文件內容的位置和方式的說明。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
檔案名稱
|
file_name | string |
要上傳的文件的檔案名稱。 |
|
|
包括縮略圖?
|
upload_thumbnail | boolean |
包含縮圖文件位置? |
傳回
檔案定義
建立機會自訂欄位
建立新的商機自訂欄位。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
代表要建立的自訂欄位的物件。 |
傳回
建立商機附件
建立機會附件
建立新的機會附件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
機會 ID
|
parent_id | True | string |
與附件相關聯之機會的系統記錄識別碼。 |
|
類型
|
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 個。 僅適用於實體附件。 |
傳回
建立商機附件
建立活動參與者選項
為事件建立新的參與者選項。
參數
| 名稱 | 機碼 | 必要 | 類型 | 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 |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
代表要建立的自訂欄位的物件。 |
傳回
已建立申訴自訂欄位
建立申訴附件
建立新的上訴附件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
申訴 ID
|
parent_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 個。 僅適用於實體附件。 |
傳回
已建立申訴附件
建立禮品批次
建立新的禮品批次。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Description
|
batch_description | string |
批次的描述。 |
|
|
預期數量
|
expected_number | integer |
批次中預期的禮物數量。 |
|
|
預期總計
|
expected_batch_total | double |
批次中禮物的總價值。 |
|
|
批號
|
batch_number | string |
批次特有的唯一識別碼。 |
傳回
已建立禮品批次
建立禮品自訂欄位
建立新的禮物自訂欄位。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
代表要建立的自訂欄位的物件。 |
傳回
已建立禮品自訂欄位
建立禮物附件
建立新的禮物附件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
禮品 ID
|
parent_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 個。 僅適用於實體附件。 |
傳回
創建禮物附件
建立組成別名
建立新的組成別名。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
選區 ID
|
constituent_id | True | string |
與別名相關聯之成分的系統記錄 ID。 |
|
Alias
|
name | True | string |
要用作成分別名的名稱。 字元限制:100。 |
|
類型
|
type | string |
別名類型。 |
傳回
已建立組成別名
建立組成動作
建立新的組成動作。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
選區 ID
|
constituent_id | True | string |
與動作相關聯之成分的系統記錄 ID。 |
|
類別
|
category | True | string |
組成互動的管道或意圖。 |
|
成?
|
completed | boolean |
動作是否完成? 如果系統配置為使用自訂動作狀態,則此值是以動作狀態值為基礎。 |
|
|
完成時間
|
completed_date | date-time |
動作完成的日期 (例如:「2020-09-18T04:13:56Z」)。 |
|
|
Date
|
date | True | date-time |
動作日期 (例如:「2020-09-18T04:13:56Z」)。 |
|
備註
|
description | string |
詳細說明動作摘要。 |
|
|
方向
|
direction | string |
動作的方向。 |
|
|
籌款活動
|
fundraisers | array of string |
與動作相關聯之募款活動的系統記錄 ID 集。 |
|
|
地點
|
location | string |
動作的位置。 |
|
|
機會 ID
|
opportunity_id | string |
與動作相關聯之機會的系統記錄 ID。 |
|
|
結果
|
outcome | string |
行動的結果。 |
|
|
Priority
|
priority | string |
動作的優先順序。 |
|
|
開始時間
|
start_time | string |
動作的開始時間。 使用 HH:mm 格式的 24 小時制。 |
|
|
結束時間
|
end_time | string |
動作的結束時間。 使用 HH:mm 格式的 24 小時制。 |
|
|
地位
|
status | string |
動作狀態。 |
|
|
總結
|
summary | string |
記錄頂端顯示的動作簡短描述。 字元限制:255。 |
|
|
類型
|
type | string |
補充類別的動作的附加說明。 |
傳回
已建立動作
建立組織組成部分
建立新的組織組成部分。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
名稱
|
name | True | string |
組織名稱。 字元限制:100。 |
|
查詢標識碼
|
lookup_id | string |
成分的使用者定義 ID。 |
|
|
型別
|
type | True | string |
位址類型。 |
|
country
|
country | string |
地址的國家/地區(可以是ID、名稱或縮寫)。 |
|
|
䋥
|
address_lines | string |
地址行。 字元限制:150。 |
|
|
city
|
city | string |
地址所在的城市 (請勿與 郊區 欄位結合使用)。 |
|
|
狀態
|
state | string |
位址的狀態。 |
|
|
郵遞區號
|
postal_code | string |
地址的郵遞區號。 字元限制:12。 |
|
|
郊區
|
suburb | string |
地址的郊區(請勿與 City 欄位結合使用)。 |
|
|
縣
|
county | string |
地址的縣。 |
|
|
start
|
start | date |
選民開始居住於該地址的日期(例如:「2005-09-18」)。 |
|
|
結束
|
end | date |
選民不再居住於該地址的日期(例如:「2005-09-18」)。 |
|
|
型別
|
type | True | string |
電話類型。 |
|
數字
|
number | True | string |
電話號碼。 |
|
是主要的嗎?
|
primary | boolean |
這是選民的主要電話號碼嗎? |
|
|
型別
|
type | True | string |
電子郵件地址的類型。 |
|
address
|
address | True | string |
電子郵件地址。 |
|
是主要的嗎?
|
primary | boolean |
這是選民的主要電子郵件地址嗎? |
|
|
型別
|
type | True | string |
線上狀態類型。 |
|
address
|
address | True | string |
線上狀態的網址。 |
|
是主要的嗎?
|
primary | boolean |
這是選民的主要在線形象嗎? |
|
|
匿名捐贈?
|
gives_anonymously | boolean |
選民是否匿名捐款? |
|
|
工業
|
industry | string |
成分股的行業。 |
|
|
員工人數
|
num_employees | integer |
組織的員工人數。 |
|
|
匹配禮物?
|
matches_gifts | boolean |
組織是否配對禮物? |
|
|
匹配禮物因素
|
matching_gift_factor | double |
匹配的禮物因素。 |
|
|
每份禮物的最小匹配次數
|
value | double |
成分股每份禮物的最低配對金額。 |
|
|
每份禮物的最大匹配
|
value | double |
成分股每份禮物的最大配對金額。 |
|
|
每個固定的最小匹配
|
value | double |
成分的最小比對總數。 |
|
|
每個固定的匹配度上限
|
value | double |
成分的最大比對總計。 |
|
|
配對禮品筆記
|
matching_gift_notes | string |
選民的匹配禮品票據。 |
傳回
已建立的組織組成
建立組織關係
建立新的組織關係。 如果關係是與另一個成分的關係,則會為該成分建立互惠關係。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
選區 ID
|
constituent_id | True | string |
與關係相關聯之成分的系統記錄 ID。 |
|
關係識別碼
|
relation_id | True | string |
相關組織的系統記錄 ID。 |
|
類型
|
type | string |
關係所代表的關係類型。 |
|
|
倒數型
|
reciprocal_type | string |
描述選民與相關組織的關係。 |
|
|
天
|
d | integer |
模糊約會中的一天。 |
|
|
月
|
m | integer |
模糊日期中的月份。 |
|
|
年
|
y | integer |
模糊日期中的年份。 |
|
|
天
|
d | integer |
模糊約會中的一天。 |
|
|
月
|
m | integer |
模糊日期中的月份。 |
|
|
年
|
y | integer |
模糊日期中的年份。 |
|
|
是接觸嗎?
|
is_organization_contact | boolean |
選民是否代表該組織作為聯繫人? |
|
|
連絡方式類型
|
organization_contact_type | string |
提供與代表組織作為連絡人的相關個人互動的上下文。 |
|
|
Position
|
position | string |
個人在組織中的位置。 字元限制:50。 |
|
|
是主要業務嗎?
|
is_primary_business | boolean |
這是選民的主要業務嗎? |
|
|
註釋
|
comment | string |
關於關係的其他說明。 |
傳回
建立的組織關聯性
建立行銷活動自訂欄位
建立新的行銷活動自訂欄位。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
代表要建立的自訂欄位的物件。 |
傳回
已建立行銷活動自訂欄位
建立行銷活動附件
建立新的行銷活動附件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
行銷活動ID
|
parent_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 個。 僅適用於實體附件。 |
傳回
已建立的行銷活動附件
建立選區地址
建立新的組成地址。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
選區 ID
|
constituent_id | True | string |
與地址相關聯之成分的系統記錄 ID。 |
|
位址類型
|
type | True | string |
位址類型。 |
|
國家
|
country | string |
地址的國家/地區(可以是ID、名稱或縮寫)。 |
|
|
地址行
|
address_lines | string |
地址行。 |
|
|
城市
|
city | string |
地址所在的城市 (請勿與 郊區 欄位結合使用)。 |
|
|
State
|
state | string |
位址的狀態。 |
|
|
郵遞區號
|
postal_code | string |
地址的郵遞區號。 |
|
|
郊區
|
suburb | string |
地址的郊區(請勿與 City 欄位結合使用)。 |
|
|
縣
|
county | string |
地址的縣。 |
|
|
資訊來源
|
information_source | string |
位址的資訊來源。 |
|
|
區域
|
region | string |
位址的區域。 |
|
|
車
|
cart | string |
地址的承運人路由 (CART)。 |
|
|
籤
|
lot | string |
地址的行進線 (LOT)。 |
|
|
DPC的
|
dpc | string |
地址的遞送點代碼 (DPC)。 |
|
|
有效自
|
start | date |
選民開始居住於該地址的日期(例如:「2005-09-18」)。 |
|
|
有效至
|
end | date |
選民不再居住於該地址的日期(例如:「2005-09-18」)。 |
|
|
初?
|
preferred | boolean |
這是選民的首選地址嗎? |
|
|
不郵寄?
|
do_not_mail | boolean |
可以通過此地址聯繫選民嗎? |
|
|
天
|
d | integer |
模糊約會中的一天。 |
|
|
月
|
m | integer |
模糊日期中的月份。 |
|
|
年
|
y | integer |
模糊日期中的年份。 |
|
|
天
|
d | integer |
模糊約會中的一天。 |
|
|
月
|
m | integer |
模糊日期中的月份。 |
|
|
年
|
y | integer |
模糊日期中的年份。 |
傳回
已建立的成分地址
建立選區自訂欄位
建立新的組成部分自訂欄位。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
代表要建立的自訂欄位的物件。 |
傳回
已建立選區自訂欄位
建立選區附件
建立新的組成附件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
選區 ID
|
parent_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 個。 僅適用於實體附件。 |
傳回
創建的成分附件
建立選區電話
建立新的組成電話。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
選區 ID
|
constituent_id | True | string |
與電話相關聯之選件的系統記錄識別碼。 |
|
類型
|
type | True | string |
電話類型。 |
|
Number
|
number | True | string |
電話號碼。 |
|
初?
|
primary | boolean |
這是選民的主要電話嗎? |
|
|
不打電話?
|
do_not_call | boolean |
可以通過此號碼聯繫選民嗎? |
|
|
㥩?
|
inactive | boolean |
這個電話號碼是非活動的嗎? |
傳回
創建選民電話
建立選民同意記錄
建立新的選民同意記錄。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
選區 ID
|
constituent_id | True | string |
與同意記錄相關聯之選件的系統記錄識別碼。 |
|
Channel
|
channel | True | string |
同意回應套用的管道。 |
|
類別
|
category | string |
同意回應所套用的類別。 |
|
|
來源
|
source | string |
選民同意回應的來源。 |
|
|
回應
|
constituent_consent_response | True | string |
選民如何回應指定頻道/類別的同意。 |
|
Date
|
consent_date | True | date-time |
收到同意聲明回覆的日期 (例如:「2020-09-18T04:13:56Z」)。 |
|
同意聲明
|
consent_statement | string |
選民在提供同意時回應的陳述。 |
|
|
隱私權聲明
|
privacy_notice | string |
提供給選民的隱私權聲明。 |
傳回
創建的選民同意
建立選民線上形象
創建新的選民在線形象。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
選區 ID
|
constituent_id | True | string |
與線上狀態相關聯之選件的系統記錄 ID。 |
|
類型
|
type | True | string |
線上狀態類型。 |
|
Link
|
address | True | string |
線上狀態的網址。 |
|
初?
|
primary | boolean |
這是選民的主要在線形象嗎? |
|
|
㥩?
|
inactive | boolean |
此線上狀態是否處於非活動狀態? |
傳回
創建選民在線形象
建立選民電子郵件地址
建立新的選民電子郵件地址。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
選區 ID
|
constituent_id | True | string |
與電子郵件地址相關聯之選件的系統記錄 ID。 |
|
電子郵件類型
|
type | True | string |
電子郵件地址的類型。 |
|
電子郵件地址
|
address | True | string |
電子郵件地址。 |
|
初?
|
primary | boolean |
這是選民的主要電子郵件地址嗎? |
|
|
不發電子郵件?
|
do_not_email | boolean |
可以通過此電子郵件地址聯繫選民嗎? |
|
|
㥩?
|
inactive | boolean |
此電子郵件地址是否處於非活動狀態? |
傳回
創建的選民電子郵件地址
從一組記錄建立清單
建立篩選為指定記錄集的新清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
名稱
|
name | True | string |
清單的名稱。 字元限制:50。 |
|
Description
|
description | True | string |
清單的描述。 |
|
清單類型
|
list_type | True | string |
決定要建立的清單類型。 |
|
權限
|
list_permissions | True | string |
決定其他使用者是否可以存取清單。 |
|
編號
|
ids | True | array of string |
清單中所包含記錄的唯一識別碼 (最多 100,000 個值)。 |
傳回
已建立清單
提出申訴
傳回上訴的相關資訊。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
申訴 ID
|
appeal_id | True | string |
要取得的申訴的系統記錄 ID。 |
傳回
Appeal
搜尋選民
根據提供的搜尋文字執行成分搜尋。 支援名字、姓氏、偏好名稱、以前的名字、別名、電子郵件地址、電話號碼、地址或查找 ID。 名字組合(例如名字和姓氏或偏好的名字和姓氏)是有效的,但除此之外,搜尋一次只支援一個參數。 根據預設,搜尋會包含聽起來與您的條件相似的結果。 例如,搜尋「Smith」會包含「Smyth」和其他替代拼字的相符專案。 此搜尋不支援萬用字元,例如 * 或 ?。 搜尋結果限制為 500 筆記錄。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
搜尋文字
|
search_text | True | string |
搜尋文字。 支援名字、姓氏、偏好名稱、以前的名字、別名、電子郵件地址、電話號碼、地址或查找 ID。 名字組合(例如名字和姓氏或偏好的名字和姓氏)是有效的,但除此之外,搜尋一次只支援一個參數。 根據預設,搜尋會包含聽起來與您的條件相似的結果。 例如,搜尋「Smith」會包含「Smyth」和其他替代拼字的相符專案。 此搜尋不支援萬用字元,例如 * 或 ?。 搜尋結果限制為 500 筆記錄。 |
|
籌款活動狀態
|
fundraiser_status | string |
代表以逗號分隔的籌款活動狀態清單,以篩選結果。 例如,「Active,None」只會傳回籌款活動狀態為「Active」或「None」的選區。 此篩選器的有效值為 Active、Inactive 和 None。 |
|
|
包括不活躍?
|
include_inactive | boolean |
在回應中包括不活躍的選民? |
|
|
搜尋欄位
|
search_field | string |
代表要搜尋的欄位。 目前,它僅支援lookup_id。 如果提供search_text,則會傳回lookup_id與search_text相符的成分。 |
|
|
使用嚴格搜索?
|
strict_search | boolean |
排除名稱聽起來像搜尋文字但拼字不同的選民? |
|
|
限制
|
limit | integer |
代表要傳回的記錄數目。 預設值為 500。 最大值為 5000。 |
|
|
Offset
|
offset | integer |
代表要略過的記錄數。 用於分頁。 |
傳回
搜尋結果
更新動作自訂欄位
更新動作自訂欄位。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
自訂欄位ID
|
custom_field_id | True | string |
要更新之自訂欄位的系統記錄 ID。 |
|
body
|
body | True | dynamic |
代表要更新之自訂欄位屬性的物件。 |
更新動作附件
更新動作附件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
附件 ID
|
attachment_id | True | string |
要更新之附件的系統記錄 ID。 |
|
名稱
|
name | string |
附件的名稱。 字元限制:150。 |
|
|
Date
|
date | date-time |
附件的日期 (例如:「2020-09-18T04:13:56Z」)。 |
|
|
URL
|
url | string |
附件的 URL。 這是連結附件所必需的,不適用於實體附件。 |
更新參與者
更新參與者的詳細資料。
參數
| 名稱 | 機碼 | 必要 | 類型 | 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 |
參與層級的名稱。 |
更新參與者選項
更新參與者選項的詳細資料。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
參與者選項 ID
|
option_id | True | string |
要更新的參與者選項的系統記錄 ID。 |
|
價值觀
|
option_value | True | string |
參與者對選項的回應。 |
更新商機
更新商機。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
機會 ID
|
opportunity_id | True | string |
要更新的機會的系統記錄識別碼。 |
|
目標
|
purpose | string |
因機會而籌集的任何資金的預期用途。 |
|
|
名稱
|
name | string |
在整個計劃中識別機會的名稱,例如在清單或組成記錄中。 字元限制:255。 |
|
|
地位
|
status | string |
指出機會在招攬程序中的位置的狀態。 |
|
|
Deadline
|
deadline | date-time |
獲得禮物的機會的目標日期 (例如:「2020-09-18T04:13:56Z」)。 |
|
|
詢問日期
|
ask_date | date-time |
發出招標的日期 (例如:「2020-09-18T04:13:56Z」)。 |
|
|
value
|
value | double |
貨幣價值。 |
|
|
預計日期
|
expected_date | date-time |
潛在客戶預期回應商機的日期 (例如:「2020-09-18T04:13:56Z」)。 |
|
|
value
|
value | double |
貨幣價值。 |
|
|
資助日期
|
funded_date | date-time |
潛在客戶回應商機的日期 (例如:「2020-09-18T04:13:56Z」)。 |
|
|
value
|
value | double |
貨幣價值。 |
|
|
行銷活動ID
|
campaign_id | string |
與商機相關聯之行銷活動的系統記錄 ID。 該活動設定了籌集資金的總體目標。 |
|
|
基金編號
|
fund_id | string |
與商機相關聯之基金的系統記錄識別碼。 該基金指定了禮物的具體財務目的,並確定了該禮物的財務帳戶。 |
|
|
選區 ID
|
constituent_id | string |
與籌款活動相關聯之選民的系統記錄 ID。 |
|
|
value
|
value | double |
貨幣價值。 |
|
|
㥩?
|
inactive | boolean |
商機是否處於非作用中狀態? |
更新基金自訂欄位
更新基金自訂欄位。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
自訂欄位ID
|
custom_field_id | True | string |
要更新之自訂欄位的系統記錄 ID。 |
|
body
|
body | True | dynamic |
代表要更新之自訂欄位屬性的物件。 |
更新基金附件
更新基金附件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
附件 ID
|
attachment_id | True | string |
要更新之附件的系統記錄 ID。 |
|
名稱
|
name | string |
附件的名稱。 字元限制:150。 |
|
|
Date
|
date | date-time |
附件的日期 (例如:「2020-09-18T04:13:56Z」)。 |
|
|
URL
|
url | string |
附件的 URL。 這是連結附件所必需的,不適用於實體附件。 |
更新成分代碼
更新成分代碼。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
組成代碼 ID
|
constituent_code_id | True | string |
要更新之成分代碼的系統記錄 ID。 |
|
天
|
d | integer |
模糊約會中的一天。 |
|
|
月
|
m | integer |
模糊日期中的月份。 |
|
|
年
|
y | integer |
模糊日期中的年份。 |
|
|
天
|
d | integer |
模糊約會中的一天。 |
|
|
月
|
m | integer |
模糊日期中的月份。 |
|
|
年
|
y | integer |
模糊日期中的年份。 |
|
|
Sequence
|
sequence | integer |
與組成代碼相關聯的數值序列。 |
更新成分地址
更新組成地址。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
地址 ID
|
address_id | True | string |
要更新之位址的系統記錄 ID。 |
|
位址類型
|
type | string |
位址類型。 |
|
|
國家
|
country | string |
地址的國家/地區(可以是ID、名稱或縮寫)。 |
|
|
地址行
|
address_lines | string |
地址行。 |
|
|
城市
|
city | string |
地址所在的城市 (請勿與 郊區 欄位結合使用)。 |
|
|
State
|
state | string |
位址的狀態。 |
|
|
郵遞區號
|
postal_code | string |
地址的郵遞區號。 |
|
|
郊區
|
suburb | string |
地址的郊區(請勿與 City 欄位結合使用)。 |
|
|
縣
|
county | string |
地址的縣。 |
|
|
資訊來源
|
information_source | string |
位址的資訊來源。 |
|
|
區域
|
region | string |
位址的區域。 |
|
|
車
|
cart | string |
地址的承運人路由 (CART)。 |
|
|
籤
|
lot | string |
地址的行進線 (LOT)。 |
|
|
DPC的
|
dpc | string |
地址的遞送點代碼 (DPC)。 |
|
|
有效自
|
start | date |
選民開始居住於該地址的日期(例如:「2005-09-18」)。 |
|
|
有效至
|
end | date |
選民不再居住於該地址的日期(例如:「2005-09-18」)。 |
|
|
初?
|
preferred | boolean |
這是選民的首選地址嗎? |
|
|
不郵寄?
|
do_not_mail | boolean |
可以通過此地址聯繫選民嗎? |
|
|
天
|
d | integer |
模糊約會中的一天。 |
|
|
月
|
m | integer |
模糊日期中的月份。 |
|
|
年
|
y | integer |
模糊日期中的年份。 |
|
|
天
|
d | integer |
模糊約會中的一天。 |
|
|
月
|
m | integer |
模糊日期中的月份。 |
|
|
年
|
y | integer |
模糊日期中的年份。 |
更新成分附註
更新成分票據。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
附註 ID
|
note_id | True | string |
要更新之附註的系統記錄 ID。 |
|
類型
|
type | string |
註記類型。 |
|
|
天
|
d | integer |
模糊約會中的一天。 |
|
|
月
|
m | integer |
模糊日期中的月份。 |
|
|
年
|
y | integer |
模糊日期中的年份。 |
|
|
總結
|
summary | string |
註釋摘要。 字元限制:50。 |
|
|
備註
|
text | string |
註釋文字。 |
更新機會自訂欄位
更新機會自訂欄位。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
自訂欄位ID
|
custom_field_id | True | string |
要更新之自訂欄位的系統記錄 ID。 |
|
body
|
body | True | dynamic |
代表要更新之自訂欄位屬性的物件。 |
更新機會附件
更新機會附件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
附件 ID
|
attachment_id | True | string |
要更新之附件的系統記錄 ID。 |
|
名稱
|
name | string |
附件的名稱。 字元限制:150。 |
|
|
Date
|
date | date-time |
附件的日期 (例如:「2020-09-18T04:13:56Z」)。 |
|
|
URL
|
url | string |
附件的 URL。 這是連結附件所必需的,不適用於實體附件。 |
更新活動
更新事件的詳細資料。
參數
| 名稱 | 機碼 | 必要 | 類型 | 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 |
活動是否活躍? |
更新申訴自訂欄位
更新申訴自訂欄位。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
自訂欄位ID
|
custom_field_id | True | string |
要更新之自訂欄位的系統記錄 ID。 |
|
body
|
body | True | dynamic |
代表要更新之自訂欄位屬性的物件。 |
更新申訴附件
更新申訴附件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
附件 ID
|
attachment_id | True | string |
要更新之附件的系統記錄 ID。 |
|
名稱
|
name | string |
附件的名稱。 字元限制:150。 |
|
|
Date
|
date | date-time |
附件的日期 (例如:「2020-09-18T04:13:56Z」)。 |
|
|
URL
|
url | string |
附件的 URL。 這是連結附件所必需的,不適用於實體附件。 |
更新禮品收據詳情
更新禮物的收據詳細資料。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
收據 ID
|
receipt_id | True | string |
要更新的禮品收據的系統記錄 ID。 它使用父禮物的 ID 作為其值。 |
|
地位
|
status | string |
禮物的接收狀態。 當狀態設定為 NeedsReceipt 或 DoNotReceipt 時,收據日期應該為 Null。 |
|
|
value
|
value | double |
貨幣價值。 |
|
|
Date
|
date | date-time |
收據上的日期 (例如:「2020-09-18T04:13:56Z」)。 |
|
|
Number
|
number | integer |
收據的編號。 |
更新禮物確認詳情
更新禮物的通知詳細資料。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
通知標識碼
|
acknowledgement_id | True | string |
要更新的禮品確認的系統記錄 ID。 它使用父禮物的 ID 作為其值。 |
|
地位
|
status | string |
通知的狀態。 當狀態設定為 DoNotRecognize 時,字母和日期應該為 Null。 當狀態設定為 NeedsAcknowledgement 時,日期應該為 Null。 |
|
|
Date
|
date | date-time |
與通知相關聯的日期 (例如:「2020-09-18T04:13:56Z」)。 |
|
|
信
|
letter | string |
與確認相關的信件。 |
更新禮物自訂欄位
更新禮物自訂欄位。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
自訂欄位ID
|
custom_field_id | True | string |
要更新之自訂欄位的系統記錄 ID。 |
|
body
|
body | True | dynamic |
代表要更新之自訂欄位屬性的物件。 |
更新禮物附件
更新禮物附件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
附件 ID
|
attachment_id | True | string |
要更新之附件的系統記錄 ID。 |
|
名稱
|
name | string |
附件的名稱。 字元限制:150。 |
|
|
Date
|
date | date-time |
附件的日期 (例如:「2020-09-18T04:13:56Z」)。 |
|
|
URL
|
url | string |
附件的 URL。 這是連結附件所必需的,不適用於實體附件。 |
更新組成別名
更新組成別名。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
別名 ID
|
alias_id | True | string |
要更新之別名的系統記錄 ID。 |
|
Alias
|
name | string |
要用作成分別名的名稱。 字元限制:100。 |
|
|
類型
|
type | string |
別名類型。 |
更新組成動作
更新組成動作。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
作ID
|
action_id | True | string |
要更新之動作的系統記錄 ID。 |
|
類別
|
category | string |
組成互動的管道或意圖。 |
|
|
成?
|
completed | boolean |
動作是否完成? 如果系統配置為使用自訂動作狀態,則此值是以動作狀態值為基礎。 |
|
|
完成時間
|
completed_date | date-time |
動作完成的日期 (例如:「2020-09-18T04:13:56Z」)。 |
|
|
Date
|
date | date-time |
動作日期 (例如:「2020-09-18T04:13:56Z」)。 |
|
|
備註
|
description | string |
詳細說明動作摘要。 |
|
|
方向
|
direction | string |
動作的方向。 |
|
|
籌款活動
|
fundraisers | array of string |
與動作相關聯之募款活動的系統記錄 ID 集。 |
|
|
地點
|
location | string |
動作的位置。 |
|
|
機會 ID
|
opportunity_id | string |
與動作相關聯之機會的系統記錄 ID。 |
|
|
結果
|
outcome | string |
行動的結果。 |
|
|
Priority
|
priority | string |
動作的優先順序。 |
|
|
開始時間
|
start_time | string |
動作的開始時間。 使用 HH:mm 格式的 24 小時制。 |
|
|
結束時間
|
end_time | string |
動作的結束時間。 使用 HH:mm 格式的 24 小時制。 |
|
|
地位
|
status | string |
動作狀態。 |
|
|
總結
|
summary | string |
記錄頂端顯示的動作簡短描述。 字元限制:255。 |
|
|
類型
|
type | string |
補充類別的動作的附加說明。 |
更新組成徵求代碼
更新選民徵求代碼。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
徵求代碼 ID
|
constituent_solicit_code_id | True | string |
要更新之請求碼的系統記錄 ID。 |
|
徵求代碼
|
solicit_code | string |
對選民的溝通說明和/或限制。 |
|
|
開始日期
|
start_date | date |
徵求代碼的開始日期(例如:「2005-09-18」)。 |
|
|
結束日期
|
end_date | date |
徵求代碼的結束日期(例如:「2005-09-18」)。 |
更新組成自訂欄位
更新組成自訂欄位。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
自訂欄位ID
|
custom_field_id | True | string |
要更新之自訂欄位的系統記錄 ID。 |
|
body
|
body | True | dynamic |
代表要更新之自訂欄位屬性的物件。 |
更新組成關係
更新選區的關係。 如果存在互惠關係,也會修改它以反映變更。 這不包括對「comments」屬性的變更,該屬性特定於每筆記錄,並且可以在每筆記錄上獨立修改。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
關係識別碼
|
relationship_id | True | string |
要更新之關係的系統記錄 ID。 |
|
類型
|
type | string |
關係所代表的關係類型。 |
|
|
倒數型
|
reciprocal_type | string |
描述成分與相關成分的關係。 例如,在男性組成部分和女性兄弟姐妹之間的關係中,互惠關係類型將是兄弟。 |
|
|
天
|
d | integer |
模糊約會中的一天。 |
|
|
月
|
m | integer |
模糊日期中的月份。 |
|
|
年
|
y | integer |
模糊日期中的年份。 |
|
|
天
|
d | integer |
模糊約會中的一天。 |
|
|
月
|
m | integer |
模糊日期中的月份。 |
|
|
年
|
y | integer |
模糊日期中的年份。 |
|
|
是配偶嗎?
|
is_spouse | boolean |
相關個人是否是選民的配偶(僅適用於個人之間的關係)? |
|
|
選民是戶主嗎?
|
is_constituent_head_of_household | boolean |
選民是戶主嗎? |
|
|
配偶是戶主嗎?
|
is_spouse_head_of_household | boolean |
配偶是一家之主嗎? |
|
|
註釋
|
comment | string |
關於關係的其他說明。 |
|
|
是接觸嗎?
|
is_organization_contact | boolean |
該選民是否代表該組織作為聯繫人(僅適用於組織與個人之間的關係)? |
|
|
是主要業務嗎?
|
is_primary_business | boolean |
這是選民的主要業務嗎(僅適用於組織與個人之間的關係)? |
|
|
連絡方式類型
|
organization_contact_type | string |
提供與代表組織作為連絡人的相關個人互動的上下文。 僅適用於組織與個人之間的關係。 |
|
|
Position
|
position | string |
個人在組織中的位置。 僅適用於組織與個人之間的關係。 字元限制:50。 |
更新組成附件
更新組成附件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
附件 ID
|
attachment_id | True | string |
要更新之附件的系統記錄 ID。 |
|
名稱
|
name | string |
附件的名稱。 字元限制:150。 |
|
|
Date
|
date | date-time |
附件的日期 (例如:「2020-09-18T04:13:56Z」)。 |
|
|
URL
|
url | string |
附件的 URL。 這是連結附件所必需的,不適用於實體附件。 |
更新行銷活動自訂欄位
更新行銷活動自訂欄位。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
自訂欄位ID
|
custom_field_id | True | string |
要更新之自訂欄位的系統記錄 ID。 |
|
body
|
body | True | dynamic |
代表要更新之自訂欄位屬性的物件。 |
更新行銷活動附件
更新行銷活動附件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
附件 ID
|
attachment_id | True | string |
要更新之附件的系統記錄 ID。 |
|
名稱
|
name | string |
附件的名稱。 字元限制:150。 |
|
|
Date
|
date | date-time |
附件的日期 (例如:「2020-09-18T04:13:56Z」)。 |
|
|
URL
|
url | string |
附件的 URL。 這是連結附件所必需的,不適用於實體附件。 |
更新選區電話
更新組成的電話。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
電話 ID
|
phone_id | True | string |
要更新的手機的系統記錄ID。 |
|
類型
|
type | string |
電話類型。 |
|
|
Number
|
number | string |
電話號碼。 |
|
|
初?
|
primary | boolean |
這是選民的主要電話嗎? |
|
|
不打電話?
|
do_not_call | boolean |
可以通過此號碼聯繫選民嗎? |
|
|
㥩?
|
inactive | boolean |
這個電話號碼是非活動的嗎? |
更新選民
更新選區。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
選區 ID
|
constituent_id | True | string |
要更新之成分的系統記錄 ID。 |
|
Title
|
title | string |
選民的主要頭銜(僅限個人)。 |
|
|
名字
|
first | string |
選民的名字(僅限個人)。 字元限制:50。 |
|
|
姓氏
|
last | string |
選民的姓氏(僅限個人)。 字元限制:100。 |
|
|
組織名稱
|
name | string |
對於個人,這是不適用於編輯作業的計算欄位。 對於組織,此欄位是必填欄位,代表組織的名稱。 字元限制:100。 |
|
|
後綴
|
suffix | string |
成分的主要後綴(僅適用於個人)。 |
|
|
偏好名稱
|
preferred_name | string |
選民的首選名稱(僅限個人)。 字元限制:50。 |
|
|
查詢標識碼
|
lookup_id | string |
成分的使用者定義 ID。 |
|
|
性別
|
gender | string |
選民的性別(僅限個人)。 |
|
|
中間名
|
middle | string |
選民的中間名(僅限個人)。 字元限制:50。 |
|
|
以前的名字
|
former_name | string |
選民的舊名(僅限個人)。 字元限制:100。 |
|
|
標題 2
|
title_2 | string |
選民的次要頭銜(僅限個人)。 |
|
|
字尾 2
|
suffix_2 | string |
成分的次要後綴(僅適用於個人)。 |
|
|
婚姻狀態
|
marital_status | string |
選民的婚姻狀況(僅限個人)。 |
|
|
匿名捐贈?
|
gives_anonymously | boolean |
選民是否匿名捐款? |
|
|
㥩?
|
inactive | boolean |
成分是否不活躍? |
|
|
天
|
d | integer |
模糊約會中的一天。 |
|
|
月
|
m | integer |
模糊日期中的月份。 |
|
|
年
|
y | integer |
模糊日期中的年份。 |
|
|
誕生地
|
birthplace | string |
成分的出生地(僅限個人)。 |
|
|
種族
|
ethnicity | string |
選民的種族(僅限個人)。 |
|
|
收入
|
income | string |
成分股的收入(僅限個人)。 |
|
|
宗教
|
religion | string |
選民的宗教信仰(僅限個人)。 |
|
|
工業
|
industry | string |
成分的產業 (僅限組織)。 |
|
|
員工人數
|
num_employees | integer |
組織的員工人數。 |
|
|
匹配禮物?
|
matches_gifts | boolean |
組織是否配對禮物? |
|
|
匹配禮物因素
|
matching_gift_factor | double |
配對的禮物因素(僅適用於組織)。 |
|
|
每份禮物的最小匹配次數
|
value | double |
成分股每份禮物的最低配對金額(僅限組織)。 |
|
|
每份禮物的最大匹配
|
value | double |
成分股的每份禮物的最大配對金額(僅適用於組織)。 |
|
|
每個固定的最小匹配
|
value | double |
成分的最小比對總數 (僅適用於組織)。 |
|
|
每個固定的匹配度上限
|
value | double |
成分的比對總計上限 (僅適用於組織)。 |
|
|
配對禮品筆記
|
matching_gift_notes | string |
選民的配對禮品票據(僅適用於組織)。 |
|
|
死了?
|
deceased | boolean |
組成人是否已死亡(僅限個人)? |
|
|
天
|
d | integer |
模糊約會中的一天。 |
|
|
月
|
m | integer |
模糊日期中的月份。 |
|
|
年
|
y | integer |
模糊日期中的年份。 |
更新選民個人資料相片
更新選民的當前個人資料圖片。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
選區 ID
|
constituent_id | True | string |
要更新其設定檔圖片的選民的系統記錄 ID。 |
|
檔案名稱
|
file_name | True | string |
檔案的檔名。 |
|
文件 ID
|
document_id | True | uuid |
文件識別碼。 |
|
縮圖 ID
|
thumbnail_id | True | uuid |
縮圖文件識別碼。 |
更新選民教育
更新選民教育。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
教育 ID
|
education_id | True | string |
要更新之教育記錄的系統記錄識別碼。 |
|
學校
|
school | string |
學校/機構名稱。 |
|
|
類型
|
type | string |
教育類型。 |
|
|
類別
|
class_of | string |
選民畢業的那一年。 |
|
|
地位
|
status | string |
教育狀況。 |
|
|
天
|
d | integer |
模糊約會中的一天。 |
|
|
月
|
m | integer |
模糊日期中的月份。 |
|
|
年
|
y | integer |
模糊日期中的年份。 |
|
|
天
|
d | integer |
模糊約會中的一天。 |
|
|
月
|
m | integer |
模糊日期中的月份。 |
|
|
年
|
y | integer |
模糊日期中的年份。 |
|
|
天
|
d | integer |
模糊約會中的一天。 |
|
|
月
|
m | integer |
模糊日期中的月份。 |
|
|
年
|
y | integer |
模糊日期中的年份。 |
|
|
度
|
degree | string |
獲得的學位。 |
|
|
平均積點
|
gpa | double |
平均績點。 |
|
|
學習主題
|
subject_of_study | string |
研究主題。 |
|
|
初?
|
primary | boolean |
這是選民的小學協會嗎? |
|
|
專業
|
majors | array of string |
主要學習課程。 |
|
|
未成年人
|
minors | array of string |
次要學習課程。 |
|
|
Campus
|
campus | string |
校園。 字元限制:50。 |
|
|
社會組織
|
social_organization | string |
社會組織。 字元限制:50。 |
|
|
已知名稱
|
known_name | string |
已知名稱。 字元限制:50。 |
|
|
學位類別
|
class_of_degree | string |
學位等級。 |
|
|
部門
|
department | string |
教育部門的名稱。 |
|
|
才能
|
faculty | string |
學院的名稱。 |
|
|
註冊號碼
|
registration_number | string |
註冊號碼。 字元限制:50。 |
更新選民線上狀態
更新選民線上狀態。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
線上狀態識別碼
|
online_presence_id | True | string |
要更新之線上狀態的系統記錄識別碼。 |
|
類型
|
type | string |
線上狀態類型。 |
|
|
Link
|
address | string |
線上狀態的網址。 |
|
|
初?
|
primary | boolean |
這是選民的主要在線形象嗎? |
|
|
㥩?
|
inactive | boolean |
此線上狀態是否處於非活動狀態? |
更新選民電子郵件地址
更新選民電子郵件地址。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
電子郵件地址 ID
|
email_address_id | True | string |
要更新的電子郵件地址的系統記錄 ID。 |
|
電子郵件類型
|
type | string |
電子郵件地址的類型。 |
|
|
電子郵件地址
|
address | string |
電子郵件地址。 |
|
|
初?
|
primary | boolean |
這是選民的主要電子郵件地址嗎? |
|
|
不發電子郵件?
|
do_not_email | boolean |
可以通過此電子郵件地址聯繫選民嗎? |
|
|
㥩?
|
inactive | boolean |
此電子郵件地址是否處於非活動狀態? |
獲取選民
傳回成分的相關資訊。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
選區 ID
|
constituent_id | True | string |
要取得之成分的系統記錄 ID。 |
傳回
成分
獲取選民個人資料圖片
傳回選民的目前設定檔圖片。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
選區 ID
|
constituent_id | True | string |
要擷取其設定檔圖片的選民的系統記錄 ID。 |
傳回
設定檔圖片
獲得基金
傳回基金的相關資訊。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
基金編號
|
fund_id | True | string |
要取得的基金的系統記錄 ID。 |
傳回
款
獲得成分股最新禮物
傳回選民的最新禮物。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
選區 ID
|
constituent_id | True | string |
成分的系統記錄 ID。 |
傳回
給予總結
獲得機會
傳回商機的相關資訊。 附註:此端點會傳回延遲約為 10 分鐘的狀態屬性。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
機會 ID
|
opportunity_id | True | string |
機會取得的系統記錄識別碼。 |
傳回
商機
獲得禮物
傳回有關禮物的資訊。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
禮品 ID
|
gift_id | True | string |
要取得的禮物的系統記錄ID。 |
傳回
禮物
獲得選民最偉大的禮物
為選民返回最大的禮物。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
選區 ID
|
constituent_id | True | string |
成分的系統記錄 ID。 |
傳回
給予總結
獲得選民第一份禮物
為選民退回第一份禮物。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
選區 ID
|
constituent_id | True | string |
成分的系統記錄 ID。 |
傳回
給予總結
獲得選民終身捐贈
傳回選件的存留期給出摘要。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
選區 ID
|
constituent_id | True | string |
成分的系統記錄 ID。 |
傳回
終身捐贈
製作禮物
創造一份新禮物。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
選區 ID
|
constituent_id | True | string |
與禮品相關聯之成分的系統記錄 ID。 |
|
總數
|
value | True | double |
禮物的金額。 |
|
Date
|
date | True | date |
贈送日期 (例如:「2020-09-18」)。 |
|
類型
|
type | True | string |
禮物類型。 |
|
行銷活動ID
|
campaign_id | string |
與禮品分割相關聯之行銷活動的系統記錄 ID。 |
|
|
基金編號
|
fund_id | True | string |
與贈與分割相關聯之基金的系統記錄 ID。 |
|
申訴 ID
|
appeal_id | string |
與禮物分割相關聯的上訴的系統記錄 ID。 |
|
|
套件 ID
|
package_id | string |
與禮品分割相關聯之封裝的系統記錄 ID。 |
|
|
金額
|
value | True | double |
禮物分割的金額。 |
|
付款方式
|
payment_method | True | string |
付款方式。 |
|
檢查號碼
|
check_number | string |
支票號碼(僅適用於付款方式為「個人支票」的情況)。 |
|
|
天
|
d | integer |
模糊約會中的一天。 |
|
|
月
|
m | integer |
模糊日期中的月份。 |
|
|
年
|
y | integer |
模糊日期中的年份。 |
|
|
Reference
|
reference | string |
付款編號(僅適用於付款方式為「其他」的情況)。 |
|
|
天
|
d | integer |
模糊約會中的一天。 |
|
|
月
|
m | integer |
模糊日期中的月份。 |
|
|
年
|
y | integer |
模糊日期中的年份。 |
|
|
是匿名的嗎?
|
is_anonymous | boolean |
禮物是匿名的嗎? 如果未提供任何值,則會使用捐贈者的預設匿名性。 |
|
|
子類型
|
subtype | string |
禮物的子類型。 |
|
|
評論
|
reference | string |
追蹤禮物特殊細節的註釋,例如背後的動機或實物禮物的詳細描述。 |
|
|
查詢標識碼
|
lookup_id | string |
禮物的使用者定義識別碼。 |
|
|
使用籌款積分?
|
default_fundraiser_credits | boolean |
使用預設的籌款活動積分? |
|
|
使用軟信用?
|
default_soft_credits | boolean |
使用預設的軟點數? |
|
|
選區
|
constituency | string |
禮物的選區。 |
|
|
批次前置詞
|
batch_prefix | string |
用於批次禮品的前置詞。 這必須至少包含一個字母,當「批號」有值時,這是必填的。 |
|
|
批號
|
batch_number | string |
批號。 字元限制:50 個(包括批次前置詞)。 |
|
|
貼文狀態
|
post_status | string |
禮物的貼文狀態。 |
|
|
發佈日期
|
post_date | date |
禮物的張貼日期 (例如:「2020-09-18」)。 |
|
|
收據狀態
|
status | True | string |
禮物的接收狀態。 |
|
收據金額
|
value | True | double |
禮物收據的金額。 |
|
收件日期
|
date | date |
收到禮物的日期 (例如:「2020-09-18」)。 |
傳回
創建的禮物
定義
CommPrefApi.ConstituentConsentRead
代表選民的同意實體。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
同意記錄的系統記錄 ID。 |
|
Channel
|
channel | string |
同意回應套用的管道。 |
|
類別
|
category | string |
同意回應所套用的類別。 |
|
來源
|
source | string |
選民同意回應的來源。 |
|
回應
|
constituent_consent_response | string |
選民如何回應指定頻道/類別的同意。 |
|
Date
|
consent_date | date-time |
收到同意回應的日期。 |
|
同意聲明
|
consent_statement | string |
選民在提供同意時回應的陳述。 |
|
隱私權聲明
|
privacy_notice | string |
提供給選民的隱私權聲明。 |
|
新增日期
|
date_added | date-time |
新增同意回應的日期。 |
|
添加者
|
user_name | string |
新增同意回應的使用者。 |
CommPrefApi.ConstituentConsentReadCollection
同意記錄
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
清單中的同意記錄數目。 |
|
value
|
value | array of CommPrefApi.ConstituentConsentRead |
回應中包含的一組同意記錄。 |
CommPrefApi.ConstituentSolicitCodeRead
徵求代碼
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
組成徵集代碼的系統記錄 ID。 |
|
徵求代碼
|
solicit_code | string |
對選民的溝通說明和/或限制。 |
|
開始日期
|
start_date | date |
徵求代碼的開始日期(例如:「2005-09-18」)。 |
|
結束日期
|
end_date | date |
徵求代碼的結束日期(例如:「2005-09-18」)。 |
CommPrefApi.ConstituentSolicitCodeReadCollection
徵求代碼
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
清單中的組成徵求代碼數目。 |
|
value
|
value | array of CommPrefApi.ConstituentSolicitCodeRead |
回應中包含的一組組成徵求代碼。 |
CommPrefApi.CreatedConstituentConsent
創建的選民同意
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立的同意記錄的識別碼。 |
CommPrefApi.CreatedConstituentSolicitCode
創建了成分徵集代碼
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立的組成徵求代碼的 ID。 |
ConstituentApi.ActionAttachmentRead
Attachment
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
附件的系統記錄 ID。 |
|
作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 |
檔案大小 (以位元組為單位)。 僅適用於實體附件。 |
ConstituentApi.ActionCustomField讀取
自訂欄位
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
自訂欄位的系統記錄 ID。 |
|
作ID
|
parent_id | string |
與自訂欄位相關聯之動作的系統記錄 ID。 |
|
類別
|
category | string |
自訂欄位類別。 |
|
類型
|
type | string |
自訂欄位所代表的資料類型。 |
|
價值觀
|
value |
自訂欄位的值。 |
|
|
Date
|
date | date |
自訂欄位上的日期。 |
|
評論
|
comment | string |
自訂欄位上的註解。 字元限制:50。 |
|
新增日期
|
date_added | date-time |
建立自訂欄位的日期。 |
|
修改日期
|
date_modified | date-time |
上次修改自訂欄位的日期。 |
ConstituentApi.ActionRead
行動
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
動作的系統記錄 ID。 |
|
選區 ID
|
constituent_id | string |
與動作相關聯之成分的系統記錄 ID。 |
|
類別
|
category | string |
組成互動的管道或意圖。 |
|
成?
|
completed | boolean |
動作是否完成? 如果系統配置為使用自訂動作狀態,則此值是以動作狀態值為基礎。 |
|
完成時間
|
completed_date | date-time |
動作完成的日期。 |
|
Date
|
date | date-time |
行動日期。 |
|
備註
|
description | string |
詳細說明動作摘要。 |
|
方向
|
direction | string |
動作的方向。 |
|
籌款活動
|
fundraisers | array of string |
與動作相關聯之募款活動的系統記錄 ID 集。 |
|
地點
|
location | string |
動作的位置。 |
|
機會 ID
|
opportunity_id | string |
與動作相關聯之機會的系統記錄 ID。 |
|
結果
|
outcome | string |
行動的結果。 |
|
Priority
|
priority | string |
動作的優先順序。 |
|
開始時間
|
start_time | string |
動作的開始時間。 使用 HH:mm 格式的 24 小時制。 |
|
結束時間
|
end_time | string |
動作的結束時間。 使用 HH:mm 格式的 24 小時制。 |
|
地位
|
status | string |
動作狀態。 |
|
狀態碼
|
status_code | string |
動作狀態碼。 只有在系統設定為使用自訂動作狀態時,才會傳回此屬性。 |
|
計算狀態
|
computed_status | string |
計算的動作狀態。 如果系統未配置為使用自訂動作狀態,則此欄位會根據已完成和日期內容來計算狀態。 如果沒有,則欄位會根據動作的日期屬性,以及動作的「動作狀態」屬性是否設定為已完成來計算狀態。 |
|
總結
|
summary | string |
記錄頂端顯示的動作簡短描述。 字元限制:255。 |
|
類型
|
type | string |
補充類別的動作的附加說明。 |
|
新增日期
|
date_added | date-time |
建立動作的日期。 |
|
修改日期
|
date_modified | date-time |
上次修改動作的日期。 |
ConstituentApi.AddressRead
Address
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
位址的系統記錄 ID。 |
|
類型
|
type | string |
位址類型。 |
|
國家
|
country | string |
地址的國家/地區(可以是ID、名稱或縮寫)。 |
|
地址行
|
address_lines | string |
地址行。 |
|
城市
|
city | string |
地址所在的城市 (請勿與 郊區 欄位結合使用)。 |
|
State
|
state | string |
位址的狀態。 |
|
郵遞區號
|
postal_code | string |
地址的郵遞區號。 |
|
郊區
|
suburb | string |
地址的郊區(請勿與 City 欄位結合使用)。 |
|
縣
|
county | string |
地址的縣。 |
|
格式化地址
|
formatted_address | string |
國家/地區已設定格式的格式化地址。 |
|
資訊來源
|
information_source | string |
位址的資訊來源。 |
|
區域
|
region | string |
位址的區域。 |
|
車
|
cart | string |
地址的承運人路由 (CART)。 |
|
籤
|
lot | string |
地址的行進線 (LOT)。 |
|
DPC的
|
dpc | string |
地址的遞送點代碼 (DPC)。 |
|
有效自
|
start | date-time |
選民開始居住在該地址的日期。 |
|
有效至
|
end | date-time |
選民不再居住在該地址的日期。 |
|
初?
|
preferred | boolean |
這是選民的首選地址嗎? |
|
㥩?
|
inactive | boolean |
地址是否處於非活動狀態(這意味著當前日期在任何結束日期之前)? |
|
不郵寄?
|
do_not_mail | boolean |
可以通過此地址聯繫選民嗎? |
|
天
|
seasonal_start.d | integer |
模糊約會中的一天。 |
|
月
|
seasonal_start.m | integer |
模糊日期中的月份。 |
|
年
|
seasonal_start.y | integer |
模糊日期中的年份。 |
|
天
|
seasonal_end.d | integer |
模糊約會中的一天。 |
|
月
|
seasonal_end.m | integer |
模糊日期中的月份。 |
|
年
|
seasonal_end.y | integer |
模糊日期中的年份。 |
|
新增日期
|
date_added | date-time |
建立地址的日期。 |
|
修改日期
|
date_modified | date-time |
上次修改地址的日期。 |
ConstituentApi.Alias讀取
Alias
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
別名的系統記錄 ID。 |
|
Alias
|
name | string |
要用作成分別名的名稱。 |
|
類型
|
type | string |
別名類型。 |
ConstituentApi.ApiCollectionOfAddressRead
Addresses
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of ConstituentApi.AddressRead |
回應中包含的專案集。 這可能是集合中項目的子集。 |
ConstituentApi.ApiCollectionOfActionAttachmentRead
Attachments
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of ConstituentApi.ActionAttachmentRead |
回應中包含的專案集。 這可能是集合中項目的子集。 |
ConstituentApi.ApiCollectionOfActionCustomFieldRead
自訂欄位
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of ConstituentApi.ActionCustomFieldRead |
回應中包含的專案集。 這可能是集合中項目的子集。 |
ConstituentApi.ApiCollectionOfActionRead
行動
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of ConstituentApi.ActionRead |
回應中包含的專案集。 這可能是集合中項目的子集。 |
ConstituentApi.ApiCollectionOfAliasRead
Aliases
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of ConstituentApi.AliasRead |
回應中包含的專案集。 這可能是集合中項目的子集。 |
ConstituentApi.ApiCollectionOfConstituentAttachmentRead
Attachments
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of ConstituentApi.ConstituentAttachmentRead |
回應中包含的專案集。 這可能是集合中項目的子集。 |
ConstituentApi.ApiCollectionOfConstituentCodeRead
組成代碼
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of ConstituentApi.ConstituentCodeRead |
回應中包含的專案集。 這可能是集合中項目的子集。 |
ConstituentApi.ApiCollectionOfConstituentCustomFieldRead
自訂欄位
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of ConstituentApi.ConstituentCustomFieldRead |
回應中包含的專案集。 這可能是集合中項目的子集。 |
ConstituentApi.ApiCollectionOfConstituentRead
成分
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of ConstituentApi.ConstituentRead |
回應中包含的專案集。 這可能是集合中項目的子集。 |
ConstituentApi.ApiCollectionOfEducationRead
學歷
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of ConstituentApi.EducationRead |
回應中包含的專案集。 這可能是集合中項目的子集。 |
ConstituentApi.ApiCollectionOfEmailAddressRead
電子郵件地址
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of ConstituentApi.EmailAddressRead |
回應中包含的專案集。 這可能是集合中項目的子集。 |
ConstituentApi.ApiCollectionOfFundraiserAssignmentRead
籌款活動任務
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of ConstituentApi.FundraiserAssignmentRead |
回應中包含的專案集。 這可能是集合中項目的子集。 |
ConstituentApi.ApiCollectionOfNoteRead
註釋
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of ConstituentApi.NoteRead |
回應中包含的專案集。 這可能是集合中項目的子集。 |
ConstituentApi.ApiCollectionOfOnlinePresenceRead
線上狀態
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of ConstituentApi.OnlinePresenceRead |
回應中包含的專案集。 這可能是集合中項目的子集。 |
ConstituentApi.ApiCollectionOfPhoneRead
電話
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of ConstituentApi.PhoneRead |
回應中包含的專案集。 這可能是集合中項目的子集。 |
ConstituentApi.ApiCollectionOfRatingRead
評級
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of ConstituentApi.RatingRead |
回應中包含的專案集。 這可能是集合中項目的子集。 |
ConstituentApi.ApiCollectionOfRelationshipRead
關係
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of ConstituentApi.RelationshipRead |
回應中包含的專案集。 這可能是集合中項目的子集。 |
ConstituentApi.ApiCollectionOfSearchResultRead
搜尋結果
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of ConstituentApi.SearchResultRead |
回應中包含的專案集。 這可能是集合中項目的子集。 |
ConstituentApi.Appeal閱讀
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
申訴的系統記錄 ID。 |
|
描述
|
description | string |
上訴描述。 |
ConstituentApi.Campaign閱讀
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
行銷活動的系統記錄ID。 |
|
描述
|
description | string |
行銷活動說明。 |
ConstituentApi.ConstituentAttachmentRead
Attachment
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
附件的系統記錄 ID。 |
|
選區 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 |
檔案大小 (以位元組為單位)。 僅適用於實體附件。 |
ConstituentApi.ConstituentCodeRead
組成代碼
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
成分代碼的系統記錄 ID。 |
|
選區 ID
|
constituent_id | string |
與成分代碼相關聯之成分的系統記錄 ID。 |
|
組成代碼
|
description | string |
組成守則。 |
|
天
|
start.d | integer |
模糊約會中的一天。 |
|
月
|
start.m | integer |
模糊日期中的月份。 |
|
年
|
start.y | integer |
模糊日期中的年份。 |
|
天
|
end.d | integer |
模糊約會中的一天。 |
|
月
|
end.m | integer |
模糊日期中的月份。 |
|
年
|
end.y | integer |
模糊日期中的年份。 |
|
㥩?
|
inactive | boolean |
成分代碼是否處於非活動狀態? |
|
Sequence
|
sequence | integer |
與組成代碼相關聯的數值序列。 |
|
新增日期
|
date_added | date-time |
建立組成代碼的日期。 |
|
修改日期
|
date_modified | date-time |
上次修改成分代碼的日期。 |
ConstituentApi.ConstituentCustomField讀取
自訂欄位
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
自訂欄位的系統記錄 ID。 |
|
選區 ID
|
parent_id | string |
與自訂欄位相關聯之成分的系統記錄 ID。 |
|
類別
|
category | string |
自訂欄位類別。 |
|
類型
|
type | string |
自訂欄位所代表的資料類型。 |
|
價值觀
|
value |
自訂欄位的值。 |
|
|
Date
|
date | date |
自訂欄位上的日期。 |
|
評論
|
comment | string |
自訂欄位上的註解。 字元限制:50。 |
|
新增日期
|
date_added | date-time |
建立自訂欄位的日期。 |
|
修改日期
|
date_modified | date-time |
上次修改自訂欄位的日期。 |
ConstituentApi.ConstituentRead
成分
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
成分的系統記錄 ID。 這與儲存在lookup_id中的使用者可定義成分識別碼不同。 |
|
類型
|
type | string |
成分的類型。 |
|
Title
|
title | string |
選民的主要頭銜(僅限個人)。 |
|
名字
|
first | string |
選民的名字(僅限個人)。 |
|
姓氏
|
last | string |
選民的姓氏(僅限個人)。 |
|
名稱
|
name | string |
對於個人,此欄位是根據目標組織的顯示名稱設定而產生的組成部分的全名。 對於組織,這是組織的名稱。 |
|
偏好名稱
|
preferred_name | string |
選民的首選名稱(僅限個人)。 |
|
後綴
|
suffix | string |
成分的主要後綴(僅適用於個人)。 |
|
查詢標識碼
|
lookup_id | string |
成分的使用者定義 ID。 |
|
ID
|
email.id | string |
電子郵件地址的系統記錄 ID。 |
|
型別
|
email.type | string |
電子郵件地址的類型。 |
|
address
|
email.address | string |
電子郵件地址。 |
|
不發電子郵件?
|
email.do_not_email | boolean |
可以通過此電子郵件地址聯繫選民嗎? |
|
㥩?
|
email.inactive | boolean |
此電子郵件地址是否處於非活動狀態? |
|
添加日期
|
email.date_added | date-time |
建立電子郵件地址的日期。 |
|
修改日期
|
email.date_modified | date-time |
上次修改電子郵件地址的日期。 |
|
ID
|
phone.id | string |
電話的系統記錄ID。 |
|
型別
|
phone.type | string |
電話類型。 |
|
數字
|
phone.number | string |
電話號碼。 |
|
不打電話?
|
phone.do_not_call | boolean |
可以通過此號碼聯繫選民嗎? |
|
㥩?
|
phone.inactive | boolean |
這個電話號碼是非活動的嗎? |
|
添加日期
|
phone.date_added | date-time |
建立電話的日期。 |
|
修改日期
|
phone.date_modified | date-time |
上次修改手機的日期。 |
|
ID
|
online_presence.id | string |
線上狀態的系統記錄 ID。 |
|
型別
|
online_presence.type | string |
線上狀態類型。 |
|
連結
|
online_presence.address | string |
線上狀態的網址。 |
|
㥩?
|
online_presence.inactive | boolean |
此線上狀態是否處於非活動狀態? |
|
添加日期
|
online_presence.date_added | date-time |
建立線上狀態的日期。 |
|
修改日期
|
online_presence.date_modified | date-time |
上次修改線上狀態的日期。 |
|
ID
|
address.id | string |
位址的系統記錄 ID。 |
|
型別
|
address.type | string |
位址類型。 |
|
country
|
address.country | string |
地址的國家/地區(可以是ID、名稱或縮寫)。 |
|
䋥
|
address.address_lines | string |
地址行。 |
|
city
|
address.city | string |
地址所在的城市 (請勿與 郊區 欄位結合使用)。 |
|
狀態
|
address.state | string |
位址的狀態。 |
|
郵遞區號
|
address.postal_code | string |
地址的郵遞區號。 |
|
郊區
|
address.suburb | string |
地址的郊區(請勿與 City 欄位結合使用)。 |
|
縣
|
address.county | string |
地址的縣。 |
|
格式化
|
address.formatted_address | string |
國家/地區已設定格式的格式化地址。 |
|
有效期限
|
address.start | date-time |
選民開始居住在該地址的日期。 |
|
有效期至
|
address.end | date-time |
選民不再居住在該地址的日期。 |
|
㥩?
|
address.inactive | boolean |
地址是否處於非活動狀態(這意味著當前日期在任何結束日期之前)? |
|
不郵寄?
|
address.do_not_mail | boolean |
可以通過此地址聯繫選民嗎? |
|
天
|
address.seasonal_start.d | integer |
模糊約會中的一天。 |
|
月
|
address.seasonal_start.m | integer |
模糊日期中的月份。 |
|
年
|
address.seasonal_start.y | integer |
模糊日期中的年份。 |
|
天
|
address.seasonal_end.d | integer |
模糊約會中的一天。 |
|
月
|
address.seasonal_end.m | integer |
模糊日期中的月份。 |
|
年
|
address.seasonal_end.y | integer |
模糊日期中的年份。 |
|
添加日期
|
address.date_added | date-time |
建立地址的日期。 |
|
修改日期
|
address.date_modified | date-time |
上次修改地址的日期。 |
|
性別
|
gender | string |
選民的性別(僅限個人)。 |
|
中間名
|
middle | string |
選民的中間名(僅限個人)。 |
|
以前的名字
|
former_name | string |
選民的舊名(僅限個人)。 |
|
標題 2
|
title_2 | string |
選民的次要頭銜(僅限個人)。 |
|
字尾 2
|
suffix_2 | string |
成分的次要後綴(僅適用於個人)。 |
|
婚姻地位
|
marital_status | string |
選民的婚姻狀況(僅限個人)。 |
|
匿名捐贈?
|
gives_anonymously | boolean |
選民是否匿名捐款? |
|
㥩?
|
inactive | boolean |
成分是否不活躍? |
|
天
|
birthdate.d | integer |
模糊約會中的一天。 |
|
月
|
birthdate.m | integer |
模糊日期中的月份。 |
|
年
|
birthdate.y | integer |
模糊日期中的年份。 |
|
誕生地
|
birthplace | string |
成分的出生地(僅限個人)。 |
|
種族
|
ethnicity | string |
選民的種族(僅限個人)。 |
|
收入
|
income | string |
成分股的收入(僅限個人)。 |
|
宗教
|
religion | string |
選民的宗教信仰(僅限個人)。 |
|
工業
|
industry | string |
成分的產業 (僅限組織)。 |
|
員工人數
|
num_employees | integer |
組織的員工人數。 |
|
匹配禮物?
|
matches_gifts | boolean |
組織是否配對禮物? |
|
匹配禮物因素
|
matching_gift_factor | double |
配對的禮物因素(僅適用於組織)。 |
|
每份禮物的最小匹配次數
|
matching_gift_per_gift_min.value | double |
成分股每份禮物的最低配對金額(僅限組織)。 |
|
每份禮物的最大匹配
|
matching_gift_per_gift_max.value | double |
成分股的每份禮物的最大配對金額(僅適用於組織)。 |
|
每個固定的最小匹配
|
matching_gift_total_min.value | double |
成分的最小比對總數 (僅適用於組織)。 |
|
每個固定的匹配度上限
|
matching_gift_total_max.value | double |
成分的比對總計上限 (僅適用於組織)。 |
|
配對禮品筆記
|
matching_gift_notes | string |
選民的配對禮品票據(僅適用於組織)。 |
|
年齡
|
age | integer |
選民的年齡,根據出生日期屬性計算(僅適用於個人)。 |
|
死了?
|
deceased | boolean |
組成人是否已死亡(僅限個人)? |
|
天
|
deceased_date.d | integer |
模糊約會中的一天。 |
|
月
|
deceased_date.m | integer |
模糊日期中的月份。 |
|
年
|
deceased_date.y | integer |
模糊日期中的年份。 |
|
籌款活動狀態
|
fundraiser_status | string |
指出選民是否為籌款人(僅限個人)。 |
|
ID
|
spouse.id | string |
配偶的系統記錄 ID。 |
|
名字
|
spouse.first | string |
配偶的名字。 |
|
姓氏
|
spouse.last | string |
配偶的姓氏。 |
|
戶主嗎?
|
spouse.is_head_of_household | boolean |
配偶是一家之主嗎? |
|
新增日期
|
date_added | date-time |
成分的建立日期。 |
|
修改日期
|
date_modified | date-time |
上次修改成分的日期。 |
ConstituentApi.CreatedAction
已建立動作
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立動作的 ID。 |
ConstituentApi.CreatedActionAttachment
已建立的動作附件
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立的動作附件的 ID。 |
ConstituentApi.CreatedActionCustomField
已建立動作自訂欄位
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立的動作自訂欄位的ID。 |
ConstituentApi.CreatedConstituentAddress
已建立的成分地址
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立的組成地址的 ID。 |
ConstituentApi.CreatedConstituentAlias
已建立組成別名
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立的組成別名的 ID。 |
ConstituentApi.CreatedConstituentAttachment
創建的成分附件
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立的組成附件的 ID。 |
ConstituentApi.CreatedConstituentCode
創建成分代碼
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立的成分代碼的 ID。 |
ConstituentApi.CreatedConstituentCustomField
已建立選區自訂欄位
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立的組成部分自訂欄位的ID。 |
ConstituentApi.CreatedConstituentEducation
創建選民教育
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立的組成教育的 ID。 |
ConstituentApi.CreatedConstituentEmailAddress
創建的選民電子郵件地址
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立的組成電子郵件地址的ID。 |
ConstituentApi.CreatedConstituentNote
創建成分票據
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立成分附註的 ID。 |
ConstituentApi.CreatedConstituentOnlinePresence
創建選民在線形象
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立的選民線上狀態的識別碼。 |
ConstituentApi.CreatedConstituentPhone
創建選民電話
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立的組成電話的ID。 |
ConstituentApi.CreatedConstituentRating
創建成分評級
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立的成分評等的識別碼。 |
ConstituentApi.CreatedIndividualConstituent
創建個人成分
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立的個別選區的 ID。 |
ConstituentApi.CreatedIndividualRelationship
創建的個人關係
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立的個別關係的識別碼。 |
ConstituentApi.CreatedOrganizationConstituent
已建立的組織組成
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立的組織組成者的 ID。 |
ConstituentApi.CreatedOrganizationRelationship
建立的組織關聯性
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立的組織關係的識別碼。 |
ConstituentApi.教育閱讀
Education
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
教育的系統記錄 ID。 |
|
選區 ID
|
constituent_id | string |
與教育相關聯之選件的系統記錄 ID。 |
|
學校
|
school | string |
學校/機構名稱。 |
|
類型
|
type | string |
教育類型。 |
|
類別
|
class_of | string |
選民畢業的那一年。 |
|
地位
|
status | string |
教育狀況。 |
|
天
|
date_entered.d | integer |
模糊約會中的一天。 |
|
月
|
date_entered.m | integer |
模糊日期中的月份。 |
|
年
|
date_entered.y | integer |
模糊日期中的年份。 |
|
天
|
date_left.d | integer |
模糊約會中的一天。 |
|
月
|
date_left.m | integer |
模糊日期中的月份。 |
|
年
|
date_left.y | integer |
模糊日期中的年份。 |
|
天
|
date_graduated.d | integer |
模糊約會中的一天。 |
|
月
|
date_graduated.m | integer |
模糊日期中的月份。 |
|
年
|
date_graduated.y | integer |
模糊日期中的年份。 |
|
度
|
degree | string |
獲得的學位。 |
|
平均積點
|
gpa | double |
平均績點。 |
|
專業
|
majors | array of string |
主要學習課程。 |
|
未成年人
|
minors | array of string |
次要學習課程。 |
|
初等教育是嗎?
|
primary | boolean |
這是選民的小學協會嗎? |
|
Campus
|
campus | string |
校園。 |
|
社會組織
|
social_organization | string |
社會組織。 |
|
已知名稱
|
known_name | string |
已知名稱。 |
|
學位類別
|
class_of_degree | string |
學位等級。 |
|
部門
|
department | string |
教育部門的名稱。 |
|
才能
|
faculty | string |
學院的名稱。 |
|
註冊號碼
|
registration_number | string |
註冊號碼。 |
|
學習主題
|
subject_of_study | string |
研究主題。 |
|
新增日期
|
date_added | date-time |
建立教育的日期。 |
|
修改日期
|
date_modified | date-time |
上次修改教育的日期。 |
ConstituentApi.EmailAddressRead
電子郵件地址
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
電子郵件地址的系統記錄 ID。 |
|
選區 ID
|
constituent_id | string |
與電子郵件地址相關聯之選件的系統記錄 ID。 |
|
電子郵件類型
|
type | string |
電子郵件地址的類型。 |
|
電子郵件地址
|
address | string |
電子郵件地址。 |
|
初?
|
primary | boolean |
這是選民的主要電子郵件地址嗎? |
|
不發電子郵件?
|
do_not_email | boolean |
可以通過此電子郵件地址聯繫選民嗎? |
|
㥩?
|
inactive | boolean |
此電子郵件地址是否處於非活動狀態? |
|
新增日期
|
date_added | date-time |
建立電子郵件地址的日期。 |
|
修改日期
|
date_modified | date-time |
上次修改電子郵件地址的日期。 |
ConstituentApi.FileDefinition
檔案定義
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
檔案 ID
|
file_id | string |
檔案的識別碼。 |
|
URL
|
file_upload_request.url | string |
要用於上傳請求的 URL。 |
|
方法
|
file_upload_request.method | string |
要與上傳要求搭配使用的 HTTP 方法。 |
|
headers
|
file_upload_request.headers | array of ConstituentApi.Header |
提出要求時要提供的標頭。 |
|
縮圖 ID
|
thumbnail_id | string |
縮圖的識別碼。 |
|
URL
|
thumbnail_upload_request.url | string |
要用於上傳請求的 URL。 |
|
方法
|
thumbnail_upload_request.method | string |
要與上傳要求搭配使用的 HTTP 方法。 |
|
headers
|
thumbnail_upload_request.headers | array of ConstituentApi.Header |
提出要求時要提供的標頭。 |
ConstituentApi.FundraiserAssignmentRead
籌款活動任務
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
籌款活動指派的系統記錄識別碼。 |
|
選區 ID
|
constituent_id | string |
指派給籌款活動之選民的系統記錄 ID。 |
|
籌款活動 ID
|
fundraiser_id | string |
籌款活動的系統記錄識別碼。 |
|
類型
|
type | string |
籌款活動的類型。 |
|
value
|
amount.value | double |
貨幣價值。 |
|
行銷活動ID
|
campaign_id | string |
要套用產生的禮物的行銷活動的系統記錄 ID。 |
|
基金編號
|
fund_id | string |
任何產生的禮物都應套用到基金的系統記錄 ID。 如果選取受限制的基金,則只能選擇與該基金相關的行銷活動和申訴。 |
|
申訴 ID
|
appeal_id | string |
籌款活動者應該用來要求禮物的上訴的系統記錄 ID。 |
|
開始日期
|
start | date-time |
籌款活動指派開始日期。 |
|
結束日期
|
end | date-time |
募款活動指派結束日期。 |
ConstituentApi.Fund閱讀
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
基金的系統記錄 ID。 |
|
描述
|
description | string |
基金說明。 |
ConstituentApi.Giving摘要閱讀
給予總結
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
禮品的系統記錄 ID。 |
|
類型
|
type | string |
禮物類型。 |
|
Date
|
date | date-time |
禮物日期。 |
|
value
|
amount.value | double |
貨幣價值。 |
|
Appeal
|
appeals | array of ConstituentApi.AppealRead |
與禮物相關的一組上訴。 |
|
活動
|
campaigns | array of ConstituentApi.CampaignRead |
與禮物相關聯的行銷活動集。 |
|
款
|
funds | array of ConstituentApi.FundRead |
與禮物相關聯的資金集。 |
ConstituentApi.標頭
用於上傳實體附件的要求標頭。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
名稱
|
name | string |
標頭的名稱。 |
|
value
|
value | string |
標頭的值。 |
ConstituentApi.LifetimeGivingRead
終身捐贈
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
連續年給出
|
consecutive_years_given | integer |
選民連續給予的年數。 |
|
給出的總年限
|
total_years_given | integer |
選民給出的總年數。 |
|
value
|
total_giving.value | double |
貨幣價值。 |
|
value
|
total_pledge_balance.value | double |
貨幣價值。 |
|
value
|
total_received_giving.value | double |
貨幣價值。 |
|
value
|
total_committed_matching_gifts.value | double |
貨幣價值。 |
|
value
|
total_received_matching_gifts.value | double |
貨幣價值。 |
|
value
|
total_soft_credits.value | double |
貨幣價值。 |
ConstituentApi.NoteRead
備註
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
附註的系統記錄 ID。 |
|
選區 ID
|
constituent_id | string |
與附註相關聯之成分的系統記錄 ID。 |
|
類型
|
type | string |
註記類型。 |
|
天
|
date.d | integer |
模糊約會中的一天。 |
|
月
|
date.m | integer |
模糊日期中的月份。 |
|
年
|
date.y | integer |
模糊日期中的年份。 |
|
總結
|
summary | string |
註釋摘要。 |
|
備註
|
text | string |
註釋文字。 |
|
新增日期
|
date_added | date-time |
建立附註的日期。 |
|
修改日期
|
date_modified | date-time |
上次修改附註的日期。 |
ConstituentApi.OnlinePresenceRead
線上狀態
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
線上狀態的系統記錄 ID。 |
|
選區 ID
|
constituent_id | string |
與線上狀態相關聯之選件的系統記錄 ID。 |
|
類型
|
type | string |
線上狀態類型。 |
|
Link
|
address | string |
線上狀態的網址。 |
|
初?
|
primary | boolean |
這是選民的主要在線形象嗎? |
|
㥩?
|
inactive | boolean |
此線上狀態是否處於非活動狀態? |
|
新增日期
|
date_added | date-time |
建立線上狀態的日期。 |
|
修改日期
|
date_modified | date-time |
上次修改線上狀態的日期。 |
ConstituentApi.PhoneRead
電話
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
電話的系統記錄ID。 |
|
選區 ID
|
constituent_id | string |
與電話相關聯之選件的系統記錄識別碼。 |
|
類型
|
type | string |
電話類型。 |
|
Number
|
number | string |
電話號碼。 |
|
初?
|
primary | boolean |
這是選民的主要電話嗎? |
|
不打電話?
|
do_not_call | boolean |
可以通過此號碼聯繫選民嗎? |
|
㥩?
|
inactive | boolean |
這個電話號碼是非活動的嗎? |
|
新增日期
|
date_added | date-time |
建立電話的日期。 |
|
修改日期
|
date_modified | date-time |
上次修改手機的日期。 |
ConstituentApi.Profile圖片閱讀
設定檔圖片
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
選區 ID
|
constituent_id | string |
與設定檔圖片相關聯之選件的系統記錄ID。 |
|
URL
|
url | string |
設定檔圖片的 URL。 URL 包含一個有時間限制的簽名,將存取限制為 60 分鐘。 |
|
縮圖網址
|
thumbnail_url | string |
設定檔圖片縮圖的 URL。 包含限制存取時間限制為 60 分鐘的限時簽名。 |
ConstituentApi.ProspectStatusRead
潛在客戶狀態
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
地位
|
status | string |
該成分股當前的前景狀態。 |
|
經過的天數
|
days_elapsed | integer |
根據開始日期,目前潛在客戶狀態的總天數。 |
|
開始日期
|
start | date-time |
潛在客戶狀態的開始日期。 |
|
評論
|
comments | string |
潛在客戶狀態的註解。 |
ConstituentApi.Rating閱讀
Rating
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
評等的系統記錄識別碼。 |
|
選區 ID
|
constituent_id | string |
與評等相關聯之選件的系統記錄 ID。 |
|
來源
|
source | string |
新評級的來源。 |
|
類別
|
category | string |
評級的類別。 |
|
Date
|
date | date-time |
評等日期。 |
|
Description
|
value |
評級的價值。 |
|
|
評論
|
comment | string |
關於評級的評論。 |
|
㥩?
|
inactive | boolean |
評級是否處於非活動狀態? |
|
類型
|
type | string |
此計算欄位會指出評等根據類別內容所代表的資料類型。 |
ConstituentApi.RelationshipRead
Relationship
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
關係的系統記錄 ID。 |
|
選區 ID
|
constituent_id | string |
與關係相關聯之成分的系統記錄 ID。 |
|
關係識別碼
|
relation_id | string |
相關個人或組織的系統記錄 ID。 |
|
互惠關係 ID
|
reciprocal_relationship_id | string |
互惠關係記錄的識別碼。 此值是唯讀的,並在建立關係時自動產生。 對此記錄所做的變更也會反映在倒數上,但 comments 屬性除外。 |
|
名稱
|
name | string |
相關成分的名稱。 如果相關選件是個人,則根據目標組織的顯示名稱設定,這將是選民的全名。 |
|
類型
|
type | string |
關係所代表的關係類型。 |
|
倒數型
|
reciprocal_type | string |
描述成分與相關成分的關係。 例如,在男性組成部分和女性兄弟姐妹之間的關係中,互惠關係類型將是兄弟。 |
|
天
|
start.d | integer |
模糊約會中的一天。 |
|
月
|
start.m | integer |
模糊日期中的月份。 |
|
年
|
start.y | integer |
模糊日期中的年份。 |
|
天
|
end.d | integer |
模糊約會中的一天。 |
|
月
|
end.m | integer |
模糊日期中的月份。 |
|
年
|
end.y | integer |
模糊日期中的年份。 |
|
是配偶嗎?
|
is_spouse | boolean |
相關個人是否是選民的配偶(僅適用於個人之間的關係)? |
|
選民是戶主嗎?
|
is_constituent_head_of_household | boolean |
選民是戶主嗎? |
|
配偶是戶主嗎?
|
is_spouse_head_of_household | boolean |
配偶是一家之主嗎? |
|
註釋
|
comment | string |
對關係的評論。 |
|
是接觸嗎?
|
is_organization_contact | boolean |
該選民是否代表該組織作為聯繫人(僅適用於組織與個人之間的關係)? |
|
是主要業務嗎?
|
is_primary_business | boolean |
這是選民的主要業務嗎(僅適用於組織與個人之間的關係)? |
|
連絡方式類型
|
organization_contact_type | string |
提供與代表組織作為連絡人的相關個人互動的上下文。 僅適用於組織與個人之間的關係。 |
|
Position
|
position | string |
個人在組織中的位置。 僅適用於組織與個人之間的關係。 |
|
新增日期
|
date_added | date-time |
建立關係的日期。 |
|
修改日期
|
date_modified | date-time |
上次修改關係的日期。 |
ConstituentApi.SearchResultRead
搜尋結果
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
成分的系統記錄 ID。 |
|
名稱
|
name | string |
組成名稱。 對於個人,此計算欄位會根據目標組織的顯示名稱設定,指出選件的完整名稱。 |
|
Address
|
address | string |
選民的首選地址。 |
|
死了?
|
deceased | boolean |
選民已故嗎? |
|
Email
|
string |
選民的電子郵件地址。 |
|
|
籌款活動狀態
|
fundraiser_status | string |
選民的籌款人狀態。 對於個人,此計算欄位會指出成分是作用中、非作用中或無。 對於組織,此值一律為 None。 |
|
㥩?
|
inactive | boolean |
成分是否不活躍? |
|
查詢標識碼
|
lookup_id | string |
成分的使用者定義 ID。 |
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.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.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 |
模糊日期中的年份。 |
|
參與程度
|
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 |
參與者支付的禮物與某種註冊費的總和。 |
|
座
|
seat | string |
參與者的座位分配。 |
|
名稱標籤
|
name_tag | 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 |
子行政區域的名稱。 |
籌款Api.ApiCollectionOfAppealAttachment閱讀
Attachments
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of FundraisingApi.AppealAttachmentRead |
回應中包含的專案集。 這可能是集合中項目的子集。 |
籌款Api.ApiCollectionOfAppealCustomField閱讀
自訂欄位
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of FundraisingApi.AppealCustomFieldRead |
回應中包含的專案集。 這可能是集合中項目的子集。 |
籌款Api.ApiCollectionOfAppeal閱讀
上訴
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of FundraisingApi.AppealRead |
回應中包含的專案集。 這可能是集合中項目的子集。 |
籌款Api.ApiCollectionOfCampaignAttachment閱讀
Attachments
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of FundraisingApi.CampaignAttachmentRead |
回應中包含的專案集。 這可能是集合中項目的子集。 |
FundraisingApi.ApiCollectionOfCampaignCustomField閱讀
自訂欄位
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of FundraisingApi.CampaignCustomFieldRead |
回應中包含的專案集。 這可能是集合中項目的子集。 |
籌款Api.ApiCollectionOfCampaign閱讀
Campaigns
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of FundraisingApi.CampaignRead |
回應中包含的專案集。 這可能是集合中項目的子集。 |
籌款Api.ApiCollectionOfFundAttachment閱讀
Attachments
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of FundraisingApi.FundAttachmentRead |
回應中包含的專案集。 這可能是集合中項目的子集。 |
籌款Api.ApiCollectionOfFundCustomField閱讀
自訂欄位
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of FundraisingApi.FundCustomFieldRead |
回應中包含的專案集。 這可能是集合中項目的子集。 |
籌款Api.ApiCollectionOfFundRead
項
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of FundraisingApi.FundRead |
回應中包含的專案集。 這可能是集合中項目的子集。 |
籌款Api.ApiCollectionOfFundraiserAssignmentRead
Assignments
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of FundraisingApi.FundraiserAssignmentRead |
回應中包含的專案集。 這可能是集合中項目的子集。 |
籌款Api.ApiCollectionOfPackageRead
Packages
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of FundraisingApi.PackageRead |
回應中包含的專案集。 這可能是集合中項目的子集。 |
籌款Api.AppealAttachment閱讀
Attachment
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
附件的系統記錄 ID。 |
|
申訴 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 |
檔案大小 (以位元組為單位)。 僅適用於實體附件。 |
籌款Api.AppealCustomField閱讀
自訂欄位
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
自訂欄位的系統記錄 ID。 |
|
申訴 ID
|
parent_id | string |
與自訂欄位相關聯之申訴的系統記錄 ID。 |
|
類別
|
category | string |
自訂欄位類別。 |
|
類型
|
type | string |
自訂欄位所代表的資料類型。 |
|
價值觀
|
value |
自訂欄位的值。 |
|
|
Date
|
date | date |
自訂欄位上的日期。 |
|
評論
|
comment | string |
自訂欄位上的註解。 字元限制:50。 |
|
新增日期
|
date_added | date-time |
建立自訂欄位的日期。 |
|
修改日期
|
date_modified | date-time |
上次修改自訂欄位的日期。 |
籌款Api.Appeal閱讀
Appeal
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
申訴的系統記錄 ID。 |
|
類別
|
category | string |
上訴的類別。 |
|
新增日期
|
date_added | date-time |
建立申訴的日期。 |
|
修改日期
|
date_modified | date-time |
上次修改上訴的日期。 |
|
Description
|
description | string |
申訴的顯示名稱。 |
|
結束日期
|
end_date | date-time |
上訴的結束日期。 |
|
value
|
goal.value | double |
貨幣價值。 |
|
㥩?
|
inactive | boolean |
申訴是否有效(這意味著當前日期在任何開始日期之後和任何結束日期之前)? |
|
查詢標識碼
|
lookup_id | string |
申訴的使用者定義識別碼。 |
|
開始日期
|
start_date | date-time |
上訴的開始日期。 |
FundraisingApi.CampaignAttachment閱讀
Attachment
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
附件的系統記錄 ID。 |
|
行銷活動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 |
檔案大小 (以位元組為單位)。 僅適用於實體附件。 |
FundraisingApi.CampaignCustomField閱讀
自訂欄位
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
自訂欄位的系統記錄 ID。 |
|
行銷活動ID
|
parent_id | string |
與自訂欄位相關聯之行銷活動的系統記錄ID。 |
|
類別
|
category | string |
自訂欄位類別。 |
|
類型
|
type | string |
自訂欄位所代表的資料類型。 |
|
價值觀
|
value |
自訂欄位的值。 |
|
|
Date
|
date | date |
自訂欄位上的日期。 |
|
評論
|
comment | string |
自訂欄位上的註解。 字元限制:50。 |
|
新增日期
|
date_added | date-time |
建立自訂欄位的日期。 |
|
修改日期
|
date_modified | date-time |
上次修改自訂欄位的日期。 |
籌款Api.Campaign閱讀
活動
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
行銷活動的系統記錄ID。 |
|
類別
|
category | string |
行銷活動的類別。 |
|
新增日期
|
date_added | date-time |
建立行銷活動的日期。 |
|
修改日期
|
date_modified | date-time |
上次修改行銷活動的日期。 |
|
Description
|
description | string |
行銷活動的顯示名稱。 |
|
結束日期
|
end_date | date-time |
行銷活動的結束日期。 |
|
value
|
goal.value | double |
貨幣價值。 |
|
㥩?
|
inactive | boolean |
行銷活動是否處於非作用中狀態 (表示目前日期在任何開始日期之後且在任何結束日期之前)? |
|
查詢標識碼
|
lookup_id | string |
行銷活動的使用者定義識別碼。 |
|
開始日期
|
start_date | date-time |
行銷活動的開始日期。 |
籌款Api.CreatedAppealAttachment
已建立申訴附件
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立的申訴附件的 ID。 |
FundraisingApi.CreatedAppealCustomField
已建立申訴自訂欄位
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立的申訴自訂欄位的ID。 |
FundraisingApi.CreatedCampaignAttachment
已建立的行銷活動附件
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立的行銷活動附件的ID。 |
FundraisingApi.CreatedCampaignCustomField
已建立行銷活動自訂欄位
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立的行銷活動自訂欄位的ID。 |
FundraisingApi.CreatedFundraiser指派
已建立的籌款活動指派
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立的籌款活動指派的識別碼。 |
籌款Api.CreatedFundAttachment
創建了資金附件
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立的基金附件的 ID。 |
FundraisingApi.CreatedFundCustomField
已建立基金自訂欄位
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立的基金自訂欄位的識別碼。 |
籌款Api.FundraiserAssignmentRead
Assignment
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
籌款活動指派的系統記錄識別碼。 |
|
選區 ID
|
constituent_id | string |
指派成分的系統記錄 ID。 |
|
類型
|
type | string |
籌款活動類型。 |
|
作業開始
|
start | date-time |
指派的開始日期。 |
|
作業結束
|
end | date-time |
指派的結束日期。 |
|
value
|
amount.value | double |
貨幣價值。 |
|
行銷活動ID
|
campaign_id | string |
將套用產生的禮品的行銷活動的系統記錄ID。 |
|
基金編號
|
fund_id | string |
將套用所產生禮物的基金的系統記錄 ID。 |
|
申訴 ID
|
appeal_id | string |
將套用所得禮物的上訴的系統記錄 ID。 |
籌款Api.FundAttachment閱讀
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 |
檔案大小 (以位元組為單位)。 僅適用於實體附件。 |
籌款Api.FundCustomField閱讀
自訂欄位
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
自訂欄位的系統記錄 ID。 |
|
基金編號
|
parent_id | string |
與自訂欄位相關聯之基金的系統記錄 ID。 |
|
類別
|
category | string |
自訂欄位類別。 |
|
類型
|
type | string |
自訂欄位所代表的資料類型。 |
|
價值觀
|
value |
自訂欄位的值。 |
|
|
Date
|
date | date |
自訂欄位上的日期。 |
|
評論
|
comment | string |
自訂欄位上的註解。 字元限制:50。 |
|
新增日期
|
date_added | date-time |
建立自訂欄位的日期。 |
|
修改日期
|
date_modified | date-time |
上次修改自訂欄位的日期。 |
籌款Api.FundRead
款
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
基金的系統記錄 ID。 |
|
類別
|
category | string |
基金的類別。 |
|
新增日期
|
date_added | date-time |
建立基金的日期。 |
|
修改日期
|
date_modified | date-time |
基金最後修改的日期。 |
|
Description
|
description | string |
基金的顯示名稱。 |
|
結束日期
|
end_date | date-time |
基金的結束日期。 |
|
value
|
goal.value | double |
貨幣價值。 |
|
㥩?
|
inactive | boolean |
基金是否處於不活躍狀態(即當前日期在任何開始日期之後和任何結束日期之前)? |
|
查詢標識碼
|
lookup_id | string |
基金的使用者定義識別碼。 |
|
開始日期
|
start_date | date-time |
基金的開始日期。 |
|
類型
|
type | string |
基金的類型。 |
籌款Api.PackageRead
Package
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
套件的系統記錄 ID。 |
|
申訴 ID
|
appeal_id | string |
與此套件相關聯的申訴的系統記錄 ID。 |
|
類別
|
category | string |
套件的類別。 |
|
新增日期
|
date_added | date-time |
建立套件的日期。 |
|
修改日期
|
date_modified | date-time |
上次修改套件的日期。 |
|
value
|
default_gift_amount.value | double |
貨幣價值。 |
|
Description
|
description | string |
套件的顯示名稱。 |
|
結束日期
|
end | date-time |
套件的結束日期。 |
|
value
|
goal.value | double |
貨幣價值。 |
|
㥩?
|
inactive | boolean |
套件是否處於非作用中狀態 (表示目前日期在任何開始日期之後,在任何結束日期之前)? |
|
查詢標識碼
|
lookup_id | string |
套件的使用者定義識別碼。 |
|
註釋
|
notes | string |
包裝上的註釋。 |
|
收件者計數
|
recipient_count | integer |
套件的收件者數目。 |
|
開始日期
|
start | date-time |
套件的開始日期。 |
GiftApi.鳴謝閱讀
鳴謝
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
date
|
date | date-time |
與通知相關聯的日期。 |
|
字母
|
letter | string |
與確認相關的信件。 |
|
狀態
|
status | string |
通知的狀態。 可用的值為:ACKNOWLEDGED、NEEDSACKNOWLEDGEMENT和DONOTACKNOWLEDGE。 |
GiftApi.ApiCollectionOfGiftAttachmentRead
Attachments
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of GiftApi.GiftAttachmentRead |
回應中包含的專案集。 這可能是集合中項目的子集。 |
GiftApi.ApiCollectionOfGiftCustomField閱讀
自訂欄位
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of GiftApi.GiftCustomFieldRead |
回應中包含的專案集。 這可能是集合中項目的子集。 |
GiftApi.ApiCollectionOfGiftRead
禮物
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of GiftApi.GiftRead |
回應中包含的專案集。 這可能是集合中項目的子集。 |
GiftApi.BatchGiftAdd結果
包含批次禮品錯誤記錄的集合,以及作業新增的批次禮品
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
錯誤
|
errors | array of GiftApi.GiftBatchGiftError |
與批次禮品新增作業相關聯的批次禮品錯誤 |
|
禮物
|
gifts | array of GiftApi.BatchGiftRead |
批次禮品新增作業所新增的批次禮品的集合 |
GiftApi.GiftBatchGift錯誤
代表防止項目新增至批次的例外狀況。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
受影響的欄位
|
affected_field | string |
受錯誤影響的欄位 |
|
批次識別碼
|
batch_id | string |
批次的系統記錄識別碼 |
|
異常錯誤碼
|
exception_error_code | integer |
例外狀況錯誤碼 |
|
異常錯誤訊息
|
exception_error_message | string |
例外狀況錯誤訊息 |
|
異常狀況錯誤名稱
|
exception_error_name | string |
例外狀況錯誤名稱 |
|
禮品編號
|
gift_id | string |
禮品的系統記錄 ID |
|
查閱標識碼
|
lookup_id | string |
禮物的使用者定義識別碼。 |
GiftApi.BatchGiftRead
批量贈送
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
批次識別碼
|
batch_id | string |
新增禮物的批次識別碼。 |
|
錯誤
|
errors | array of GiftApi.GiftBatchGiftError |
與批次禮品相關聯的錯誤。 |
|
ID
|
id | string |
批次贈品的系統記錄 ID。 |
|
組成 ID
|
constituent_id | string |
與禮品相關聯之成分的系統記錄 ID。 |
|
型別
|
type | string |
禮物類型。 |
|
子類型
|
subtype | string |
禮物的子類型。 |
|
date
|
date | date-time |
禮物日期。 |
|
value
|
amount.value | double |
貨幣價值。 |
|
value
|
balance.value | double |
貨幣價值。 |
|
批號
|
batch_number | string |
與此禮品相關聯的批號。 |
|
狀態
|
gift_status | string |
禮物的狀態。 |
|
匿名?
|
is_anonymous | boolean |
禮物是匿名的嗎? |
|
顧客群
|
constituency | string |
禮物的選區。 |
|
查閱標識碼
|
lookup_id | string |
禮物的使用者定義識別碼。 |
|
原點
|
origin | string |
禮物的起源。 |
|
貼文狀態
|
post_status | string |
禮物的總帳過帳狀態。 可用的值為 Posted、NotPosted 和 DoNotPost。 當post_status設定為 DoNotPost> 時,post_date應該為 Null。 當它設定為 NotPosted 時,post_date是必需的,但仍可編輯。 當它設定為已張貼時,post_date是必填的,且無法再編輯。 |
|
發佈日期
|
post_date | date-time |
禮物過帳到總帳的日期。 |
|
參考
|
reference | string |
追蹤禮物特殊細節的註釋,例如背後的動機或實物禮物的詳細描述。 |
|
天
|
recurring_gift_status_date.d | integer |
模糊約會中的一天。 |
|
月
|
recurring_gift_status_date.m | integer |
模糊日期中的月份。 |
|
年
|
recurring_gift_status_date.y | integer |
模糊日期中的年份。 |
|
頻率
|
recurring_gift_schedule.frequency | string |
要查看的定期禮物的分期付款頻率。 可用值為 WEEKLY、EVERY_TWO_WEEKS、EVERY_FOUR_WEEKS、MONTHLY、QUARTERLY、ANNUALLY。 |
|
start
|
recurring_gift_schedule.start_date | date-time |
定期禮物應該開始的日期。 |
|
結束
|
recurring_gift_schedule.end_date | date-time |
定期禮物應結束的日期。 |
|
value
|
gift_aid_amount.value | double |
貨幣價值。 |
|
禮品援助資格狀態
|
gift_aid_qualification_status | string |
此計算欄位會根據稅務申報資訊和資料庫格式來決定禮品援助資格狀態。 可用的值為:Qualified、NotQualified 和 PartlyQualified。 僅適用於英國。 |
|
禮包碼
|
gift_code | string |
與禮品相關聯的禮品代碼值。 |
|
禮物分割
|
gift_splits | array of GiftApi.GiftSplitRead |
與禮品相關聯的一組禮品分割。 |
|
籌款活動
|
fundraisers | array of GiftApi.GiftFundraiserRead |
獲得禮物積分的籌款人組。 |
|
軟學分
|
soft_credits | array of GiftApi.SoftCreditRead |
與禮物相關聯的一組軟點數。 |
|
收益
|
receipts | array of GiftApi.ReceiptRead |
與禮物相關聯的收據集。 |
|
致謝
|
acknowledgements | array of GiftApi.AcknowledgementRead |
與禮物相關聯的一組通知。 |
|
付款
|
payments | array of GiftApi.PaymentRead |
禮物上的付款。 |
|
連結禮物
|
linked_gifts | array of string |
與此禮物連結的其他禮物的識別碼。 |
|
新增日期
|
date_added | date-time |
建立禮物的日期。 |
|
修改日期
|
date_modified | date-time |
上次修改禮物的日期。 |
GiftApi.創建禮物
創建的禮物
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立的禮物的ID。 |
GiftApi.CreatedGiftAttachment
創建禮物附件
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立的禮品附件的 ID。 |
GiftApi.CreatedGiftCustomField
已建立禮品自訂欄位
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立的禮品自訂欄位的ID。 |
GiftApi.GiftAttachment閱讀
Attachment
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
附件的系統記錄 ID。 |
|
禮品 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 |
檔案大小 (以位元組為單位)。 僅適用於實體附件。 |
GiftApi.GiftCustomField閱讀
自訂欄位
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
自訂欄位的系統記錄 ID。 |
|
禮品 ID
|
parent_id | string |
與自訂欄位相關聯之禮品的系統記錄 ID。 |
|
類別
|
category | string |
自訂欄位類別。 |
|
類型
|
type | string |
自訂欄位所代表的資料類型。 |
|
價值觀
|
value |
自訂欄位的值。 |
|
|
Date
|
date | date |
自訂欄位上的日期。 |
|
評論
|
comment | string |
自訂欄位上的註解。 字元限制:50。 |
|
新增日期
|
date_added | date-time |
建立自訂欄位的日期。 |
|
修改日期
|
date_modified | date-time |
上次修改自訂欄位的日期。 |
GiftApi.Gift籌款活動閱讀
禮物籌款活動
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
value
|
amount.value | double |
貨幣價值。 |
|
籌款活動 ID
|
constituent_id | string |
與禮物相關聯之籌款活動的組成系統記錄 ID。 |
GiftApi.GiftRead
禮物
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
禮品的系統記錄 ID。 |
|
選區 ID
|
constituent_id | string |
與禮品相關聯之成分的系統記錄 ID。 |
|
類型
|
type | string |
禮物類型。 |
|
子類型
|
subtype | string |
禮物的子類型。 |
|
Date
|
date | date-time |
禮物日期。 |
|
value
|
amount.value | double |
貨幣價值。 |
|
value
|
balance.value | double |
貨幣價值。 |
|
批號
|
batch_number | string |
與此禮品相關聯的批號。 |
|
地位
|
gift_status | string |
禮物的狀態。 |
|
匿名?
|
is_anonymous | boolean |
禮物是匿名的嗎? |
|
選區
|
constituency | string |
禮物的選區。 |
|
查詢標識碼
|
lookup_id | string |
禮物的使用者定義識別碼。 |
|
Origin
|
origin | string |
禮物的起源。 |
|
貼文狀態
|
post_status | string |
禮物的總帳過帳狀態。 可用的值為 Posted、NotPosted 和 DoNotPost。 當post_status設定為 DoNotPost> 時,post_date應該為 Null。 當它設定為 NotPosted 時,post_date是必需的,但仍可編輯。 當它設定為已張貼時,post_date是必填的,且無法再編輯。 |
|
發佈日期
|
post_date | date-time |
禮物過帳到總帳的日期。 |
|
Reference
|
reference | string |
追蹤禮物特殊細節的註釋,例如背後的動機或實物禮物的詳細描述。 |
|
天
|
recurring_gift_status_date.d | integer |
模糊約會中的一天。 |
|
月
|
recurring_gift_status_date.m | integer |
模糊日期中的月份。 |
|
年
|
recurring_gift_status_date.y | integer |
模糊日期中的年份。 |
|
頻率
|
recurring_gift_schedule.frequency | string |
要查看的定期禮物的分期付款頻率。 可用值為 WEEKLY、EVERY_TWO_WEEKS、EVERY_FOUR_WEEKS、MONTHLY、QUARTERLY、ANNUALLY。 |
|
start
|
recurring_gift_schedule.start_date | date-time |
定期禮物應該開始的日期。 |
|
結束
|
recurring_gift_schedule.end_date | date-time |
定期禮物應結束的日期。 |
|
value
|
gift_aid_amount.value | double |
貨幣價值。 |
|
禮品援助資格狀態
|
gift_aid_qualification_status | string |
此計算欄位會根據稅務申報資訊和資料庫格式來決定禮品援助資格狀態。 可用的值為:Qualified、NotQualified 和 PartlyQualified。 僅適用於英國。 |
|
禮品代碼
|
gift_code | string |
與禮品相關聯的禮品代碼值。 |
|
禮物分割
|
gift_splits | array of GiftApi.GiftSplitRead |
與禮品相關聯的一組禮品分割。 |
|
籌款活動
|
fundraisers | array of GiftApi.GiftFundraiserRead |
獲得禮物積分的籌款人組。 |
|
軟學分
|
soft_credits | array of GiftApi.SoftCreditRead |
與禮物相關聯的一組軟點數。 |
|
收益
|
receipts | array of GiftApi.ReceiptRead |
與禮物相關聯的收據集。 |
|
致謝
|
acknowledgements | array of GiftApi.AcknowledgementRead |
與禮物相關聯的一組通知。 |
|
付款
|
payments | array of GiftApi.PaymentRead |
禮物上的付款。 |
|
連結禮物
|
linked_gifts | array of string |
與此禮物連結的其他禮物的識別碼。 |
|
新增日期
|
date_added | date-time |
建立禮物的日期。 |
|
修改日期
|
date_modified | date-time |
上次修改禮物的日期。 |
GiftApi.GiftSplit閱讀
禮物分割
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
禮品分割的系統記錄識別碼。 |
|
value
|
amount.value | double |
貨幣價值。 |
|
申訴 ID
|
appeal_id | string |
與禮物分割相關聯的上訴的系統記錄 ID。 |
|
行銷活動ID
|
campaign_id | string |
與禮品分割相關聯之行銷活動的系統記錄 ID。 |
|
基金編號
|
fund_id | string |
與贈與分割相關聯之基金的系統記錄 ID。 |
|
value
|
gift_aid_amount.value | double |
貨幣價值。 |
|
禮品援助資格狀態
|
gift_aid_qualification_status | string |
禮品分割的禮品援助資格狀態。 可用的值為:Qualified 和 NotQualified。 僅適用於英國。 |
|
套件 ID
|
package_id | string |
與禮品分割相關聯之封裝的系統記錄 ID。 |
GiftApi.收據讀取
收據
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
value
|
amount.value | double |
貨幣價值。 |
|
date
|
date | date-time |
收據上的日期。 |
|
數字
|
number | integer |
收據的編號。 |
|
狀態
|
status | string |
收據的狀態。 可用的值為:RECEIPTED、NEEDSRECEIPT 和 DONOTRECEIPT。 |
GiftApi.付款閱讀
付款
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
帳戶權杖
|
account_token | string |
來自外部付款提供者的權杖化帳戶資訊(例如:信用卡)。 只適用於「信用卡」及「直接扣賬」的付款方式。 |
|
BBPS 組態 ID
|
bbps_configuration_id | string |
BBPS 組態 ID。 只適用於「信用卡」及「直接扣賬」的付款方式。 |
|
BBPS 交易 ID
|
bbps_transaction_id | string |
BBPS 交易 ID。 只適用於「信用卡」及「直接扣賬」的付款方式。 |
|
天
|
check_date.d | integer |
模糊約會中的一天。 |
|
月
|
check_date.m | integer |
模糊日期中的月份。 |
|
年
|
check_date.y | integer |
模糊日期中的年份。 |
|
支票號碼
|
check_number | string |
支票號碼。 只適用於「個人支票」的付款方式。 |
|
結帳交易 ID
|
checkout_transaction_id | string |
結帳交易ID。 只適用於「信用卡」及「直接扣賬」的付款方式。 |
|
付款方式
|
payment_method | string |
付款方式。 下面列出了可用的值。 |
|
參考
|
reference | string |
參考。 只適用於「其他」之付款方式。 |
|
天
|
reference_date.d | integer |
模糊約會中的一天。 |
|
月
|
reference_date.m | integer |
模糊日期中的月份。 |
|
年
|
reference_date.y | integer |
模糊日期中的年份。 |
GiftApi.SoftCredit閱讀
軟信用
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
軟性信用的系統記錄 ID。 |
|
value
|
amount.value | double |
貨幣價值。 |
|
組成 ID
|
constituent_id | string |
與軟性信用相關聯之成分的系統記錄 ID。 |
|
禮品編號
|
gift_id | string |
與軟性信用相關聯之禮品的系統記錄 ID。 |
GiftBatchApi.ApiCollectionOfGiftBatch
禮品批次
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
回應中的禮品批次總數。 |
|
value
|
value | array of GiftBatchApi.GiftBatch |
回應中包含的專案集。 |
GiftBatchApi.CreatedBatch
已建立禮品批次
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
batch_id | string |
新建立的禮品批次的系統記錄識別碼。 |
GiftBatchApi.GiftBatch
代表禮品批次物件
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
批次的系統記錄 ID。 |
|
描述
|
batch_description | string |
批次描述。 |
|
批號
|
batch_number | string |
批號 |
|
預計數量
|
projected_number_of_gifts | integer |
批次中預計的禮物數量。 |
|
實際數量
|
number_of_gifts | integer |
批次中的實際贈品數量。 |
|
預計金額
|
projected_amount | double |
批次中禮物的預計價值。 |
|
實際金額
|
actual_amount | double |
批次中禮品的實際價值。 |
|
有例外嗎?
|
has_exceptions | boolean |
批次是否有例外狀況? |
|
批准了嗎?
|
is_approved | boolean |
批次是否獲得批准? |
|
由...創建
|
created_by | string |
建立批次的使用者名稱。 |
|
建立時間
|
created_on | date-time |
建立批次的日期。 |
ListApi.CreatedList
已建立清單
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立清單的識別碼。 |
OpportunityApi.ApiCollectionOfOpportunityAttachmentRead
Attachments
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of OpportunityApi.OpportunityAttachmentRead |
回應中包含的專案集。 這可能是集合中項目的子集。 |
OpportunityApi.ApiCollectionOfOpportunityCustomFieldRead
自訂欄位
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of OpportunityApi.OpportunityCustomFieldRead |
回應中包含的專案集。 這可能是集合中項目的子集。 |
OpportunityApi.ApiCollectionOfOpportunityRead
機會
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of OpportunityApi.OpportunityRead |
回應中包含的專案集。 這可能是集合中項目的子集。 |
OpportunityApi.CreatedOpportunity
創造的機會
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立機會的識別碼。 |
OpportunityApi.CreatedOpportunityAttachment
建立商機附件
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立的機會附件的 ID。 |
OpportunityApi.CreatedOpportunityCustomField
建立商機附件
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立的機會附件的 ID。 |
OpportunityApi.籌款活動
籌款活動
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
選區 ID
|
constituent_id | string |
與籌款活動相關聯之選民的系統記錄 ID。 |
|
value
|
credit_amount.value | double |
貨幣價值。 |
OpportunityApi.OpportunityAttachmentRead
Attachment
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
附件的系統記錄 ID。 |
|
機會 ID
|
parent_id | string |
與附件相關聯之機會的系統記錄識別碼。 |
|
類型
|
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 |
檔案大小 (以位元組為單位)。 僅適用於實體附件。 |
OpportunityApi.OpportunityCustomFieldRead
自訂欄位
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
自訂欄位的系統記錄 ID。 |
|
機會 ID
|
parent_id | string |
與自訂欄位相關聯之機會的系統記錄識別碼。 |
|
類別
|
category | string |
自訂欄位類別。 |
|
類型
|
type | string |
自訂欄位所代表的資料類型。 |
|
價值觀
|
value |
自訂欄位的值。 |
|
|
Date
|
date | date |
自訂欄位上的日期。 |
|
評論
|
comment | string |
自訂欄位上的註解。 字元限制:50。 |
|
新增日期
|
date_added | date-time |
建立自訂欄位的日期。 |
|
修改日期
|
date_modified | date-time |
上次修改自訂欄位的日期。 |
OpportunityApi.OpportunityRead
商機
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
商機的系統記錄識別碼。 |
|
選區 ID
|
constituent_id | string |
與商機相關聯之選件的系統記錄識別碼。 |
|
目標
|
purpose | string |
因機會而籌集的任何資金的預期用途。 |
|
名稱
|
name | string |
在整個計劃中識別機會的名稱,例如在清單或組成記錄中。 字元限制:255。 |
|
地位
|
status | string |
指出機會在招攬程序中的位置的狀態。 |
|
Deadline
|
deadline | date-time |
獲得禮物機會的目標日期。 |
|
詢問日期
|
ask_date | date-time |
進行招標的日期。 |
|
value
|
ask_amount.value | double |
貨幣價值。 |
|
預計日期
|
expected_date | date-time |
潛在客戶預期回應機會的日期。 |
|
value
|
expected_amount.value | double |
貨幣價值。 |
|
資助日期
|
funded_date | date-time |
潛在客戶回應機會的日期。 |
|
value
|
funded_amount.value | double |
貨幣價值。 |
|
行銷活動ID
|
campaign_id | string |
與商機相關聯之行銷活動的系統記錄 ID。 該活動設定了籌集資金的總體目標。 |
|
基金編號
|
fund_id | string |
與商機相關聯之基金的系統記錄識別碼。 該基金指定了禮物的具體財務目的,並確定了該禮物的財務帳戶。 |
|
籌款活動
|
fundraisers | array of OpportunityApi.Fundraiser |
指派給商機之籌款活動的系統記錄 ID 集。 |
|
㥩?
|
inactive | boolean |
商機是否處於非作用中狀態? |
|
linked_gifts
|
linked_gifts | array of string |
系統會記錄與商機相關的禮物 ID。 |
|
新增日期
|
date_added | date-time |
建立商機的日期。 |
|
修改日期
|
date_modified | date-time |
上次修改商機的日期。 |