次の方法で共有

Blackbaud Raisers Edge NXT Constituents

  • リファレンス

Blackbaud Raiser's Edge NXT は、非営利団体と社会貢献コミュニティ全体のために特別に構築された、包括的なクラウドベースの資金調達および寄付者管理ソフトウェア ソリューションです。 Constituents コネクタを使用して、構成要素の経歴、取引先担当者情報、およびリレーション シップを管理します。

このコネクタは、次の製品および地域で利用可能です。

Service クラス 地域
Logic Apps 標準 以下を除くすべての Logic Apps 地域 :
     -   Azure 政府の地域
     -   Azure 中国の地域
     -   国防総省 (DoD)
Power Automate プレミアム 以下を除くすべての Power Automate 地域 :
     -   米国政府 (GCC)
     -   米国政府 (GCC High)
     -   21Vianet が運用する中国のクラウド
     -   国防総省 (DoD)
Power Apps プレミアム 以下を除くすべての Power Apps 地域 :
     -   米国政府 (GCC)
     -   米国政府 (GCC High)
     -   21Vianet が運用する中国のクラウド
     -   米国国防総省 (DoD)
お問い合わせ先
件名 Blackbaud サポート
[URL] https://www.blackbaud.com/support
メール skyapi@blackbaud.com
Connector Metadata
発行者 Blackbaud, Inc.
Web サイト https://www.blackbaud.com/products/blackbaud-raisers-edge-nxt
プライバシー ポリシー https://www.blackbaud.com/privacy-shield
カテゴリー 販売と CRM、生産性

Raiser's Edge NXT は、非営利団体と社会貢献コミュニティ全体のために特別に構築された、包括的なクラウドベースの資金調達および寄付者管理ソフトウェア ソリューションです。

このコネクタは Blackbaud の SKY API 上に構築されていて、The Raiser's Edge NXT 内の以下のようなスタッフおよび関連エンティティを管理するのに役立つ操作を提供します。

  • スタッフ
  • 住所
  • 電話番号とメール
  • エイリアス
  • カスタム フィールド
  • メモ
  • Attachments
  • 顧客間関係
  • その他...

詳細については、ドキュメントを参照してください。

前提条件

このコネクタを使用するには、1 つ以上の Blackbaud 環境にアクセスできる Blackbaud ID アカウントが必要です。

さらに、組織の管理者は、この コネクタが Blackbaud 環境にアクセスできるようにするために、システム内で管理者レベルのアクションも実行する必要があります。 これらの前提条件の詳細については、初期設定ドキュメントを参照してください。

資格情報の入手方法

組織の管理者は、組織の Raiser's Edge NXT 環境への招待状を送信し、環境内でユーザー アカウントのアクセス許可を構成します。 このコネクタを使用するために追加の資格情報は必要ありません。

既知の問題と制限事項

コネクタはユーザー アカウントのコンテキストで機能するため、環境内のユーザー アクセス許可が適用されます。

調整制限

名前 呼び出し 更新期間
接続ごとの API 呼び出し 100 60 秒

アクション

スタッフ エイリアスを作成する

新しいスタッフ エイリアスを作成します。
スタッフ エイリアスを更新する

スタッフ エイリアスを更新します。
スタッフ カスタム フィールドを一覧表示する

スタッフのカスタム フィールドを一覧表示します。
スタッフ コードを一覧表示する

スタッフのスタッフ コードを一覧表示します。
スタッフ コードを作成する

新しいスタッフ コードを作成します。
スタッフ コードを削除する

スタッフ コードを削除します。
スタッフ コードを更新する

スタッフ コードを更新します。
スタッフ プロファイル画像を取得する

スタッフの現在のプロファイル画像を返します。
スタッフ メモを作成する

新しいスタッフ メモを作成します。
スタッフ メモを更新する

スタッフ メモを更新します。
スタッフ メンバーシップをリストする

スタッフ メンバーシップをリストします。
スタッフに変換する

非スタッフをスタッフに変換します。
スタッフのエイリアスを一覧表示する

スタッフのエイリアスを一覧表示します。
スタッフのオンライン プレゼンスを一覧表示する

スタッフのオンライン プレゼンスを一覧表示します。
スタッフのオンライン プレゼンスを作成する

新しいスタッフのオンライン プレゼンスを作成します。
スタッフのオンライン プレゼンスを更新する

スタッフのオンライン プレゼンスを更新します。
スタッフのカスタム フィールドを作成する

新しいスタッフのカスタム フィールドを作成します。
スタッフのカスタム フィールドを更新する

スタッフのカスタム フィールドを更新します。
スタッフのトリビュートを一覧表示する

スタッフのトリビュートを一覧表示します。
スタッフのトリビュートを作成

スタッフの新しいトリビュートを作成します。
スタッフのトリビュートを取得する

スタッフのトリビュートに関する詳細を返します。
スタッフのプライマリ名前書式を作成する

スタッフのプライマリ名前書式を作成します。
スタッフのプライマリ名前書式を更新します

スタッフに対してプライマリ名前書式を更新します。
スタッフのプロフィール写真を更新する

スタッフの現在のプロフィール写真を更新します。
スタッフのメモをリストする

スタッフのメモをリストします。
スタッフの住所を一覧表示する

スタッフの住所を一覧表示します。
スタッフの同意レコードを一覧表示する

スタッフの同意レコードを一覧表示します。
スタッフの同意レコードを作成する

新しいスタッフの同意レコードを作成します。
スタッフの名前書式の概要を取得する

スタッフの名前書式の概要を返します。
スタッフの名前書式を作成する

新しいスタッフの名前書式を作成します。
スタッフの名前書式を更新する

スタッフの名前書式を更新します。
スタッフの検索

指定された検索テキストに基づいてスタッフ検索を実行します。 名、姓、優先名、旧名、エイリアス、電子メール アドレス、電話番号、アドレス、または検索 ID をサポートします。 名と姓、または優先名と姓など、名前の組み合わせは有効ですが、検索は一度に 1 つのパラメーターのみをサポートします。 既定では、検索には条件に類似した結果が含まれます。 たとえば、"Smith" の検索には、"Smyth" やその他の代替スペルの一致が含まれます。 この検索では、* や？などのワイルドカード文字はサポートされていません。 検索結果は 500 レコードに制限されています。
スタッフの検索 (拡張)

指定されたフィルター基準を使用して構成レコードを検索します。
スタッフの電子メール アドレスを一覧表示する

スタッフの電子メール アドレスを一覧表示します。
スタッフの電子メール アドレスを作成する

新しいスタッフの電子メール アドレスを作成します。
スタッフの電子メール アドレスを更新する

スタッフの電子メール アドレスを更新します。
スタッフの電話番号を一覧表示する

スタッフの電話番号を一覧表示します。
スタッフの電話番号を作成する

新しいスタッフの電話番号を作成します。
スタッフの電話番号を更新する

スタッフの電話番号を更新します。
スタッフを一覧表示する

スタッフのリストを返します。
スタッフを取得する

スタッフに関する情報を返します。
スタッフを更新する

スタッフを更新します。
スタッフ住所を作成する

スタッフ住所を新しく作成します。
スタッフ住所を更新する

スタッフ住所を更新します。
スタッフ基金調達者を一覧表示する

スタッフの基金調達者割り当てを一覧表示します。
スタッフ学歴を一覧表示する

スタッフの学歴レコードを一覧表示します。
スタッフ学歴を更新する

スタッフ学歴を更新します。
スタッフ教育を作成する

新しいスタッフ教育を作成します。
スタッフ添付資料を一覧表示する

スタッフの添付資料を一覧表示します。
スタッフ添付資料を作成する

新しいスタッフ添付資料を作成します。
スタッフ添付資料を更新する

スタッフ添付資料を更新します。
スタッフ要請コードを作成する

新しいスタッフ要請コードを作成します。
スタッフ要請コードを更新する

スタッフ要請コードを更新します。
スタッフ関連付けをリストする

スタッフの関連付けをリストします。
スタッフ関連付けを更新する

スタッフの関連付けを更新します。 相互関係が存在する場合は、変更を反映するようにも変更されます。 これには、各レコードに固有であり、各レコードで個別に変更できる "コメント" プロパティへの変更は含まれません。
トリビュート アクノリッジ リスト

トリビュートのアクノリッジを一覧表示します。
トリビュート アクノリッジを作成

新しいトリビュート アクノリッジを作成します。
個々のリレーションシップを作成する

新しい関連付けを作成します。 別のスタッフとの関連付けである場合、そのスタッフに対して相互関係が作成されます。
個人スタッフを作成する

新しい個人スタッフを作成します。
基金調達者の割り当てを一覧で表示する

基金調達者の割り当てを一覧で表示します。
基金調達者の割り当てを作成する

新しい基金調達者の割り当てを作成します。
検索 ID でスタッフを取得する

指定された検索 ID からスタッフのシステム レコード ID を返します。
組織のリレーションシップを作成する

新しい組織の関連付けを作成します。 別のスタッフとの関連付けである場合、そのスタッフに対して相互関係が作成されます。
組織スタッフを作成する

新しい組織スタッフ作成します。
要請コードを一覧表示する

スタッフの要請コードを一覧表示します。
重複構成要素の検索

個人、組織、関連する連絡先レコードを検索し、指定された検索フィルターに基づいて潜在的な重複をランク付けします。 複数のフィルターに一致するレコードは、潜在的な重複としてランク付けされます。

スタッフ エイリアスを作成する

操作 ID:
CreateConstituentAlias

新しいスタッフ エイリアスを作成します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

エイリアスに関連付けられたスタッフのシステム レコード ID。
エイリアス
 name True string

スタッフのエイリアスとして使用する名前。 文字数制限: 100。
タイプ
 type string

エイリアスの種類。

戻り値

作成済みスタッフ エイリアス

本文​​
ConstituentApi.CreatedConstituentAlias

スタッフ エイリアスを更新する

操作 ID:
EditConstituentAlias

スタッフ エイリアスを更新します。

パラメーター

名前 キー 必須 型 説明
エイリアス ID
 alias_id True string

更新するエイリアスのシステム レコード ID。
エイリアス
 name string

スタッフのエイリアスとして使用する名前。 文字数制限: 100。
タイプ
 type string

エイリアスの種類。

スタッフ カスタム フィールドを一覧表示する

操作 ID:
ListConstituentCustomFields

スタッフのカスタム フィールドを一覧表示します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

スタッフのシステム レコード ID。

戻り値

カスタム フィールド

本文​​
ConstituentApi.ApiCollectionOfConstituentCustomFieldRead

スタッフ コードを一覧表示する

操作 ID:
ListConstituentCodes

スタッフのスタッフ コードを一覧表示します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

スタッフのシステム レコード ID。

戻り値

スタッフ コード

本文​​
ConstituentApi.ApiCollectionOfConstituentCodeRead

スタッフ コードを作成する

操作 ID:
CreateConstituentCode

新しいスタッフ コードを作成します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

スタッフ コードに関連付けられたスタッフのシステム レコード ID。
スタッフ コード
 description True string

スタッフ コード。
日
 d integer

あいまいな日付で表した日。
月
 m integer

あいまいな日付で表した月。
年
 y integer

あいまいな日付で表した年。
日
 d integer

あいまいな日付で表した日。
月
 m integer

あいまいな日付で表した月。
年
 y integer

あいまいな日付で表した年。
シーケンス
 sequence integer

スタッフ コードに関連付けられた数列。

戻り値

作成済みスタッフ コード

本文​​
ConstituentApi.CreatedConstituentCode

スタッフ コードを削除する

操作 ID:
DeleteConstituentCode

スタッフ コードを削除します。

パラメーター

名前 キー 必須 型 説明
スタッフ コード ID
 constituent_code_id True string

削除するスタッフ コードのシステム レコード ID。

スタッフ コードを更新する

操作 ID:
EditConstituentCode

スタッフ コードを更新します。

パラメーター

名前 キー 必須 型 説明
スタッフ コード ID
 constituent_code_id True string

更新するスタッフ コードのシステム レコード ID。
日
 d integer

あいまいな日付で表した日。
月
 m integer

あいまいな日付で表した月。
年
 y integer

あいまいな日付で表した年。
日
 d integer

あいまいな日付で表した日。
月
 m integer

あいまいな日付で表した月。
年
 y integer

あいまいな日付で表した年。
シーケンス
 sequence integer

スタッフ コードに関連付けられた数列。

スタッフ プロファイル画像を取得する

操作 ID:
GetConstituentProfilePicture

スタッフの現在のプロファイル画像を返します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

プロファイル画像を取得するスタッフのシステム レコード ID。

戻り値

プロフィール写真

本文
ConstituentApi.ProfilePictureRead

スタッフ メモを作成する

操作 ID:
CreateConstituentNote

新しいスタッフ メモを作成します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

メモに関連付けられたスタッフのシステム レコード ID。
タイプ
 type True string

メモの種類。
日
 d integer

あいまいな日付で表した日。
月
 m integer

あいまいな日付で表した月。
年
 y integer

あいまいな日付で表した年。
要約
 summary string

ノートの概要。 文字数制限: 50。
メモ
 text string

メモ テキスト。
作成者
 author string

メモの作成者。 指定しない場合、ユーザーのアカウントに基づいて既定が設定されます。 文字数制限: 50。

戻り値

作成したスタッフ メモ

本文
ConstituentApi.CreatedConstituentNote

スタッフ メモを更新する

操作 ID:
EditConstituentNote

スタッフ メモを更新します。

パラメーター

名前 キー 必須 型 説明
メモ ID
 note_id True string

更新するメモのシステム レコード ID。
タイプ
 type string

メモの種類。
日
 d integer

あいまいな日付で表した日。
月
 m integer

あいまいな日付で表した月。
年
 y integer

あいまいな日付で表した年。
サマリー
 summary string

メモの概要。 文字数制限: 50。
メモ
text string

メモのテキスト。

スタッフ メンバーシップをリストする

操作 ID:
ListConstituentMemberships

スタッフ メンバーシップをリストします。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

スタッフのシステム レコード ID。

戻り値

メンバーシップ

Body
ConstituentApi.ApiCollectionOfMembershipRead

スタッフに変換する

操作 ID:
ConvertToConstituent

非スタッフをスタッフに変換します。

パラメーター

名前 キー 必須 型 説明
非スタッフの ID
 non_constituent_id True string

変換する非スタッフ レコードのシステム レコード ID。
ID
 id string

スタッフ コードのシステム レコード ID。
day
 d integer

あいまいな日付の中の日。
month
 m integer

あいまいな日付の中の月。
年
 y integer

あいまいな日付で表した年。
日
 d integer

あいまいな日付で表した日。
month
 m integer

あいまいな日付の中の月。
year
 y integer

あいまいな日付の中の年。
シーケンス
 sequence integer

スタッフ コードのシーケンス。

戻り値

変換済みのスタッフ

Body
ConstituentApi.ConvertedConstituent

スタッフのエイリアスを一覧表示する

操作 ID:
ListConstituentAliases

スタッフのエイリアスを一覧表示します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

スタッフのシステム レコード ID。

戻り値

エイリアス

本文​​
ConstituentApi.ApiCollectionOfAliasRead

スタッフのオンライン プレゼンスを一覧表示する

操作 ID:
ListConstituentOnlinePresences

スタッフのオンライン プレゼンスを一覧表示します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

スタッフのシステム レコード ID。
非アクティブを含む?
 include_inactive boolean

非アクティブのオンライン プレゼンスを含みますか?

戻り値

オンライン プレゼンス

本文​​
ConstituentApi.ApiCollectionOfOnlinePresenceRead

スタッフのオンライン プレゼンスを作成する

操作 ID:
CreateConstituentOnlinePresence

新しいスタッフのオンライン プレゼンスを作成します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

オンライン プレゼンスに関連付けられたスタッフのシステム レコード ID。
タイプ
 type True string

オンライン プレゼンスの種類。
リンク
 address True string

オンライン プレゼンスの Web アドレス。
プライマリ?
 primary boolean

これはスタッフの優先オンライン プレゼンスですか?
非アクティブ?
 inactive boolean

このオンライン プレゼンスは非アクティブですか?

戻り値

作成済みスタッフのオンライン プレゼンス

本文​​
ConstituentApi.CreatedConstituentOnlinePresence

スタッフのオンライン プレゼンスを更新する

操作 ID:
EditConstituentOnlinePresence

スタッフのオンライン プレゼンスを更新します。

パラメーター

名前 キー 必須 型 説明
オンライン プレゼンス ID
 online_presence_id True string

更新するオンライン プレゼンスのシステム レコード ID。
タイプ
 type string

オンライン プレゼンスの種類。
リンク
 address string

オンライン プレゼンスの Web アドレス。
プライマリ?
 primary boolean

これはスタッフの優先オンライン プレゼンスですか?
非アクティブ?
 inactive boolean

このオンライン プレゼンスは非アクティブですか?

スタッフのカスタム フィールドを作成する

操作 ID:
CreateConstituentCustomField

新しいスタッフのカスタム フィールドを作成します。

パラメーター

名前 キー 必須 型 説明
本文
 body True dynamic

作成するカスタム フィールドを表すオブジェクト。

戻り値

作成済みスタッフのカスタム フィールド

本文​​
ConstituentApi.CreatedConstituentCustomField

スタッフのカスタム フィールドを更新する

操作 ID:
EditConstituentCustomField

スタッフのカスタム フィールドを更新します。

パラメーター

名前 キー 必須 型 説明
カスタム フィールド ID
 custom_field_id True string

更新するカスタム フィールドのシステム レコード ID。
本文
 body True dynamic

更新するカスタム フィールドのプロパティを表すオブジェクト。

スタッフのトリビュートを一覧表示する

操作 ID:
ListConstituentTributes

スタッフのトリビュートを一覧表示します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituentId True integer

スタッフのシステム レコード ID。

戻り値

トリビュート

本文
NXTDataIntegrationApi.TributeCollection

スタッフのトリビュートを作成

操作 ID:
CreateConstituentTribute

スタッフの新しいトリビュートを作成します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_record_id True integer

トリビュートに関連付けられたスタッフのシステム レコード ID。
トリビュートのタイプ
 tribute_type_id True integer

トリビュートのタイプ。
説明
 description string

トリビュートの説明。
日
 d integer

あいまいな日付で表した日。
月
 m integer

あいまいな日付で表した月。
年
 y integer

あいまいな日付で表した年。
日
 d integer

あいまいな日付で表した日。
月
 m integer

あいまいな日付で表した月。
年
 y integer

あいまいな日付で表した年。
既定の資金 ID
 default_fund_id integer

トリビュートに関連付けられた既定の資金のシステム レコード ID。
メモ
 notes string

トリビュート メモ。
アクティブ?
 is_active boolean

このトリビュートはアクティブですか?

戻り値

作成したスタッフのトリビュート

本文
NXTDataIntegrationApi.CreatedConstituentTribute

スタッフのトリビュートを取得する

操作 ID:
GetConstituentTribute

スタッフのトリビュートに関する詳細を返します。

パラメーター

名前 キー 必須 型 説明
トリビュート ID
tribute_id True string

トリビュート ID。

戻り値

トリビュート

本文
NXTDataIntegrationApi.Tribute

スタッフのプライマリ名前書式を作成する

操作 ID:
CreateConstituentPrimaryNameFormat

スタッフのプライマリ名前書式を作成します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

スタッフのシステム レコード ID。
タイプ
 primary_type True string

プライマリ名の書式タイプ。
名前はカスタム書式ですか?
 custom_format boolean

カスタム形式ですか?
書式
 configuration_id string

名前の書式構成 (カスタム形式を使用しない限り必須)。
カスタム名
 formatted_name string

書式設定した名前 (カスタム形式を使用する場合は必須)。 文字数制限: 255。

戻り値

作成した名前書式

Body
ConstituentApi.CreatedNameFormat

スタッフのプライマリ名前書式を更新します

操作 ID:
EditConstituentPrimaryNameFormat

スタッフに対してプライマリ名前書式を更新します。

パラメーター

名前 キー 必須 型 説明
名前の書式 ID
 primary_name_format_id True string

更新するプライマリ名前書式のシステム レコード ID。
名前はカスタム書式ですか?
 custom_format boolean

カスタム形式ですか?
書式
 configuration_id string

名前の書式構成 (カスタム形式を使用しない限り必須)。
カスタム名
 formatted_name string

書式設定した名前 (カスタム形式を使用する場合は必須)。 文字数制限: 255。

スタッフのプロフィール写真を更新する

操作 ID:
EditConstituentProfilePicture

スタッフの現在のプロフィール写真を更新します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

プロファイル画像を更新するスタッフのシステム レコード ID。
ファイル名
 file_name True string

ファイルの名前。
ドキュメント ID
 document_id True uuid

ドキュメントの識別子。
サムネイル ID
 thumbnail_id True uuid

サムネイル ドキュメントの識別子。

スタッフのメモをリストする

操作 ID:
ListConstituentNotes

スタッフのメモをリストします。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

スタッフのシステム レコード ID。

戻り値

メモ

本文​​
ConstituentApi.ApiCollectionOfNoteRead

スタッフの住所を一覧表示する

操作 ID:
ListConstituentAddresses

スタッフの住所を一覧表示します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

スタッフのシステム レコード ID。
非アクティブを含む?
 include_inactive boolean

非アクティブな住所を含みますか？

戻り値

住所

本文​​
ConstituentApi.ApiCollectionOfAddressRead

スタッフの同意レコードを一覧表示する

操作 ID:
ListConstituentConsents

スタッフの同意レコードを一覧表示します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

スタッフのシステム レコード ID。
最新のみ?
 most_recent_only boolean

各チャネル カテゴリの組み合わせに対する最新の同意レコードのみを応答に含めますか?

戻り値

同意レコード

本文​​
CommPrefApi.ConstituentConsentReadCollection

スタッフの同意レコードを作成する

操作 ID:
CreateConstituentConsent

新しいスタッフの同意レコードを作成します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

同意レコードに関連付けられたスタッフのシステム レコード ID。
チャネル
 channel True string

同意応答が適用されるチャネル。
カテゴリ
 category string

同意応答が適用されるカテゴリ。
ソース
 source string

スタッフからの同意応答のソース。
回答
 constituent_consent_response True string

指定されたチャネル/カテゴリの同意に対するスタッフの応答方法。
日
 consent_date True date-time

同意応答が受信された日付 (例: '2020-09-18T04:13:56Z')。
同意書
 consent_statement string

同意時にスタッフが応答したステートメント。
プライバシー通知
 privacy_notice string

スタッフに提供されるプライバシーに関する声明。

戻り値

作成済みスタッフ同意

本文​​
CommPrefApi.CreatedConstituentConsent

スタッフの名前書式の概要を取得する

操作 ID:
GetConstituentNameFormatSummary

スタッフの名前書式の概要を返します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

スタッフのシステム レコード ID。

戻り値

名前書式の概要

Body
ConstituentApi.NameFormatSummaryRead

スタッフの名前書式を作成する

操作 ID:
CreateConstituentNameFormat

新しいスタッフの名前書式を作成します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

スタッフのシステム レコード ID。
タイプ
 type True string

名前の書式タイプ。
名前はカスタム書式ですか?
 custom_format boolean

カスタム形式ですか?
書式
 configuration_id string

名前の書式構成 (カスタム形式を使用しない限り必須)。
カスタム名
 formatted_name string

書式設定した名前 (カスタム形式を使用する場合は必須)。 文字数制限: 255。

戻り値

作成した名前書式

本文​​
ConstituentApi.CreatedNameFormat

スタッフの名前書式を更新する

操作 ID:
EditConstituentNameFormat

スタッフの名前書式を更新します。

パラメーター

名前 キー 必須 型 説明
名前の書式 ID
 name_format_id True string

更新する名前書式のシステム レコード ID。
タイプ
 type string

名前の書式タイプ。
名前はカスタム書式ですか?
 custom_format boolean

カスタム形式ですか?
書式
 configuration_id string

名前の書式構成 (カスタム形式を使用しない限り必須)。
カスタム名
 formatted_name string

書式設定した名前 (カスタム形式を使用する場合は必須)。 文字数制限: 255。

スタッフの検索

操作 ID:
SearchConstituent

指定された検索テキストに基づいてスタッフ検索を実行します。 名、姓、優先名、旧名、エイリアス、電子メール アドレス、電話番号、アドレス、または検索 ID をサポートします。 名と姓、または優先名と姓など、名前の組み合わせは有効ですが、検索は一度に 1 つのパラメーターのみをサポートします。 既定では、検索には条件に類似した結果が含まれます。 たとえば、"Smith" の検索には、"Smyth" やその他の代替スペルの一致が含まれます。 この検索では、* や？などのワイルドカード文字はサポートされていません。 検索結果は 500 レコードに制限されています。

パラメーター

名前 キー 必須 型 説明
検索テキスト
 search_text True string

検索テキスト。 名、姓、優先名、旧名、エイリアス、電子メール アドレス、電話番号、アドレス、または検索 ID をサポートします。 名と姓、または優先名と姓など、名前の組み合わせは有効ですが、検索は一度に 1 つのパラメーターのみをサポートします。 既定では、検索には条件に類似した結果が含まれます。 たとえば、"Smith" の検索には、"Smyth" やその他の代替スペルの一致が含まれます。 この検索では、* や？などのワイルドカード文字はサポートされていません。 検索結果は 500 レコードに制限されています。
基金調達者ステータス
 fundraiser_status string

結果をフィルタリングする基金調達者ステータスのコンマ区切り一覧を表します。 たとえば、"アクティブ、なし" は、基金調達者ステータスが「アクティブ」または「なし」であるスタッフのみを返します。 このフィルターの有効な値は、「アクティブ」、「非アクティブ」、および「なし」です。
非アクティブを含む?
 include_inactive boolean

非アクティブ スタッフを応答に含めますか?
検索フィールド
 search_field string

検索するフィールドを表します。 現在、lookup_id のみをサポートしています。 search_text が指定されている場合、search_text と一致する lookup_id があるスタッフが返されます。
制限検索を使用?
 strict_search boolean

名前が検索テキストのように聞こえるが、スペルが異なるスタッフを除外しますか?
制限
 limit integer

返されるレコード数を表します。 既定値は 500 です。 最大値は 5000 です。
オフセット
 offset integer

スキップするレコード数を表します。 改ページで使用します。

戻り値

検索結果

本文
ConstituentApi.ApiCollectionOfSearchResultRead

スタッフの検索 (拡張)

操作 ID:
SearchConstituentEnhanced

指定されたフィルター基準を使用して構成レコードを検索します。

パラメーター

名前 キー 必須 型 説明
名
 first_name string

スタッフの名。
姓
 last_name string

スタッフの姓。
検索 ID
 lookup_id string

スタッフ検索 ID。
電子メールアドレス
 email string

スタッフの電子メール アドレス。
電話番号
 phone_number string

電話番号。
制限
 limit integer

返されるレコード数を表します。 既定値は 500 です。 最大値は 1000 です。
住所行
 address_lines string

住所行。
都市
 city string

住所の市区町村。
状態
 state string

住所の状態。
郵便番号
 post_code string

住所の郵便番号。
エイリアスを含めますか?
 include_alias boolean

姓で検索するときにエイリアスを含めますか?
エイリアス タイプ
 alias_type string

エイリアス タイプ。
旧姓を含めますか？
 include_maiden_name boolean

姓で検索するときに旧姓を含めますか?

戻り値

スタッフ

Body
NXTDataIntegrationApi.ConstituentSearchResultCollection

スタッフの電子メール アドレスを一覧表示する

操作 ID:
ListConstituentEmailAddresses

スタッフの電子メール アドレスを一覧表示します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

スタッフのシステム レコード ID。
非アクティブを含む?
 include_inactive boolean

非アクティブな電子メール アドレスを含みますか?

戻り値

電子メール アドレス

本文​​
ConstituentApi.ApiCollectionOfEmailAddressRead

スタッフの電子メール アドレスを作成する

操作 ID:
CreateConstituentEmailAddress

新しいスタッフの電子メール アドレスを作成します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

電子メール アドレスに関連付けられたスタッフのシステム レコード ID。
電子メールの種類
 type True string

電子メール アドレスの種類。
メール アドレス
 address True string

電子メール アドレス。
プライマリ?
 primary boolean

これはスタッフの優先電子メール アドレスですか?
電子メール不可?
 do_not_email boolean

この電子メール アドレスでスタッフに連絡できますか?
非アクティブ?
 inactive boolean

この電子メール アドレスは非アクティブですか?

戻り値

作成したスタッフのメール アドレス

本文​​
ConstituentApi.CreatedConstituentEmailAddress

スタッフの電子メール アドレスを更新する

操作 ID:
EditConstituentEmailAddress

スタッフの電子メール アドレスを更新します。

パラメーター

名前 キー 必須 型 説明
電子メール アドレス ID
 email_address_id True string

更新する電子メール アドレスのシステム レコード ID。
電子メールの種類
 type string

電子メール アドレスの種類。
メール アドレス
 address string

電子メール アドレス。
プライマリ?
 primary boolean

これはスタッフの優先電子メール アドレスですか?
電子メール不可?
 do_not_email boolean

この電子メール アドレスでスタッフに連絡できますか?
非アクティブですか?
 inactive boolean

このメール アドレスは非アクティブですか?

スタッフの電話番号を一覧表示する

操作 ID:
ListConstituentPhones

スタッフの電話番号を一覧表示します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

スタッフのシステム レコード ID。
非アクティブを含みますか?
 include_inactive boolean

非アクティブな電話番号を含みますか?

戻り値

電話

Body
ConstituentApi.ApiCollectionOfPhoneRead

スタッフの電話番号を作成する

操作 ID:
CreateConstituentPhone

新しいスタッフの電話番号を作成します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

電話番号に関連付けられたスタッフのシステム レコード ID。
タイプ
 type True string

電話番号の種類。
数
 number True string

電話番号。
プライマリ?
 primary boolean

これはスタッフの優先電話番号ですか?
電話不可?
 do_not_call boolean

この電話番号でスタッフに連絡できますか?
非アクティブ?
 inactive boolean

この電話番号は非アクティブですか?

戻り値

作成したスタッフの電話

本文​​
ConstituentApi.CreatedConstituentPhone

スタッフの電話番号を更新する

操作 ID:
EditConstituentPhone

スタッフの電話番号を更新します。

パラメーター

名前 キー 必須 型 説明
電話番号 ID
 phone_id True string

更新する電話番号のシステム レコード ID。
タイプ
 type string

電話番号の種類。
数
 number string

電話番号。
プライマリ?
 primary boolean

これはスタッフの優先電話番号ですか?
電話不可?
 do_not_call boolean

この電話番号でスタッフに連絡できますか?
非アクティブですか?
 inactive boolean

この電話番号は非アクティブですか?

スタッフを一覧表示する

操作 ID:
ListConstituents

スタッフのリストを返します。

パラメーター

名前 キー 必須 型 説明
リスト
 list_id string

指定されたリストに含まれる一連のスタッフをフィルター処理するために使用されるリスト識別子を定義します。 この値が設定されている場合、他の指定されたフィルターは無視されます。
制限
 limit integer

返されるレコード数を表します。 既定値は 500 です。 最大値は 5000 です。
オフセット
 offset integer

スキップするレコード数を表します。 改ページで使用します。
スタッフ コード
 constituent_code string

一覧をフィルタリングするスタッフ コードを表します。 たとえば、"取締役会役員" は、取締役会役員スタッフ コードを持つスタッフのみを返します。
スタッフ ID
 constituent_id string

結果をフィルター処理する、スタッフ システム レコード ID のコンマ区切りリストを表します。 たとえば、"280,1232" はスタッフ 280 またはスタッフ 1232 のみを返します。
カスタム フィールド カテゴリ
 custom_field_category string

結果をフィルタリングするカスタム フィールド カテゴリを表します。 たとえば、"記念日" は、アクティブな記念日カスタム フィールドを持つスタッフのみを返します。
基金調達者ステータス
 fundraiser_status string

結果をフィルタリングする基金調達者ステータスのコンマ区切り一覧を表します。 たとえば、"アクティブ、なし" は、基金調達者ステータスが「アクティブ」または「なし」であるスタッフのみを返します。 このフィルターの有効な値は、「アクティブ」、「非アクティブ」、および「なし」です。
故人を含む?
 include_deceased boolean

故人であるスタッフを応答に含めますか?
非アクティブを含む?
 include_inactive boolean

非アクティブ スタッフを応答に含めますか?
郵便番号
 postal_code string

結果をフィルタリングする郵便番号のコンマ区切り一覧を表します。 たとえば、"29466,29492" は、優先住所の郵便番号が 29466、29492、または 29492-0727 などの 29466 または 29492 で始まるスタッフのみを返します。
以降に追加済
 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" フィールドで降順で並べ替えます。

戻り値

スタッフ

Body
ConstituentApi.ApiCollectionOfConstituentRead

スタッフを取得する

操作 ID:
GetConstituent

スタッフに関する情報を返します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

取得するスタッフのシステム レコード ID。

戻り値

スタッフ

本文
ConstituentApi.ConstituentRead

スタッフを更新する

操作 ID:
EditConstituent

スタッフを更新します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

更新するスタッフのシステム レコード ID。
敬称
 title string

スタッフの主な役職 (個人のみ)。
名
 first string

スタッフの名 (個人のみ)。 文字数制限: 50。
姓
 last string

スタッフの姓 (個人のみ)。 文字数制限: 100。
組織名
 name string

個人の場合、これは編集操作には適用されない計算フィールドです。 組織の場合、このフィールドは必須であり、組織の名前を表します。 文字数制限: 100。
敬称
 suffix string

スタッフの主な敬称 (個人のみ)。
希望する名前
 preferred_name string

スタッフの希望する名前 (個人のみ)。 文字数制限: 50。
検索 ID
 lookup_id string

スタッフのユーザー定義した識別子。
性別
 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

スタッフは名誉/記念ですか？

スタッフ住所を作成する

操作 ID:
CreateConstituentAddress

スタッフ住所を新しく作成します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

住所に関連付けられたスタッフのシステム レコード ID。
住所の種類
 type True string

住所の種類。
国
 country string

住所の国 (ID、名前、または略語形の場合があります)。
住所行
 address_lines string

住所行。
市
 city string

住所の市 (区町村フィールドと組み合わせて使用しないでください)。
完了状態
 state string

住所の状態。
郵便番号
 postal_code string

住所の郵便番号。
区町村
 suburb string

住所の区町村 (市フィールドと組み合わせて使用しないでください)。
国
 county string

住所の郡。
情報元
 information_source string

住所の情報元。
リージョン
 region string

住所の地域。
CART
 cart string

住所の配送ルート (CART)。
LOT
 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

あいまいな日付で表した年。

戻り値

作成済みスタッフ住所

本文​​
ConstituentApi.CreatedConstituentAddress

スタッフ住所を更新する

操作 ID:
EditConstituentAddress

スタッフ住所を更新します。

パラメーター

名前 キー 必須 型 説明
住所 ID
 address_id True string

更新する住所のシステム レコード ID。
住所の種類
 type string

住所の種類。
国
 country string

住所の国 (ID、名前、または略語形の場合があります)。
住所行
 address_lines string

住所行。
市
 city string

住所の市 (区町村フィールドと組み合わせて使用しないでください)。
完了状態
 state string

住所の状態。
郵便番号
 postal_code string

住所の郵便番号。
区町村
 suburb string

住所の区町村 (市フィールドと組み合わせて使用しないでください)。
国
 county string

住所の郡。
情報元
 information_source string

住所の情報元。
リージョン
 region string

住所の地域。
CART
 cart string

住所の配送ルート (CART)。
LOT
 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

あいまいな日付で表した年。

スタッフ基金調達者を一覧表示する

操作 ID:
ListConstituentFundraiserAssignments

スタッフの基金調達者割り当てを一覧表示します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

スタッフのシステム レコード ID。
非アクティブを含む?
 include_inactive boolean

非アクティブな資金調達者の割り当てを含みますか？

戻り値

基金調達者の割り当て

Body
ConstituentApi.ApiCollectionOfFundraiserAssignmentRead

スタッフ学歴を一覧表示する

操作 ID:
ListConstituentEducations

スタッフの学歴レコードを一覧表示します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

スタッフのシステム レコード ID。

戻り値

学歴

本文​​
ConstituentApi.ApiCollectionOfEducationRead

スタッフ学歴を更新する

操作 ID:
EditConstituentEducation

スタッフ学歴を更新します。

パラメーター

名前 キー 必須 型 説明
学歴 ID
 education_id True string

更新する学歴レコードのシステム レコード ID。
学校
 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
 gpa double

成績平均点。
研究のテーマ
 subject_of_study string

研究のテーマ。
プライマリ?
 primary boolean

これはスタッフのプライマリ学校協会ですか?
主専攻
 majors array of string

研究の専攻コース。
副専攻
 minors array of string

研究の副専攻コース。
キャンパス
 campus string

キャンパス。 文字数制限: 50。
社会組織
 social_organization string

社会組織。 文字数制限: 50。
既知の名前
 known_name string

既知の名前。 文字数制限: 50。
学位の種類
 class_of_degree string

学位の種類。
部署
 department string

学科の名前。
学部
 faculty string

学部の名前。
登録番号
 registration_number string

登録番号。 文字数制限: 50。

スタッフ教育を作成する

操作 ID:
CreateConstituentEducation

新しいスタッフ教育を作成します。

パラメーター

名前 キー 必須 型 説明
スタッフ 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
 gpa double

成績平均点。
研究のテーマ
 subject_of_study string

研究のテーマ。
プライマリ?
 primary boolean

これはスタッフのプライマリ学校協会ですか?
主専攻
 majors array of string

研究の専攻コース。
副専攻
 minors array of string

研究の副専攻コース。
キャンパス
 campus string

キャンパス。 文字数制限: 50。
社会組織
 social_organization string

社会組織。 文字数制限: 50。
既知の名前
 known_name string

既知の名前。 文字数制限: 50。
学位の種類
 class_of_degree string

学位の種類 (英国バージョンにのみ適用可能)。
部署
 department string

学科の名前 (英国バージョンにのみ適用可能)。
学部
 faculty string

学部の名前 (英国バージョンにのみ適用可能)。
登録番号
 registration_number string

登録番号 (英国バージョンにのみ適用可能)。 文字数制限: 50。

戻り値

作成済みスタッフ教育

本文​​
ConstituentApi.CreatedConstituentEducation

スタッフ添付資料を一覧表示する

操作 ID:
ListConstituentAttachments

スタッフの添付資料を一覧表示します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

スタッフのシステム レコード ID。

戻り値

Attachments

本文​​
ConstituentApi.ApiCollectionOfConstituentAttachmentRead

スタッフ添付資料を作成する

操作 ID:
CreateConstituentAttachment

新しいスタッフ添付資料を作成します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 parent_id True string

添付資料に関連付けられたスタッフのシステム レコード ID。
タイプ
 type True string

添付資料の種類。 物理的な添付資料は、ローカルまたはネットワークに保存されている画像、PDF、Word 文書などのアップロードされたファイルです。 これらはシステムに保存および管理されます。 リンク添付資料は、オンラインまたはクラウド ストレージ アカウントにある画像、ブログ投稿、または YouTube ビデオにリンクしています。 それらは外部に保存および管理されます。
件名
 name string

添付資料の名前。 文字数制限: 150。
日
 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

添付ファイルに関連付けられているタグ

戻り値

作成したスタッフの添付ファイル

Body
ConstituentApi.CreatedConstituentAttachment

スタッフ添付資料を更新する

操作 ID:
EditConstituentAttachment

スタッフ添付資料を更新します。

パラメーター

名前 キー 必須 型 説明
添付ファイル ID
 attachment_id True string

更新する添付資料のシステム レコード ID。
件名
 name string

添付資料の名前。 文字数制限: 150。
日
 date date-time

添付資料の日付 (例: '2020-09-18T04:13:56Z')。
URL
 url string

添付資料の URL。 これはリンク添付ファイルに必要であり、物理的な添付ファイルには適用されません。
Tags
 tags array of string

添付ファイルに関連付けられているタグ

スタッフ要請コードを作成する

操作 ID:
CreateConstituentSolicitCode

新しいスタッフ要請コードを作成します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

要請コードに関連付けられたスタッフのシステム レコード ID。
要請コード
 solicit_code True string

スタッフに対する通信指示や制限。
開始日
 start_date date

要請コードの開始日 (例: '2005-09-18')。
終了日
 end_date date

送信要求コードの終了日 (例: '2005-09-18')。

戻り値

作成したスタッフ送信請求コード

本文
CommPrefApi.CreatedConstituentSolicitCode

スタッフ要請コードを更新する

操作 ID:
EditConstituentSolicitCode

スタッフ要請コードを更新します。

パラメーター

名前 キー 必須 型 説明
要請コード ID
 constituent_solicit_code_id True string

更新する要請コードのシステム レコード ID。
要請コード
 solicit_code string

スタッフに対する通信指示や制限。
開始日
 start_date date

要請コードの開始日 (例: '2005-09-18')。
終了日
 end_date date

要請コードの終了日 (例: '2005-09-18')。

スタッフ関連付けをリストする

操作 ID:
ListConstituentRelationships

スタッフの関連付けをリストします。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

スタッフのシステム レコード ID。
制限
 limit integer

返されるレコード数を表します。 既定値は 500 です。 最大数はありません。
オフセット
 offset integer

スキップするレコード数を表します。 改ページで使用します。

戻り値

関係

本文​​
ConstituentApi.ApiCollectionOfRelationshipRead

スタッフ関連付けを更新する

操作 ID:
EditConstituentRelationship

スタッフの関連付けを更新します。 相互関係が存在する場合は、変更を反映するようにも変更されます。 これには、各レコードに固有であり、各レコードで個別に変更できる "コメント" プロパティへの変更は含まれません。

パラメーター

名前 キー 必須 型 説明
リレーションシップ ID
 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 string

組織内での個人のポジション。 組織と個人間のリレーションシップにのみ適用されます。 文字数制限: 50。

トリビュート アクノリッジ リスト

操作 ID:
ListTributeAcknowledgees

トリビュートのアクノリッジを一覧表示します。

パラメーター

名前 キー 必須 型 説明
トリビュート ID
 tributeId True integer

トリビュートのシステム レコード ID

戻り値

トリビュート アクノリッジ

本文
NXTDataIntegrationApi.TributeAcknowledgeeCollection

トリビュート アクノリッジを作成

操作 ID:
CreateTributeAcknowledgee

新しいトリビュート アクノリッジを作成します。

パラメーター

名前 キー 必須 型 説明
トリビュート ID
tribute_id True integer

アクノリッジに関連付けられたトリビュートのシステム レコード ID。
リレーションシップ ID
 relationship_id integer

リレーションシップののシステム レコード ID (null の場合、これは自己確認を表します)。
レター ID
 letter_id integer

レター ID。

戻り値

作成されたトリビュート アクノリッジ

本文
NXTDataIntegrationApi.CreatedTributeAcknowledgee

個々のリレーションシップを作成する

操作 ID:
CreateIndividualRelationship

新しい関連付けを作成します。 別のスタッフとの関連付けである場合、そのスタッフに対して相互関係が作成されます。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

関連付けに関連付けられたスタッフのシステム レコード ID。
関係 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

関係に関する追加のメモです。

戻り値

作成した個人の関係

本文​​
ConstituentApi.CreatedIndividualRelationship

個人スタッフを作成する

操作 ID:
CreateIndividualConstituent

新しい個人スタッフを作成します。

パラメーター

名前 キー 必須 型 説明
敬称
 title string

スタッフの主な役職。
名
 first string

スタッフの名。 文字数制限: 50。
姓
 last True string

スタッフの姓。 文字数制限: 100。
敬称
 suffix string

スタッフの主な敬称。
検索 ID
 lookup_id string

スタッフのユーザー定義した識別子。
種類
 type True string

住所の種類。
country
 country string

住所の国 (ID、名前、または略語形の場合があります)。
行数
 address_lines string

住所行。 文字数制限: 150。
city
 city string

住所の市 (区町村フィールドと組み合わせて使用しないでください)。
状態
 state string

住所の状態。
郵便番号
 postal_code string

住所の郵便番号。 文字数制限: 12。
区町村
 suburb string

住所の区町村 (市フィールドと組み合わせて使用しないでください)。
county
 county string

住所の郡。
開始
 start date

スタッフがこの住所に居住し始めた日付 (例: '2005-09-18')。
終了
 end date

スタッフがこの住所に居住しなくなった日付 (例: '2005-09-18')。
種類
 type True string

電話番号の種類。
数値
 number True string

電話番号。
プライマリ?
 primary boolean

これはスタッフの優先電話番号ですか?
種類
 type True string

電子メール アドレスの種類。
アドレス
 address True string

電子メール アドレス。
プライマリ?
 primary boolean

これはスタッフの優先電子メール アドレスですか?
種類
 type True string

オンライン プレゼンスの種類。
アドレス
 address True string

オンライン プレゼンスの Web アドレス。
プライマリ?
 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

スタッフは名誉/記念ですか？

戻り値

作成済み個々のスタッフ

本文
ConstituentApi.CreatedIndividualConstituent

基金調達者の割り当てを一覧で表示する

操作 ID:
ListFundraiserAssignments

基金調達者の割り当てを一覧で表示します。

パラメーター

名前 キー 必須 型 説明
基金調達者 ID
 fundraiser_id True string

割り当てを返す対象の基金調達者を表すシステム レコード ID。
制限
 limit integer

返されるレコード数を表します。 既定値は 500 です。 最大値は 5000 です。
オフセット
 offset integer

スキップするレコード数を表します。 改ページで使用します。

戻り値

割り当て

本文
FundraisingApi.ApiCollectionOfFundraiserAssignmentRead

基金調達者の割り当てを作成する

操作 ID:
CreateFundraiserAssignment

新しい基金調達者の割り当てを作成します。

パラメーター

名前 キー 必須 型 説明
基金調達者 ID
 fundraiser_id True string

基金調達者のシステム レコード ID。
スタッフ ID
 constituent_id True string

割り当て済みスタッフのシステム レコード ID。
タイプ
 type string

資金調達者のタイプ。
割り当て開始
 start date-time

割り当ての開始日 (例: '2020-09-18T04:13:56Z')。
割り当て終了
 end date-time

割り当ての終了日 (例: '2020-09-18T04:13:56Z')。
Amount
 value True double

割り当てられたスタッフに求める資金調達の目標金額。
キャンペーン ID
 campaign_id string

ギフトを適用することになる、キャンペーン対象のシステム レコード ID。
資金 ID
 fund_id string

ギフトを適用することになる、資金対象のシステム レコード ID。
訴求力 ID
 appeal_id string

ギフトを適用することになる、異議申し立てのシステム レコード ID。

戻り値

作成した基金調達者の割り当て

本文
FundraisingApi.CreatedFundraiserAssignment

検索 ID でスタッフを取得する

操作 ID:
GetConstituentIdFromLookupId

指定された検索 ID からスタッフのシステム レコード ID を返します。

パラメーター

名前 キー 必須 型 説明
検索 ID
 constituent_id True string

スタッフ検索 ID。

戻り値

スタッフ ID マップ

本文
NXTDataIntegrationApi.ConstituentIdMap

組織のリレーションシップを作成する

操作 ID:
CreateOrganizationRelationship

新しい組織の関連付けを作成します。 別のスタッフとの関連付けである場合、そのスタッフに対して相互関係が作成されます。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

関連付けに関連付けられたスタッフのシステム レコード ID。
関係 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 string

組織内での個人のポジション。 文字数制限: 50。
プライマリ事業?
 is_primary_business boolean

これはスタッフのプライマリ事業ですか?
メモ
comment string

関係についての追加メモ。

戻り値

作成済み組織の関連付け

本文​​
ConstituentApi.CreatedOrganizationRelationship

組織スタッフを作成する

操作 ID:
CreateOrganizationConstituent

新しい組織スタッフ作成します。

パラメーター

名前 キー 必須 型 説明
件名
 name True string

組織名。 文字数制限: 100。
検索 ID
 lookup_id string

スタッフのユーザー定義した識別子。
種類
 type True string

住所の種類。
country
 country string

住所の国 (ID、名前、または略語形の場合があります)。
行数
 address_lines string

住所行。 文字数制限: 150。
city
 city string

住所の市 (区町村フィールドと組み合わせて使用しないでください)。
状態
 state string

住所の状態。
郵便番号
 postal_code string

住所の郵便番号。 文字数制限: 12。
区町村
 suburb string

住所の区町村 (市フィールドと組み合わせて使用しないでください)。
county
 county string

住所の郡。
開始
 start date

スタッフがこの住所に居住し始めた日付 (例: '2005-09-18')。
終了
 end date

スタッフがこの住所に居住しなくなった日付 (例: '2005-09-18')。
種類
 type True string

電話番号の種類。
数値
 number True string

電話番号。
プライマリ?
 primary boolean

これはスタッフの優先電話番号ですか?
種類
 type True string

電子メール アドレスの種類。
アドレス
 address True string

電子メール アドレス。
プライマリ?
 primary boolean

これはスタッフの優先電子メール アドレスですか?
種類
 type True string

オンライン プレゼンスの種類。
アドレス
 address True string

オンライン プレゼンスの Web アドレス。
プライマリ?
 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

スタッフは名誉/記念ですか？

戻り値

作成した組織スタッフ

本文
ConstituentApi.CreatedOrganizationConstituent

要請コードを一覧表示する

操作 ID:
ListConstituentSolicitCodes

スタッフの要請コードを一覧表示します。

パラメーター

名前 キー 必須 型 説明
スタッフ ID
 constituent_id True string

スタッフのシステム レコード ID。

戻り値

送信請求コード

本文
CommPrefApi.ConstituentSolicitCodeReadCollection

重複構成要素の検索

操作 ID:
GetDuplicateSearchResults

個人、組織、関連する連絡先レコードを検索し、指定された検索フィルターに基づいて潜在的な重複をランク付けします。 複数のフィルターに一致するレコードは、潜在的な重複としてランク付けされます。

パラメーター

名前 キー 必須 型 説明
姓/組織名
 last_org_name True string

指定された姓または組織名に一致するレコードのフィルター。
First name
 first_name string

指定した名と一致する個々のレコードに対するフィルター。
ミドル ネーム
 middle_name string

指定したミドルネームと一致する個々のレコードに対するフィルター。
Suffix
 suffix string

指定した敬称と一致する個々のレコードに対するフィルター。
住所 (ブロック)
 address_block string

指定したアドレス ブロックと一致するレコードに対するフィルター。
都市
 city string

指定された街に一致するレコードのフィルター。
状態
 state string

指定された州に一致するレコードのフィルター。
Postal code
 post_code string

指定された郵便番号に一致するレコードのフィルター。
メール
 email array

指定したメール アドレスと一致するレコードに対するフィルター。
電話番号
 phone array

指定した電話番号と一致するレコードに対するフィルター。
個人を検索しますか ?
 search_individuals boolean

重複する個々のレコードを検索しますか ?
エイリアスを検索しますか ?
 search_aliases boolean

姓/組織名パラメータで指定されたエイリアスで検索しますか ?
取引先担当者を検索しますか ?
 search_contacts boolean

リレーションシップ取引先担当者レコードを検索しますか ?
Limit
 limit integer

結果をページする際に返すレコードの数 (規定 = 3)。
ページ
 offset integer

結果をページングする際にスキップするレコードの数。

戻り値

検索結果の重複

Body
ConstituentApi.DuplicateSearchResultCollection

定義

CommPrefApi.ConstituentConsentRead

スタッフの同意エンティティを表します。

名前 パス 型 説明
ID
 id string

同意レコードのシステム レコード ID。
チャネル
 channel string

同意応答が適用されるチャネル。
カテゴリ
 category string

同意応答が適用されるカテゴリ。
ソース
 source string

スタッフからの同意応答のソース。
回答
 constituent_consent_response string

指定されたチャネル/カテゴリの同意に対するスタッフの応答方法。
日
 consent_date date-time

同意応答が受信された日付。
同意書
 consent_statement string

同意時にスタッフが応答したステートメント。
プライバシー通知
 privacy_notice string

スタッフに提供されるプライバシーに関する声明。
追加した日付
 date_added date-time

同意応答が追加された日付。
追加者
 user_name string

同意応答を追加したユーザー。

CommPrefApi.ConstituentConsentReadCollection

同意レコード

名前 パス 型 説明
カウント
 count integer

一覧内の同意レコードの数。
値
 value array of CommPrefApi.ConstituentConsentRead

応答に含まれる一連の同意レコード。

CommPrefApi.ConstituentSolicitCodeRead

要請コード

名前 パス 型 説明
ID
 id string

スタッフ要請コードのシステム レコード ID。
要請コード
 solicit_code string

スタッフに対する通信指示や制限。
開始日
 start_date date

要請コードの開始日 (例: '2005-09-18')。
終了日
 end_date date

要請コードの終了日 (例: '2005-09-18')。

CommPrefApi.ConstituentSolicitCodeReadCollection

要請コード

名前 パス 型 説明
カウント
 count integer

一覧内のスタッフ要請コードの数。
値
 value array of CommPrefApi.ConstituentSolicitCodeRead

応答に含まれる一連のスタッフ要請コード。

CommPrefApi.CreatedConstituentConsent

作成済みスタッフ同意

名前 パス 型 説明
ID
 id string

新しく作成された同意レコードの ID。

CommPrefApi.CreatedConstituentSolicitCode

作成済みスタッフ要請コード

名前 パス 型 説明
ID
 id string

新しく作成されたスタッフ要請コードの ID。

ConstituentApi.AddressRead

住所

名前 パス 型 説明
ID
 id string

住所のシステム レコード ID。
タイプ
 type string

住所の種類。
国
 country string

住所の国 (ID、名前、または略語形の場合があります)。
住所行
 address_lines string

住所行。
市
 city string

住所の市 (区町村フィールドと組み合わせて使用しないでください)。
完了状態
 state string

住所の状態。
郵便番号
 postal_code string

住所の郵便番号。
区町村
 suburb string

住所の区町村 (市フィールドと組み合わせて使用しないでください)。
国
 county string

住所の郡。
書式設定された住所
 formatted_address string

国の構成済み形式で書式設定された住所。
情報元
 information_source string

住所の情報元。
リージョン
 region string

住所の地域。
CART
 cart string

住所の配送ルート (CART)。
LOT
 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.AliasRead

エイリアス

名前 パス 型 説明
ID
 id string

エイリアスのシステム レコード ID。
エイリアス
 name string

スタッフのエイリアスとして使用する名前。
タイプ
 type string

エイリアスの種類。

ConstituentApi.ApiCollectionOfAddressRead

住所

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of ConstituentApi.AddressRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

ConstituentApi.ApiCollectionOfAliasRead

エイリアス

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of ConstituentApi.AliasRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

ConstituentApi.ApiCollectionOfConstituentAttachmentRead

Attachments

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of ConstituentApi.ConstituentAttachmentRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

ConstituentApi.ApiCollectionOfConstituentCodeRead

スタッフ コード

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of ConstituentApi.ConstituentCodeRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

ConstituentApi.ApiCollectionOfConstituentCustomFieldRead

カスタム フィールド

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of ConstituentApi.ConstituentCustomFieldRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

ConstituentApi.ApiCollectionOfConstituentRead

スタッフ

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of ConstituentApi.ConstituentRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

ConstituentApi.ApiCollectionOfEducationRead

学歴

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of ConstituentApi.EducationRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

ConstituentApi.ApiCollectionOfEmailAddressRead

電子メール アドレス

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of ConstituentApi.EmailAddressRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

ConstituentApi.ApiCollectionOfFundraiserAssignmentRead

基金調達者の割り当て

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of ConstituentApi.FundraiserAssignmentRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

ConstituentApi.ApiCollectionOfMembershipRead

メンバーシップ

名前 パス 型 説明
数
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of ConstituentApi.MembershipRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

ConstituentApi.ApiCollectionOfNoteRead

メモ

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of ConstituentApi.NoteRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

ConstituentApi.ApiCollectionOfOnlinePresenceRead

オンライン プレゼンス

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of ConstituentApi.OnlinePresenceRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

ConstituentApi.ApiCollectionOfPhoneRead

電話

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of ConstituentApi.PhoneRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

ConstituentApi.ApiCollectionOfRelationshipRead

関係

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of ConstituentApi.RelationshipRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

ConstituentApi.ApiCollectionOfSearchResultRead

検索結果

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of ConstituentApi.SearchResultRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

ConstituentApi.ConstituentAttachmentRead

添付

名前 パス 型 説明
ID
 id string

添付資料のシステム レコード ID。
スタッフ ID
 parent_id string

添付資料に関連付けられたスタッフのシステム レコード ID。
タイプ
 type string

添付資料の種類。 物理的な添付資料は、ローカルまたはネットワークに保存されている画像、PDF、Word 文書などのアップロードされたファイルです。 これらはシステムに保存および管理されます。 リンク添付資料は、オンラインまたはクラウド ストレージ アカウントにある画像、ブログ投稿、または YouTube ビデオにリンクしています。 それらは外部に保存および管理されます。
件名
 name string

添付資料の名前。 文字数制限: 150。
日
 date date-time

添付資料の日付。
URL
 url string

添付資料の URL。 これはリンク添付資料に必要であり、物理的な添付資料には適用されません。
ファイル名
 file_name string

ファイルの名前。 文字数制限: 36。 物理的な添付資料のみ。
ファイル ID
 file_id string

ファイルの識別子。 文字数制限: 36。 物理的な添付資料のみ。
サムネイル ID
 thumbnail_id string

サムネイルの識別子。 文字数制限: 36。 物理的な添付資料のみ。
サムネイル URL
 thumbnail_url string

サムネイルの URL。 画像のみの物理的な添付資料の場合。 アクセスを 60 分に制限する、時間期限付きの署名が含まれます。
コンテンツ タイプ
 content_type string

コンテンツの種類。 物理的な添付資料のみ。
ファイル サイズ
 file_size integer

ファイル サイズ (バイト数)。 物理的な添付ファイルのみ。
タグ
 tags array of string

添付ファイルに関連付けられているタグ

ConstituentApi.ConstituentCodeRead

スタッフ コード

名前 パス 型 説明
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 integer

スタッフ コードに関連付けられた数列。
追加した日付
 date_added date-time

スタッフ コードが作成された日付。
変更日
 date_modified date-time

スタッフ コードが最終変更された日付。

ConstituentApi.ConstituentCustomFieldRead

カスタム フィールド

名前 パス 型 説明
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

カスタム フィールドの日付。
コメント
 comment string

カスタム フィールドのコメント。 文字数制限: 50。
追加した日付
 date_added date-time

カスタム フィールドが作成された日付。
変更日
 date_modified date-time

カスタム フィールドが最終変更された日付。

ConstituentApi.ConstituentRead

スタッフ

名前 パス 型 説明
ID
 id string

スタッフのシステム レコード ID。 これは、lookup_id に格納されているユーザー定義可能なスタッフ識別子と同じではありません。
タイプ
 type string

スタッフの種類。
敬称
 title string

スタッフの主な役職 (個人のみ)。
名
 first string

スタッフの名 (個人のみ)。
姓
 last string

スタッフの姓 (個人のみ)。
件名
 name string

個人の場合、このフィールドは、対象組織の表示名設定に基づくスタッフの氏名です。 組織の場合、これは組織の名前です。
希望する名前
 preferred_name string

スタッフの希望する名前 (個人のみ)。
敬称
 suffix string

スタッフの主な敬称 (個人のみ)。
検索 ID
 lookup_id string

スタッフのユーザー定義した識別子。
ID
 email.id string

電子メール アドレスのシステム レコード ID。
種類
 email.type string

電子メール アドレスの種類。
アドレス
 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

オンライン プレゼンスの Web アドレス。
非アクティブ?
 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

住所の区町村 (市フィールドと組み合わせて使用しないでください)。
county
 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

一致するギフト要素 (組織のみ)。
価値
 matching_gift_per_gift_min.value double

金額の値。
価値
 matching_gift_per_gift_max.value double

金額の値。
価値
 matching_gift_total_min.value double

金額の値。
価値
 matching_gift_total_max.value double

金額の値。
一致するギフト メモ
 matching_gift_notes string

スタッフの一致するギフト メモ (組織のみ)。
年齢
 age integer

生年月日プロパティに基づいて計算された、スタッフの年齢 (個人のみ)。
故人?
 deceased boolean

故人であるスタッフですか (個人のみ)?
日
 deceased_date.d integer

あいまいな日付で表した日。
月
 deceased_date.m integer

あいまいな日付で表した月。
年
 deceased_date.y integer

あいまいな日付で表した年。
基金調達者ステータス
 fundraiser_status string

スタッフが基金調達者であるかどうかを示します (個人のみ)。
記念ですか?
 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

変換済みのスタッフ

名前 パス 型 説明
ID
 id string

変換したスタッフの ID。

ConstituentApi.CreatedConstituentAddress

作成済みスタッフ住所

名前 パス 型 説明
ID
 id string

新しく作成されたスタッフ住所の ID。

ConstituentApi.CreatedConstituentAlias

作成済みスタッフ エイリアス

名前 パス 型 説明
ID
 id string

新しく作成されたスタッフ エイリアスの ID。

ConstituentApi.CreatedConstituentAttachment

作成済みスタッフ添付資料

名前 パス 型 説明
ID
 id string

新しく作成されたスタッフ添付資料の ID。

ConstituentApi.CreatedConstituentCode

作成済みスタッフ コード

名前 パス 型 説明
ID
 id string

新しく作成されたスタッフ コードの ID。

ConstituentApi.CreatedConstituentCustomField

作成済みスタッフのカスタム フィールド

名前 パス 型 説明
ID
 id string

新しく作成されたスタッフ カスタム フィールドの ID。

ConstituentApi.CreatedConstituentEducation

作成済みスタッフ教育

名前 パス 型 説明
ID
 id string

新しく作成されたスタッフ学歴の ID。

ConstituentApi.CreatedConstituentEmailAddress

作成済みスタッフの電子メール アドレス

名前 パス 型 説明
ID
 id string

新しく作成されたスタッフ電子メール アドレスの ID。

ConstituentApi.CreatedConstituentNote

作成済みスタッフ メモ

名前 パス 型 説明
ID
 id string

新しく作成されたスタッフ メモの ID。

ConstituentApi.CreatedConstituentOnlinePresence

作成済みスタッフのオンライン プレゼンス

名前 パス 型 説明
ID
 id string

新しく作成されたスタッフオンライン プレゼンスの ID。

ConstituentApi.CreatedConstituentPhone

作成済みスタッフの電話番号

名前 パス 型 説明
ID
 id string

新しく作成されたスタッフ電話番号の ID。

ConstituentApi.CreatedIndividualConstituent

作成済み個々のスタッフ

名前 パス 型 説明
ID
 id string

新しく作成された個々のスタッフの ID。

ConstituentApi.CreatedIndividualRelationship

作成済み個々の関係

名前 パス 型 説明
ID
 id string

新しく作成した個人の関係の ID。

ConstituentApi.CreatedNameFormat

作成した名前書式

名前 パス 型 説明
ID
 id string

新しく作成した名前書式の ID。

ConstituentApi.CreatedOrganizationConstituent

作成した組織スタッフ

名前 パス 型 説明
ID
 id string

新しく作成された組織スタッフの ID。

ConstituentApi.CreatedOrganizationRelationship

作成済み組織の関連付け

名前 パス 型 説明
ID
 id string

新しく作成された組織の関連付けの ID。

ConstituentApi.DuplicateSearchResult

検索結果の重複

名前 パス 型 説明
ID
 id string

スタッフのシステム レコード ID。
件名
 name string

スタッフ名。 個人の場合、この計算フィールドには、スタッフの対象組織の表示名の設定に基づいて氏名が表示されます。
表示名称
 display_name string

スタッフの表示名。
番地
 formatted_address string

スタッフの書式設定されたプライマリ アドレス。
故人?
 deceased boolean

このスタッフは故人ですか?
スタッフ?
 is_constituent boolean

レコードはスタッフですか?
検索 ID
 constituent_id string

スタッフのユーザー定義の識別子。
追加した日付
 date_added date-time

スタッフが追加された日付。
Rank
 rank string

スタッフが一致したものを示す検索ランク。

ConstituentApi.DuplicateSearchResultCollection

検索結果の重複

名前 パス 型 説明
数
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of ConstituentApi.DuplicateSearchResult

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

ConstituentApi.EducationRead

教育です

名前 パス 型 説明
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
 gpa double

成績平均点。
主専攻
 majors array of string

研究の専攻コース。
副専攻
 minors array of string

研究の副専攻コース。
プライマリ学歴?
 primary boolean

これはスタッフのプライマリ学校協会ですか?
キャンパス
 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

メール アドレス

名前 パス 型 説明
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

基金調達者の割り当て

名前 パス 型 説明
ID
 id string

基金調達者割り当てのシステム レコード ID。
スタッフ ID
 constituent_id string

基金調達者に割り当てられたスタッフのシステム レコード ID。
基金調達者 ID
 fundraiser_id string

基金調達者のシステム レコード ID。
タイプ
 type string

基金調達者の種類。
値
 amount.value double

金額。
キャンペーン ID
 campaign_id string

ギフトを適用することになる、キャンペーン対象のシステム レコード ID。
資金 ID
 fund_id string

任意のギフトを適用する必要がある、資金対象のシステム レコード ID。 制限付き資金が選択された場合、その資金に関連付けられたキャンペーンと異議申し立てのみを選択できます。
訴求力 ID
 appeal_id string

ギフトを要求するために資金調達者が使用すべきアピールのシステム レコード ID。
開始日
 start date-time

資金調達者の割り当て開始日。
終了日
 end date-time

資金調達者の割り当て終了日。

ConstituentApi.MembershipMemberRead

メンバー

名前 パス 型 説明
ID
 id string

メンバーのシステム レコード ID。
スタッフ ID
 constituent_id string

メンバーに関連付けられたスタッフのシステム レコード ID。
プライマリ メンバーですか?
 primary boolean

これはプライマリ メンバーですか?

ConstituentApi.MembershipRead

メンバーシップ

名前 パス 型 説明
ID
 id string

メンバーシップのシステム レコード ID。
スタッフ ID
 constituent_id string

メンバーシップに関連付けられたスタッフのシステム レコード ID。
プログラム
 program string

メンバーシップ プログラム。
Category
 category string

メンバーシップ カテゴリ。
サブカテゴリ
 subcategory string

メンバーシップ サブカテゴリ。
口座自動振替
 standing string

メンバーシップのステータス。
有効期限
 expires date-time

メンバーシップの有効期限が切れる日付。
参加済み
 joined date-time

メンバーシップが有効になる日付。
価値
 dues.value double

金額。
Members
 members array of ConstituentApi.MembershipMemberRead

メンバーシップに属するメンバーのセット。
追加した日付
 date_added date-time

メンバーシップを作成した日付。
変更日
 date_modified date-time

メンバーシップが最終変更された日付。

ConstituentApi.NameFormatRead

名前の書式によって、コミュニケーションで使用するスタッフの呼び方を定義します。 個人をどのように呼ぶかは、その人とのコミュニケーションの雰囲気を決め、対話の印象に影響します。

名前 パス 型 説明
ID
 id string

名前書式のシステム レコード ID。
type
 type string

名前の書式タイプ。
カスタム形式ですか?
 custom_format boolean

これはカスタム書式ですか?
構成 ID
 configuration_id string

名前書式の構成 ID (非カスタム書式用)。
書式設定済みの名前
 formatted_name string

書式設定済みの名前 (カスタム書式用)。

ConstituentApi.NameFormatSummaryRead

名前書式の概要

名前 パス 型 説明
ID
 primary_addressee.id string

名前書式のシステム レコード ID。
type
 primary_addressee.primary_type string

名前の書式タイプ。
カスタム形式ですか?
 primary_addressee.custom_format boolean

これはカスタム書式ですか?
構成 ID
 primary_addressee.configuration_id string

名前書式の構成 ID (非カスタム書式用)。
書式設定済みの名前
 primary_addressee.formatted_name string

書式設定済みの名前 (カスタム書式用)。
ID
 primary_salutation.id string

名前書式のシステム レコード ID。
type
 primary_salutation.primary_type string

名前の書式タイプ。
カスタム形式ですか?
 primary_salutation.custom_format boolean

これはカスタム書式ですか?
構成 ID
 primary_salutation.configuration_id string

名前書式の構成 ID (非カスタム書式用)。
書式設定済みの名前
 primary_salutation.formatted_name string

書式設定済みの名前 (カスタム書式用)。
追加の名前書式
 additional_name_formats array of ConstituentApi.NameFormatRead

スタッフに対する追加の名前書式。

ConstituentApi.NoteRead

メモ

名前 パス 型 説明
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

オンライン プレゼンス

名前 パス 型 説明
ID
 id string

オンライン プレゼンスのシステム レコード ID。
スタッフ ID
 constituent_id string

オンライン プレゼンスに関連付けられたスタッフのシステム レコード ID。
タイプ
 type string

オンライン プレゼンスの種類。
リンク
 address string

オンライン プレゼンスの Web アドレス。
プライマリ?
 primary boolean

これはスタッフの優先オンライン プレゼンスですか?
非アクティブ?
 inactive boolean

このオンライン プレゼンスは非アクティブですか?
追加した日付
 date_added date-time

オンライン プレゼンスが作成された日付。
変更日
 date_modified date-time

オンライン プレゼンスが最終変更された日付。

ConstituentApi.PhoneRead

電話

名前 パス 型 説明
ID
 id string

電話番号のシステム レコード ID。
スタッフ ID
 constituent_id string

電話番号に関連付けられたスタッフのシステム レコード ID。
タイプ
 type string

電話番号の種類。
数
 number string

電話番号。
プライマリ?
 primary boolean

これはスタッフの優先電話番号ですか?
電話不可?
 do_not_call boolean

この電話番号でスタッフに連絡できますか?
非アクティブ?
 inactive boolean

この電話番号は非アクティブですか?
追加した日付
 date_added date-time

電話番号が作成された日付。
変更日
 date_modified date-time

電話番号が最終変更された日付。

ConstituentApi.ProfilePictureRead

プロファイル画像

名前 パス 型 説明
スタッフ ID
 constituent_id string

プロフィール画像に関連付けられたスタッフのシステム レコード ID。
URL
 url string

プロファイル画像の URL。 URL にはアクセスを 60 分に制限する、時間期限付きの署名が含まれます。
サムネイル URL
 thumbnail_url string

プロフィール画像のサムネイルの URL。 アクセスを 60 分に制限する、時間期限付きの署名が含まれます。

ConstituentApi.RelationshipRead

Relationship

名前 パス 型 説明
ID
 id string

関係のシステム レコード ID。
スタッフ ID
 constituent_id string

関連付けに関連付けられたスタッフのシステム レコード ID。
関連 ID
 relation_id string

関連する個人や組織のシステム レコード ID。
相互関係 ID
 reciprocal_relationship_id string

相互の関係レコードの識別子。 この値は読み取り専用であり、関係の作成時に自動的に生成されます。 このレコードを変更すると、コメント プロパティ以外の相互関係に反映されます。
件名
 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 string

組織内での個人のポジション。 組織と個人間のリレーションシップにのみ適用されます。
追加した日付
 date_added date-time

関係の作成日。
変更日
 date_modified date-time

関係を最終変更した日付。

ConstituentApi.SearchResultRead

検索結果

名前 パス 型 説明
ID
 id string

スタッフのシステム レコード ID。
件名
 name string

スタッフ名。 個人の場合、この計算フィールドには、スタッフの対象組織の表示名の設定に基づいて氏名が表示されます。
住所
address string

スタッフの優先住所。
故人?
 deceased boolean

このスタッフは故人ですか?
電子メール
 email string

スタッフの電子メール アドレス。
資金調達者の状態
 fundraiser_status string

スタッフの資金調達者の状態。 個人の場合、この計算フィールドは、スタッフが「アクティブ」、「非アクティブ」、または「なし」のいずれであるかを示します。 組織の場合、この値は常に「なし」になります。
非アクティブ?
 inactive boolean

スタッフは非アクティブですか?
検索 ID
 lookup_id string

スタッフのユーザー定義の識別子。

FundraisingApi.ApiCollectionOfFundraiserAssignmentRead

割り当て

名前 パス 型 説明
カウント
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of FundraisingApi.FundraiserAssignmentRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

FundraisingApi.CreatedFundraiserAssignment

作成した基金調達者の割り当て

名前 パス 型 説明
ID
 id string

新しく作成した基金調達者割り当ての ID。

FundraisingApi.FundraiserAssignmentRead

割り当て

名前 パス 型 説明
ID
 id string

基金調達者割り当てのシステム レコード ID。
スタッフ ID
 constituent_id string

割り当て済みスタッフのシステム レコード ID。
タイプ
 type string

基金調達者の種類。
割り当て開始
 start date-time

割り当ての開始日。
割り当て終了
 end date-time

割り当ての終了日。
値
 amount.value double

金額。
キャンペーン ID
 campaign_id string

ギフトを適用することになる、キャンペーン対象のシステム レコード ID。
資金 ID
 fund_id string

ギフトを適用することになる、資金対象のシステム レコード ID。
訴求力 ID
 appeal_id string

ギフトを適用することになる、異議申し立てのシステム レコード ID。

NXTDataIntegrationApi.ConstituentIdMap

スタッフ ID マップ

名前 パス 型 説明
ID
 system_record_id integer

スタッフのシステム レコード ID。

NXTDataIntegrationApi.ConstituentSearchResult

検索結果

名前 パス 型 説明
ID
 record_id integer

スタッフのシステム レコード ID。
検索 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
 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

スタッフ

名前 パス 型 説明
結果
 results array of NXTDataIntegrationApi.ConstituentSearchResult

応答に含まれる項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

NXTDataIntegrationApi.CreatedConstituentTribute

作成したスタッフのトリビュート

名前 パス 型 説明
ID
 id string

新しく作成したスタッフ トリビュート ID。

NXTDataIntegrationApi.CreatedTributeAcknowledgee

作成されたトリビュート アクノリッジ

名前 パス 型 説明
ID
 id string

新しく作成したスタッフ トリビュートの謝辞の ID。

NXTDataIntegrationApi.Tribute

トリビュート

名前 パス 型 説明
ID
 id integer

トリビュートのシステム レコード ID
スタッフ ID
 constituent_record_id integer

トリビュートに関連付けられたスタッフのシステム レコード ID。
トリビュート タイプ
 tribute_type_name string

トリビュートのタイプ。
トリビュート タイプ ID
 tribute_type_id integer

トリビュート タイプ ID。
説明
 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

あいまいな日付で表した年。
既定の資金 ID
 default_fund_id integer

トリビュートに関連付けられた既定の資金のシステム レコード ID。
メモ
 notes string

トリビュート メモ。
アクティブ?
 is_active boolean

このトリビュートはアクティブですか?
シーケンス
 sequence integer

トリビュート シーケンスです。
追加した日付
 date_added date-time

トリビュートを作成した日付。
変更日
 date_modified date-time

トリビュートが最終変更された日付。

NXTDataIntegrationApi.TributeAcknowledgee

トリビュート アクノリッジ

名前 パス 型 説明
ID
 id integer

トリビュート アクノリッジのシステム レコード ID。
トリビュート ID
 tribute_id integer

アクノリッジに関連付けられたトリビュートのシステム レコード ID。
リレーションシップ ID
 relationships_id integer

リレーションシップののシステム レコード ID (null の場合、これは自己確認を表します)。
レター ID
 letter integer

レター ID。
シークエンス
 sequence integer

トリビュート アクノリッジ シーケンス。

NXTDataIntegrationApi.TributeAcknowledgeeCollection

トリビュート アクノリッジ

名前 パス 型 説明
数
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of NXTDataIntegrationApi.TributeAcknowledgee

応答に含まれる項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

NXTDataIntegrationApi.TributeCollection

トリビュート

名前 パス 型 説明
数
 count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。
値
 value array of NXTDataIntegrationApi.Tribute

応答に含まれる項目セット。 これはコレクションが含む項目のサブセットである可能性があります。