События Blackbaud Raisers Edge NXT
Blackbaud Raiser Edge NXT — это комплексное облачное решение для сбора средств и программного обеспечения для управления донорами, созданное специально для некоммерческих организаций и всего социального хорошего сообщества. Используйте соединитель событий для управления событиями и участниками.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | Class | Регионы |
|---|---|---|
| Copilot Studio | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Логические приложения | Стандарт | Все регионы Logic Apps , кроме следующих: — Регионы Azure для государственных организаций — Регионы Azure Для Китая - Министерство обороны США (DoD) |
| Power Apps | Премия | Все регионы Power Apps , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Power Automate | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Контакт | |
|---|---|
| Имя | Поддержка Blackbaud |
| URL | https://www.blackbaud.com/support |
| Адрес электронной почты | skyapi@blackbaud.com |
| Метаданные соединителя | |
|---|---|
| Publisher | Blackbaud, Inc. |
| Веб-сайт | https://www.blackbaud.com/products/blackbaud-raisers-edge-nxt |
| Политика конфиденциальности | https://www.blackbaud.com/privacy-shield |
| Категории | Продажи и CRM; Продуктивность |
Edge NXT Raiser — это комплексное облачное решение для сбора средств и программного обеспечения для управления донорами, созданное специально для некоммерческих организаций и всего социального хорошего сообщества.
Этот соединитель построен на основе API Sky Blackbaud и предоставляет операции для управления событиями и связанными сущностями, найденными в NXT Edge Raiser, в том числе:
- Events
- Участники
- Сборы и пожертвования
- и другие...
Дополнительные сведения см. в документации.
Предпосылки
Чтобы использовать этот соединитель, у вас должна быть учетная запись Blackbaud ID с доступом к одной или нескольким средам Blackbaud.
Кроме того, администратор вашей организации также должен выполнять действия уровня администратора в системе, чтобы этот соединитель мог получить доступ к вашей среде Blackbaud. Дополнительные сведения об этих предварительных требованиях см. в документации по начальной настройке .
Как получить учетные данные?
Администратор вашей организации отправит вам приглашение в среду NXT edge организации и настроит разрешения учетной записи пользователя в среде. Для использования этого соединителя дополнительные учетные данные не требуются.
Известные проблемы и ограничения
Соединитель будет работать в контексте учетной записи пользователя и, следовательно, будет применяться к вашим разрешениям пользователя в среде.
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Вывод списка вложений событий |
Перечисляет вложения для события. |
| Обновление вложения событий |
Обновляет вложение события. |
| Обновление параметра участника |
Обновляет сведения о параметре участника. |
| Обновление события |
Обновляет сведения о событии. |
| Обновление участника |
Обновляет сведения об участнике. |
| Перечисление параметров участника события |
Выводит список параметров участника для события. |
| Перечисление платежей за сбор участников |
Перечисляет платежи за плату для участника. |
| Перечисление пожертвований участников |
Перечисляет пожертвования для участника. |
| Перечисление сборов за события |
Выводит список сборов за событие. |
| Перечисление сборов участников |
Перечисляет сборы за участника. |
| Перечисление участников события |
Выводит список участников для события. |
| Получение события |
Возвращает сведения о событии. |
| Получение участника |
Возвращает сведения о конкретном участнике события. |
| Создание вложения событий |
Создает новое вложение события. |
| Создание оплаты за участие |
Создает новый платеж за участника. |
| Создание параметра участника |
Создает новый параметр участника. |
| Создание параметра участника события |
Создает новый параметр участника для события. |
| Создание платы за событие |
Создает новую плату за событие. |
| Создание платы за участника |
Создает новую плату для участника. |
| Создание пожертвования участника |
Создает новое пожертвование для участника. |
| Создание события |
Создает новое событие. |
| Создание участника |
Создает нового участника для события. |
| Список параметров участника |
Выводит список параметров участника. |
| Список событий |
Возвращает список событий. |
Вывод списка вложений событий
Перечисляет вложения для события.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор события
|
event_id | True | string |
Идентификатор системной записи события. |
Возвращаемое значение
Attachments
Обновление вложения событий
Обновляет вложение события.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор события
|
event_id | True | string |
Идентификатор системной записи события. |
|
Идентификатор вложения
|
attachment_id | True | string |
Идентификатор системной записи для обновления вложения. |
|
Имя
|
name | string |
Имя вложения. Ограничение символов: 150. |
|
|
Date
|
date | date-time |
Дата вложения (например, '2020-09-18T04:13:56Z'). |
|
|
URL
|
url | string |
URL-адрес для вложения. Это необходимо для вложений ссылок и неприменимо для физических вложений. |
|
|
Метки
|
tags | array of string |
Теги, связанные с вложением. |
Обновление параметра участника
Обновляет сведения о параметре участника.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор параметра участника
|
option_id | True | string |
Идентификатор системной записи параметра участника для обновления. |
|
Ценность
|
option_value | True | string |
Ответ участника на параметр. |
Обновление события
Обновляет сведения о событии.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор события
|
event_id | True | string |
Идентификатор системной записи события для обновления. |
|
Имя события
|
name | string |
Название мероприятия. |
|
|
Description
|
description | string |
Описание события. |
|
|
Категория
|
name | True | string |
Имя категории. |
|
Начальная дата
|
start_date | date |
Дата начала события (например, "2020-09-18"). |
|
|
Время запуска
|
start_time | string |
Время начала события (например, "07:30". |
|
|
Дата окончания
|
end_date | date |
Дата окончания события (например, "2020-09-18"). |
|
|
Время окончания
|
end_time | string |
Время окончания события (например, "07:30". |
|
|
Идентификатор подстановки
|
lookup_id | string |
Идентификатор подстановки события. |
|
|
Capacity
|
capacity | integer |
Количество людей, которые могут присутствовать на мероприятии. |
|
|
Цель
|
goal | double |
Денежные цели события. |
|
|
Идентификатор кампании
|
campaign_id | string |
Системный идентификатор записи кампании, связанной с событием. |
|
|
Идентификатор фонда
|
fund_id | string |
Системный идентификатор фонда, связанного с событием. |
|
|
Неактивный?
|
inactive | boolean |
Активен ли событие? |
Обновление участника
Обновляет сведения об участнике.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор участника
|
participant_id | True | string |
Идентификатор системной записи участника для обновления. |
|
Составной идентификатор
|
constituent_id | string |
Составляющий идентификатор участника. |
|
|
Идентификатор узла
|
host_id | string |
Идентификатор записи участника узла. |
|
|
Состояние RSVP
|
rsvp_status | string |
Состояние взаимодействия участника с событием. |
|
|
Присутствовал?
|
attended | boolean |
Присутствовал ли участник на мероприятии? |
|
|
Статус приглашения
|
invitation_status | string |
Состояние приглашения участнику. |
|
|
day
|
d | integer |
День в нечеткой дате. |
|
|
month
|
m | integer |
Месяц в нечеткой дате. |
|
|
год
|
y | integer |
Год в нечеткой дате. |
|
|
day
|
d | integer |
День в нечеткой дате. |
|
|
month
|
m | integer |
Месяц в нечеткой дате. |
|
|
год
|
y | integer |
Год в нечеткой дате. |
|
|
Уровень участия
|
name | True | string |
Имя уровня участия. |
|
Сводная заметка
|
summary_note | string |
Краткие справочные сведения, закрепленные в записи участника. |
Перечисление параметров участника события
Выводит список параметров участника для события.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор события
|
event_id | True | string |
Идентификатор события. |
Возвращаемое значение
Параметры участника события
Перечисление платежей за сбор участников
Перечисляет платежи за плату для участника.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор участника
|
participant_id | True | string |
Системный идентификатор записи участника. |
|
Лимит
|
limit | integer |
Представляет количество возвращаемых записей. Значение по умолчанию — 500. Максимальное значение — 10000. |
|
|
Смещение
|
offset | integer |
Представляет количество пропускаемых записей. Для использования с разбивкой на страницы. Значение по умолчанию — 0. |
Возвращаемое значение
Платежи за плату
Перечисление пожертвований участников
Перечисляет пожертвования для участника.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор участника
|
participant_id | True | string |
Системный идентификатор записи участника. |
|
Лимит
|
limit | integer |
Представляет количество возвращаемых записей. Значение по умолчанию — 500. Максимальное значение — 10000. |
|
|
Смещение
|
offset | integer |
Представляет количество пропускаемых записей. Для использования с разбивкой на страницы. Значение по умолчанию — 0. |
Возвращаемое значение
Пожертвования
Перечисление сборов за события
Выводит список сборов за событие.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор события
|
event_id | True | string |
Идентификатор системной записи события. |
Возвращаемое значение
Оплата
Перечисление сборов участников
Перечисляет сборы за участника.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор участника
|
participant_id | True | string |
Системный идентификатор записи участника. |
|
Лимит
|
limit | integer |
Представляет количество возвращаемых записей. Значение по умолчанию — 500. Максимальное значение — 10000. |
|
|
Смещение
|
offset | integer |
Представляет количество пропускаемых записей. Для использования с разбивкой на страницы. Значение по умолчанию — 0. |
Возвращаемое значение
Оплата
Перечисление участников события
Выводит список участников для события.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор события
|
event_id | True | string |
Идентификатор системной записи события. |
|
Состояние 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"). |
Возвращаемое значение
Участники
Получение события
Возвращает сведения о событии.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор события
|
event_id | True | string |
Идентификатор системной записи события, который требуется получить. |
Возвращаемое значение
Event
- Тело
- EventApi.Event
Получение участника
Возвращает сведения о конкретном участнике события.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор участника
|
participant_id | True | string |
Системный идентификатор записи участника. |
Возвращаемое значение
Участник
- Тело
- EventApi.Participant
Создание вложения событий
Создает новое вложение события.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор события
|
event_id | True | string |
Идентификатор системной записи события. |
|
Тип
|
type | True | string |
Тип вложения. Физические вложения отправляются в файлы, такие как изображения, PDF-файлы или документы Word, сохраненные локально или в сети. Они хранятся и управляются в системе. Ссылки на вложения — это ссылки на такие файлы, как изображения, записи блога или видео YouTube, которые находятся в Сети или в облачной учетной записи хранения. Они хранятся и управляются внешним образом. |
|
Имя
|
name | string |
Имя вложения. Ограничение символов: 150. |
|
|
Date
|
date | date-time |
Дата вложения (например, '2020-09-18T04:13:56Z'). Это поле по умолчанию использует текущую дату и время, если она не указана. |
|
|
URL
|
url | string |
URL-адрес для вложения. Это необходимо для вложений ссылок и неприменимо для физических вложений. |
|
|
Имя файла
|
file_name | string |
Имя файла. Ограничение символов: 36. Только для физических вложений. |
|
|
Идентификатор файла
|
file_id | string |
Идентификатор файла. Ограничение символов: 36. Только для физических вложений. |
|
|
Идентификатор эскиза
|
thumbnail_id | string |
Идентификатор эскиза. Ограничение символов: 36. Только для физических вложений. |
|
|
Метки
|
tags | array of string |
Теги, связанные с вложением. |
Возвращаемое значение
Созданное вложение событий
Создание оплаты за участие
Создает новый платеж за участника.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор участника
|
participant_id | True | string |
Системный идентификатор записи участника. |
|
Идентификатор подарка
|
gift_id | True | string |
Идентификатор записи systetm для подарка, к которому связана плата участника. |
|
Примененная сумма
|
applied_amount | True | double |
Сумма платежа, применяемого к сбору участников. |
Возвращаемое значение
Созданный платеж за участие
Создание параметра участника
Создает новый параметр участника.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор участника
|
participant_id | True | string |
Идентификатор участника. |
|
body
|
body | True | dynamic |
Объект, представляющий параметр участника для создания. |
Возвращаемое значение
Параметр "Созданный участник"
Создание параметра участника события
Создает новый параметр участника для события.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор события
|
event_id | True | string |
Идентификатор события. |
|
Имя
|
name | True | string |
Имя параметра участника события. |
|
Тип входных данных
|
input_type | True | string |
Типы участников значений могут использовать для предоставления ответов. |
|
Разрешить выбор нескольких вариантов?
|
multi_select | boolean |
Разрешить несколько значений для списков? |
|
|
имя
|
name | string |
Имя параметра списка. |
|
|
последовательность
|
sequence | integer |
Последовательность на основе 0, используемая для упорядочивания. |
Возвращаемое значение
Параметр "Созданный участник события"
Создание платы за событие
Создает новую плату за событие.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор события
|
event_id | True | string |
Идентификатор системной записи события. |
|
Имя
|
name | True | string |
Имя платы. |
|
Сумма платы
|
cost | True | double |
Сумма денег, связанных с сбором. |
|
Сумма вклада
|
contribution_amount | True | double |
Сумма платы, которая является пожертвованием выше расходов на событие. |
Возвращаемое значение
Созданная плата за событие
Создание платы за участника
Создает новую плату для участника.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор участника
|
participant_id | True | string |
Системный идентификатор записи участника. |
|
Идентификатор события
|
event_id | True | string |
Идентификатор системной записи события. |
|
Плата
|
event_fee_id | True | string |
Плата за событие. |
|
Количество
|
quantity | True | integer |
Количество приобретенных. |
|
Сумма платы
|
fee_amount | True | double |
Сумма денег, связанных с сбором. |
|
Сумма вклада
|
contribution_amount | True | double |
Сумма платы, которая является пожертвованием выше расходов на событие. Это сумма, которая обычно отображается в квитанциях. |
|
day
|
d | integer |
День в нечеткой дате. |
|
|
month
|
m | integer |
Месяц в нечеткой дате. |
|
|
год
|
y | integer |
Год в нечеткой дате. |
Возвращаемое значение
Созданная плата за участника
Создание пожертвования участника
Создает новое пожертвование для участника.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор участника
|
participant_id | True | string |
Системный идентификатор записи участника. |
|
Идентификатор подарка
|
gift_id | True | string |
Идентификатор записи systetm подарка, к которому связан пожертвование участника. |
Возвращаемое значение
Созданное пожертвование участника
Создание события
Создает новое событие.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя события
|
name | True | string |
Название мероприятия. |
|
Description
|
description | string |
Описание события. |
|
|
Категория
|
name | True | string |
Имя категории. |
|
Начальная дата
|
start_date | True | date |
Дата начала события (например, "2020-09-18"). |
|
Время запуска
|
start_time | string |
Время начала события (например, "07:30". |
|
|
Дата окончания
|
end_date | date |
Дата окончания события (например, "2020-09-18"). |
|
|
Время окончания
|
end_time | string |
Время окончания события (например, "07:30)". |
|
|
Идентификатор подстановки
|
lookup_id | string |
Идентификатор подстановки события. |
|
|
Capacity
|
capacity | integer |
Количество людей, которые могут присутствовать на мероприятии. |
|
|
Цель
|
goal | double |
Денежные цели события. |
|
|
Идентификатор кампании
|
campaign_id | string |
Системный идентификатор записи кампании, связанной с событием. |
|
|
Идентификатор фонда
|
fund_id | string |
Системный идентификатор фонда, связанного с событием. |
|
|
Неактивный?
|
inactive | boolean |
Активен ли событие? |
Возвращаемое значение
Созданное событие
Создание участника
Создает нового участника для события.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор события
|
event_id | True | string |
Идентификатор системной записи события. |
|
Составной идентификатор
|
constituent_id | True | string |
Составляющий идентификатор участника. |
|
Идентификатор узла
|
host_id | string |
Идентификатор записи участника узла. |
|
|
Состояние RSVP
|
rsvp_status | string |
Состояние взаимодействия участника с событием. |
|
|
Присутствовал?
|
attended | boolean |
Присутствовал ли участник на мероприятии? |
|
|
Статус приглашения
|
invitation_status | string |
Состояние приглашения участнику. |
|
|
day
|
d | integer |
День в нечеткой дате. |
|
|
month
|
m | integer |
Месяц в нечеткой дате. |
|
|
год
|
y | integer |
Год в нечеткой дате. |
|
|
day
|
d | integer |
День в нечеткой дате. |
|
|
month
|
m | integer |
Месяц в нечеткой дате. |
|
|
год
|
y | integer |
Год в нечеткой дате. |
|
|
Уровень участия
|
name | True | string |
Имя уровня участия. |
|
Сводная заметка
|
summary_note | string |
Краткие справочные сведения, закрепленные в записи участника. |
Возвращаемое значение
Созданный участник
Список параметров участника
Выводит список параметров участника.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор участника
|
participant_id | True | string |
Системный идентификатор записи участника. |
Возвращаемое значение
Параметры участника
Список событий
Возвращает список событий.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Категория
|
category | string |
Фильтрация на основе категории событий. |
|
|
Идентификатор подстановки
|
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 |
Представляет количество пропускаемых записей. Для использования с разбивкой на страницы. |
|
|
Идентификатор события
|
event_id | string |
Отфильтруйте события, соответствующие указанному идентификатору системной записи. |
|
|
Имя
|
name | string |
Фильтруйте события, соответствующие указанному имени. |
|
|
Добавлен или после
|
date_added | date-time |
Отфильтруйте результаты по событиям, созданным по указанной дате (например, "2020-09-18T04:13:56Z"). |
|
|
Изменено или после
|
last_modified | date-time |
Отфильтруйте результаты до событий, измененных по указанной дате (например, "2020-09-18T04:13:56Z"). |
Возвращаемое значение
Events
Определения
EventApi.AdministrativeArea
Определяет модель данных, используемую для административной области адреса (например, штат в США).
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор записи административной области. |
|
имя
|
name | string |
Имя административной области. |
|
краткое описание
|
short_description | string |
Краткое описание административной области. |
EventApi.ApiCollectionOfEventFee
Оплата
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений. |
|
value
|
value | array of EventApi.EventFee |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
EventApi.ApiCollectionOfEventListEntry
Events
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений. |
|
value
|
value | array of EventApi.EventListEntry |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
EventApi.ApiCollectionOfEventParticipantOption
Параметры участника события
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений. |
|
value
|
value | array of EventApi.EventParticipantOption |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
EventApi.ApiCollectionOfParticipantDonation
Пожертвования
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений. |
|
value
|
value | array of EventApi.ParticipantDonation |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
EventApi.ApiCollectionOfParticipantFee
Оплата
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений. |
|
value
|
value | array of EventApi.ParticipantFee |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
EventApi.ApiCollectionOfParticipantFeePayment
Платежи за плату
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений. |
|
value
|
value | array of EventApi.ParticipantFeePayment |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
EventApi.ApiCollectionOfParticipantListEntry
Участники
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений. |
|
value
|
value | array of EventApi.ParticipantListEntry |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
EventApi.ApiCollectionOfParticipantOption
Параметры участника
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений. |
|
value
|
value | array of EventApi.ParticipantOption |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
EventApi.Country
Определяет модель данных, используемую для страны адреса.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор записи страны. |
|
отображаемое имя
|
display_name | string |
Отображаемое имя страны. |
|
ISO-код
|
iso_alpha2_code | string |
Код ISO 3166-1 alpha-2 для страны. |
EventApi.CreatedEvent
Созданное событие
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор только что созданного события. |
EventApi.CreatedEventAttachment
Созданное вложение событий
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор только что созданного вложения события. |
EventApi.CreatedEventFee
Созданная плата за событие
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор только что созданной платы за событие. |
EventApi.CreatedEventParticipantOption
Параметр "Созданный участник события"
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор только что созданного параметра участника события. |
EventApi.CreatedParticipant
Созданный участник
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор только что созданного участника. |
EventApi.CreatedParticipantDonation
Созданное пожертвование участника
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор только что созданного пожертвования участника. |
EventApi.CreatedParticipantFee
Созданная плата за участника
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор только что созданной платы участника. |
EventApi.CreatedParticipantFeePayment
Созданный платеж за участие
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор только что созданного платежа за участника. |
EventApi.CreatedParticipantOption
Параметр "Созданный участник"
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор только что созданного параметра участника. |
EventApi.Event
Event
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор системной записи события. Это не то же самое, что и идентификатор события, определяемый пользователем, который хранится в lookup_id. |
|
Имя
|
name | string |
Название мероприятия. |
|
Description
|
description | string |
Описание события. |
|
Начальная дата
|
start_date | date |
Дата начала события. |
|
Время запуска
|
start_time | string |
Время начала события. |
|
Дата окончания
|
end_date | date |
Дата окончания события. |
|
Время окончания
|
end_time | string |
Время окончания события. |
|
Категория
|
category | EventApi.EventCategory |
Категория событий — это настраиваемая классификация для события. |
|
Идентификатор подстановки
|
lookup_id | string |
Идентификатор подстановки события. |
|
Местоположение
|
location | EventApi.Location |
Определяет модель данных, используемую для расположения. |
|
Capacity
|
capacity | integer |
Количество людей, которые могут присутствовать на мероприятии. |
|
Цель
|
goal | double |
Денежные цели события. |
|
Идентификатор кампании
|
campaign_id | string |
Системный идентификатор записи кампании, связанной с событием. |
|
Идентификатор фонда
|
fund_id | string |
Системный идентификатор фонда, связанного с событием. |
|
Неактивный?
|
inactive | boolean |
Неактивен ли событие? |
|
Дата добавления
|
date_added | date-time |
Дата создания события. |
|
Дата изменения
|
date_modified | date-time |
Дата последнего изменения события. |
EventApi.EventAttachment
Вложение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор системной записи вложения. |
|
Идентификатор события
|
parent_id | string |
Идентификатор системной записи события, связанного с вложением. |
|
Тип
|
type | string |
Тип вложения. Физические вложения отправляются в файлы, такие как изображения, PDF-файлы или документы Word, сохраненные локально или в сети. Они хранятся и управляются в системе. Ссылки на вложения — это ссылки на такие файлы, как изображения, записи блога или видео YouTube, которые находятся в Сети или в облачной учетной записи хранения. Они хранятся и управляются внешним образом. |
|
Имя
|
name | string |
Имя вложения. Ограничение символов: 150. |
|
Date
|
date | date-time |
Дата вложения. |
|
URL
|
url | string |
URL-адрес для вложения. Это необходимо для вложений ссылок и неприменимо для физических вложений. |
|
Имя файла
|
file_name | string |
Имя файла. Ограничение символов: 36. Только для физических вложений. |
|
Идентификатор файла
|
file_id | string |
Идентификатор файла. Ограничение символов: 36. Только для физических вложений. |
|
Идентификатор эскиза
|
thumbnail_id | string |
Идентификатор эскиза. Ограничение символов: 36. Только для физических вложений. |
|
URL-адрес эскиза
|
thumbnail_url | string |
URL-адрес эскиза. Для физических вложений, которые являются только изображениями. Содержит сигнатуру с привязкой к времени, которая ограничивает доступ к 60 минутам. |
|
Тип контента
|
content_type | string |
Тип контента. Только для физических вложений. |
|
Размер файла
|
file_size | integer |
Размер файла в байтах. Только для физических вложений. |
|
Метки
|
tags | array of string |
Теги, связанные с вложением. |
EventApi.EventAttachmentCollection
Attachments
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений. |
|
value
|
value | array of EventApi.EventAttachment |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
EventApi.EventCategory
Категория событий — это настраиваемая классификация для события.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Системный идентификатор записи категории событий. |
|
имя
|
name | string |
Имя категории событий. |
|
неактивный?
|
inactive | boolean |
Неактивна ли эта категория? |
EventApi.EventFee
Плата за мероприятия — это плата за участие или участие в мероприятии в организации для отдельных лиц или организаций.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Системный идентификатор платы за событие. |
|
имя
|
name | string |
Имя платы за событие. |
|
количество
|
cost | double |
Стоимость платы. |
|
Сумма вклада
|
contribution_amount | double |
Налог вычитаемой суммы за эту плату. |
|
число продано
|
number_sold | integer |
Количество проданных сборов. |
EventApi.EventListEntry
Event
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор системной записи события. |
|
Имя
|
name | string |
Название мероприятия. |
|
Начальная дата
|
start_date | date |
Дата начала события. |
|
Время запуска
|
start_time | string |
Время начала события. |
|
Дата окончания
|
end_date | date |
Дата окончания события. |
|
Время окончания
|
end_time | string |
Время окончания события. |
|
Категория
|
category | EventApi.EventCategory |
Категория событий — это настраиваемая классификация для события. |
|
Идентификатор подстановки
|
lookup_id | string |
Идентификатор подстановки события. |
|
Capacity
|
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
Параметры участника события — это поля, которые собирают сведения о участниках, таких как размер футболки, предпочтения питания или запросы на сидение. Задайте параметры и их значения для события, а затем добавьте ответы для каждого участника.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор системной записи параметра участника события. |
|
имя
|
name | string |
Имя параметра участника события. |
|
тип входных данных
|
input_type | string |
Тип параметра участника события. |
|
разрешить выбор нескольких вариантов?
|
multi_select | boolean |
Разрешить несколько значений для списков? |
|
list_options
|
list_options | array of EventApi.EventParticipantOptionListOption |
Доступные параметры списка. |
|
добавлен пользователем
|
added_by_user | string |
Идентификатор пользователя, добавляющего этот параметр. |
|
изменено пользователем
|
updated_by_user | string |
Идентификатор пользователя, изменившего параметр. |
|
добавлено службой
|
added_by_service | string |
Имя службы, которая добавила этот параметр. |
|
изменено службой
|
updated_by_service | string |
Имя службы, которая изменила этот параметр. |
|
Добавлено
|
date_added | date-time |
Дата создания параметра. |
|
дата изменения
|
date_updated | date-time |
Дата последнего изменения параметра. |
|
version
|
version | integer |
Номер версии параметра. |
EventApi.EventParticipantOptionListOption
Параметр списка параметров участника события
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор параметра списка |
|
имя
|
name | string |
Имя параметра списка |
|
последовательность
|
sequence | integer |
Последовательность, используемая для упорядочивания параметров списка |
EventApi.Locality
Определяет модель данных, используемую для локальности адреса.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор записи локальности. |
|
имя
|
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 | string |
Идентификатор системной записи категории членства. |
|
имя
|
name | string |
Имя категории членства. |
EventApi.Participant
Участник
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Системный идентификатор записи участника. |
|
Составной идентификатор
|
constituent_id | string |
Составляющий идентификатор участника. |
|
Идентификатор события
|
event_id | string |
Системный идентификатор записи для посещаемого события. |
|
Идентификатор узла
|
host_id | string |
Идентификатор записи участника узла. |
|
Состояние RSVP
|
rsvp_status | string |
Состояние взаимодействия участника с событием. |
|
Присутствовал?
|
attended | boolean |
Присутствовал ли участник на мероприятии? |
|
Статус приглашения
|
invitation_status | string |
Состояние приглашения участнику. |
|
day
|
rsvp_date.d | integer |
День в нечеткой дате. |
|
month
|
rsvp_date.m | integer |
Месяц в нечеткой дате. |
|
год
|
rsvp_date.y | integer |
Год в нечеткой дате. |
|
day
|
invitation_date.d | integer |
День в нечеткой дате. |
|
month
|
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 | string |
Системный идентификатор пожертвования участника. |
|
Идентификатор подарка
|
gift_id | string |
Системный идентификатор записи подарка, к которому связан пожертвование участника. |
EventApi.ParticipantFee
Определяет модель данных для оплаты участника
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор платы участника. |
|
Идентификатор участника
|
participant_id | string |
Идентификатор записи, с которым связана плата участника. |
|
количество
|
quantity | integer |
Количество приобретенных. |
|
Сумма сборов
|
fee_amount | double |
Сумма платы за участника. |
|
Сумма вклада
|
tax_receiptable_amount | double |
Налог вычитаемой суммы за эту плату. |
|
day
|
date.d | integer |
День в нечеткой дате. |
|
month
|
date.m | integer |
Месяц в нечеткой дате. |
|
год
|
date.y | integer |
Год в нечеткой дате. |
|
Плата за событие
|
event_fee | EventApi.EventFee |
Плата за мероприятия — это плата за участие или участие в мероприятии в организации для отдельных лиц или организаций. |
EventApi.ParticipantFeePayment
Определяет модель данных для оплаты платы участника
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Системный идентификатор оплаты оплаты за участие. |
|
Идентификатор участника
|
participant_id | string |
Системный идентификатор записи участника, к которому связан платеж за плату участника. |
|
Идентификатор подарка
|
gift_id | string |
Системный идентификатор подарка, к которому связан платеж за плату участника. |
|
примененная сумма
|
applied_amount | double |
Примененная сумма оплаты за участие. |
EventApi.ParticipantListEntry
Участник
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Системный идентификатор записи участника. |
|
Код контактного лица
|
contact_id | string |
Идентификатор контакта, посещающего событие. |
|
Состояние RSVP
|
rsvp_status | string |
Состояние взаимодействия участника с событием. |
|
Присутствовал?
|
attended | boolean |
Присутствовал ли участник на мероприятии? |
|
Статус приглашения
|
invitation_status | string |
Состояние приглашения участнику. |
|
day
|
rsvp_date.d | integer |
День в нечеткой дате. |
|
month
|
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 |
Суффикс участника. |
|
Идентификатор подстановки
|
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 |
Дата последнего изменения участника. |
|
Идентификатор контакта
|
host.contact_id | string |
Идентификатор контакта, посещающего событие. |
|
Идентификатор участника
|
host.participant_id | string |
Идентификатор участника. |
|
имя
|
host.name | string |
Полное имя участника. |
|
Гости
|
guests | array of EventApi.ParticipantListParticipantSummary |
Гости участника. |
|
Членство
|
memberships | array of EventApi.Membership |
Сведения о членстве для участника. |
EventApi.ParticipantListParticipantSummary
Основные сведения о участниках.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор контакта
|
contact_id | string |
Идентификатор контакта, посещающего событие. |
|
Идентификатор участника
|
participant_id | string |
Идентификатор участника. |
|
имя
|
name | string |
Полное имя участника. |
EventApi.ParticipantOption
Параметр участника, связанный с заданным участником
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор системной записи параметра участника. |
|
Идентификатор участника
|
participant_id | string |
Системный идентификатор записи участника. |
|
Идентификатор события
|
event_id | string |
Идентификатор системной записи события. |
|
Идентификатор параметра участника события
|
event_participant_option_id | string |
Идентификатор системной записи параметра участника события. |
|
value
|
option_value | string |
Ответ участника на параметр. |
|
добавлен пользователем
|
added_by_user | string |
Идентификатор пользователя, добавляющего параметр участника. |
|
изменено пользователем
|
updated_by_user | string |
Идентификатор пользователя, изменившего параметр участника. |
|
добавлено службой
|
added_by_service | string |
Имя службы, которая добавила этот параметр участника. |
|
изменено службой
|
updated_by_service | string |
Имя службы, изменив этот параметр участника. |
|
Добавлено
|
date_added | date-time |
Дата создания параметра участника. |
|
дата изменения
|
date_updated | date-time |
Дата последнего изменения параметра участника. |
EventApi.ParticipationLevel
Уровни участия — это уровень участия участников в событии.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор системной записи уровня участия. |
|
имя
|
name | string |
Имя уровня участия. |
|
неактивный?
|
is_inactive | boolean |
Неактивен ли уровень участия? |
EventApi.SubAdministrativeArea
Определяет модель данных, используемую для подадминиционной области адреса (например, город в США).
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор подадминистрирования. |
|
имя
|
name | string |
Имя подадминистрирования. |