Blackbaud Raisers Edge NXT Events
Blackbaud Raiser's Edge NXT は、非営利団体と社会貢献コミュニティ全体のために特別に構築された、包括的なクラウドベースの資金調達および寄付者管理ソフトウェア ソリューションです。 イベント コネクタを使用して、イベントと参加者を管理します。
このコネクタは、次の製品および地域で利用可能です。
| 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 内の以下のようなイベントおよび関連エンティティを管理するのに役立つ操作を提供します:
- イベント
- 参加者
- 料金と寄付
- その他...
詳細については、ドキュメントを参照してください。
前提条件
このコネクタを使用するには、1 つ以上の Blackbaud 環境にアクセスできる Blackbaud ID アカウントが必要です。
さらに、組織の管理者は、この コネクタが Blackbaud 環境にアクセスできるようにするために、システム内で管理者レベルのアクションも実行する必要があります。 これらの前提条件の詳細については、初期設定ドキュメントを参照してください。
資格情報の入手方法
組織の管理者は、組織の Raiser's Edge NXT 環境への招待状を送信し、環境内でユーザー アカウントのアクセス許可を構成します。 このコネクタを使用するために追加の資格情報は必要ありません。
既知の問題と制限事項
コネクタはユーザー アカウントのコンテキストで機能するため、環境内のユーザー アクセス許可が適用されます。
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| イベントの参加者オプションを一覧表示する |
イベントの参加者オプションを一覧表示します。 |
| イベントの参加者オプションを作成する |
イベントの新しい参加者オプションを作成します。 |
| イベントを一覧表示する |
イベントの一覧を返します。 |
| イベントを作成する |
新しいイベントを作成します。 |
| イベントを取得する |
イベントに関する情報を返します。 |
| イベントを更新する |
イベントに関する詳細を更新します。 |
| イベント参加者を一覧表示する |
イベントの参加者を一覧表示します。 |
| イベント手数料を一覧表示する |
イベントの手数料を一覧表示します。 |
| イベント料金を作成する |
イベントの新しい料金を作成します。 |
| イベント添付ファイルのリスト |
イベントの添付ファイルをリストする。 |
| イベント添付ファイルの作成 |
新しいイベント添付資料を作成します。 |
| イベント添付ファイルを更新する |
イベント添付ファイルを更新します。 |
| 参加者の寄付を一覧で表示する |
参加者の寄付を一覧で表示します。 |
| 参加者の寄付を作成する |
参加者の新しい寄付を作成します。 |
| 参加者の手数料を一覧表示する |
参加者の手数料を一覧表示します。 |
| 参加者の手数料支払を一覧表示する |
参加者の手数料支払を一覧表示します。 |
| 参加者の手数料支払を作成する |
参加者の新しい手数料支払を作成します。 |
| 参加者を作成する |
イベントの新しい参加者を作成します。 |
| 参加者を取得する |
特定のイベント参加者に関する情報を返します。 |
| 参加者を更新する |
参加者に関する詳細を更新します。 |
| 参加者オプションを一覧表示する |
参加者の参加者オプションを一覧表示します。 |
| 参加者オプションを作成する |
参加者の新しい参加者オプションを作成します。 |
| 参加者オプションを更新する |
参加者オプションに関する詳細を更新します。 |
| 参加者費用を作成する |
参加者の新しい費用を作成します。 |
イベントの参加者オプションを一覧表示する
イベントの参加者オプションを一覧表示します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
イベント ID
|
event_id | True | string |
イベントの ID。 |
戻り値
イベントの参加者オプション
イベントの参加者オプションを作成する
イベントの新しい参加者オプションを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
イベント ID
|
event_id | True | string |
イベントの ID。 |
|
件名
|
name | True | string |
イベント参加者オプションの名前。 |
|
入力の種類
|
input_type | True | string |
参加者が応答を提供するために使用できる値の種類。 |
|
複数選択を許可?
|
multi_select | boolean |
一覧に対して複数の値を許可しますか? |
|
|
名前
|
name | string |
一覧オプションの名前。 |
|
|
sequence
|
sequence | integer |
注文に使用される 0 ベースのシーケンス。 |
戻り値
作成済みイベントの参加者オプション
イベントを一覧表示する
イベントの一覧を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
カテゴリ
|
category | string |
イベント カテゴリに基づいてフィルタリングします。 |
|
|
検索 ID
|
lookup_id | string |
イベント レコードのカスタム識別子に一致する結果のフィルター。 |
|
|
開始日 (から)
|
start_date_from | date |
指定した日付以降に開始日があるイベントに結果をフィルタリングします (例: '2020-09-18')。 |
|
|
開始日 (まで)
|
start_date_to | date |
指定した日付以前に開始日があるイベントに結果をフィルタリングします (例: '2020-09-18')。 |
|
|
非アクティブを含む?
|
include_inactive | boolean |
非アクティブなセッションを含みますか? |
|
|
制限
|
limit | integer |
返されるレコード数を表します。 既定値は 500 です。 最大値は 10000 です。 |
|
|
オフセット
|
offset | integer |
スキップするレコード数を表します。 改ページで使用します。 |
|
|
イベント ID
|
event_id | string |
指定されたシステム レコード ID に一致するイベントをフィルタリングします。 |
|
|
件名
|
name | string |
指定された名前に一致するイベントをフィルタリングします。 |
|
|
以降に追加済
|
date_added | date-time |
指定した日付以降に作成されたイベントに結果をフィルタリングします (例: '2020-09-18T04:13:56Z')。 |
|
|
以降に修正済
|
last_modified | date-time |
指定した日付以降に修正されたイベントに結果をフィルタリングします (例: '2020-09-18T04:13:56Z')。 |
戻り値
イベント
イベントを作成する
新しいイベントを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
イベント名
|
name | True | string |
イベントの名前です。 |
|
内容
|
description | string |
イベントの説明。 |
|
|
カテゴリ
|
name | True | string |
カテゴリ名。 |
|
開始日
|
start_date | True | date |
イベントの開始日 (例: '2020-09-18')。 |
|
開始時刻
|
start_time | string |
イベントの開始時刻 (例: '07:30')。 |
|
|
終了日
|
end_date | date |
イベントの終了日 (例: '2020-09-18')。 |
|
|
終了時刻
|
end_time | string |
イベントの終了時刻 (例: '07:30')。 |
|
|
検索 ID
|
lookup_id | string |
イベントの検索 ID。 |
|
|
容量
|
capacity | integer |
イベントに参加できる人数。 |
|
|
目標
|
goal | double |
イベントの目標金額。 |
|
|
キャンペーン ID
|
campaign_id | string |
イベントに関連付けられたキャンペーンのシステム レコード ID。 |
|
|
資金 ID
|
fund_id | string |
イベントに関連付けられた資金のシステム レコード ID。 |
|
|
非アクティブですか?
|
inactive | boolean |
イベントはアクティブですか? |
戻り値
作成したイベント
イベントを取得する
イベントに関する情報を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
イベント ID
|
event_id | True | string |
取得するイベントのシステム レコード ID。 |
戻り値
イベント
- Body
- EventApi.Event
イベントを更新する
イベントに関する詳細を更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
イベント ID
|
event_id | True | string |
更新するイベントのシステム レコード ID。 |
|
イベント名
|
name | string |
イベントの名前です。 |
|
|
内容
|
description | string |
イベントの説明。 |
|
|
カテゴリ
|
name | True | string |
カテゴリ名。 |
|
開始日
|
start_date | date |
イベントの開始日 (例: '2020-09-18')。 |
|
|
開始時刻
|
start_time | string |
イベントの開始時刻 (例: '07:30')。 |
|
|
終了日
|
end_date | date |
イベントの終了日 (例: '2020-09-18')。 |
|
|
終了時刻
|
end_time | string |
イベントの終了時刻 (例: '07:30')。 |
|
|
検索 ID
|
lookup_id | string |
イベントの検索 ID。 |
|
|
容量
|
capacity | integer |
イベントに参加できる人数。 |
|
|
目標
|
goal | double |
イベントの目標金額。 |
|
|
キャンペーン ID
|
campaign_id | string |
イベントに関連付けられたキャンペーンのシステム レコード ID。 |
|
|
資金 ID
|
fund_id | string |
イベントに関連付けられた資金のシステム レコード ID。 |
|
|
非アクティブですか?
|
inactive | boolean |
イベントはアクティブですか? |
イベント参加者を一覧表示する
イベントの参加者を一覧表示します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
イベント ID
|
event_id | True | string |
イベントのシステム レコード ID。 |
|
RSVP ステータス
|
rsvp_status | string |
RSVP ステータスに基づいて参加者をフィルタリングします。 |
|
|
招待の状態
|
invitation_status | string |
招待の状態に基づいて参加者をフィルタリングします。 |
|
|
参加レベル
|
participation_level | string |
関与のレベルに基づいて参加者をフィルタリングします。 |
|
|
参加済?
|
attended_filter | boolean |
出席済みとしてマークされた参加者を含めるかまたは除外するかをフィルタリングします。 |
|
|
手数料支払済?
|
fees_paid_filter | boolean |
手数料を支払った参加者を含めるか除外するかをフィルタリングします。 |
|
|
制限
|
limit | integer |
返されるレコード数を表します。 既定値は 500 です。 最大値は 10000 です。 |
|
|
オフセット
|
offset | integer |
スキップするレコード数を表します。 改ページで使用します。 |
|
|
スタッフ?
|
is_constituent_filter | boolean |
スタッフである参加者を含めるかまたは除外するかをフィルタリングします。 |
|
|
対象となる電子メールあり?
|
email_eligible_filter | boolean |
「電子メール不可」とマークされていない既定電子メール アドレスがあるかどうかに基づいて、参加者を含めるか除外するかをフィルタリングします。 |
|
|
対象となる電話番号あり?
|
phone_call_eligible_filter | boolean |
「電話不可」とマークされていない既定の電話番号があるかどうかに基づいて、参加者を含めるか除外するかをフィルタリングします。 |
|
|
件名
|
name | string |
指定された名前に一致する参加者をフィルタリングします。 |
|
|
以降に追加済
|
date_added | date-time |
指定した日付以降に作成された参加者に結果をフィルタリングします (例: '2020-09-18T04:13:56Z')。 |
|
|
以降に修正済
|
last_modified | date-time |
指定した日付以降に修正された参加者に結果をフィルタリングします (例: '2020-09-18T04:13:56Z')。 |
戻り値
参加者
イベント手数料を一覧表示する
イベントの手数料を一覧表示します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
イベント ID
|
event_id | True | string |
イベントのシステム レコード ID。 |
戻り値
手数料
イベント料金を作成する
イベントの新しい料金を作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
イベント ID
|
event_id | True | string |
イベントのシステム レコード ID。 |
|
件名
|
name | True | string |
料金の名前。 |
|
手数料金額
|
cost | True | double |
手数料に関連する金額。 |
|
寄付額
|
contribution_amount | True | double |
イベントの費用を超える寄付金の金額。 |
戻り値
作成済みイベント料金
イベント添付ファイルのリスト
イベントの添付ファイルをリストする。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
イベント ID
|
event_id | True | string |
イベントのシステム レコード ID。 |
戻り値
Attachments
イベント添付ファイルの作成
新しいイベント添付資料を作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
イベント ID
|
event_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 |
添付ファイルに関連付けられているタグ |
戻り値
作成したイベント添付ファイル
イベント添付ファイルを更新する
イベント添付ファイルを更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
イベント ID
|
event_id | True | string |
イベントのシステム レコード ID。 |
|
Attachment 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
|
participant_id | True | string |
参加者のシステム レコード ID。 |
|
制限
|
limit | integer |
返されるレコード数を表します。 既定値は 500 です。 最大値は 10000 です。 |
|
|
オフセット
|
offset | integer |
スキップするレコード数を表します。 改ページで使用します。 既定値は 0 です。 |
戻り値
寄付
参加者の寄付を作成する
参加者の新しい寄付を作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
参加者 ID
|
participant_id | True | string |
参加者のシステム レコード ID。 |
|
ギフト ID
|
gift_id | True | string |
参加者の寄付をリンクしたギフトのシステム レコード ID。 |
戻り値
参加者の寄付を作成する
参加者の手数料を一覧表示する
参加者の手数料を一覧表示します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
参加者 ID
|
participant_id | True | string |
参加者のシステム レコード ID。 |
|
制限
|
limit | integer |
返されるレコード数を表します。 既定値は 500 です。 最大値は 10000 です。 |
|
|
オフセット
|
offset | integer |
スキップするレコード数を表します。 改ページで使用します。 既定値は 0 です。 |
戻り値
手数料
参加者の手数料支払を一覧表示する
参加者の手数料支払を一覧表示します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
参加者 ID
|
participant_id | True | string |
参加者のシステム レコード ID。 |
|
制限
|
limit | integer |
返されるレコード数を表します。 既定値は 500 です。 最大値は 10000 です。 |
|
|
オフセット
|
offset | integer |
スキップするレコード数を表します。 改ページで使用します。 既定値は 0 です。 |
戻り値
手数料支払
参加者の手数料支払を作成する
参加者の新しい手数料支払を作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
参加者 ID
|
participant_id | True | string |
参加者のシステム レコード ID。 |
|
ギフト ID
|
gift_id | True | string |
参加者費用をリンクしたギフトのシステム レコード ID。 |
|
適用済み金額
|
applied_amount | True | double |
参加者費用に適用される支払い額。 |
戻り値
作成済み参加者の手数料支払
参加者を作成する
イベントの新しい参加者を作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
イベント ID
|
event_id | True | string |
イベントのシステム レコード ID。 |
|
スタッフ ID
|
constituent_id | True | string |
参加者のスタッフ ID。 |
|
ホスト ID
|
host_id | string |
ホストの参加者レコードの ID。 |
|
|
RSVP ステータス
|
rsvp_status | string |
参加者のイベントへのエンゲージメントのステータス。 |
|
|
参加済?
|
attended | boolean |
参加者はイベントに参加しましたか? |
|
|
招待の状態
|
invitation_status | string |
参加者への招待のステータス。 |
|
|
日
|
d | integer |
あいまいな日付で表した日。 |
|
|
月
|
m | integer |
あいまいな日付で表した月。 |
|
|
年
|
y | integer |
あいまいな日付で表した年。 |
|
|
日
|
d | integer |
あいまいな日付で表した日。 |
|
|
月
|
m | integer |
あいまいな日付で表した月。 |
|
|
年
|
y | integer |
あいまいな日付の中の年。 |
|
|
参加レベル
|
name | True | string |
参加レベルの名前。 |
|
サマリー メモ
|
summary_note | string |
参加者の記録に固定されたクイック リファレンス情報。 |
戻り値
作成した参加者
参加者を取得する
特定のイベント参加者に関する情報を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
参加者 ID
|
participant_id | True | string |
参加者のシステム レコード ID。 |
戻り値
参加者
参加者を更新する
参加者に関する詳細を更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
参加者 ID
|
participant_id | True | string |
更新する参加者のシステム レコード ID。 |
|
スタッフ ID
|
constituent_id | string |
参加者のスタッフ ID。 |
|
|
ホスト ID
|
host_id | string |
ホストの参加者レコードの ID。 |
|
|
RSVP ステータス
|
rsvp_status | string |
参加者のイベントへのエンゲージメントのステータス。 |
|
|
参加済?
|
attended | boolean |
参加者はイベントに参加しましたか? |
|
|
招待の状態
|
invitation_status | string |
参加者への招待のステータス。 |
|
|
日
|
d | integer |
あいまいな日付で表した日。 |
|
|
月
|
m | integer |
あいまいな日付で表した月。 |
|
|
年
|
y | integer |
あいまいな日付で表した年。 |
|
|
日
|
d | integer |
あいまいな日付で表した日。 |
|
|
月
|
m | integer |
あいまいな日付で表した月。 |
|
|
年
|
y | integer |
あいまいな日付の中の年。 |
|
|
参加レベル
|
name | True | string |
参加レベルの名前。 |
|
サマリー メモ
|
summary_note | string |
参加者の記録に固定されたクイック リファレンス情報。 |
参加者オプションを一覧表示する
参加者の参加者オプションを一覧表示します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
参加者 ID
|
participant_id | True | string |
参加者のシステム レコード ID。 |
戻り値
参加者オプション
参加者オプションを作成する
参加者の新しい参加者オプションを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
参加者 ID
|
participant_id | True | string |
参加者の ID。 |
|
本文
|
body | True | dynamic |
作成する参加者オプションを表すオブジェクト。 |
戻り値
作成済み参加者オプション
参加者オプションを更新する
参加者オプションに関する詳細を更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
参加者オプション ID
|
option_id | True | string |
更新する参加者オプションのシステム レコード ID。 |
|
値
|
option_value | True | string |
オプションに対する参加者の応答。 |
参加者費用を作成する
参加者の新しい費用を作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
参加者 ID
|
participant_id | True | string |
参加者のシステム レコード ID。 |
|
イベント ID
|
event_id | True | string |
イベントのシステム レコード ID。 |
|
料金
|
event_fee_id | True | string |
イベント料金。 |
|
数量
|
quantity | True | integer |
購入済みの数量。 |
|
手数料金額
|
fee_amount | True | double |
手数料に関連する金額。 |
|
寄付額
|
contribution_amount | True | double |
イベントの費用を超える寄付金の金額。 これは通常、領収書に表示される金額です。 |
|
日
|
d | integer |
あいまいな日付で表した日。 |
|
|
月
|
m | integer |
あいまいな日付で表した月。 |
|
|
年
|
y | integer |
あいまいな日付で表した年。 |
戻り値
作成済み参加者費用
定義
EventApi.AdministrativeArea
住所の行政区画で使用されるデータ モデルを定義します (例: 米国における州)。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
行政区画のレコード ID。 |
|
名前
|
name | string |
行政区画の名前。 |
|
簡単な説明
|
short_description | string |
行政区画の簡単な説明。 |
EventApi.ApiCollectionOfEventFee
手数料
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
カウント
|
count | integer |
要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。 |
|
値
|
value | array of EventApi.EventFee |
応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。 |
EventApi.ApiCollectionOfEventListEntry
イベント
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
カウント
|
count | integer |
要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。 |
|
値
|
value | array of EventApi.EventListEntry |
応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。 |
EventApi.ApiCollectionOfEventParticipantOption
イベントの参加者オプション
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
カウント
|
count | integer |
要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。 |
|
値
|
value | array of EventApi.EventParticipantOption |
応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。 |
EventApi.ApiCollectionOfParticipantDonation
寄付
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
カウント
|
count | integer |
要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。 |
|
値
|
value | array of EventApi.ParticipantDonation |
応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。 |
EventApi.ApiCollectionOfParticipantFee
手数料
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
カウント
|
count | integer |
要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。 |
|
値
|
value | array of EventApi.ParticipantFee |
応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。 |
EventApi.ApiCollectionOfParticipantFeePayment
手数料支払
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
カウント
|
count | integer |
要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。 |
|
値
|
value | array of EventApi.ParticipantFeePayment |
応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。 |
EventApi.ApiCollectionOfParticipantListEntry
参加者
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
カウント
|
count | integer |
要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。 |
|
値
|
value | array of EventApi.ParticipantListEntry |
応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。 |
EventApi.ApiCollectionOfParticipantOption
参加者オプション
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
カウント
|
count | integer |
要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。 |
|
値
|
value | array of EventApi.ParticipantOption |
応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。 |
EventApi.Country
住所の国に使用するデータ モデルを定義します。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
国レコードの ID。 |
|
表示名
|
display_name | string |
国の表示名。 |
|
ISO コード
|
iso_alpha2_code | string |
国を表す ISO 3166-1 alpha-2 コード。 |
EventApi.CreatedEvent
作成したイベント
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
新しく作成したイベントの ID。 |
EventApi.CreatedEventAttachment
作成したイベント添付ファイル
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
新しく作成されたイベント添付資料の ID。 |
EventApi.CreatedEventFee
作成済みイベント料金
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
新しく作成したイベント料金の ID。 |
EventApi.CreatedEventParticipantOption
作成済みイベントの参加者オプション
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
新しく作成したイベント参加者オプションの ID。 |
EventApi.CreatedParticipant
作成した参加者
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
新しく作成した参加者の ID。 |
EventApi.CreatedParticipantDonation
参加者の寄付を作成する
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
新しく作成した参加者の寄付に対する ID。 |
EventApi.CreatedParticipantFee
作成済み参加者費用
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
新しく作成した参加者料金の ID。 |
EventApi.CreatedParticipantFeePayment
作成済み参加者の手数料支払
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
新しく作成した参加者の料金支払いの ID。 |
EventApi.CreatedParticipantOption
作成済み参加者オプション
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
新しく作成した参加者オプションの ID。 |
EventApi.Event
イベント
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
イベントのシステム レコード ID。 これは、lookup_id に格納されているユーザー定義可能なイベント識別子と同じではありません。 |
|
件名
|
name | string |
イベントの名前です。 |
|
内容
|
description | string |
イベントの説明。 |
|
開始日
|
start_date | date |
イベントの開始日。 |
|
開始時刻
|
start_time | string |
イベントの開始時刻。 |
|
終了日
|
end_date | date |
イベントの終了日。 |
|
終了時刻
|
end_time | string |
イベントの終了時刻。 |
|
カテゴリ
|
category | EventApi.EventCategory |
イベント カテゴリは、イベントのカスタム分類です。 |
|
検索 ID
|
lookup_id | string |
イベントの検索 ID。 |
|
場所
|
location | EventApi.Location |
場所に使用するデータ モデルを定義します。 |
|
容量
|
capacity | integer |
イベントに参加できる人数。 |
|
目標
|
goal | double |
イベントの目標金額。 |
|
キャンペーン ID
|
campaign_id | string |
イベントに関連付けられたキャンペーンのシステム レコード ID。 |
|
資金 ID
|
fund_id | string |
イベントに関連付けられた資金のシステム レコード ID。 |
|
非アクティブ?
|
inactive | boolean |
イベントは非アクティブですか? |
|
追加した日付
|
date_added | date-time |
イベントの作成日。 |
|
変更日
|
date_modified | date-time |
イベントの最終変更日。 |
EventApi.EventAttachment
添付
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
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
|
tags | array of string |
添付ファイルに関連付けられているタグ |
EventApi.EventAttachmentCollection
Attachments
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
数
|
count | integer |
要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。 |
|
値
|
value | array of EventApi.EventAttachment |
応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。 |
EventApi.EventCategory
イベント カテゴリは、イベントのカスタム分類です。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
イベント カテゴリのシステム レコード ID。 |
|
名前
|
name | string |
イベント カテゴリの名前。 |
|
非アクティブ?
|
inactive | boolean |
このカテゴリは非アクティブですか? |
EventApi.EventFee
イベント料金は、個人や組織がイベントに参加または出席する際に組織が請求する金額です。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
イベント料金のシステム レコード ID。 |
|
名前
|
name | string |
イベント料金の名前。 |
|
金額
|
cost | double |
料金のコスト。 |
|
寄付額
|
contribution_amount | double |
この料金の税金控除額。 |
|
売上数
|
number_sold | integer |
販売された料金の数。 |
EventApi.EventListEntry
イベント
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
イベントのシステム レコード ID。 |
|
件名
|
name | string |
イベントの名前です。 |
|
開始日
|
start_date | date |
イベントの開始日。 |
|
開始時刻
|
start_time | string |
イベントの開始時刻。 |
|
終了日
|
end_date | date |
イベントの終了日。 |
|
終了時刻
|
end_time | string |
イベントの終了時刻。 |
|
カテゴリ
|
category | EventApi.EventCategory |
イベント カテゴリは、イベントのカスタム分類です。 |
|
検索 ID
|
lookup_id | string |
イベントの検索 ID。 |
|
容量
|
capacity | integer |
イベントに参加できる人数。 |
|
出席
|
attending_count | integer |
出席を予定しているイベント参加者の数。 |
|
有人
|
attended_count | integer |
イベント出席者の数。 |
|
招待済み
|
invited_count | integer |
イベントに招待された人の数。 |
|
売上
|
revenue | double |
イベントの売上高。 |
|
目標
|
goal | double |
イベントの目標金額。 |
|
目標に対する割合
|
percent_of_goal | integer |
目標売上に対する割合としての売上高。 |
|
非アクティブ?
|
inactive | boolean |
イベントは非アクティブですか? |
|
追加した日付
|
date_added | date-time |
イベントの作成日。 |
|
変更日
|
date_modified | date-time |
イベントの最終変更日。 |
EventApi.EventParticipantOption
イベント参加者のオプションは、T シャツのサイズ、食事の好み、座席の希望など、参加者に関する詳細情報を収集するフィールドです。 イベントのオプションとその値を設定してから、各参加者の応答を追加します。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
イベント参加者オプションのシステム レコード ID。 |
|
名前
|
name | string |
イベント参加者オプションの名前。 |
|
入力の種類
|
input_type | string |
イベント参加者オプションの種類。 |
|
マルチ選択を許可?
|
multi_select | boolean |
一覧に対して複数の値を許可しますか? |
|
list_options
|
list_options | array of EventApi.EventParticipantOptionListOption |
使用可能な一覧のオプション。 |
|
ユーザーにより追加済
|
added_by_user | string |
オプションを追加したユーザーの ID。 |
|
ユーザーにより変更済
|
updated_by_user | string |
オプションを変更したユーザーの ID。 |
|
サービスにより追加済
|
added_by_service | string |
このオプションを追加したサービスの名前。 |
|
サービスにより変更済
|
updated_by_service | string |
このオプションを変更したサービスの名前。 |
|
追加日
|
date_added | date-time |
オプションが作成された日付。 |
|
変更日
|
date_updated | date-time |
オプションが最終変更された日付。 |
|
バージョン
|
version | integer |
オプションのバージョン番号。 |
EventApi.EventParticipantOptionListOption
イベント参加者オプションの一覧オプション
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
一覧オプションの ID |
|
名前
|
name | string |
一覧オプションの名前 |
|
sequence
|
sequence | integer |
一覧オプションの順序付けに使用するシーケンス |
EventApi.Locality
住所の地域に使用するデータ モデルを定義します。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
地域レコードのレコード ID。 |
|
名前
|
name | string |
地域の名前。 |
EventApi.Location
場所に使用するデータ モデルを定義します。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
名前
|
name | string |
場所の名前。 |
|
住所行
|
address_lines | string |
場所の住所行。 |
|
郵便番号
|
postal_code | string |
場所の郵便番号。 |
|
地域
|
locality | EventApi.Locality |
住所の地域に使用するデータ モデルを定義します。 |
|
行政区画
|
administrative_area | EventApi.AdministrativeArea |
住所の行政区画で使用されるデータ モデルを定義します (例: 米国における州)。 |
|
副行政区画
|
sub_administrative_area | EventApi.SubAdministrativeArea |
住所の副行政区画で使用するデータ モデルを定義します (例: 米国における市)。 |
|
country
|
country | EventApi.Country |
住所の国に使用するデータ モデルを定義します。 |
|
書式設定された住所
|
formatted_address | string |
場所の書式設定された住所 |
EventApi.Membership
参加者のメンバーシップ情報。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
メンバーシップ カテゴリ
|
category | EventApi.MembershipCategory |
個人のメンバーシップ カテゴリ。 |
EventApi.MembershipCategory
個人のメンバーシップ カテゴリ。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
メンバーシップ カテゴリのシステム レコード ID。 |
|
名前
|
name | string |
メンバーシップ カテゴリの名前。 |
EventApi.Participant
関係者
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
参加者のシステム レコード ID。 |
|
スタッフ ID
|
constituent_id | string |
参加者のスタッフ ID。 |
|
イベント ID
|
event_id | string |
参加しているイベントのシステム レコード ID。 |
|
ホスト ID
|
host_id | string |
ホストの参加者レコードの ID。 |
|
RSVP の状態
|
rsvp_status | string |
参加者のイベントへのエンゲージメントのステータス。 |
|
参加済?
|
attended | boolean |
参加者はイベントに参加しましたか? |
|
招待の状態
|
invitation_status | string |
参加者への招待のステータス。 |
|
日
|
rsvp_date.d | integer |
あいまいな日付で表した日。 |
|
月
|
rsvp_date.m | integer |
あいまいな日付で表した月。 |
|
年
|
rsvp_date.y | integer |
あいまいな日付で表した年。 |
|
日
|
invitation_date.d | integer |
あいまいな日付で表した日。 |
|
月
|
invitation_date.m | integer |
あいまいな日付の中の月。 |
|
年
|
invitation_date.y | integer |
あいまいな日付の中の年。 |
|
サマリー メモ
|
summary_note | string |
参加者の記録に固定されたクイック リファレンス情報。 |
|
参加レベル
|
participation_level | EventApi.ParticipationLevel |
参加レベルは、イベントに対する参加者の関わり合いのレベルです。 |
|
追加した日付
|
date_added | date-time |
参加者が作成された日付。 |
|
変更日
|
date_modified | date-time |
参加者が最終変更された日付。 |
EventApi.ParticipantDonation
参加者の寄付に使用するデータ モデルを定義する
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
参加者の寄付に対するシステム レコード ID。 |
|
ギフト ID
|
gift_id | string |
参加者の寄付をリンクしたギフトに対するシステム レコード ID。 |
EventApi.ParticipantFee
参加者料金のデータ モデルを定義します
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
参加者料金の ID。 |
|
参加者 ID
|
participant_id | string |
参加者料金がリンクされるレコードの ID。 |
|
数量
|
quantity | integer |
購入済みの数量。 |
|
手数料の金額
|
fee_amount | double |
参加者料金の額。 |
|
寄付額
|
tax_receiptable_amount | double |
この料金の税金控除額。 |
|
日
|
date.d | integer |
あいまいな日付で表した日。 |
|
月
|
date.m | integer |
あいまいな日付で表した月。 |
|
年
|
date.y | integer |
あいまいな日付で表した年。 |
|
イベント料金
|
event_fee | EventApi.EventFee |
イベント料金は、個人や組織がイベントに参加または出席する際に組織が請求する金額です。 |
EventApi.ParticipantFeePayment
参加者料金の支払いのデータ モデルを定義します
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
参加者料金の支払いのシステム レコード ID。 |
|
参加者 ID
|
participant_id | string |
参加者料金の支払いをリンクする参加者のシステム レコード ID。 |
|
ギフト ID
|
gift_id | string |
参加者料金の支払いをリンクするギフトのシステム レコード ID。 |
|
適用額
|
applied_amount | double |
参加者料金の支払いに適用される金額。 |
EventApi.ParticipantListEntry
関係者
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
参加者のシステム レコード ID。 |
|
取引先担当者 ID
|
contact_id | string |
イベントに参加中の取引先担当者の ID。 |
|
RSVP の状態
|
rsvp_status | string |
参加者のイベントへのエンゲージメントのステータス。 |
|
参加済?
|
attended | boolean |
参加者はイベントに参加しましたか? |
|
招待の状態
|
invitation_status | string |
参加者への招待のステータス。 |
|
日
|
rsvp_date.d | integer |
あいまいな日付で表した日。 |
|
月
|
rsvp_date.m | integer |
あいまいな日付で表した月。 |
|
年
|
rsvp_date.y | integer |
あいまいな日付で表した年。 |
|
参加レベル
|
participation_level | EventApi.ParticipationLevel |
参加レベルは、イベントに対する参加者の関わり合いのレベルです。 |
|
敬称
|
title | string |
参加者の役職。 |
|
名
|
first_name | string |
参加者の名。 |
|
姓
|
last_name | string |
参加者の姓。 |
|
件名
|
name | string |
参加者の氏名。 |
|
希望する名前
|
preferred_name | string |
参加者の希望する名前。 |
|
敬称
|
suffix | string |
参加者の敬称。 |
|
検索 ID
|
lookup_id | string |
参加者の LookupId。 |
|
電子メール
|
string |
参加者の電子メール アドレス。 |
|
|
電子メール不可?
|
do_not_email | boolean |
この電子メール アドレスで参加者に連絡を取ることができますか? |
|
電話
|
phone | string |
参加者の電話番号。 |
|
電話不可?
|
do_not_call | boolean |
この電話番号で参加者に連絡を取ることができますか? |
|
ミドルネーム
|
middle_name | string |
参加者のミドル ネーム。 |
|
旧名
|
former_name | string |
参加者の旧名。 |
|
スタッフ?
|
is_constituent | boolean |
参加者はスタッフですか? |
|
学位
|
class_of | string |
参加者の卒業時学位。 |
|
合計登録料
|
total_registration_fees | double |
参加者の手数料の合計。 |
|
合計支払い金額
|
total_paid | double |
参加者の支払い済みギフトと登録料の種類の合計。 |
|
寄付
|
donations | double |
参加者の支払い済みギフトと寄付の種類の合計。 |
|
売上
|
revenue | double |
すべてのタイプの参加者が支払ったギフトの合計。 |
|
シート
|
seat | string |
参加者の座席割り当て。 |
|
名前タグ
|
name_tag | string |
参加者の名前タグ |
|
サマリー メモ
|
summary_note | string |
参加者の記録に固定されたクイック リファレンス情報。 |
|
追加した日付
|
date_added | date-time |
参加者が作成された日付。 |
|
変更日
|
date_modified | date-time |
参加者が最終変更された日付。 |
|
取引先担当者 ID
|
host.contact_id | string |
イベントに参加中の取引先担当者の ID。 |
|
参加者 ID
|
host.participant_id | string |
参加者の ID。 |
|
名前
|
host.name | string |
参加者の氏名。 |
|
ゲスト
|
guests | array of EventApi.ParticipantListParticipantSummary |
参加者のゲスト。 |
|
メンバーシップ
|
memberships | array of EventApi.Membership |
参加者のメンバーシップ情報。 |
EventApi.ParticipantListParticipantSummary
参加者の基本概要情報。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
取引先担当者 ID
|
contact_id | string |
イベントに参加中の取引先担当者の ID。 |
|
参加者 ID
|
participant_id | string |
参加者の ID。 |
|
名前
|
name | string |
参加者の氏名。 |
EventApi.ParticipantOption
特定の参加者に関連付けられた参加者オプション
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
参加者オプションのシステム レコード ID。 |
|
参加者 ID
|
participant_id | string |
参加者のシステム レコード ID。 |
|
イベント ID
|
event_id | string |
イベントのシステム レコード ID。 |
|
イベント参加者オプション ID
|
event_participant_option_id | string |
イベント参加者オプションのシステム レコード ID。 |
|
値
|
option_value | string |
オプションに対する参加者の応答。 |
|
ユーザーにより追加済
|
added_by_user | string |
参加者オプションを追加したユーザーの ID。 |
|
ユーザーにより変更済
|
updated_by_user | string |
参加者オプションを変更したユーザーの ID。 |
|
サービスにより追加済
|
added_by_service | string |
この参加者オプションを追加したサービスの名前。 |
|
サービスにより変更済
|
updated_by_service | string |
この参加者オプションを変更したサービスの名前。 |
|
追加日
|
date_added | date-time |
参加者オプションが作成された日付。 |
|
変更日
|
date_updated | date-time |
参加者オプションが最終変更された日付。 |
EventApi.ParticipationLevel
参加レベルは、イベントに対する参加者の関わり合いのレベルです。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
参加レベルのシステム レコード ID。 |
|
名前
|
name | string |
参加レベルの名前。 |
|
非アクティブ?
|
is_inactive | boolean |
参加レベルは非アクティブですか? |
EventApi.SubAdministrativeArea
住所の副行政区画で使用するデータ モデルを定義します (例: 米国における市)。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
副行政区画の ID。 |
|
名前
|
name | string |
副行政区画の名前。 |