Blackbaud Raisers Edge NXT 成分股
Blackbaud Raiser 的 Edge NXT 是一款全面的基於雲的籌款和捐助者管理軟件解決方案,專為非營利組織和整個社會公益社區構建。 使用「選民」聯結器來管理選民傳記詳細資料、聯絡資訊和關係。
此連接器適用於以下產品和區域:
| 服務 | Class | Regions |
|---|---|---|
| 副駕駛工作室 | 進階 | 除下列區域外的所有 Power Automate 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| 邏輯應用程式 | 標準 | 所有 Logic Apps 區域, 但下列區域除外: - Azure Government 區域 - Azure 中國區域 - 美國國防部 (DoD) |
| Power Apps | - | 無法提供 |
| 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 中的成分和相關實體,包括:
- 成分
- Addresses
- 電話和電子郵件
- Aliases
- 自訂欄位
- 註釋
- Attachments
- 關係
- 不勝枚舉...
如需詳細資訊,請檢視 文件。
先決條件
若要使用此連接器,您必須擁有 Blackbaud ID 帳戶,才能存取一或多個 Blackbaud 環境。
此外,您組織的管理員還必須在系統內執行管理員層級動作,才能讓此連接器存取您的 Blackbaud 環境。 有關這些先決條件的詳細資訊,請參閱 初始設定 文件。
如何取得憑證?
您組織的管理員將向您發送組織的 Raiser's Edge NXT 環境的邀請,並在環境中配置您的用戶帳戶權限。 使用此連接器不需要其他認證。
已知問題與限制
連接器將在您的使用者帳戶的內容中運作,因此將受限於您在環境中的使用者權限。
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 100 | 60 秒 |
動作
| 列出成分 |
傳回成分清單。 |
| 列出成分代碼 |
列出成分的成分代碼。 |
| 列出成分地址 |
列出選區的地址。 |
| 列出成分票據 |
列出成分的附註。 |
| 列出成分貢品 |
列出對選民的貢品。 |
| 列出成分電話 |
列出選民的電話。 |
| 列出構成教育 |
列出選民的教育記錄。 |
| 列出籌款活動指派 |
列出籌款活動的指派工作。 |
| 列出籌款活動的組成部分 |
列出選民的籌款活動指派。 |
| 列出組成別名 |
列出成分的別名。 |
| 列出組成成員 |
列出選民的成員資格。 |
| 列出組成自訂欄位 |
列出成分的自訂欄位。 |
| 列出組成關係 |
列出成分的關係。 |
| 列出組成附件 |
列出成分的附件。 |
| 列出選民同意記錄 |
列出選民的同意記錄。 |
| 列出選民徵集代碼 |
列出選民的徵求代碼。 |
| 列出選民線上狀態 |
列出選民的線上狀態。 |
| 列出選民電子郵件地址 |
列出選民的電子郵件地址。 |
| 列表致敬致謝 |
列出致敬的致謝。 |
| 刪除成分代碼 |
刪除組成代碼。 |
| 創建選民教育 |
創造新的組成教育。 |
| 創建選民致敬 |
創建新的組成貢品。 |
| 取得組成名稱格式摘要 |
傳回成分的名稱格式摘要。 |
| 建立個人關係 |
建立新的個人關係。 如果關係是與另一個成分的關係,則會為該成分建立互惠關係。 |
| 建立個別選區 |
建立新的個別選區。 |
| 建立募款活動指派 |
建立新的籌款活動指派。 |
| 建立成分代碼 |
建立新的組成代碼。 |
| 建立成分徵求代碼 |
建立新的選區徵求代碼。 |
| 建立成分附註 |
建立新的成分附註。 |
| 建立組成主要名稱格式 |
建立成分的主要名稱格式。 |
| 建立組成別名 |
建立新的組成別名。 |
| 建立組成名稱格式 |
建立新的組成部分名稱格式。 |
| 建立組織組成部分 |
建立新的組織組成部分。 |
| 建立組織關係 |
建立新的組織關係。 如果關係是與另一個成分的關係,則會為該成分建立互惠關係。 |
| 建立致敬 確認 |
創建新的致敬致謝。 |
| 建立選區地址 |
建立新的組成地址。 |
| 建立選區自訂欄位 |
建立新的組成部分自訂欄位。 |
| 建立選區附件 |
建立新的組成附件。 |
| 建立選區電話 |
建立新的組成電話。 |
| 建立選民同意記錄 |
建立新的選民同意記錄。 |
| 建立選民線上形象 |
創建新的選民在線形象。 |
| 建立選民電子郵件地址 |
建立新的選民電子郵件地址。 |
| 搜尋成分(增強) |
使用指定的篩選條件搜尋成分記錄。 |
| 搜尋選民 |
根據提供的搜尋文字執行成分搜尋。 支援名字、姓氏、偏好名稱、以前的名字、別名、電子郵件地址、電話號碼、地址或查找 ID。 名字組合(例如名字和姓氏或偏好的名字和姓氏)是有效的,但除此之外,搜尋一次只支援一個參數。 根據預設,搜尋會包含聽起來與您的條件相似的結果。 例如,搜尋「Smith」會包含「Smyth」和其他替代拼字的相符專案。 此搜尋不支援萬用字元,例如 * 或 ?。 搜尋結果限制為 500 筆記錄。 |
| 搜尋重複成分 |
搜尋個人、組織和相關聯絡人記錄,並根據指定的搜尋篩選器對潛在的重複項進行排名。 符合多個篩選條件的記錄會作為潛在重複項目排名較高。 |
| 更新成分代碼 |
更新成分代碼。 |
| 更新成分地址 |
更新組成地址。 |
| 更新成分附註 |
更新成分票據。 |
| 更新組成主要名稱格式 |
更新成分的主要名稱格式。 |
| 更新組成別名 |
更新組成別名。 |
| 更新組成名稱格式 |
更新組成部分名稱格式。 |
| 更新組成徵求代碼 |
更新選民徵求代碼。 |
| 更新組成自訂欄位 |
更新組成自訂欄位。 |
| 更新組成關係 |
更新選區的關係。 如果存在互惠關係,也會修改它以反映變更。 這不包括對「comments」屬性的變更,該屬性特定於每筆記錄,並且可以在每筆記錄上獨立修改。 |
| 更新組成附件 |
更新組成附件。 |
| 更新選區電話 |
更新組成的電話。 |
| 更新選民 |
更新選區。 |
| 更新選民個人資料相片 |
更新選民的當前個人資料圖片。 |
| 更新選民教育 |
更新選民教育。 |
| 更新選民線上狀態 |
更新選民線上狀態。 |
| 更新選民電子郵件地址 |
更新選民電子郵件地址。 |
| 獲取選民 |
傳回成分的相關資訊。 |
| 獲取選民個人資料圖片 |
傳回選民的目前設定檔圖片。 |
| 獲得選民致敬 |
傳回有關選區貢品的詳細資料。 |
| 轉換為成分 |
將非成分轉換為成分。 |
| 透過查詢 ID 取得選民 |
從指定的查閱 ID 傳回成分的系統記錄 ID。 |
列出成分
傳回成分清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | 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
|
constituentId | True | integer |
成分的系統記錄 ID。 |
傳回
致敬
列出成分電話
列出選民的電話。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
選區 ID
|
constituent_id | True | string |
成分的系統記錄 ID。 |
|
包括不活躍?
|
include_inactive | boolean |
包括非活動手機? |
傳回
電話
列出構成教育
列出選民的教育記錄。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
選區 ID
|
constituent_id | True | string |
成分的系統記錄 ID。 |
傳回
學歷
列出籌款活動指派
列出籌款活動的指派工作。
參數
| 名稱 | 機碼 | 必要 | 類型 | 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。 |
傳回
Memberships
列出組成自訂欄位
列出成分的自訂欄位。
參數
| 名稱 | 機碼 | 必要 | 類型 | 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 |
|---|---|---|---|---|
|
選區 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
|
tributeId | True | integer |
貢品的系統記錄 ID。 |
傳回
致敬致謝
刪除成分代碼
刪除組成代碼。
參數
| 名稱 | 機碼 | 必要 | 類型 | 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
|
constituent_record_id | True | integer |
與貢品相關聯之成分的系統記錄 ID。 |
|
貢品類型
|
tribute_type_id | True | integer |
貢品類型。 |
|
Description
|
description | string |
致敬描述。 |
|
|
天
|
d | integer |
模糊約會中的一天。 |
|
|
個月
|
m | integer |
模糊日期中的月份。 |
|
|
年
|
y | integer |
模糊日期中的年份。 |
|
|
天
|
d | integer |
模糊約會中的一天。 |
|
|
個月
|
m | integer |
模糊日期中的月份。 |
|
|
年
|
y | integer |
模糊日期中的年份。 |
|
|
預設基金編號
|
default_fund_id | integer |
與貢品相關聯之預設基金的系統記錄 ID。 |
|
|
註釋
|
notes | string |
致敬筆記。 |
|
|
活躍的?
|
is_active | boolean |
這個致敬活動活躍嗎? |
傳回
創建了選民貢品
取得組成名稱格式摘要
傳回成分的名稱格式摘要。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
選區 ID
|
constituent_id | True | string |
成分的系統記錄 ID。 |
傳回
名稱格式摘要
建立個人關係
建立新的個人關係。 如果關係是與另一個成分的關係,則會為該成分建立互惠關係。
參數
| 名稱 | 機碼 | 必要 | 類型 | 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 |
選民是否匿名捐款? |
|
|
沒有電子郵件請求?
|
requests_no_email | boolean |
選民是否要求不發送電子郵件? |
|
|
是律師嗎?
|
is_solicitor | boolean |
選民是律師嗎? |
|
|
沒有有效地址?
|
no_valid_address | boolean |
成分股是否沒有有效地址? |
|
|
天
|
d | integer |
模糊約會中的一天。 |
|
|
個月
|
m | integer |
模糊日期中的月份。 |
|
|
年
|
y | integer |
模糊日期中的年份。 |
|
|
誕生地
|
birthplace | string |
成分的發源地。 |
|
|
種族
|
ethnicity | string |
選民的種族。 |
|
|
標的
|
target | string |
成分的目標。 |
|
|
收入
|
income | string |
選民的收入。 |
|
|
收據類型
|
receipt_type | string |
成分的收據類型。 |
|
|
宗教
|
religion | string |
選民的宗教。 |
|
|
客製化收件人?
|
custom_format | boolean |
主要收件人是自訂格式嗎? |
|
|
收件人格式
|
configuration_id | string |
主要收件人配置(除非使用自定義格式,否則需要)。 |
|
|
收件人自訂名稱
|
formatted_name | string |
主要收件人格式名稱(使用自訂格式時需要)。 字元限制:255。 |
|
|
自定義稱呼?
|
custom_format | boolean |
主要稱呼是自訂格式嗎? |
|
|
稱呼格式
|
configuration_id | string |
主要稱呼設定 (除非使用自訂格式,否則必須) 。 |
|
|
稱呼自訂名稱
|
formatted_name | string |
主要稱呼格式名稱 (使用自訂格式時需要)。 字元限制:255。 |
|
|
是紀念嗎?
|
is_memorial | boolean |
選民是榮譽/紀念嗎? |
傳回
創建個人成分
建立募款活動指派
建立新的籌款活動指派。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
籌款活動 ID
|
fundraiser_id | True | string |
籌款活動的系統記錄識別碼。 |
|
選區 ID
|
constituent_id | True | string |
指派成分的系統記錄 ID。 |
|
類型
|
type | string |
籌款活動的類型。 |
|
|
作業開始
|
start | date-time |
指派的開始日期 (例如:「2020-09-18T04:13:56Z」)。 |
|
|
作業結束
|
end | date-time |
指派的結束日期 (例如:「2020-09-18T04:13:56Z」)。 |
|
|
總數
|
value | True | double |
籌款人向指定選民募集的目標金額。 |
|
行銷活動ID
|
campaign_id | string |
將套用產生的禮品的行銷活動的系統記錄ID。 |
|
|
基金編號
|
fund_id | string |
將套用所產生禮物的基金的系統記錄 ID。 |
|
|
申訴 ID
|
appeal_id | string |
將套用所得禮物的上訴的系統記錄 ID。 |
傳回
已建立的籌款活動指派
建立成分代碼
建立新的組成代碼。
參數
| 名稱 | 機碼 | 必要 | 類型 | 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 |
|---|---|---|---|---|
|
選區 ID
|
constituent_id | True | string |
與附註相關聯之成分的系統記錄 ID。 |
|
類型
|
type | True | string |
註記類型。 |
|
天
|
d | integer |
模糊約會中的一天。 |
|
|
個月
|
m | integer |
模糊日期中的月份。 |
|
|
年
|
y | integer |
模糊日期中的年份。 |
|
|
總結
|
summary | string |
註釋摘要。 字元限制:50。 |
|
|
備註
|
text | string |
註釋文字。 |
|
|
作者
|
author | string |
筆記作者。 如果未提供,則會根據使用者的帳戶設定預設值。 字元限制:50。 |
傳回
創建成分票據
建立組成主要名稱格式
建立成分的主要名稱格式。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
選區 ID
|
constituent_id | True | string |
成分的系統記錄 ID。 |
|
類型
|
primary_type | True | string |
主要名稱格式類型。 |
|
自訂名稱格式?
|
custom_format | boolean |
是自訂格式嗎? |
|
|
格式
|
configuration_id | string |
名稱格式設定 (除非使用自訂格式,否則必須) 。 |
|
|
自訂名稱
|
formatted_name | string |
格式化名稱 (使用自訂格式時需要)。 字元限制:255。 |
傳回
建立名稱格式
建立組成別名
建立新的組成別名。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
選區 ID
|
constituent_id | True | string |
與別名相關聯之成分的系統記錄 ID。 |
|
Alias
|
name | True | string |
要用作成分別名的名稱。 字元限制:100。 |
|
類型
|
type | string |
別名類型。 |
傳回
已建立組成別名
建立組成名稱格式
建立新的組成部分名稱格式。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
選區 ID
|
constituent_id | True | string |
成分的系統記錄 ID。 |
|
類型
|
type | True | string |
名稱格式類型。 |
|
自訂名稱格式?
|
custom_format | boolean |
是自訂格式嗎? |
|
|
格式
|
configuration_id | string |
名稱格式設定 (除非使用自訂格式,否則必須) 。 |
|
|
自訂名稱
|
formatted_name | string |
格式化名稱 (使用自訂格式時需要)。 字元限制:255。 |
傳回
建立名稱格式
建立組織組成部分
建立新的組織組成部分。
參數
| 名稱 | 機碼 | 必要 | 類型 | 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 |
選民是否匿名捐款? |
|
|
沒有電子郵件請求?
|
requests_no_email | boolean |
選民是否要求不發送電子郵件? |
|
|
是律師嗎?
|
is_solicitor | boolean |
選民是律師嗎? |
|
|
沒有有效地址?
|
no_valid_address | boolean |
成分股是否沒有有效地址? |
|
|
標的
|
target | string |
成分的目標。 |
|
|
收入
|
income | string |
選民的收入。 |
|
|
收據類型
|
receipt_type | 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 |
選民的匹配禮品票據。 |
|
|
是紀念嗎?
|
is_memorial | 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_organization_contact | boolean |
選民是否代表該組織作為聯繫人? |
|
|
連絡方式類型
|
organization_contact_type | string |
提供與代表組織作為連絡人的相關個人互動的上下文。 |
|
|
Position
|
position | string |
個人在組織中的位置。 字元限制:50。 |
|
|
是主要業務嗎?
|
is_primary_business | boolean |
這是選民的主要業務嗎? |
|
|
註釋
|
comment | string |
關於關係的其他說明。 |
傳回
建立的組織關聯性
建立致敬 確認
創建新的致敬致謝。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
致敬 ID
|
tribute_id | True | integer |
與確認相關聯的貢品的系統記錄 ID。 |
|
關係識別碼
|
relationship_id | integer |
關係的系統記錄識別碼 (如果為空值,則代表自我確認)。 |
|
|
字母 ID
|
letter_id | integer |
字母 ID。 |
傳回
創建致敬致謝
建立選區地址
建立新的組成地址。
參數
| 名稱 | 機碼 | 必要 | 類型 | 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 個。 僅適用於實體附件。 |
|
|
Tags
|
tags | array of string |
與附件相關聯的標籤。 |
傳回
創建的成分附件
建立選區電話
建立新的組成電話。
參數
| 名稱 | 機碼 | 必要 | 類型 | 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 |
|---|---|---|---|---|
|
名字
|
first_name | string |
組成名字。 |
|
|
姓氏
|
last_name | string |
組成姓氏。 |
|
|
查詢標識碼
|
lookup_id | string |
組成部分查詢 ID。 |
|
|
電子郵件地址
|
string |
選民電子郵件地址。 |
||
|
電話號碼
|
phone_number | string |
電話號碼。 |
|
|
限制
|
limit | integer |
代表要傳回的記錄數目。 預設值為 500。 最大值為 1000。 |
|
|
地址行
|
address_lines | string |
地址行。 |
|
|
城市
|
city | string |
位址城市。 |
|
|
State
|
state | string |
位址狀態。 |
|
|
郵遞區號
|
post_code | string |
地址郵遞區號。 |
|
|
包括別名?
|
include_alias | boolean |
搜索姓氏時包含別名? |
|
|
別名類型
|
alias_type | string |
別名類型。 |
|
|
包括婚前姓氏?
|
include_maiden_name | boolean |
搜索姓氏時包含婚前姓氏? |
傳回
成分
搜尋選民
根據提供的搜尋文字執行成分搜尋。 支援名字、姓氏、偏好名稱、以前的名字、別名、電子郵件地址、電話號碼、地址或查找 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 |
|---|---|---|---|---|
|
姓氏/組織名稱
|
last_org_name | True | string |
符合指定姓氏或組織名稱之記錄的篩選器。 |
|
名字
|
first_name | string |
符合指定名字之個別記錄的篩選器。 |
|
|
中間名
|
middle_name | string |
符合指定中間名之個別記錄的篩選器。 |
|
|
後綴
|
suffix | string |
符合指定字尾之個別記錄的篩選器。 |
|
|
地址區塊
|
address_block | string |
符合指定位址區塊之記錄的篩選器。 |
|
|
城市
|
city | string |
符合指定城市之記錄的篩選器。 |
|
|
State
|
state | string |
符合指定狀態之記錄的篩選器。 |
|
|
郵遞區號
|
post_code | string |
符合指定郵遞區號之記錄的篩選器。 |
|
|
Email
|
array |
符合指定電子郵件地址之記錄的篩選器。 |
||
|
電話
|
phone | array |
符合指定電話號碼之記錄的篩選器。 |
|
|
搜尋個人?
|
search_individuals | boolean |
搜尋重複的個別記錄? |
|
|
搜索別名?
|
search_aliases | boolean |
依別名搜尋,如姓氏/組織名稱參數所指定? |
|
|
搜尋聯絡人?
|
search_contacts | boolean |
搜尋關係聯絡人記錄? |
|
|
限制
|
limit | integer |
分頁結果時要傳回的記錄數 (預設值 = 3)。 |
|
|
Offset
|
offset | integer |
分頁結果時要略過的記錄數。 |
傳回
重複的搜尋結果
更新成分代碼
更新成分代碼。
參數
| 名稱 | 機碼 | 必要 | 類型 | 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
|
primary_name_format_id | True | string |
要更新的主要名稱格式的系統記錄 ID。 |
|
自訂名稱格式?
|
custom_format | boolean |
是自訂格式嗎? |
|
|
格式
|
configuration_id | string |
名稱格式設定 (除非使用自訂格式,否則必須) 。 |
|
|
自訂名稱
|
formatted_name | string |
格式化名稱 (使用自訂格式時需要)。 字元限制:255。 |
更新組成別名
更新組成別名。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
別名 ID
|
alias_id | True | string |
要更新之別名的系統記錄 ID。 |
|
Alias
|
name | string |
要用作成分別名的名稱。 字元限制:100。 |
|
|
類型
|
type | string |
別名類型。 |
更新組成名稱格式
更新組成部分名稱格式。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
名稱格式 ID
|
name_format_id | True | string |
要更新之名稱格式的系統記錄 ID。 |
|
類型
|
type | string |
名稱格式類型。 |
|
|
自訂名稱格式?
|
custom_format | boolean |
是自訂格式嗎? |
|
|
格式
|
configuration_id | string |
名稱格式設定 (除非使用自訂格式,否則必須) 。 |
|
|
自訂名稱
|
formatted_name | string |
格式化名稱 (使用自訂格式時需要)。 字元限制:255。 |
更新組成徵求代碼
更新選民徵求代碼。
參數
| 名稱 | 機碼 | 必要 | 類型 | 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。 這是連結附件所必需的,不適用於實體附件。 |
|
|
Tags
|
tags | array of string |
與附件相關聯的標籤。 |
更新選區電話
更新組成的電話。
參數
| 名稱 | 機碼 | 必要 | 類型 | 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 |
選民是否匿名捐款? |
|
|
沒有電子郵件請求?
|
requests_no_email | boolean |
選民是否要求不發送電子郵件? |
|
|
是律師嗎?
|
is_solicitor | boolean |
選民是律師嗎? |
|
|
沒有有效地址?
|
no_valid_address | boolean |
成分股是否沒有有效地址? |
|
|
㥩?
|
inactive | boolean |
成分是否不活躍? |
|
|
天
|
d | integer |
模糊約會中的一天。 |
|
|
個月
|
m | integer |
模糊日期中的月份。 |
|
|
年
|
y | integer |
模糊日期中的年份。 |
|
|
誕生地
|
birthplace | string |
成分的出生地(僅限個人)。 |
|
|
種族
|
ethnicity | string |
選民的種族(僅限個人)。 |
|
|
標的
|
target | string |
成分的目標。 |
|
|
收入
|
income | string |
成分股的收入(僅限個人)。 |
|
|
收據類型
|
receipt_type | 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 |
模糊日期中的年份。 |
|
|
是紀念嗎?
|
is_memorial | boolean |
選民是榮譽/紀念嗎? |
更新選民個人資料相片
更新選民的當前個人資料圖片。
參數
| 名稱 | 機碼 | 必要 | 類型 | 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 |
|---|---|---|---|---|
|
致敬 ID
|
tribute_id | True | string |
貢品 ID。 |
傳回
貢
轉換為成分
將非成分轉換為成分。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
非成分 ID
|
non_constituent_id | True | string |
要轉換之非組成記錄的系統記錄 ID。 |
|
ID
|
id | string |
成分代碼的系統記錄 ID。 |
|
|
天
|
d | integer |
模糊約會中的一天。 |
|
|
個月
|
m | integer |
模糊日期中的月份。 |
|
|
年
|
y | integer |
模糊日期中的年份。 |
|
|
天
|
d | integer |
模糊約會中的一天。 |
|
|
個月
|
m | integer |
模糊日期中的月份。 |
|
|
年
|
y | integer |
模糊日期中的年份。 |
|
|
序列
|
sequence | integer |
組成代碼的順序。 |
傳回
轉換成分
透過查詢 ID 取得選民
從指定的查閱 ID 傳回成分的系統記錄 ID。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
查詢標識碼
|
constituent_id | True | string |
成分查閱 ID。 |
傳回
選區 ID 地圖
定義
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.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.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.ApiCollectionOfMembershipRead
Memberships
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of ConstituentApi.MembershipRead |
回應中包含的專案集。 這可能是集合中項目的子集。 |
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.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.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 |
檔案大小 (以位元組為單位)。 僅適用於實體附件。 |
|
Tags
|
tags | array of string |
與附件相關聯的標籤。 |
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 |
自訂欄位的值。 |
|
|
文字值
|
text_value | string |
自訂欄位的文字值。 |
|
數字值
|
number_value | integer |
自訂欄位的數值。 |
|
日期值
|
date_value | date |
自訂欄位的日期值。 |
|
貨幣價值
|
currency_value | double |
自訂欄位的貨幣值。 |
|
布林值
|
boolean_value | boolean |
自訂欄位的布林值。 |
|
表格項目值
|
codetableentry_value | string |
自訂欄位的表格項目值。 |
|
成分 ID 值
|
constituentid_value | string |
自訂欄位的組成 ID 值。 |
|
天
|
fuzzydate_value.d | integer |
模糊約會中的一天。 |
|
個月
|
fuzzydate_value.m | integer |
模糊日期中的月份。 |
|
年
|
fuzzydate_value.y | integer |
模糊日期中的年份。 |
|
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 |
選民是否匿名捐款? |
|
沒有電子郵件請求?
|
requests_no_email | boolean |
選民是否要求不發送電子郵件? |
|
是律師嗎?
|
is_solicitor | boolean |
選民是律師嗎? |
|
沒有有效地址?
|
no_valid_address | boolean |
成分股是否沒有有效地址? |
|
㥩?
|
inactive | boolean |
成分是否不活躍? |
|
天
|
birthdate.d | integer |
模糊約會中的一天。 |
|
個月
|
birthdate.m | integer |
模糊日期中的月份。 |
|
年
|
birthdate.y | integer |
模糊日期中的年份。 |
|
誕生地
|
birthplace | string |
成分的出生地(僅限個人)。 |
|
種族
|
ethnicity | string |
選民的種族(僅限個人)。 |
|
標的
|
target | string |
成分的目標。 |
|
收入
|
income | string |
成分股的收入(僅限個人)。 |
|
收據類型
|
receipt_type | string |
成分的收據類型。 |
|
宗教
|
religion | string |
選民的宗教信仰(僅限個人)。 |
|
工業
|
industry | string |
成分的產業 (僅限組織)。 |
|
員工人數
|
num_employees | integer |
組織的員工人數。 |
|
匹配禮物?
|
matches_gifts | boolean |
組織是否配對禮物? |
|
匹配禮物因素
|
matching_gift_factor | double |
配對的禮物因素(僅適用於組織)。 |
|
value
|
matching_gift_per_gift_min.value | double |
金額值。 |
|
value
|
matching_gift_per_gift_max.value | double |
金額值。 |
|
value
|
matching_gift_total_min.value | double |
金額值。 |
|
value
|
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 |
指出選民是否為籌款人(僅限個人)。 |
|
是紀念嗎?
|
is_memorial | boolean |
選民是榮譽/紀念嗎? |
|
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.ConvertedConstituent
轉換成分
| 名稱 | 路徑 | 類型 | 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.CreatedIndividualConstituent
創建個人成分
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立的個別選區的 ID。 |
ConstituentApi.CreatedIndividualRelationship
創建的個人關係
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立的個別關係的識別碼。 |
ConstituentApi.CreatedNameFormat
建立名稱格式
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立名稱格式的識別碼。 |
ConstituentApi.CreatedOrganizationConstituent
已建立的組織組成
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立的組織組成者的 ID。 |
ConstituentApi.CreatedOrganizationRelationship
建立的組織關聯性
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立的組織關係的識別碼。 |
ConstituentApi.DuplicateSearchResult
重複的搜尋結果
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
成分的系統記錄 ID。 |
|
名稱
|
name | string |
組成名稱。 對於個人,此計算欄位會根據目標組織的顯示名稱設定,指出選件的完整名稱。 |
|
顯示名稱
|
display_name | string |
成分的顯示名稱。 |
|
Address
|
formatted_address | string |
成分的格式化主要位址。 |
|
死了?
|
deceased | boolean |
選民已故嗎? |
|
是選民嗎?
|
is_constituent | boolean |
記錄是成分嗎? |
|
查詢標識碼
|
constituent_id | string |
成分的使用者定義 ID。 |
|
新增日期
|
date_added | date-time |
新增成分的日期。 |
|
等級
|
rank | string |
搜尋排名,指示選區相符的內容。 |
ConstituentApi.DuplicateSearchResultCollection
重複的搜尋結果
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of ConstituentApi.DuplicateSearchResult |
回應中包含的專案集。 這可能是集合中項目的子集。 |
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.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.MembershipMemberRead
會員
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
成員的系統記錄 ID。 |
|
選區 ID
|
constituent_id | string |
與成員相關聯之選件的系統記錄 ID。 |
|
是主要成員嗎?
|
primary | boolean |
這是主要成員嗎? |
ConstituentApi.MembershipRead
Membership
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
成員資格的系統記錄識別碼。 |
|
選區 ID
|
constituent_id | string |
與成員資格相關聯之選件的系統記錄 ID。 |
|
程式
|
program | string |
會員計劃。 |
|
類別
|
category | string |
成員資格類別。 |
|
子類別
|
subcategory | string |
成員資格子類別。 |
|
身份
|
standing | string |
會員資格狀態。 |
|
過期
|
expires | date-time |
會籍到期的日期。 |
|
沓
|
joined | date-time |
成員資格變成作用中的日期。 |
|
value
|
dues.value | double |
貨幣價值。 |
|
Members
|
members | array of ConstituentApi.MembershipMemberRead |
屬於成員資格的成員集。 |
|
新增日期
|
date_added | date-time |
建立成員資格的日期。 |
|
修改日期
|
date_modified | date-time |
上次修改成員資格的日期。 |
ConstituentApi.NameFormatRead
名稱格式定義了如何在通信中稱呼成分。 你如何稱呼個人決定了你與他們溝通的基調以及他們接受你互動的程度。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
名稱格式的系統記錄 ID。 |
|
型別
|
type | string |
名稱格式類型。 |
|
自訂格式?
|
custom_format | boolean |
這是自訂格式嗎? |
|
組態識別碼
|
configuration_id | string |
名稱格式的組態識別碼 (適用於非自訂格式)。 |
|
格式化名稱
|
formatted_name | string |
格式化名稱 (適用於自訂格式)。 |
ConstituentApi.NameFormatSummaryRead
名稱格式摘要
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
primary_addressee.id | string |
名稱格式的系統記錄 ID。 |
|
型別
|
primary_addressee.primary_type | string |
名稱格式類型。 |
|
自訂格式?
|
primary_addressee.custom_format | boolean |
這是自訂格式嗎? |
|
組態識別碼
|
primary_addressee.configuration_id | string |
名稱格式的組態識別碼 (適用於非自訂格式)。 |
|
格式化名稱
|
primary_addressee.formatted_name | string |
格式化名稱 (適用於自訂格式)。 |
|
ID
|
primary_salutation.id | string |
名稱格式的系統記錄 ID。 |
|
型別
|
primary_salutation.primary_type | string |
名稱格式類型。 |
|
自訂格式?
|
primary_salutation.custom_format | boolean |
這是自訂格式嗎? |
|
組態識別碼
|
primary_salutation.configuration_id | string |
名稱格式的組態識別碼 (適用於非自訂格式)。 |
|
格式化名稱
|
primary_salutation.formatted_name | string |
格式化名稱 (適用於自訂格式)。 |
|
其他名稱格式
|
additional_name_formats | array of ConstituentApi.NameFormatRead |
成分的其他名稱格式。 |
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.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。 |
籌款Api.ApiCollectionOfFundraiserAssignmentRead
Assignments
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of FundraisingApi.FundraiserAssignmentRead |
回應中包含的專案集。 這可能是集合中項目的子集。 |
FundraisingApi.CreatedFundraiser指派
已建立的籌款活動指派
| 名稱 | 路徑 | 類型 | 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。 |
NXTDataIntegrationApi.ConstituentIdMap
選區 ID 地圖
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
system_record_id | integer |
組成系統記錄 ID。 |
NXTDataIntegrationApi.ConstituentSearchResult
搜尋結果
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
record_id | integer |
成分的系統記錄 ID。 |
|
查詢標識碼
|
constituent_id | string |
組成 ID。 |
|
關鍵指標
|
key_indicator | string |
記錄的關鍵指標。 |
|
名字
|
first_name | string |
名字(僅限個人)。 |
|
姓氏
|
last_name | string |
姓氏 (僅限個人)。 |
|
中間名
|
middle_name | string |
中間名(僅限個人)。 |
|
偏好名稱
|
preferred_name | string |
偏好名稱 (僅限個人)。 |
|
以前的名字
|
maiden_name | string |
以前的名稱(僅限個人)。 |
|
標題 1
|
title1 | string |
標題 1(僅限個人)。 |
|
尾碼 1
|
suffix1 | string |
尾碼 1 (僅限個人)。 |
|
性別
|
gender | string |
組成性別(僅限個人)。 |
|
天
|
birth_date.d | integer |
模糊約會中的一天。 |
|
個月
|
birth_date.m | integer |
模糊日期中的月份。 |
|
年
|
birth_date.y | integer |
模糊日期中的年份。 |
|
配偶名字
|
spouse_first_name | string |
配偶的名字(僅限個人)。 |
|
配偶姓氏
|
spouse_last_name | string |
配偶的姓氏(僅限個人)。 |
|
組織名稱
|
org_name | string |
組織名稱 (僅限組織)。 |
|
地址區塊
|
address_block | string |
位址區塊。 |
|
城市和州
|
address_city_state | string |
地址城市和州。 |
|
郵遞區號
|
address_post_code | string |
地址郵遞區號。 |
|
主要電子郵件地址
|
primary_email | string |
主要電子郵件。 |
|
主要電話號碼
|
primary_phone | string |
主要電話。 |
|
相符的別名
|
matched_alias | string |
相符的別名 (僅限個人)。 |
|
相符的電子郵件
|
matched_email | string |
相符的電子郵件地址。 |
|
匹配的手機
|
matched_phone | string |
相符的電話號碼。 |
|
是選民嗎?
|
is_constituent | boolean |
記錄是成分嗎? |
|
死了嗎?
|
is_deceased | boolean |
唱片已故嗎? |
|
不活躍嗎?
|
is_inactive | boolean |
記錄是否處於非活動狀態? |
NXTDataIntegrationApi.ConstituentSearchResultCollection
成分
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
results
|
results | array of NXTDataIntegrationApi.ConstituentSearchResult |
回應中包含的專案集。 這可能是集合中項目的子集。 |
NXTDataIntegrationApi.CreatedConstituentTribute
創建了選民貢品
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立的組成貢品的 ID。 |
NXTDataIntegrationApi.CreatedTributeAcknowledgee
創建致敬致謝
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
新建立的貢品的 ID 確認。 |
NXTDataIntegrationApi.Tribute
貢
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | integer |
貢品的系統記錄 ID。 |
|
選區 ID
|
constituent_record_id | integer |
與貢品相關聯之成分的系統記錄 ID。 |
|
貢品類型
|
tribute_type_name | string |
貢品類型。 |
|
貢品類型 ID
|
tribute_type_id | integer |
貢品類型 ID。 |
|
Description
|
description | string |
致敬描述。 |
|
天
|
start_date.d | integer |
模糊約會中的一天。 |
|
個月
|
start_date.m | integer |
模糊日期中的月份。 |
|
年
|
start_date.y | integer |
模糊日期中的年份。 |
|
天
|
end_date.d | integer |
模糊約會中的一天。 |
|
個月
|
end_date.m | integer |
模糊日期中的月份。 |
|
年
|
end_date.y | integer |
模糊日期中的年份。 |
|
預設基金編號
|
default_fund_id | integer |
與貢品相關聯之預設基金的系統記錄 ID。 |
|
註釋
|
notes | string |
致敬筆記。 |
|
活躍的?
|
is_active | boolean |
這個致敬活動活躍嗎? |
|
Sequence
|
sequence | integer |
致敬序列。 |
|
新增日期
|
date_added | date-time |
創建貢品的日期。 |
|
修改日期
|
date_modified | date-time |
最後修改貢品的日期。 |
NXTDataIntegrationApi.TributeAcknowledgee
致敬致謝
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | integer |
致敬的系統記錄識別碼會確認。 |
|
致敬 ID
|
tribute_id | integer |
與確認相關聯的貢品的系統記錄 ID。 |
|
關係識別碼
|
relationships_id | integer |
關係的系統記錄識別碼 (如果為空值,則代表自我確認)。 |
|
字母 ID
|
letter | integer |
字母 ID。 |
|
Sequence
|
sequence | integer |
致敬致謝序列。 |
NXTDataIntegrationApi.TributeAcknowledgee集合
致敬致謝
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of NXTDataIntegrationApi.TributeAcknowledgee |
回應中包含的專案集。 這可能是集合中項目的子集。 |
NXTDataIntegrationApi.TributeCollection
致敬
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。 |
|
value
|
value | array of NXTDataIntegrationApi.Tribute |
回應中包含的專案集。 這可能是集合中項目的子集。 |