共用方式為


Blackbaud Altru 成分(預覽)

Altru 是一款全面的企業級票務軟件解決方案,專為非營利組織和整個社會公益社區構建。 使用「選民」聯結器來管理選民傳記詳細資料、聯絡資訊和關係。

此連接器適用於以下產品和區域:

服務 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
Email skyapi@blackbaud.com
連接器中繼資料
Publisher 布萊克博德公司
網站 https://www.blackbaud.com/products/blackbaud-altru
隱私策略 https://www.blackbaud.com/privacy-shield
類別 銷售和客戶關係管理;生產力

Blackbaud Altru 是完整的解決方案,旨在支援有效的多通路票務、會員資格、捐贈和網路銷售。

此連接器建立在 Blackbaud 的 SKY API 之上,並提供操作來幫助管理 Blackbaud Altru 中的成分和相關實體。

如需詳細資訊,請檢視 文件

先決條件

若要使用此連接器,您必須擁有 Blackbaud ID 帳戶,才能存取一或多個 Blackbaud 環境。

此外,您組織的管理員還必須在系統內執行管理員層級動作,才能讓此連接器存取您的 Blackbaud 環境。 有關這些先決條件的詳細資訊,請參閱 初始設定 文件。

如何取得憑證?

您組織的管理員將向您發送組織 Blackbaud Altru 環境的邀請,並在環境中配置您的用戶帳戶權限。 使用此連接器不需要其他認證。

已知問題與限制

連接器將在您的使用者帳戶的內容中運作,因此將受限於您在環境中的使用者權限。

節流限制

名稱 呼叫 續約期間
每個連線的 API 呼叫 100 60 秒

動作

列出成分地址

列出選區的地址。

列出成分貢品

列出對選民的貢品。

列出成分電話

列出選民的電話。

列出構成教育

列出選民的教育程度。

列出組成屬性

列出成分的屬性。

列出組成替代查閱標識碼

列出成分的替代查閱識別碼。

列出選民工作經歷

列出選民的工作經歷。

列出選民徵集代碼

列出選民的徵求代碼。

列出選民申訴

列出傳送給選民的申訴。

列出選民電子郵件地址

列出選民的電子郵件地址。

刪除成分

刪除成分。

刪除成分互動

刪除組成互動。

刪除成分地址

刪除組成地址。

刪除成分徵求代碼

刪除成分徵求代碼。

刪除成分註釋

刪除成分附註。

刪除籌款活動選區

從選民中刪除籌款人選區。

刪除組成屬性

刪除組成屬性。

刪除組成替代查閱標識碼

刪除組成替代查閱識別碼。

刪除選區電話

刪除組成電話。

刪除選民就業記錄

刪除選民工作歷史。

刪除選民教育

刪除選區教育記錄。

刪除選民申訴

刪除選民申訴。

刪除選民電子郵件地址

刪除組成電子郵件地址。

創建選民工作經歷

創建新的選民就業歷史。

創建選民教育

創造新的組成教育。

取得個別選區

傳回個別選區的相關資訊。

取得組織選區

傳回組織組成部分的相關資訊。

取得選民摘要設定檔

傳回選件的摘要設定檔資訊。

合併兩個成分

合併兩個組成記錄。

建立個別選區

建立新的個別選區。

建立成分徵求代碼

建立新的選區徵求代碼。

建立成分附註

建立新的成分附註。

建立籌款活動選區

為選民創建一個新的籌款人選區。

建立組織組成部分

建立新的組織組成部分。

建立選區地址

建立新的組成地址。

建立選區替代查閱識別碼

建立新的組成替代查閱標識碼。

建立選區電話

建立新的組成電話。

建立選民互動

建立新的成分互動。

建立選民申訴回應

建立新的選民申訴回應。

建立選民訴求

創建新的選民訴求。

建立選民電子郵件地址

建立新的選民電子郵件地址。

搜尋選民

使用指定的篩選條件搜尋成分記錄。

更新個別選區

更新個別選區。 如果存在互惠關係,也會修改它以反映變更。 這不包括對「comments」屬性的變更,該屬性特定於每筆記錄,並且可以在每筆記錄上獨立修改。

更新成分互動

更新組成互動。

更新成分地址

更新組成地址。

更新成分附註

更新成分票據。

更新籌款活動選區

更新選民的籌款人選區。

更新組成徵求代碼

更新成分票據。

更新組成替代查閱識別碼

更新組成替代查閱標識碼。

更新組織組成部分

更新組織組成部分。

更新選區電話

更新組成的電話。

更新選民就業經歷

更新選民就業歷史。

更新選民教育

更新選民教育。

更新選民申訴

更新選民上訴。

更新選民電子郵件地址

更新選民電子郵件地址。

獲取選民主要聯繫信息

傳回選民的主要聯絡資訊。

獲取選民個人資料圖片

傳回選民的設定檔圖片。

獲得選民互動

傳回指定組成互動的詳細資料。

列出成分地址

列出選區的地址。

參數

名稱 機碼 必要 類型 Description
選區 ID
constituent_id True string

成分的系統記錄 ID。

包括前者?
include_former boolean

包括以前的地址?

傳回

Addresses

列出成分貢品

列出對選民的貢品。

參數

名稱 機碼 必要 類型 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。

傳回

Attributes

列出組成替代查閱標識碼

列出成分的替代查閱識別碼。

參數

名稱 機碼 必要 類型 Description
選區 ID
constituent_id True string

成分的系統記錄 ID。

傳回

替代查閱標識碼

列出選民工作經歷

列出選民的工作經歷。

參數

名稱 機碼 必要 類型 Description
選區 ID
constituent_id True string

成分的系統記錄 ID。

包括不活躍?
include_inactive boolean

包括非活動記錄?

傳回

工作經歷

列出選民徵集代碼

列出選民的徵求代碼。

參數

名稱 機碼 必要 類型 Description
選區 ID
constituent_id True string

成分的系統記錄 ID。

節目過期了?
show_expired boolean

顯示過期的徵求代碼?

日期範圍
date_range string

將結果篩選至指定的日期範圍。

傳回

徵求代碼

列出選民申訴

列出傳送給選民的申訴。

參數

名稱 機碼 必要 類型 Description
選區 ID
constituent_id True string

成分的系統記錄 ID。

傳回

上訴

列出選民電子郵件地址

列出選民的電子郵件地址。

參數

名稱 機碼 必要 類型 Description
選區 ID
constituent_id True string

成分的系統記錄 ID。

傳回

電子郵件地址

刪除成分

刪除成分。

參數

名稱 機碼 必要 類型 Description
選區 ID
constituent_id True string

要刪除之成分的系統記錄 ID。

刪除成分互動

刪除組成互動。

參數

名稱 機碼 必要 類型 Description
互動 ID
constituent_interaction_id True string

要刪除之組成互動的系統記錄 ID。

刪除成分地址

刪除組成地址。

參數

名稱 機碼 必要 類型 Description
組成地址 ID
constituent_address_id True string

要刪除之組成位址的系統記錄 ID。

刪除成分徵求代碼

刪除成分徵求代碼。

參數

名稱 機碼 必要 類型 Description
徵求代碼 ID
constituent_solicit_code_id True string

要刪除的組成請求代碼的系統記錄 ID。

刪除成分註釋

刪除成分附註。

參數

名稱 機碼 必要 類型 Description
成分票據 ID
constituent_note_id True string

要刪除之成分附註的系統記錄 ID。

刪除籌款活動選區

從選民中刪除籌款人選區。

參數

名稱 機碼 必要 類型 Description
選區ID
fundraiser_constituency_id True string

要刪除的籌款人選區的系統記錄 ID。

刪除組成屬性

刪除組成屬性。

參數

名稱 機碼 必要 類型 Description
組成屬性 ID
constituent_attribute_id True string

要刪除之組成屬性的系統記錄 ID。

刪除組成替代查閱標識碼

刪除組成替代查閱識別碼。

參數

名稱 機碼 必要 類型 Description
替代查閱標識碼
alternate_lookup_id True string

要刪除之組成替代查閱 ID 的系統記錄 ID。

刪除選區電話

刪除組成電話。

參數

名稱 機碼 必要 類型 Description
選區電話 ID
constituent_phone_id True string

要刪除的組成電話的系統記錄 ID。

刪除選民就業記錄

刪除選民工作歷史。

參數

名稱 機碼 必要 類型 Description
工作經歷 ID
relationship_job_info_id True string

要刪除之組成工作歷程的系統記錄 ID。

刪除選民教育

刪除選區教育記錄。

參數

名稱 機碼 必要 類型 Description
教育歷史 ID
educational_history_id True string

要刪除之教育記錄的系統記錄識別碼。

刪除選民申訴

刪除選民申訴。

參數

名稱 機碼 必要 類型 Description
選民申訴 ID
constituent_appeal_id True string

選區刪除申訴的系統記錄 ID。

刪除選民電子郵件地址

刪除組成電子郵件地址。

參數

名稱 機碼 必要 類型 Description
電子郵件地址 ID
email_address_id True string

要刪除之組成電子郵件地址的系統記錄ID。

創建選民工作經歷

創建新的選民就業歷史。

參數

名稱 機碼 必要 類型 Description
選區 ID
context_id True string

成分的系統記錄 ID。

Relationship
relationship True string

組成關係。

職稱
job_title string

職稱。 字元限制:100。

職業水平
career_level string

職業水平。

類別
job_category string

工作類別。

開始日期
start_date date

受僱開始日期(例如:「2005-09-18」)。

結束日期
end_date date

僱傭關係結束日期(例如:「2005-09-18」)。

部門
job_department string

工作部門。 字元限制:100。

除法
job_division string

工作分工。 字元限制:100。

職業水平
job_schedule string

職業水平。

責任
job_responsibility string

工作職責。 字元限制:250。

是私人的嗎?
private_record boolean

工作經歷是私人的嗎?

傳回

創建選民就業歷史

創建選民教育

創造新的組成教育。

參數

名稱 機碼 必要 類型 Description
選區 ID
constituent_id True string

成分的系統記錄 ID。

教育機構
educational_institution_id True string

教育機構。

地位
educational_history_status True string

教育狀況。

初?
primary_record boolean

這是選民的初等教育嗎?

程式
educational_program string

教育計劃。

educational_degree string

教育學位。

授予的榮譽
educational_award string

授予的榮譽。

來源
educational_source string

信息來源。

year integer

模糊日期中的年份。

month integer

模糊日期中的月份。

day integer

模糊約會中的一天。

評論
comment string

教育評論。 字元限制:500。

year integer

模糊日期中的年份。

month integer

模糊日期中的月份。

day integer

模糊約會中的一天。

類別
class_year integer

的類別。

首選類別
preferred_class_year integer

首選類別。

附屬?
affiliated boolean

教育機構是否隸屬於該組織?

year integer

模糊日期中的年份。

month integer

模糊日期中的月份。

day integer

模糊約會中的一天。

year integer

模糊日期中的年份。

month integer

模糊日期中的月份。

day integer

模糊約會中的一天。

原因
educational_history_reason string

教育歷史原因(僅適用於「未知」教育狀況)。

Level
educational_history_level string

教育經歷級別(僅適用於“正在就讀”的教育狀態)。

傳回

創建選民教育

取得個別選區

傳回個別選區的相關資訊。

參數

名稱 機碼 必要 類型 Description
選區 ID
constituent_id True string

要取得之個別成分的系統記錄 ID。

傳回

個別成分

取得組織選區

傳回組織組成部分的相關資訊。

參數

名稱 機碼 必要 類型 Description
選區 ID
constituent_id True string

要取得之組織組成部分的系統記錄 ID。

傳回

組織組成

取得選民摘要設定檔

傳回選件的摘要設定檔資訊。

參數

名稱 機碼 必要 類型 Description
選區 ID
constituent_id True string

成分的系統記錄 ID。

傳回

選民摘要概況

合併兩個成分

合併兩個組成記錄。

參數

名稱 機碼 必要 類型 Description
來源成分 ID
source_id True string

來源成分的系統記錄 ID,其資料將合併到目標成分中。

目標成分 ID
target_id True string

目標成分的系統記錄 ID,將代表合併完成後資料的合併檢視。

設定
config True string

合併組態。

刪除來源?
delete_source True boolean

合併完成後刪除來源成分?

刪除動作
delete_source_constituent True string

刪除來源成分。 可用的值為 刪除來源成分將來源成分標記為非作用中

不活動原因
constituent_inactivity_reason_code string

不活躍的原因。

閒置詳細資料
constituent_inactivity_details string

非活動細節。 字元限制:300。

傳回

合併成分

建立個別選區

建立新的個別選區。

參數

名稱 機碼 必要 類型 Description
姓氏
last_name True string

選民的姓氏。 字元限制:100。

Title
title string

選民的主要頭銜。

名字
first_name string

選民的名字。 字元限制:50。

後綴
suffix string

選區的主要後綴。

位址類型
address_type string

主要位址類型。

國家
address_country string

主要地址國家/地區。

Address
address_block string

選民的主要地址。 字元限制:150。

城市
address_city string

主要的 addres 城市。 字元限制:50。

State
address_state string

位址狀態。

郵遞區號
address_post_code string

主要地址的郵遞區號。 字元限制:12。

不發送郵件?
address_do_not_mail boolean

不寄郵件到這個地址?

請勿郵寄原因
address_do_not_mail_reason string

未傳送郵件至此位址的原因。

DPC的
address_dpc string

位址 DPC. 字元限制:8。

address_cart string

地址 CART. 字元限制:10。

address_lot string

地址 LOT。 字元限制:5。

address_county string

地址縣代碼。

國會選區
address_congressional_district string

國會選區代碼。

電話類型
phone_type string

電話類型。

電話號碼
phone_number string

電話號碼。 字元限制:100。

電子郵件類型
email_address_type string

電子郵件類型。

電子郵件地址
email_address string

電子郵件地址。 字元限制:100。

中間名
middle_name string

選民的中間名。 字元限制:50。

標題 2
title_2 string

選民的次要頭銜。

字尾 2
suffix_2 string

成分的次要後綴

暱稱
nickname string

選民的暱稱。 字元限制:50。

婚前姓氏
maiden_name string

選民的婚前姓氏。 字元限制:100。

婚姻狀態
marital_status string

婚姻狀況。

year integer

模糊日期中的年份。

month integer

模糊日期中的月份。

day integer

模糊約會中的一天。

性別
gender_code string

選民的性別。

傳回

創建個人成分

建立成分徵求代碼

建立新的選區徵求代碼。

參數

名稱 機碼 必要 類型 Description
選區 ID
constituent_id True string

成分的系統記錄 ID。

徵求代碼
solicit_code True string

徵求代碼。

開始日期
start_date date

徵求代碼開始日期(例如:「2005-09-18」)。

結束日期
end_date date

徵求代碼結束日期 (例如:「2005-09-18」)。

評論
comments string

徵求程式碼註解。 字元限制:100。

傳回

創建了成分徵集代碼

建立成分附註

建立新的成分附註。

參數

名稱 機碼 必要 類型 Description
選區 ID
constituent_id True string

成分的系統記錄 ID。

類型
note_type True string

註記類型。

Date
date_entered True date

註釋日期(例如:「2005-09-18」)。

Title
title string

附註標題。 字元限制:50。

作者編號
author_id string

附註作者的系統記錄 ID。

備註
text_note string

附註的純文字。

HTML
html_note string

附註的 html 文字。

傳回

創建成分票據

建立籌款活動選區

為選民創建一個新的籌款人選區。

參數

名稱 機碼 必要 類型 Description
選區 ID
constituent_id True string

成分的系統記錄 ID。

日期開始
date_from date

選區的開始日期(例如:「2005-09-18」)。

日期至
date_to date

選區的結束日期(例如:「2005-09-18」)。

傳回

創建籌款人選區

建立組織組成部分

建立新的組織組成部分。

參數

名稱 機碼 必要 類型 Description
名稱
name True string

組織組成者的名稱。 字元限制:100。

工業
industry string

行業代碼。

否。 員工人數
num_employees integer

員工人數。

否。 附屬組織
num_subsidiaries integer

子組織數目。

上層組織
parent_corp_id string

母公司的系統記錄 ID。

位址類型
address_type string

位址類型。

國家
address_country string

地址國家/地區。

Address
address_block string

位址區塊。 字元限制:150。

城市
address_city string

地址所在的城市。 字元限制:50。

State
address_state string

位址狀態。

郵遞區號
address_postcode string

地址的郵遞區號。 字元限制:12。

不發送郵件?
address_do_not_mail boolean

不寄郵件到這個地址?

請勿郵寄原因
address_do_not_mail_reason string

未傳送郵件至此位址的原因。

DPC的
dpc string

位址 DPC. 字元限制:8。

cart string

地址 CART. 字元限制:10。

lot string

地址 LOT。 字元限制:5。

county string

地址縣代碼。

國會選區
congressional_district string

國會選區代碼。

電話類型
phone_type string

電話類型。

電話號碼
phone_number string

電話號碼。 字元限制:100。

電子郵件類型
email_address_type string

電子郵件類型。

電子郵件地址
email_address string

電子郵件地址。 字元限制:100。

網址
web_address string

網站。 字元限制:100

是主要組織嗎?
is_primary boolean

這是主要組織嗎?

資訊來源
info_source string

信息來源。

設定檔圖片
picture string

選民的個人資料圖片。

設定檔縮圖
picture_thumbnail string

選民的個人資料圖片縮略圖。

傳回

已建立的組織組成

建立選區地址

建立新的組成地址。

參數

名稱 機碼 必要 類型 Description
選區 ID
constituent_id True string

成分的系統記錄 ID。

國家
country True string

地址國家/地區。

類型
address_type string

位址類型。

Address
address_block string

位址區塊。 字元限制:150。

城市
city string

地址城市。 字元限制:50。

State
state string

位址狀態。

郵遞區號
postcode string

地址 potal 代碼。 字元限制:12。

初?
primary boolean

這是選民的主要地址嗎?

不郵寄?
do_not_mail boolean

不聯繫此地址的選民?

請勿郵寄原因
do_not_mail_reason string

未聯繫該地址選民的原因。

是保密的嗎?
confidential boolean

這個地址保密嗎?

month integer

月份。

day integer

當天。

month integer

月份。

day integer

當天。

歷史開始日期
historical_start_date date

歷史開始日期 (例如:「2005-09-18」)。

county string

地址縣。

區域
region string

位址區域。

DPC的
dpc string

地址遞送點代碼。 字元限制:8。

cart string

地址承運人路由。 字元限制:10。

lot string

地址地段。 字元限制:5。

國會選區
congressional_district string

地址國會選區。

州議會大廈區
state_house_district string

地址 州議會選區。

州參議院選區
state_senate_district string

地址:州參議院選區。

地方轄區
local_precinct string

地址 當地選區。

Origin
origin string

位址來源。

資訊來源
info_source string

位址的資訊來源。

信息來源評論
info_source_comments string

信息來源評論。 字元限制:256。

最近搬家了?
recent_move boolean

最近從這個地址移動/更改?

舊地址
old_address string

舊地址。

從驗證中省略?
omit_from_validation boolean

從驗證中省略此位址?

複製給配偶?
update_matching_spouse_addresses boolean

將地址資料複製給配偶(只適用於個別選民)?

複製到家庭?
update_matching_household_addresses boolean

將住址資料複製給住戶成員(只適用於個別選民)?

傳回

已建立的成分地址

建立選區替代查閱識別碼

建立新的組成替代查閱標識碼。

參數

名稱 機碼 必要 類型 Description
選區 ID
constituent_id True string

成分的系統記錄 ID。

類型
alternate_lookup_id_type True string

替代查閱識別碼類型。

替代查閱標識碼
alternate_lookup_id True string

替代查閱 ID。 字元限制:100。

傳回

已建立選區替代查閱標識碼

建立選區電話

建立新的組成電話。

參數

名稱 機碼 必要 類型 Description
選區 ID
constituent_id True string

成分的系統記錄 ID。

類型
phone_type string

電話類型。

Number
number True string

電話號碼。 字元限制:100。

國家
country string

電話國家。

小時
hour integer

小時。

分鐘
minute integer

分鐘。

小時
hour integer

小時。

分鐘
minute integer

分鐘。

開始日期
start_date date

電話開始日期 (例如:「2005-09-18」)。

初?
primary boolean

這是選民的主要電話嗎?

不打電話?
do_not_call boolean

不聯繫這個號碼的選民?

不叫理由
do_not_call_reason string

沒有聯繫該號碼選民的原因。

不發短信?
donottext boolean

不透過簡訊聯絡選民?

是保密的嗎?
confidential boolean

這個電話號碼保密嗎?

month integer

月份。

day integer

當天。

month integer

月份。

day integer

當天。

Origin
origin string

電話來源。

資訊來源
info_source string

電話號碼的資訊來源。

信息來源評論
info_source_comments string

信息來源評論。 字元限制:256。

複製給配偶?
update_matching_spouse_phone boolean

將電話資料複製給配偶(只適用於個別選民)?

複製到家庭?
update_matching_household_phone boolean

將電話資料複製給住戶成員(只適用於個別選民)?

傳回

創建選民電話

建立選民互動

建立新的成分互動。

參數

名稱 機碼 必要 類型 Description
選區 ID
constituent_id True string

成分的系統記錄 ID。

總結
objective True string

互動摘要。 字元限制:100。

地位
status True string

互動狀態。

類別
interaction_category string

互動類別。

子類別
interaction_subcategory string

互動子類別。

預計日期
expected_date True date

預期互動日期 (例如:「2005-09-18」)。

小時
hour integer

小時。

分鐘
minute integer

分鐘。

小時
hour integer

小時。

分鐘
minute integer

分鐘。

實際日期
actual_date date

互動實際日期 (例如:「2005-09-18」)。

小時
hour integer

小時。

分鐘
minute integer

分鐘。

小時
hour integer

小時。

分鐘
minute integer

分鐘。

時區
time_zone_entry string

互動時區。

全天活動?
is_all_day_event boolean

互動是全天活動嗎?

負責人識別碼
fundraiser_id string

擁有互動之籌款活動的系統記錄 ID。

聯絡方式
interaction_type True string

互動聯絡方式。

事件識別碼
event_id string

互動事件的系統記錄 ID。

評論
comment string

互動註解。

持續識別碼
constituent_id True string

參與成分的系統記錄 ID。

傳回

創建的成分互動

建立選民申訴回應

建立新的選民申訴回應。

參數

名稱 機碼 必要 類型 Description
選民申訴 ID
constituent_appeal_id True string

組成申訴的系統記錄 ID。

類別
response_category True string

回應類別。

回應
response True string

回應。

Date
date date

回應日期 (例如:「2005-09-18」)。

傳回

創建了選民上訴回應

建立選民訴求

創建新的選民訴求。

參數

名稱 機碼 必要 類型 Description
選區 ID
constituent_id True string

成分的系統記錄 ID。

申訴 ID
appeal_id True string

申訴的系統記錄 ID。

郵寄
mkt_segmentation string

與上訴相關的郵件。

發送日期
date_sent date

傳送日期 (例如:「2005-09-18」)。

Package
mkt_package_id string

套件的系統記錄 ID。

原始程式碼
source_code string

原始程式碼。 字元限制:50。

評論
comments string

選民上訴評論。 字元限制:255。

傳回

創建了選民上訴

建立選民電子郵件地址

建立新的選民電子郵件地址。

參數

名稱 機碼 必要 類型 Description
選區 ID
constituent_id True string

成分的系統記錄 ID。

類型
email_address_type string

電子郵件地址類型。

電子郵件地址
email_address True string

電子郵件地址。 字元限制:100。

開始日期
start_date date

電子郵件地址開始日期 (例如:「2005-09-18」)。

初?
primary boolean

這是選民的主要電子郵件地址嗎?

不發電子郵件?
do_not_email boolean

請勿透過此電郵地址聯絡選民?

Origin
origin string

電子郵件地址來源。

資訊來源
info_source string

電子郵件地址的資訊來源。

信息來源評論
info_source_comments string

信息來源評論。 字元限制:256。

複製給配偶?
update_matching_spouse_email_address boolean

將電郵地址資料複製給配偶(只適用於個別選民)?

複製到家庭?
update_matching_household_email_address boolean

將電郵地址資料複製給住戶成員(只適用於個別選民)?

傳回

創建的選民電子郵件地址

搜尋選民

使用指定的篩選條件搜尋成分記錄。

參數

名稱 機碼 必要 類型 Description
鍵名稱
key_name string

組成索引鍵名稱 (個人的姓氏、組織的組織名稱)。

名字
first_name string

組成名字。

查詢標識碼
lookup_id string

成分查閱 ID。

電子郵件地址
email_address string

選民電子郵件地址。

電話號碼
phone_number string

組成電話號碼。

國家
country string

組成地址國家/地區的篩選器。

Address
address_block string

組成位址區塊的篩選器。

城市
city string

組成地址城市的篩選器。

State
state string

組成位址狀態的篩選器。

郵遞區號
post_code string

組成地址郵遞區號的篩選器。

類別
classof integer

選民小學班級的篩選器。

完全匹配?
exact_match_only boolean

完全符合所有標準?

中間名
middle_name string

組成中間名。

選區
constituency string

選民選區的過濾器。

原始程式碼
sourcecode string

選民申訴原始碼的篩選器。

包括個人?
include_individuals boolean

包括個人選民?

包括組織?
include_organizations boolean

包括組織成分?

包括團體?
include_groups boolean

搜索時包含組?

排除家庭?
exclude_households boolean

搜尋時排除住戶?

檢查暱稱?
check_nickname boolean

搜索時查看暱稱?

檢查別名?
check_aliases boolean

搜尋時檢查別名?

檢查替代查找 ID?
check_alternate_lookup_ids boolean

搜尋時檢查替代查詢 ID?

只有主要的?
only_primary_address boolean

只搜尋主要地址?

包括死者?
include_deceased boolean

包括已故的選民?

包括不活躍?
include_inactive boolean

包括不活躍的成分?

使用模糊搜尋?
fuzzy_search_on_name boolean

對名稱使用模糊搜索?

限制
limit integer

代表要傳回的記錄數目。

傳回

搜尋結果

更新個別選區

更新個別選區。 如果存在互惠關係,也會修改它以反映變更。 這不包括對「comments」屬性的變更,該屬性特定於每筆記錄,並且可以在每筆記錄上獨立修改。

參數

名稱 機碼 必要 類型 Description
選區 ID
constituent_id True string

要更新之個人的系統記錄 ID。

姓氏
last_name string

選民的姓氏。 字元限制:100。

Title
title string

選民的主要頭銜。

名字
first_name string

選民的名字。 字元限制:50。

後綴
suffix string

選區的主要後綴。

中間名
middle_name string

選民的中間名。 字元限制:50。

標題 2
title_2 string

選民的次要頭銜。

字尾 2
suffix_2 string

成分的次要後綴

暱稱
nickname string

選民的暱稱。 字元限制:50。

婚前姓氏
maiden_name string

選民的婚前姓氏。 字元限制:100。

婚姻狀態
marital_status string

婚姻狀況。

year integer

模糊日期中的年份。

month integer

模糊日期中的月份。

day integer

模糊約會中的一天。

性別
gender_code string

選民的性別。

網站
web_address string

選民的網站。

匿名捐贈?
gives_anonymously boolean

選民是否匿名捐款?

死了?
deceased boolean

組成人已故嗎?

設定檔圖片
picture string

選民的個人資料圖片。

設定檔縮圖
picture_thumbnail string

選民的個人資料圖片縮略圖。

更新成分互動

更新組成互動。

參數

名稱 機碼 必要 類型 Description
互動 ID
constituent_interaction_id True string

要刪除之組成互動的系統記錄 ID。

總結
objective string

互動摘要。 字元限制:100。

地位
status string

互動狀態。

類別
interaction_category string

互動類別。

子類別
interaction_subcategory string

互動子類別。

預計日期
expected_date date

預期互動日期 (例如:「2005-09-18」)。

小時
hour integer

小時。

分鐘
minute integer

分鐘。

小時
hour integer

小時。

分鐘
minute integer

分鐘。

實際日期
actual_date date

互動實際日期 (例如:「2005-09-18」)。

小時
hour integer

小時。

分鐘
minute integer

分鐘。

小時
hour integer

小時。

分鐘
minute integer

分鐘。

時區
time_zone_entry string

互動時區。

全天活動?
all_day_event boolean

互動是全天活動嗎?

負責人識別碼
fundraiser_id string

擁有互動之籌款活動的系統記錄 ID。

聯絡方式
interaction_type string

互動聯絡方式。

事件識別碼
event_id string

互動事件的系統記錄 ID。

評論
comment string

互動註解。

ID
id string

互動參與者的系統記錄 ID。

組成 ID
constituent_id True string

參與成分的系統記錄 ID。

更新成分地址

更新組成地址。

參數

名稱 機碼 必要 類型 Description
組成地址 ID
constituent_address_id True string

要更新之組成地址的系統記錄 ID。

國家
country string

地址國家/地區。

類型
address_type string

位址類型。

Address
address_block string

位址區塊。 字元限制:150。

城市
city string

地址城市。 字元限制:50。

State
state string

位址狀態。

郵遞區號
postcode string

地址 potal 代碼。 字元限制:12。

初?
primary boolean

這是選民的主要地址嗎?

不郵寄?
do_not_mail boolean

不聯繫此地址的選民?

請勿郵寄原因
do_not_mail_reason string

未聯繫該地址選民的原因。

是保密的嗎?
confidential boolean

這個地址保密嗎?

month integer

月份。

day integer

當天。

month integer

月份。

day integer

當天。

歷史開始日期
historical_start_date date

歷史開始日期 (例如:「2005-09-18」)。

歷史結束日期
historical_end_date date

歷史結束日期 (例如:「2005-09-18」)。

county string

地址縣。

區域
region string

位址區域。

DPC的
dpc string

地址遞送點代碼。 字元限制:8。

cart string

地址承運人路由。 字元限制:10。

lot string

地址地段。 字元限制:5。

國會選區
congressional_district string

地址國會選區。

州議會大廈區
state_house_district string

地址 州議會選區。

州參議院選區
state_senate_district string

地址:州參議院選區。

地方轄區
local_precinct string

地址 當地選區。

資訊來源
info_source string

位址的資訊來源。

信息來源評論
info_source_comments string

信息來源評論。 字元限制:256。

從驗證中省略?
omit_from_validation boolean

從驗證中省略此位址?

更新聯絡人?
update_contacts boolean

更新使用此地址的聯絡人?

複製到家庭?
update_matching_household_addresses boolean

將地址資訊複製給家庭成員?

更新成分附註

更新成分票據。

參數

名稱 機碼 必要 類型 Description
成分票據 ID
constituent_note_id True string

要更新之成分附註的系統記錄 ID。

類型
note_type string

註記類型。

Date
date_entered date

註釋日期(例如:「2005-09-18」)。

Title
title string

附註標題。 字元限制:50。

作者編號
author_id string

附註作者的系統記錄 ID。

備註
text_note string

附註的純文字。

HTML
html_note string

附註的 html 文字。

更新籌款活動選區

更新選民的籌款人選區。

參數

名稱 機碼 必要 類型 Description
選區ID
fundraiser_constituency_id True string

要更新的籌款人選區的系統記錄 ID。

日期開始
date_from date

選區的開始日期(例如:「2005-09-18」)。

日期至
date_to date

選區的結束日期(例如:「2005-09-18」)。

更新組成徵求代碼

更新成分票據。

參數

名稱 機碼 必要 類型 Description
徵求代碼 ID
constituent_solicit_code_id True string

要更新的組成徵用代碼的系統記錄 ID。

徵求代碼
solicit_code string

徵求代碼。

開始日期
start_date date

徵求代碼開始日期(例如:「2005-09-18」)。

結束日期
end_date date

徵求代碼結束日期 (例如:「2005-09-18」)。

評論
comments string

徵求程式碼註解。 字元限制:100。

更新組成替代查閱識別碼

更新組成替代查閱標識碼。

參數

名稱 機碼 必要 類型 Description
替代查閱標識碼
alternate_lookup_id True string

要更新之組成替代查閱 ID 的系統記錄 ID。

類型
alternate_lookup_id_type string

替代查閱識別碼類型。

替代查閱標識碼
alternate_lookup_id string

替代查閱 ID。 字元限制:100。

更新組織組成部分

更新組織組成部分。

參數

名稱 機碼 必要 類型 Description
選區 ID
constituent_id True string

要更新之組織組成部分的系統記錄 ID。

名稱
organization_name string

組織組成者的名稱。 字元限制:100。

工業
industry string

行業代碼。

否。 員工人數
num_employees integer

員工人數。

否。 附屬組織
num_subsidiaries integer

子組織數目。

上層組織
parent_corp_id string

母公司的系統記錄 ID。

網址
web_address string

網站。 字元限制:100

是主要組織嗎?
is_primary boolean

這是主要組織嗎?

設定檔圖片
picture string

選民的個人資料圖片。

設定檔縮圖
picture_thumbnail string

選民的個人資料圖片縮略圖。

更新選區電話

更新組成的電話。

參數

名稱 機碼 必要 類型 Description
選區電話 ID
constituent_phone_id True string

要更新的組成電話的系統記錄ID。

類型
phone_type string

電話類型。

Number
number string

電話號碼。 字元限制:100。

國家
country string

電話國家。

小時
hour integer

小時。

分鐘
minute integer

分鐘。

小時
hour integer

小時。

分鐘
minute integer

分鐘。

開始日期
start_date date

電話開始日期 (例如:「2005-09-18」)。

結束日期
end_date date

電話結束日期 (例如:「2005-09-18」)。

初?
primary boolean

這是選民的主要電話嗎?

不打電話?
do_not_call boolean

不聯繫這個號碼的選民?

不叫理由
do_not_call_reason string

沒有聯繫該號碼選民的原因。

不發短信?
donottext boolean

不透過簡訊聯絡選民?

是保密的嗎?
confidential boolean

這個電話號碼保密嗎?

month integer

月份。

day integer

當天。

month integer

月份。

day integer

當天。

資訊來源
info_source string

電話號碼的資訊來源。

信息來源評論
info_source_comments string

信息來源評論。 字元限制:256。

複製給配偶?
update_matching_spouse_phone boolean

將電話資料複製給配偶(只適用於個別選民)?

複製到家庭?
update_matching_household_phone boolean

將電話資料複製給住戶成員(只適用於個別選民)?

更新選民就業經歷

更新選民就業歷史。

參數

名稱 機碼 必要 類型 Description
工作經歷 ID
relationship_job_info_id True string

要刪除之組成工作歷程的系統記錄 ID。

職稱
job_title string

職稱。 字元限制:100。

職業水平
career_level string

職業水平。

類別
job_category string

工作類別。

開始日期
start_date date

受僱開始日期(例如:「2005-09-18」)。

結束日期
end_date date

僱傭關係結束日期(例如:「2005-09-18」)。

部門
job_department string

工作部門。 字元限制:100。

除法
job_division string

工作分工。 字元限制:100。

職業水平
job_schedule string

職業水平。

責任
job_responsibility string

工作職責。 字元限制:250。

是私人的嗎?
private_record boolean

工作經歷是私人的嗎?

更新選民教育

更新選民教育。

參數

名稱 機碼 必要 類型 Description
教育歷史 ID
educational_history_id True string

要更新的組成教育的系統記錄 ID。

教育機構
educational_institution_id string

教育機構。

地位
educational_history_status string

教育狀況。

初?
primary_record boolean

這是選民的初等教育嗎?

程式
educational_program string

教育計劃。

educational_degree string

教育學位。

授予的榮譽
educational_award string

授予的榮譽。

來源
educational_source string

信息來源。

year integer

模糊日期中的年份。

month integer

模糊日期中的月份。

day integer

模糊約會中的一天。

評論
comment string

教育評論。 字元限制:500。

year integer

模糊日期中的年份。

month integer

模糊日期中的月份。

day integer

模糊約會中的一天。

類別
class_year integer

的類別。

首選類別
preferred_class_year integer

首選類別。

附屬?
affiliated boolean

教育機構是否隸屬於該組織?

year integer

模糊日期中的年份。

month integer

模糊日期中的月份。

day integer

模糊約會中的一天。

year integer

模糊日期中的年份。

month integer

模糊日期中的月份。

day integer

模糊約會中的一天。

原因
educational_history_reason string

教育歷史原因(僅適用於「未知」教育狀況)。

Level
educational_history_level string

教育經歷級別(僅適用於“正在就讀”的教育狀態)。

更新選民申訴

更新選民上訴。

參數

名稱 機碼 必要 類型 Description
選民申訴 ID
constituent_appeal_id True string

組成項目申訴更新的系統記錄 ID。

申訴 ID
appeal_id string

申訴的系統記錄 ID。

郵寄
mkt_segmentation string

與上訴相關的郵件。

發送日期
date_sent date

傳送日期 (例如:「2005-09-18」)。

Package
mkt_package_id string

套件的系統記錄 ID。

原始程式碼
source_code string

原始程式碼。 字元限制:50。

評論
comments string

選民上訴評論。 字元限制:255。

更新選民電子郵件地址

更新選民電子郵件地址。

參數

名稱 機碼 必要 類型 Description
電子郵件地址 ID
email_address_id True string

要更新之組成電子郵件地址的系統記錄 ID。

類型
email_address_type string

電子郵件地址類型。

電子郵件地址
email_address string

電子郵件地址。 字元限制:100。

開始日期
start_date date

電子郵件地址開始日期 (例如:「2005-09-18」)。

結束日期
end_date date

電子郵件地址結束日期 (例如:「2005-09-18」)。

初?
primary boolean

這是選民的主要電子郵件地址嗎?

不發電子郵件?
do_not_email boolean

請勿透過此電郵地址聯絡選民?

資訊來源
info_source string

電子郵件地址的資訊來源。

信息來源評論
info_source_comments string

信息來源評論。 字元限制:256。

複製給配偶?
update_matching_spouse_email_address boolean

將電郵地址資料複製給配偶(只適用於個別選民)?

複製到家庭?
update_matching_household_email_address boolean

將電郵地址資料複製給住戶成員(只適用於個別選民)?

獲取選民主要聯繫信息

傳回選民的主要聯絡資訊。

參數

名稱 機碼 必要 類型 Description
選區 ID
constituent_id True string

成分的系統記錄 ID。

傳回

選民主要聯絡資訊

獲取選民個人資料圖片

傳回選民的設定檔圖片。

參數

名稱 機碼 必要 類型 Description
選區 ID
constituent_id True string

成分的系統記錄 ID。

傳回

選民主要聯絡資訊

獲得選民互動

傳回指定組成互動的詳細資料。

參數

名稱 機碼 必要 類型 Description
互動 ID
constituent_interaction_id True string

要取得之組成互動的系統記錄 ID。

傳回

互動

定義

Conmg.地址

Address

名稱 路徑 類型 Description
ID
id string

位址的系統記錄 ID。

類型
type string

地址類型。

Address
contact_info string

位址。

是主要的嗎?
primary string

這是選民的主要地址嗎?

是保密的嗎?
confidential boolean

地址保密嗎?

是前者嗎?
former boolean

地址是以前的地址嗎?

不聯繫?
do_not_contact string

不聯繫此地址的選民?

開始日期
start_date date-time

地址開始日期。

結束日期
end_date date

地址結束日期。

地理編碼?
geocoded boolean

地址是否經過地理編碼?

待處理的地理編碼?
pending_geocode boolean

地址是否正在等待地理編碼?

地理編碼無效?
invalid_geocode boolean

地址地理編碼是否無效?

對應環境定義 ID
map_context_id string

位址對應環境定義 ID

Conmg.Address集合

Addresses

名稱 路徑 類型 Description
Count
count integer

套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。

value
value array of Conmg.Address

回應中包含的專案集。 這可能是集合中項目的子集。

Conmg.AlternateLookupID

替代查閱標識碼

名稱 路徑 類型 Description
ID
id string

替代查閱 ID 的系統記錄 ID。

類型
type string

替代查閱標識碼的類型。

替代查閱標識碼
alternate_lookup_id string

替代查閱 ID。

Conmg.AlternateLookupIDCollection

替代查閱標識碼

名稱 路徑 類型 Description
Count
count integer

套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。

value
value array of Conmg.AlternateLookupID

回應中包含的專案集。 這可能是集合中項目的子集。

Conmg.屬性

Attribute

名稱 路徑 類型 Description
ID
id string

屬性的系統記錄 ID。

類別
category string

屬性類別。

類別標識碼
attribute_category_id string

屬性種類的系統記錄 ID。

群體
attribute_group string

屬性群組。

價值觀
value string

屬性值。

開始日期
start_date date-time

屬性開始日期。

結束日期
end_date date-time

屬性結束日期。

評論
comment string

屬性註解。

Conmg.AttributeCollection

Attributes

名稱 路徑 類型 Description
Count
count integer

套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。

value
value array of Conmg.Attribute

回應中包含的專案集。 這可能是集合中項目的子集。

Conmg.ConstituentAppeal

Appeal

名稱 路徑 類型 Description
ID
id string

組成申訴的系統記錄 ID。

申訴 ID
appeal_id string

申訴的系統記錄 ID。

申訴名稱
appeal string

申訴名稱。

申訴說明
description string

上訴描述。

郵寄編號
mkt_segmentation_id string

郵件的系統記錄 ID。

郵寄姓名
mailing string

郵寄名稱。

郵寄家庭類型代碼
mailing_family_type_code integer

郵寄族群類型代碼。

發送日期
date_sent date-time

發送的日期。

封裝名稱
package string

套件名稱。

原始程式碼
source_code string

原始程式碼。

區段識別碼
mkt_segmentation_segment_id string

郵件區段的系統記錄 ID。

區段
segment string

郵寄區段。

查找器編號
finder_number integer

發現者編號。

測試區段
test_segment string

測試區段。

letter string

選民上訴郵寄信。

評論
comments string

選民上訴評論。

有回應嗎?
has_responses boolean

這個呼籲有回應嗎?

申訴郵寄?
appeal_mailing boolean

這是上訴郵件嗎?

時間範圍
time_frame_text string

選民上訴時間範圍。

時間範圍群組排序
time_frame_group_sort string

時間範圍群組排序順序。

Conmg.ConstituentAppealCollection

上訴

名稱 路徑 類型 Description
Count
count integer

套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。

value
value array of Conmg.ConstituentAppeal

回應中包含的專案集。 這可能是集合中項目的子集。

Conmg.ConstituentInteraction參與者

代表組成互動參與者的物件。

名稱 路徑 類型 Description
ID
id string

互動參與者的系統記錄 ID。

組成 ID
constituent_id string

參與成分的系統記錄 ID。

Conmg.ConstituentInteraction

互動

名稱 路徑 類型 Description
選區 ID
constituent_id string

成分的系統記錄 ID。

組成名稱
constituent_name string

組成名稱。

總結
objective string

互動摘要。

地位
status string

互動狀態。

類別
interaction_category string

互動類別。

子類別
interaction_subcategory string

互動子類別。

預計日期
expected_date date-time

預期的互動日期。

小時
expected_start_time.hour integer

小時。

分鐘
expected_start_time.minute integer

分鐘。

小時
expected_end_time.hour integer

小時。

分鐘
expected_end_time.minute integer

分鐘。

實際日期
actual_date date-time

互動實際日期。

小時
actual_start_time.hour integer

小時。

分鐘
actual_start_time.minute integer

分鐘。

小時
actual_end_time.hour integer

小時。

分鐘
actual_end_time.minute integer

分鐘。

時區
time_zone_entry string

互動時區。

全天活動?
all_day_event boolean

互動是全天活動嗎?

負責人識別碼
fundraiser_id string

擁有互動之籌款活動的系統記錄 ID。

聯絡方式
interaction_type string

互動聯絡方式。

事件識別碼
event_id string

互動事件的系統記錄 ID。

評論
comment string

互動註解。

Participants
participants array of Conmg.ConstituentInteractionParticipant

互動參與者。

Conmg.ConstituentPrimaryContactInfo

選民主要聯絡資訊

名稱 路徑 類型 Description
位址類型
address_type_label string

主要位址類型。

地址類型 ID
address_type_id string

主要位址類型的系統記錄 ID。

主要地址國家/地區 ID
country_id string

主要地址國家/地區的系統記錄 ID。

主要地址
address string

主要位址。

主要地址城市
city string

主要地址城市。

主要位址狀態識別碼
state_id string

主要位址狀態的系統記錄 ID。

主要地址郵遞區號
post_code string

主要地址郵遞區號。

地址保密嗎?
confidential boolean

地址保密嗎?

不郵寄?
do_not_mail boolean

不聯繫此地址的選民?

請勿郵寄原因 ID
do_not_mail_reason_code_id string

系統記錄未聯絡此地址選民的原因 ID。

主要電話類型
phone_type_label string

主要電話類型。

主要電話類型 ID
phone_type_id string

主要電話類型的系統記錄識別碼。

主要電話號碼
phone string

主要電話號碼。

電話保密嗎?
phone_is_confidential boolean

電話號碼保密嗎?

不打電話?
do_not_call boolean

不聯繫這個號碼的選民?

請勿呼叫原因ID
do_not_call_reason_code_id string

系統記錄未聯絡此號碼選民的原因 ID。

主要電子郵件地址類型
email_type_label string

主要電子郵件地址類型。

主要電子郵件地址類型 ID
email_type_id string

主要電子郵件地址類型的系統記錄 ID。

主要電子郵件地址
email string

主要電子郵件地址。

不發電子郵件?
do_not_email boolean

請勿透過此電郵地址聯絡選民?

網站
web_address string

選民的網站。

Conmg.ConstituentProfile圖片

選民主要聯絡資訊

名稱 路徑 類型 Description
圖片
picture string

相關的個人資料圖片。

Title
title string

選民的主要頭銜。

名字
first_name string

選民的名字。

鍵名稱
key_name string

成分的索引鍵名稱。

後綴
suffix string

選區的主要後綴。

中間名
middle_name string

選民的中間名。

暱稱
nick_name string

選民的暱稱。

婚前姓氏
maiden_name string

選民的婚前姓氏。

匿名捐贈?
gives_anonymously boolean

選民是否匿名捐款?

Conmg.ConstituentSearchResult

搜尋結果

名稱 路徑 類型 Description
ID
id string

成分的系統記錄 ID。

名稱
name string

組成名稱。 對於個人,此計算欄位會根據目標組織的顯示名稱設定,指出選件的完整名稱。

中間名
middle_name string

選民的中間名。

尾碼 ID
suffixcodeid string

成分字尾的系統記錄 ID。

查詢標識碼
lookup_id string

成分的使用者定義 ID。

排序名稱
sort_constituent_name string

組成排序名稱。

國家/地區 ID
country_id string

成分主要地址國家/地區的系統記錄 ID。

Address
address string

選民的首選地址。

城市
city string

選民的首選地址城市。

State
state string

選民的首選地址狀態。

郵遞區號
post_code string

選民的首選地址郵遞區號。

電話
phone string

選民的電話。

電子郵件地址
email_address string

選民的電子郵件地址。

類別
classof integer

選民的小學班級。

匿名捐贈?
gives_anonymously boolean

選民是否匿名捐款?

是組織嗎?
organization boolean

組成部分是組織嗎?

是團體嗎?
group boolean

選民是一個群體嗎?

是家庭嗎?
household boolean

選民是家庭嗎?

潛在客戶經理
prospectmanager string

選民的潛在客戶經理

Conmg.ConstituentSearchResultCollection

搜尋結果

名稱 路徑 類型 Description
Count
count integer

套用任何要求參數之後,可擷取到集合中的項目數目。

value
value array of Conmg.ConstituentSearchResult

回應中包含的專案集。 這可能是集合中項目的子集。

Conmg.ConstituentSummary簡介

選民摘要概況

名稱 路徑 類型 Description
名稱
name string

組成名稱。

查詢標識碼
lookup_id string

成分查閱 ID。

是選民檔案嗎?
constituent_profile boolean

是選民檔案嗎?

是組織嗎?
organization boolean

組成部分是組織嗎?

上級組織
top_parent string

上層組織。

上層組織識別碼
top_parent_id string

父組織的系統記錄 ID。

是團體嗎?
group boolean

選民是一個群體嗎?

集團解散了嗎?
dissolved boolean

該團體解散了嗎?

群組類型
group_type string

群組類型。

群組成員人數
group_member_count integer

群組成員的數目。

是委員會成員嗎?
committee_member boolean

是委員會成員嗎?

是家庭嗎?
household boolean

選民是家庭嗎?

家庭 ID
household_id string

家庭的系統記錄 ID。

家庭文本
household_text string

家喻戶曉的文本。

不活躍嗎?
inactive boolean

成分是否不活躍?

閒置原因
constituent_inactivity_reason string

共存的不活動原因。

死了嗎?
deceased boolean

組成人已故嗎?

deceaseddate.year integer

模糊日期中的年份。

deceaseddate.month integer

模糊日期中的月份。

deceaseddate.day integer

模糊約會中的一天。

配偶已故嗎?
spouse_deceased boolean

配偶已故嗎?

匿名捐贈?
gives_anonymously boolean

選民是否匿名捐款?

存檔聲明?
declarations_on_file boolean

選民有存檔聲明嗎?

WealthPoint 更新待定?
wealthpoint_update_pending boolean

WealthPoint 更新是否待處理?

設定檔圖片
picture string

選民的個人資料圖片。

主要業務
primary_business string

選民的主要業務。

主要企業編號
primary_business_id string

主要企業的系統記錄 ID。

小學教育
primary_education string

選民的初等教育。

小學教育 ID
primary_education_id string

初等教育的系統記錄 ID。

教育屬性的定義?
education_attribute_defined boolean

選民是否定義了教育屬性?

相關成分股
related_constituent string

相關成分。

相關成分 ID
related_constituent_id string

相關成分的系統記錄 ID。

徵求代碼計數
solicit_code_count integer

徵求代碼的數量。

主要位址識別碼
address_id string

主要位址的系統記錄 ID。

主要地址
address string

主要位址。

地址保密嗎?
address_is_confidential boolean

地址保密嗎?

不郵寄?
do_not_mail boolean

不聯繫此地址的選民?

主要電話 ID
phone_number_id string

主要電話的系統記錄 ID。

主要電話類型
phone_type string

主要電話類型。

主要電話號碼
phone_number string

主要電話號碼。

電話保密嗎?
phone_is_confidential boolean

電話號碼保密嗎?

不打電話?
do_not_phone boolean

不聯繫這個號碼的選民?

主要電子郵件地址 ID
email_address_id string

主要電子郵件地址的系統記錄 ID。

主要電子郵件地址
email_address string

主要電子郵件地址。

不發電子郵件?
do_not_email boolean

請勿透過此電郵地址聯絡選民?

網站
web_address string

選民的網站。

註冊人狀態文字
registrant_status_text string

註冊人狀態文字。

廠商狀態文字
vendor_status_text string

廠商狀態文字。

校友狀態文本
alumnus_status_text string

校友狀態文本。

校友註冊 ID
alumnus_enrollment_id string

校友註冊 ID。

目前的註冊標識碼
current_enrollment_id string

目前的註冊標識碼。

目前註冊標識碼 2
current_enrollment_id_2 string

目前的註冊標識碼 2.

目前註冊標識碼 3
current_enrollment_id_3 string

目前的註冊標識碼 3.

學生註冊 ID
student_enrollment_id string

學生註冊 ID。

在校
current_school string

現在的學校。

在校2
current_school_2 string

現在的學校 2.

現校3
current_school_3 string

現在的學校 3.

生命週期階段
lifecycle_stage string

捐贈者生命週期階段。

生命週期階段
lifecycle_stage_as_of date-time

捐贈者生命週期階段 as-of 日期。

計劃的給予者階段
planned_giver_stage string

計劃的給予者階段。

計劃的給予者階段截至
planned_giver_stage_as_of date-time

計劃的給予者階段 as-of 日期。

捐贈國
donor_state string

捐贈國。

捐贈者州代碼
donor_state_code integer

捐贈者州代碼。

贊助商類型代碼
sponsor_type_code integer

贊助者類型代碼。

最後收入日期
last_revenue_date date-time

最後收入日期。

校友選區正文
alumnus_constituency_text string

校友選區文本。

倡導者選區文本
advocate_constituency_text string

倡導者選區文本。

銀行選區文本
bank_constituency_text string

銀行選區文本。

董事會成員選區文本
board_member_constituency_text string

董事會成員選區文本。

委員會選區文本
committee_constituency_text string

委員會選區文本。

委員選區正文
committee_member_constituency_text string

委員會成員選區文本。

社區成員選區文本
community_member_constituency_text string

社區成員選區文本。

捐助者選區文本
donor_constituency_text string

捐助者選區文本。

教職員工選區文本
faculty_constituency_text string

教職員工選區文本。

籌款選區文本
fundraiser_constituency_text string

籌款人選區文本。

籌款團體選區正文
fundraising_group_constituency_text string

籌款團體選區文本。

授予人選區文本
grantor_constituency_text string

設保人選區文本。

忠誠捐助者選區文本
loyal_donor_constituency_text string

忠誠的捐助者選區文本。

主要捐助者選區文本
major_donor_constituency_text string

主要捐助者選區文本。

MatchFinder 選區文本
matchfinder_constituency_text string

MatchFinder 選區文本。

MatchFinder 線上記錄 ID
matchfinder_online_record_id integer

MatchFinder 線上記錄 ID。

議員選區文本
member_constituency_text string

議員選區文本。

NFG 選區文本
nfg_constituency_text string

NFG 選區文本。

贊助人選區文本
patron_constituency_text string

贊助人選區文本。

計劃捐助者選區文本
plannedgiverconstituencytext string

計劃的給予者選區文本。

潛在選區文本
prospect_constituency_text string

潛在選區文本。

認可選區文本
recognition_constituency_text string

認可選區文本。

關係選區文本
relation_constituency_text string

關係選區文本。

發起人選區文本
sponsor_constituency_text string

發起人選區文本。

職員選區內文
staff_constituency_text string

工作人員選區文本。

學生選區文本
student_constituency_text string

學生選區文本。

學生關係選區文本
student_relation_constituency_text string

學生關係選區文本。

使用者定義的選區文字
user_defined_constituency_text string

使用者定義的選區文字。

志願者選區文本
volunteer_constituency_text string

志願者選區文本。

選區顯示順序
constituencies_display_order array of Conmg.ConstituencyDisplayOrder

選區的顯示順序。

使用者定義的選區
user_defined_constituencies array of Conmg.UserDefinedConstituency

使用者定義的選區集。

學生關係選區
student_relation_constituencies array of Conmg.StudentRelationConstituency

學生關係選區集。

社交媒體帳戶
social_media_accounts array of Conmg.ConstituentSocialMediaAccount

選民的社交媒體帳戶集。

Conmg.ConstituencyDisplayOrder

選區顯示順序

名稱 路徑 類型 Description
ID
id string

選區 ID。

說明
description string

選區描述。

序列
sequence integer

選區順序。

是系統?
system boolean

組成系統是定義的嗎?

Conmg.UserDefinedConstituency

使用者定義的選區

名稱 路徑 類型 Description
說明
description string

選區描述。

序列
sequence string

選區順序。

Conmg.StudentRelationConstituency

學生關係選區

名稱 路徑 類型 Description
說明
description string

選區描述。

序列
sequence string

選區順序。

Conmg.ConstituentSocialMediaAccount

選民社交媒體賬號

名稱 路徑 類型 Description
ID
id string

社交媒體帳戶的系統記錄 ID。

服務標識碼
social_media_service_id string

社交媒體服務的系統記錄 ID。

服務名稱
social_media_service_name string

社交媒體服務。

icon
social_media_service_icon string

社交媒體服務圖標。

帳戶類型 ID
social_media_account_type_code_id string

社群媒體服務帳戶類型的系統記錄 ID。

帳戶類型
social_media_account_type string

社交媒體服務帳戶類型。

使用者識別碼
user_id string

社交媒體帳戶使用者 ID。

url
url string

社交媒體網址。

info 原始碼 ID
info_source_code_id string

社群媒體帳號資訊原始碼的系統記錄ID。

資訊來源
info_source string

社交媒體帳戶信息來源。

不聯繫?
do_not_contact boolean

不聯繫此帳戶的選民?

序列
sequence integer

社交媒體帳戶序列。

Conmg.CreatedConstituentAddress

已建立的成分地址

名稱 路徑 類型 Description
ID
id string

新建立的組成地址的 ID。

Conmg.CreatedConstituentAlternateLookupID

已建立選區替代查閱標識碼

名稱 路徑 類型 Description
ID
id string

新建立的組成替代查閱 ID 的 ID。

Conmg.CreatedConstituentAppeal

創建了選民上訴

名稱 路徑 類型 Description
ID
id string

新建立的選民申訴的 ID。

Conmg.CreatedConstituentAppeal回應

創建了選民上訴回應

名稱 路徑 類型 Description
ID
id string

新建立的選民申訴回應的 ID。

Conmg.CreatedConstituentEducation

創建選民教育

名稱 路徑 類型 Description
ID
id string

新建立的組成教育的 ID。

Conmg.CreatedConstituentEmailAddress

創建的選民電子郵件地址

名稱 路徑 類型 Description
ID
id string

新建立的組成電子郵件地址的ID。

Conmg.CreatedConstituentEmploymentHistory

創建選民就業歷史

名稱 路徑 類型 Description
ID
id string

新建立的組成工作記錄的 ID。

Conmg.CreatedConstituentInteraction

創建的成分互動

名稱 路徑 類型 Description
ID
id string

新建立的組成互動的ID。

Conmg.CreatedConstituentNote

創建成分票據

名稱 路徑 類型 Description
ID
id string

新建立成分附註的 ID。

Conmg.CreatedConstituentPhone

創建選民電話

名稱 路徑 類型 Description
ID
id string

新建立的組成電話的ID。

Conmg.CreatedConstituentSolicitCode

創建了成分徵集代碼

名稱 路徑 類型 Description
ID
id string

新建立的組成徵求代碼的 ID。

Conmg.CreatedFundraiserConstituency

創建籌款人選區

名稱 路徑 類型 Description
ID
id string

新建立的籌款人選區的 ID。

Conmg.CreatedIndividualConstituent

創建個人成分

名稱 路徑 類型 Description
ID
id string

新建立的個別選區的 ID。

Conmg.CreatedOrganizationConstituent

已建立的組織組成

名稱 路徑 類型 Description
ID
id string

新建立的組織組成者的 ID。

教育

Education

名稱 路徑 類型 Description
ID
id string

組成教育的系統記錄 ID。

教育機構
name string

教育機構。

地位
education_history_status string

教育狀況。

初?
primary_record boolean

這是選民的初等教育嗎?

程式
program string

教育計劃。

degree string

教育學位。

類別
class_of integer

的類別。

受苦了?
affiliated boolean

教育機構是否隸屬於該組織?

start_date.year integer

模糊日期中的年份。

start_date.month integer

模糊日期中的月份。

start_date.day integer

模糊約會中的一天。

end_date.year integer

模糊日期中的年份。

end_date.month integer

模糊日期中的月份。

end_date.day integer

模糊約會中的一天。

Conmg.EducationCollection

學歷

名稱 路徑 類型 Description
Count
count integer

套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。

value
value array of Conmg.Education

回應中包含的專案集。 這可能是集合中項目的子集。

Conmg.電子郵件地址

電子郵件地址

名稱 路徑 類型 Description
ID
id string

電子郵件地址的系統記錄 ID。

電子郵件類型
type string

電子郵件地址的類型。

電子郵件地址
email_address string

電子郵件地址。

初?
primary boolean

這是選民的主要電子郵件地址嗎?

開始日期
start_date date-time

電子郵件地址開始日期。

結束日期
end_date date

電子郵件地址結束日期。

資訊來源
info_source string

信息來源。

信息來源評論
info_source_comments string

信息來源評論。

Conmg.EmailAddress集合

電子郵件地址

名稱 路徑 類型 Description
Count
count integer

套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。

value
value array of Conmg.EmailAddress

回應中包含的專案集。 這可能是集合中項目的子集。

Conmg.就業歷史

工作經歷

名稱 路徑 類型 Description
ID
id string

組成工作履歷的系統記錄 ID。

Relationship
name string

組成關係。

職稱
job_title string

職稱。

職業水平
career_level string

職業水平。

類別
job_category string

工作類別。

開始日期
start_date date-time

僱傭開始日期。

結束日期
end_date date-time

僱傭結束日期。

部門
job_department string

工作部門。

除法
job_division string

工作分工。

職業水平
job_schedule string

職業水平。

責任
job_responsibility string

工作職責。

是私人的嗎?
private_record boolean

工作經歷是私人的嗎?

Conmg.EmploymentHistoryCollection

工作經歷

名稱 路徑 類型 Description
Count
count integer

套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。

value
value array of Conmg.EmploymentHistory

回應中包含的專案集。 這可能是集合中項目的子集。

Conmg.IndividualConstituent

個別成分

名稱 路徑 類型 Description
Title
title string

選民的主要頭銜。

名字
first_name string

選民的名字。

姓氏
last_name string

選民的姓氏。

後綴
suffix string

選區的主要後綴。

中間名
middle_name string

選民的中間名。

暱稱
nickname string

選民的暱稱。

婚前姓氏
maiden_name string

選民的婚前姓氏。

婚姻狀態
marital_status string

婚姻狀況。

birth_date.year integer

模糊日期中的年份。

birth_date.month integer

模糊日期中的月份。

birth_date.day integer

模糊約會中的一天。

年齡
age integer

選民的年齡。

性別
gender_code string

選民的性別。

網站
web_address string

選民的網站。

標題 2
title_2 string

選民的次要頭銜。

字尾 2
suffix_2 string

成分的次要後綴

匿名捐贈?
gives_anonymously boolean

選民是否匿名捐款?

死了?
deceased boolean

組成人已故嗎?

設定檔圖片
picture string

選民的個人資料圖片。

個人資料圖片縮略圖
picture_thumbnail string

選民的個人資料圖片縮略圖。

Conmg.MergedConstituent

合併成分

名稱 路徑 類型 Description
ID
id string

合併成分的識別碼。

Conmg.Organization組成

組織組成

名稱 路徑 類型 Description
名稱
organization_name string

組織名稱。

工業
industry string

行業。

母公司
parent_corp_id string

母公司的系統記錄 ID。

員工人數
num_employees integer

員工人數。

子公司數量
num_subsidiaries integer

子組織數目。

網站
web_address string

組織網站。

是主要組織嗎?
is_primary boolean

選民是主要組織嗎?

設定檔圖片
picture string

組織的個人資料圖片。

個人資料圖片縮略圖
picture_thumbnail string

組織的個人資料圖片縮圖。

主要位址識別碼
primary_address_id string

主要位址的系統記錄 ID。

主要地址類型
address_type string

主要位址類型。

主要地址國家/地區
address_country string

主要地址國家/地區。

主要位址區塊
address_block string

主要位址區塊。

主要地址城市
address_city string

主要地址城市。

主要位址狀態
address_state string

主要位址狀態。

主要地址郵遞區號
address_postcode string

主要地址郵遞區號。

不郵寄?
address_do_not_mail boolean

不聯繫此地址的選民?

請勿郵寄原因
address_do_not_mail_reason string

未聯繫該地址選民的原因。

主要電話 ID
primary_phone_id string

主要電話號碼的系統記錄 ID。

主要電話類型
phone_type string

主要電話類型。

主要電話號碼
phone_number string

主要電話號碼。

主要電子郵件地址 ID
primary_email_address_id string

主要電子郵件地址的系統記錄 ID。

主要電子郵件地址類型
email_address_type string

主要電子郵件地址類型。

主要電子郵件地址
email_address string

主要電子郵件地址。

電話

電話

名稱 路徑 類型 Description
ID
id string

電話的系統記錄ID。

類型
type string

電話類型。

國家
country string

電話國家。

Number
phone_number string

電話號碼。

初?
primary boolean

這是選民的主要電話嗎?

不打電話?
donotcall boolean

不聯繫這個號碼的選民?

資訊來源
info_source string

信息來源。

信息來源評論
info_source_comments string

信息來源評論。

開始日期
start_date date-time

電話通話開始日期。

結束日期
end_date date-time

電話通話結束日期。

小時
start_time.hour integer

小時。

分鐘
start_time.minute integer

分鐘。

小時
end_time.hour integer

小時。

分鐘
end_time.minute integer

分鐘。

Conmg.PhoneCollection

電話

名稱 路徑 類型 Description
Count
count integer

套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。

value
value array of Conmg.Phone

回應中包含的專案集。 這可能是集合中項目的子集。

Conmg.SolicitCode

徵求代碼

名稱 路徑 類型 Description
ID
id string

徵用代碼的系統記錄 ID。

徵求代碼
description string

徵求代碼。

開始日期
start_date date-time

徵求代碼開始日期。

結束日期
end_date date-time

徵求代碼結束日期。

評論
comments string

徵求程式碼註解。

過期了?
expired boolean

徵求代碼是否已過期?

Conmg.SolicitCode集合

徵求代碼

名稱 路徑 類型 Description
Count
count integer

套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。

value
value array of Conmg.SolicitCode

回應中包含的專案集。 這可能是集合中項目的子集。

Conmg.貢品

名稱 路徑 類型 Description
ID
id string

貢品的系統記錄 ID。

貢品類型
tribute_type string

貢品類型。

致敬文字
tribute_text string

致敬文字。

是貢品嗎?
tributee boolean

選民是被貢品嗎?

是承認嗎?
acknowledgee boolean

選民是承認的嗎?

活躍的?
active boolean

致敬活動是否活躍?

建立日期
date_created date-time

創建貢品的日期。

Conmg.TributeCollection

致敬

名稱 路徑 類型 Description
Count
count integer

套用任何要求參數之後,可擷取到集合中的項目數目。 limit和offset參數不會影響計數,但為了方便分頁,它們可能會影響值結果集中的項目數。

value
value array of Conmg.Tribute

回應中包含的專案集。 這可能是集合中項目的子集。