Blackbaud Raisers Edge NXT Fundraising
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 и предоставляет операции для управления сущностями сбора средств, найденными в Edge NXT The Raiser, в том числе:
- Кампании
- Денежные средства
- Апелляция
- Packages
- и другие...
Дополнительные сведения см. в документации.
Предпосылки
Чтобы использовать этот соединитель, у вас должна быть учетная запись Blackbaud ID с доступом к одной или нескольким средам Blackbaud.
Кроме того, администратор вашей организации также должен выполнять действия уровня администратора в системе, чтобы этот соединитель мог получить доступ к вашей среде Blackbaud. Дополнительные сведения об этих предварительных требованиях см. в документации по начальной настройке .
Как получить учетные данные?
Администратор вашей организации отправит вам приглашение в среду NXT edge организации и настроит разрешения учетной записи пользователя в среде. Для использования этого соединителя дополнительные учетные данные не требуются.
Известные проблемы и ограничения
Соединитель будет работать в контексте учетной записи пользователя и, следовательно, будет применяться к вашим разрешениям пользователя в среде.
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Вывод списка вложений в апелляцию |
Перечисляет вложения для апелляции. |
| Вывод списка вложений кампании |
Выводит список вложений для кампании. |
| Вывод списка вложений фонда |
Перечисляет вложения для фонда. |
| Вывод списка настраиваемых полей для обращения |
Перечисляет настраиваемые поля для призыва. |
| Вывод списка настраиваемых полей кампании |
Перечисляет настраиваемые поля для кампании. |
| Вывод списка настраиваемых полей фонда |
Перечисляет настраиваемые поля для фонда. |
| Вывод списка пакетов |
Возвращает список пакетов. |
| Обновление апелляции |
Обновляет апелляцию. |
| Обновление вложения апелляции |
Обновляет вложение апелляции. |
| Обновление вложения кампании |
Обновляет вложение кампании. |
| Обновление вложения фонда |
Обновляет вложение фонда. |
| Обновление кампании |
Обновляет кампанию. |
| Обновление настраиваемого поля для привлекательности |
Обновляет настраиваемое поле для обращения. |
| Обновление настраиваемого поля кампании |
Обновляет настраиваемое поле кампании. |
| Обновление настраиваемого поля фонда |
Обновляет настраиваемое поле фонда. |
| Обновление составной апелляции |
Обновляет составную апелляцию. |
| Обновление фонда |
Обновляет фонд. |
| Перечисление апелляций |
Возвращает список апелляций. |
| Перечисление связей, составляющих фонд |
Перечисляет составляющие отношения для фонда. |
| Перечисление связей с составляющими фондами |
Перечисляет отношения фонда для составляющих. |
| Перечисление составных апелляций |
Перечисляет призывы к избирателю. |
| Перечисление средств |
Возвращает список средств. |
| Получение апелляции |
Возвращает сведения об апелляции. |
| Получение кампании |
Возвращает сведения о кампании. |
| Получение пакета |
Возвращает сведения о пакете. |
| Получение фонда |
Возвращает сведения о фонде. |
| Создание вложения апелляции |
Создает новое вложение апелляции. |
| Создание вложения кампании |
Создает новое вложение кампании. |
| Создание вложения фонда |
Создает новое вложение фонда. |
| Создание настраиваемого поля для привлекательности |
Создает новое настраиваемое поле привлекательности. |
| Создание настраиваемого поля кампании |
Создает настраиваемое поле кампании. |
| Создание настраиваемого поля фонда |
Создает настраиваемое поле фонда. |
| Создание призыва |
Создает новую апелляцию. |
| Создание составной апелляции |
Создает новую составную апелляцию. |
| Создание фонда |
Создает новый фонд. |
| Создать кампанию |
Создает новую кампанию. |
| Список кампаний |
Возвращает список кампаний. |
Вывод списка вложений в апелляцию
Перечисляет вложения для апелляции.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор апелляции
|
appeal_id | True | string |
Идентификатор системной записи апелляции. |
Возвращаемое значение
Attachments
Вывод списка вложений кампании
Выводит список вложений для кампании.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор кампании
|
campaign_id | True | string |
Идентификатор системной записи кампании. |
Возвращаемое значение
Attachments
Вывод списка вложений фонда
Перечисляет вложения для фонда.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор фонда
|
fund_id | True | string |
Системный идентификатор фонда. |
Возвращаемое значение
Attachments
Вывод списка настраиваемых полей для обращения
Перечисляет настраиваемые поля для призыва.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор апелляции
|
appeal_id | True | string |
Идентификатор системной записи апелляции. |
Возвращаемое значение
Пользовательские поля
Вывод списка настраиваемых полей кампании
Перечисляет настраиваемые поля для кампании.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор кампании
|
campaign_id | True | string |
Идентификатор системной записи кампании. |
Возвращаемое значение
Пользовательские поля
Вывод списка настраиваемых полей фонда
Перечисляет настраиваемые поля для фонда.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор фонда
|
fund_id | True | string |
Системный идентификатор фонда. |
Возвращаемое значение
Пользовательские поля
Вывод списка пакетов
Возвращает список пакетов.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор апелляции
|
appeal_id | string |
Представляет разделенный запятыми список идентификаторов записей системы апелляции для фильтрации результатов. Например, "506 918" возвращает только пакеты для апелляции 506 или апелляции 918. |
|
|
Лимит
|
limit | integer |
Представляет количество возвращаемых записей. Значение по умолчанию — 500. Максимальное значение — 5000. |
|
|
Смещение
|
offset | integer |
Представляет количество пропускаемых записей. Для использования с разбивкой на страницы. |
|
|
Включить неактивное?
|
include_inactive | boolean |
Включить неактивные пакеты? |
|
|
Добавлен или после
|
date_added | date-time |
Отфильтруйте результаты до пакетов, созданных по указанной дате (например, "2020-09-18T04:13:56Z"). |
|
|
Изменено или после
|
last_modified | date-time |
Отфильтруйте результаты до пакетов, измененных по указанной дате (например, "2020-09-18T04:13:56Z"). |
Возвращаемое значение
Packages
Обновление апелляции
Обновляет апелляцию.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор апелляции
|
id | True | integer |
Идентификатор системной записи призыва к обновлению. |
|
Идентификатор подстановки
|
appeal_id | string |
Определяемый пользователем идентификатор для апелляции. |
|
|
Description
|
description | string |
Описание апелляции. |
|
|
Начальная дата
|
start_date | date |
Дата начала обращения (например, "2005-09-18"). |
|
|
Дата окончания
|
end_date | date |
Дата окончания апелляции (например, "2005-09-18"). |
|
|
Категория
|
appeal_category_id | integer |
Категория апелляции. |
|
|
Цель
|
goal | double |
Целевая сумма, которую необходимо поднять через апелляцию. |
|
|
Сумма подарков по умолчанию
|
default_gift_amount | double |
Денежный объем подарка по умолчанию. Это свойство по умолчанию равно 0,00, если сумма не указана. |
|
|
Запрошенное число
|
number_solicited | integer |
Число избирателей, запрошенных в апелляции. |
|
|
Примечания.
|
notes | string |
Заметки, связанные с апелляцией. |
|
|
Идентификатор кампании по умолчанию
|
campaign_id | integer |
Идентификатор кампании, связанной с апелляцией. |
|
|
Идентификатор фонда по умолчанию
|
default_fund_id | integer |
Идентификатор фонда по умолчанию, связанного с апелляцией. |
|
|
Неактивный?
|
inactive | boolean |
Неактивна ли апелляция (то есть текущая дата после любой даты начала и до любой даты окончания)? |
Обновление вложения апелляции
Обновляет вложение апелляции.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор вложения
|
attachment_id | True | string |
Идентификатор системной записи для обновления вложения. |
|
Имя
|
name | string |
Имя вложения. Ограничение символов: 150. |
|
|
Date
|
date | date-time |
Дата вложения (например, '2020-09-18T04:13:56Z'). |
|
|
URL
|
url | string |
URL-адрес для вложения. Это необходимо для вложений ссылок и неприменимо для физических вложений. |
|
|
Метки
|
tags | array of 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 |
Теги, связанные с вложением. |
Обновление вложения фонда
Обновляет вложение фонда.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор вложения
|
attachment_id | True | string |
Идентификатор системной записи для обновления вложения. |
|
Имя
|
name | string |
Имя вложения. Ограничение символов: 150. |
|
|
Date
|
date | date-time |
Дата вложения (например, '2020-09-18T04:13:56Z'). |
|
|
URL
|
url | string |
URL-адрес для вложения. Это необходимо для вложений ссылок и неприменимо для физических вложений. |
|
|
Метки
|
tags | array of string |
Теги, связанные с вложением. |
Обновление кампании
Обновляет кампанию.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор кампании
|
id | True | integer |
Идентификатор системной записи кампании для обновления. |
|
Идентификатор подстановки
|
campaign_id | string |
Определяемый пользователем идентификатор кампании. |
|
|
Description
|
description | string |
Описание кампании. |
|
|
Начальная дата
|
start_date | date |
Дата начала кампании (например, "2005-09-18"). |
|
|
Дата окончания
|
end_date | date |
Дата окончания кампании (например, "2005-09-18"). |
|
|
Категория
|
campaign_category_id | integer |
Категория кампании. |
|
|
Цель
|
goal | double |
Целевая сумма, которую нужно поднять через кампанию. |
|
|
Примечания.
|
notes | string |
Заметки, связанные с кампанией. |
|
|
Неактивный?
|
inactive | boolean |
Неактивна ли кампания (то есть текущая дата после любой даты начала и до любой даты окончания)? |
|
|
Идентификатор фонда по умолчанию
|
default_fund_id | integer |
Идентификатор фонда по умолчанию, связанного с кампанией. |
Обновление настраиваемого поля для привлекательности
Обновляет настраиваемое поле для обращения.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор настраиваемого поля
|
custom_field_id | True | string |
Идентификатор системной записи настраиваемого поля для обновления. |
|
body
|
body | True | dynamic |
Объект, представляющий свойства настраиваемого поля для обновления. |
Обновление настраиваемого поля кампании
Обновляет настраиваемое поле кампании.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор настраиваемого поля
|
custom_field_id | True | string |
Идентификатор системной записи настраиваемого поля для обновления. |
|
body
|
body | True | dynamic |
Объект, представляющий свойства настраиваемого поля для обновления. |
Обновление настраиваемого поля фонда
Обновляет настраиваемое поле фонда.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор настраиваемого поля
|
custom_field_id | True | string |
Идентификатор системной записи настраиваемого поля для обновления. |
|
body
|
body | True | dynamic |
Объект, представляющий свойства настраиваемого поля для обновления. |
Обновление составной апелляции
Обновляет составную апелляцию.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор апелляции
|
id | True | integer |
Системный идентификатор пакета апелляции на обновление. |
|
Описание апелляции
|
appeal_description | string |
Описание апелляции; используется для поиска идентификатора записи апелляции. |
|
|
Описание пакета
|
package_description | string |
Описание пакета; используется для поиска идентификатора записи пакета. |
|
|
Date
|
appeal_date | date |
Дата составной апелляции (например, "2005-09-18"). |
|
|
Ответ
|
response_description | string |
Длинное описание ответа на составную апелляцию. |
|
|
Сегмент маркетинга
|
marketing_segment | string |
Сегмент маркетинга, связанный с составной апелляцией. |
|
|
Маркетинговый исходный код
|
marketing_source_code | string |
Маркетинговый исходный код, связанный с составной апелляцией. |
|
|
Идентификатор почты
|
mailing_id | integer |
Идентификатор рассылки в составной апелляции. |
|
|
Номер средства поиска
|
market_finder_number | string |
Номер средства поиска рынка, связанный с составной апелляцией. |
|
|
Comments
|
comments | string |
Комментарии, связанные с составной апелляцией. |
Обновление фонда
Обновляет фонд.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор фонда
|
id | True | integer |
Системный идентификатор фонда для обновления. |
|
Идентификатор подстановки
|
fund_id | string |
Определяемый пользователем идентификатор для фонда. |
|
|
Description
|
description | string |
Описание фонда. |
|
|
Начальная дата
|
start_date | date |
Дата начала для фонда (например, "2005-09-18"). |
|
|
Дата окончания
|
end_date | date |
Дата окончания фонда (например, "2005-09-18"). |
|
|
Категория
|
fund_category_id | integer |
Категория фонда. |
|
|
Тип
|
fund_type_id | integer |
Тип фонда. |
|
|
Цель
|
goal | double |
Целевая сумма, которую необходимо собрать для фонда. |
|
|
Примечания.
|
notes | string |
Заметки, связанные с фондом. |
|
|
Ограниченный?
|
restricted | boolean |
Ограничен ли фонд конкретными пользователями? |
|
|
Неактивный?
|
inactive | boolean |
Неактивен ли фонд (то есть текущая дата после любой даты начала и до любой даты окончания)? |
|
|
Идентификатор кампании
|
campaign_id | integer |
Идентификатор кампании, связанной с фондом. |
|
|
Идентификатор апелляции по умолчанию
|
default_appeal_id | integer |
Идентификатор апелляции по умолчанию, связанной с фондом. |
Перечисление апелляций
Возвращает список апелляций.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Лимит
|
limit | integer |
Представляет количество возвращаемых записей. Значение по умолчанию — 500. Максимальное значение — 5000. |
|
|
Смещение
|
offset | integer |
Представляет количество пропускаемых записей. Для использования с разбивкой на страницы. |
|
|
Включить неактивное?
|
include_inactive | boolean |
Включить неактивные апелляции? |
|
|
Добавлен или после
|
date_added | date-time |
Отфильтруйте результаты по апелляциям, созданным по указанной дате (например, "2020-09-18T04:13:56Z"). |
|
|
Изменено или после
|
last_modified | date-time |
Отфильтруйте результаты, изменяемые по указанной дате или после указанной даты (например, "2020-09-18T04:13:56Z"). |
Возвращаемое значение
Апелляция
Перечисление связей, составляющих фонд
Перечисляет составляющие отношения для фонда.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор фонда
|
fundId | True | integer |
Системный идентификатор фонда. |
|
Лимит
|
limit | integer |
Представляет количество возвращаемых записей. |
|
|
Смещение
|
offset | integer |
Представляет количество пропускаемых записей. Для использования с разбивкой на страницы. |
Возвращаемое значение
Составляющие связи
Перечисление связей с составляющими фондами
Перечисляет отношения фонда для составляющих.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Составной идентификатор
|
constituentId | True | integer |
Системный идентификатор записи компонента. |
|
Лимит
|
limit | integer |
Представляет количество возвращаемых записей. |
|
|
Смещение
|
offset | integer |
Представляет количество пропускаемых записей. Для использования с разбивкой на страницы. |
Возвращаемое значение
Отношения фонда
Перечисление составных апелляций
Перечисляет призывы к избирателю.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Составной идентификатор
|
constituent_id | True | string |
Системный идентификатор записи компонента. |
Возвращаемое значение
Составные апелляции
Перечисление средств
Возвращает список средств.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Лимит
|
limit | integer |
Представляет количество возвращаемых записей. Значение по умолчанию — 500. Максимальное значение — 5000. |
|
|
Смещение
|
offset | integer |
Представляет количество пропускаемых записей. Для использования с разбивкой на страницы. |
|
|
Включить неактивное?
|
include_inactive | boolean |
Включить неактивные средства? |
|
|
Добавлен или после
|
date_added | date-time |
Отфильтруйте результаты для средств, созданных по указанной дате (например, "2020-09-18T04:13:56Z"). |
|
|
Изменено или после
|
last_modified | date-time |
Отфильтруйте результаты по фондам, измененным по указанной дате (например, "2020-09-18T04:13:56Z"). |
Возвращаемое значение
Денежные средства
Получение апелляции
Возвращает сведения об апелляции.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор апелляции
|
appeal_id | True | string |
Идентификатор системной записи для получения апелляции. |
Возвращаемое значение
Appeal
Получение кампании
Возвращает сведения о кампании.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор кампании
|
campaign_id | True | string |
Системный идентификатор записи кампании для получения. |
Возвращаемое значение
кампания
Получение пакета
Возвращает сведения о пакете.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пакета
|
package_id | True | string |
Идентификатор системной записи пакета, который требуется получить. |
Возвращаемое значение
Package
Получение фонда
Возвращает сведения о фонде.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор фонда
|
fund_id | True | string |
Системный идентификатор фонда для получения. |
Возвращаемое значение
Фонд
Создание вложения апелляции
Создает новое вложение апелляции.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор апелляции
|
parent_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 |
Теги, связанные с вложением. |
Возвращаемое значение
Созданное вложение апелляции
Создание вложения кампании
Создает новое вложение кампании.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор кампании
|
parent_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 |
Теги, связанные с вложением. |
Возвращаемое значение
Созданное вложение кампании
Создание вложения фонда
Создает новое вложение фонда.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор фонда
|
parent_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 |
Теги, связанные с вложением. |
Возвращаемое значение
Созданное вложение фонда
Создание настраиваемого поля для привлекательности
Создает новое настраиваемое поле привлекательности.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
Объект, представляющий настраиваемое поле для создания. |
Возвращаемое значение
Созданное настраиваемое поле для обращения
Создание настраиваемого поля кампании
Создает настраиваемое поле кампании.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
Объект, представляющий настраиваемое поле для создания. |
Возвращаемое значение
Созданное настраиваемое поле кампании
Создание настраиваемого поля фонда
Создает настраиваемое поле фонда.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
Объект, представляющий настраиваемое поле для создания. |
Возвращаемое значение
Созданное настраиваемое поле фонда
Создание призыва
Создает новую апелляцию.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор подстановки
|
appeal_id | True | string |
Определяемый пользователем идентификатор для апелляции. |
|
Description
|
description | True | string |
Описание апелляции. |
|
Начальная дата
|
start_date | date |
Дата начала обращения (например, "2005-09-18"). |
|
|
Дата окончания
|
end_date | date |
Дата окончания апелляции (например, "2005-09-18"). |
|
|
Категория
|
appeal_category_id | integer |
Категория апелляции. |
|
|
Цель
|
goal | double |
Целевая сумма, которую необходимо поднять через апелляцию. |
|
|
Сумма подарков по умолчанию
|
default_gift_amount | double |
Денежный объем подарка по умолчанию. Это свойство по умолчанию равно 0,00, если сумма не указана. |
|
|
Запрошенное число
|
number_solicited | integer |
Число избирателей, запрошенных в апелляции. |
|
|
Примечания.
|
notes | string |
Заметки, связанные с апелляцией. |
|
|
Идентификатор кампании по умолчанию
|
campaign_id | integer |
Идентификатор кампании, связанной с апелляцией. |
|
|
Идентификатор фонда по умолчанию
|
default_fund_id | integer |
Идентификатор фонда по умолчанию, связанного с апелляцией. |
|
|
Неактивный?
|
inactive | boolean |
Неактивна ли апелляция (то есть текущая дата после любой даты начала и до любой даты окончания)? |
Возвращаемое значение
Созданная апелляция
Создание составной апелляции
Создает новую составную апелляцию.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Составной идентификатор
|
constituent_id | True | integer |
Системный идентификатор компонента, связанного с составной апелляцией. |
|
Описание апелляции
|
appeal_description | True | string |
Описание апелляции; используется для поиска идентификатора записи апелляции. |
|
Описание пакета
|
package_description | string |
Описание пакета; используется для поиска идентификатора записи пакета. |
|
|
Date
|
appeal_date | date |
Дата составной апелляции (например, "2005-09-18"). |
|
|
Ответ
|
response_description | string |
Длинное описание ответа на составную апелляцию. |
|
|
Сегмент маркетинга
|
marketing_segment | string |
Сегмент маркетинга, связанный с составной апелляцией. |
|
|
Маркетинговый исходный код
|
marketing_source_code | string |
Маркетинговый исходный код, связанный с составной апелляцией. |
|
|
Идентификатор почты
|
mailing_id | integer |
Идентификатор рассылки в составной апелляции. |
|
|
Номер средства поиска
|
market_finder_number | string |
Номер средства поиска рынка, связанный с составной апелляцией. |
|
|
Comments
|
comments | string |
Комментарии, связанные с составной апелляцией. |
|
|
Идентификатор импорта
|
import_id | string |
Идентификатор импорта конституционной апелляции. |
Возвращаемое значение
Созданная составная апелляция
Создание фонда
Создает новый фонд.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор подстановки
|
fund_id | True | string |
Определяемый пользователем идентификатор для фонда. |
|
Description
|
description | True | string |
Описание фонда. |
|
Начальная дата
|
start_date | date |
Дата начала для фонда (например, "2005-09-18"). |
|
|
Дата окончания
|
end_date | date |
Дата окончания фонда (например, "2005-09-18"). |
|
|
Категория
|
fund_category_id | integer |
Категория фонда. |
|
|
Тип
|
fund_type_id | integer |
Тип фонда. |
|
|
Цель
|
goal | double |
Целевая сумма, которую необходимо собрать для фонда. |
|
|
Примечания.
|
notes | string |
Заметки, связанные с фондом. |
|
|
Ограниченный?
|
restricted | boolean |
Ограничен ли фонд конкретными пользователями? |
|
|
Неактивный?
|
inactive | boolean |
Неактивен ли фонд (то есть текущая дата после любой даты начала и до любой даты окончания)? |
|
|
Идентификатор кампании
|
campaign_id | integer |
Идентификатор кампании, связанной с фондом. |
|
|
Идентификатор апелляции по умолчанию
|
default_appeal_id | integer |
Идентификатор апелляции по умолчанию, связанной с фондом. |
Возвращаемое значение
Созданный фонд
Создать кампанию
Создает новую кампанию.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор подстановки
|
campaign_id | True | string |
Определяемый пользователем идентификатор кампании. |
|
Description
|
description | True | string |
Описание кампании. |
|
Начальная дата
|
start_date | date |
Дата начала кампании (например, "2005-09-18"). |
|
|
Дата окончания
|
end_date | date |
Дата окончания кампании (например, "2005-09-18"). |
|
|
Категория
|
campaign_category_id | integer |
Категория кампании. |
|
|
Цель
|
goal | double |
Целевая сумма, которую нужно поднять через кампанию. |
|
|
Примечания.
|
notes | string |
Заметки, связанные с кампанией. |
|
|
Неактивный?
|
inactive | boolean |
Неактивна ли кампания (то есть текущая дата после любой даты начала и до любой даты окончания)? |
|
|
Идентификатор фонда по умолчанию
|
default_fund_id | integer |
Идентификатор фонда по умолчанию, связанного с кампанией. |
Возвращаемое значение
Созданная кампания
Список кампаний
Возвращает список кампаний.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Лимит
|
limit | integer |
Представляет количество возвращаемых записей. Значение по умолчанию — 500. Максимальное значение — 5000. |
|
|
Смещение
|
offset | integer |
Представляет количество пропускаемых записей. Для использования с разбивкой на страницы. |
|
|
Включить неактивное?
|
include_inactive | boolean |
Включить неактивные кампании? |
|
|
Добавлен или после
|
date_added | date-time |
Отфильтруйте результаты до кампаний, созданных по указанной дате (например, "2020-09-18T04:13:56Z"). |
|
|
Изменено или после
|
last_modified | date-time |
Отфильтруйте результаты до кампаний, измененных по указанной дате (например, "2020-09-18T04:13:56Z"). |
Возвращаемое значение
Кампании
Определения
ConstituentApi.ApiCollectionOfConstituentAppealRead
Составные апелляции
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений. |
|
value
|
value | array of ConstituentApi.ConstituentAppealRead |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
ConstituentApi.ConstituentAppealRead
Составная апелляция
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Системный идентификатор конституционной апелляции. |
|
Идентификатор
|
appeal.id | string |
Идентификатор системной записи апелляции. |
|
описание
|
appeal.description | string |
Описание апелляции. |
|
Идентификатор
|
package.id | string |
Идентификатор системной записи пакета. |
|
описание
|
package.description | string |
Описание пакета. |
|
Date
|
date | date-time |
Дата подачи апелляции. |
|
Ответ
|
response | string |
Ответ на составную апелляцию. |
|
Сегмент маркетинга
|
marketing_segment | string |
Сегмент маркетинга для составной апелляции. |
|
Маркетинговый исходный код
|
marketing_source_code | string |
Маркетинговый исходный код для составной апелляции. |
|
Идентификатор почты
|
mailing_id | string |
Определяемый пользователем идентификатор рассылки для составной апелляции. |
|
Номер средства поиска
|
finder_number | string |
Номер средства поиска маркетинга для составной апелляции. |
|
Comments
|
comments | string |
Комментарии пользователей к составной апелляции. |
Сбор средствApi.ApiCollectionOfAppealAttachmentRead
Attachments
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений. |
|
value
|
value | array of FundraisingApi.AppealAttachmentRead |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
Сбор средствApi.ApiCollectionOfAppealCustomFieldRead
Пользовательские поля
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений. |
|
value
|
value | array of FundraisingApi.AppealCustomFieldRead |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
Сбор средствApi.ApiCollectionOfAppealRead
Апелляция
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений. |
|
value
|
value | array of FundraisingApi.AppealRead |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
Сбор средствApi.ApiCollectionOfCampaignAttachmentRead
Attachments
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений. |
|
value
|
value | array of FundraisingApi.CampaignAttachmentRead |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
Сбор средствApi.ApiCollectionOfCampaignCustomFieldRead
Пользовательские поля
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений. |
|
value
|
value | array of FundraisingApi.CampaignCustomFieldRead |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
Сбор средствApi.ApiCollectionOfCampaignRead
Кампании
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений. |
|
value
|
value | array of FundraisingApi.CampaignRead |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
Сбор средствApi.ApiCollectionOfFundAttachmentRead
Attachments
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений. |
|
value
|
value | array of FundraisingApi.FundAttachmentRead |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
Сбор средствApi.ApiCollectionOfFundCustomFieldRead
Пользовательские поля
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений. |
|
value
|
value | array of FundraisingApi.FundCustomFieldRead |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
Сбор средствApi.ApiCollectionOfFundRead
Денежные средства
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений. |
|
value
|
value | array of FundraisingApi.FundRead |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
Сбор средствApi.ApiCollectionOfPackageRead
Packages
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений. |
|
value
|
value | array of FundraisingApi.PackageRead |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
Сбор средствApi.AppealAttachmentRead
Вложение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
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 |
Теги, связанные с вложением. |
Сбор средствApi.AppealCustomFieldRead
Настраиваемое поле
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор системной записи настраиваемого поля. |
|
Идентификатор апелляции
|
parent_id | string |
Идентификатор системной записи апелляции, связанной с настраиваемым полем. |
|
Категория
|
category | string |
Категория настраиваемого поля. |
|
Тип
|
type | string |
Тип данных, которые представляет настраиваемое поле. |
|
Ценность
|
value |
Значение настраиваемого поля. |
|
|
Текстовое значение
|
text_value | string |
Текстовое значение настраиваемого поля. |
|
Числовое значение
|
number_value | integer |
Числовое значение настраиваемого поля. |
|
Значение даты
|
date_value | date |
Значение даты настраиваемого поля. |
|
Значение валюты
|
currency_value | double |
Значение валюты настраиваемого поля. |
|
Логическое значение
|
boolean_value | boolean |
Логическое значение настраиваемого поля. |
|
Значение записи таблицы
|
codetableentry_value | string |
Значение записи таблицы настраиваемого поля. |
|
Значение составного идентификатора
|
constituentid_value | string |
Значение составного идентификатора настраиваемого поля. |
|
day
|
fuzzydate_value.d | integer |
День в нечеткой дате. |
|
month
|
fuzzydate_value.m | integer |
Месяц в нечеткой дате. |
|
год
|
fuzzydate_value.y | integer |
Год в нечеткой дате. |
|
Date
|
date | date |
Дата настраиваемого поля. |
|
Комментарий
|
comment | string |
Комментарий к пользовательскому полю. Ограничение символов: 50. |
|
Дата добавления
|
date_added | date-time |
Дата создания настраиваемого поля. |
|
Дата изменения
|
date_modified | date-time |
Дата последнего изменения настраиваемого поля. |
Сбор средствApi.AppealRead
Appeal
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор системной записи апелляции. |
|
Категория
|
category | string |
Категория апелляции. |
|
Дата добавления
|
date_added | date-time |
Дата создания апелляции. |
|
Дата изменения
|
date_modified | date-time |
Дата последнего изменения апелляции. |
|
Description
|
description | string |
Отображаемое имя призыва. |
|
Дата окончания
|
end_date | date-time |
Дата окончания апелляции. |
|
value
|
goal.value | double |
Денежное значение. |
|
Неактивный?
|
inactive | boolean |
Активна ли апелляция (то есть текущая дата после любой даты начала и до любой даты окончания)? |
|
Идентификатор подстановки
|
lookup_id | string |
Определяемый пользователем идентификатор для апелляции. |
|
Начальная дата
|
start_date | date-time |
Дата начала апелляции. |
Сбор средствApi.CampaignAttachmentRead
Вложение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
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 |
Теги, связанные с вложением. |
Сбор средствApi.CampaignCustomFieldRead
Настраиваемое поле
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор системной записи настраиваемого поля. |
|
Идентификатор кампании
|
parent_id | string |
Идентификатор системной записи кампании, связанной с настраиваемым полем. |
|
Категория
|
category | string |
Категория настраиваемого поля. |
|
Тип
|
type | string |
Тип данных, которые представляет настраиваемое поле. |
|
Ценность
|
value |
Значение настраиваемого поля. |
|
|
Текстовое значение
|
text_value | string |
Текстовое значение настраиваемого поля. |
|
Числовое значение
|
number_value | integer |
Числовое значение настраиваемого поля. |
|
Значение даты
|
date_value | date |
Значение даты настраиваемого поля. |
|
Значение валюты
|
currency_value | double |
Значение валюты настраиваемого поля. |
|
Логическое значение
|
boolean_value | boolean |
Логическое значение настраиваемого поля. |
|
Значение записи таблицы
|
codetableentry_value | string |
Значение записи таблицы настраиваемого поля. |
|
Значение составного идентификатора
|
constituentid_value | string |
Значение составного идентификатора настраиваемого поля. |
|
day
|
fuzzydate_value.d | integer |
День в нечеткой дате. |
|
month
|
fuzzydate_value.m | integer |
Месяц в нечеткой дате. |
|
год
|
fuzzydate_value.y | integer |
Год в нечеткой дате. |
|
Date
|
date | date |
Дата настраиваемого поля. |
|
Комментарий
|
comment | string |
Комментарий к пользовательскому полю. Ограничение символов: 50. |
|
Дата добавления
|
date_added | date-time |
Дата создания настраиваемого поля. |
|
Дата изменения
|
date_modified | date-time |
Дата последнего изменения настраиваемого поля. |
Сбор средствApi.CampaignRead
кампания
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор системной записи кампании. |
|
Категория
|
category | string |
Категория кампании. |
|
Дата добавления
|
date_added | date-time |
Дата создания кампании. |
|
Дата изменения
|
date_modified | date-time |
Дата последнего изменения кампании. |
|
Description
|
description | string |
Отображаемое имя кампании. |
|
Дата окончания
|
end_date | date-time |
Дата окончания кампании. |
|
value
|
goal.value | double |
Денежное значение. |
|
Неактивный?
|
inactive | boolean |
Неактивна ли кампания (то есть текущая дата после любой даты начала и до любой даты окончания)? |
|
Идентификатор подстановки
|
lookup_id | string |
Определяемый пользователем идентификатор кампании. |
|
Начальная дата
|
start_date | date-time |
Дата начала кампании. |
Сбор средствApi.CreatedAppealAttachment
Созданное вложение апелляции
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор только что созданного вложения апелляции. |
Сбор средствApi.CreatedAppealCustomField
Созданное настраиваемое поле для обращения
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор только что созданного настраиваемого поля для обращения. |
Сбор средствApi.CreatedCampaignAttachment
Созданное вложение кампании
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор только что созданного вложения кампании. |
Сбор средствApi.CreatedCampaignCustomField
Созданное настраиваемое поле кампании
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор созданного настраиваемого поля кампании. |
Сбор средствApi.CreatedFundAttachment
Созданное вложение фонда
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор только что созданного вложения фонда. |
Сбор средствApi.CreatedFundCustomField
Созданное настраиваемое поле фонда
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор только что созданного настраиваемого поля фонда. |
Сбор средствApi.FundAttachmentRead
Вложение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
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 |
Теги, связанные с вложением. |
Сбор средствApi.FundCustomFieldRead
Настраиваемое поле
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор системной записи настраиваемого поля. |
|
Идентификатор фонда
|
parent_id | string |
Системный идентификатор фонда, связанного с настраиваемым полем. |
|
Категория
|
category | string |
Категория настраиваемого поля. |
|
Тип
|
type | string |
Тип данных, которые представляет настраиваемое поле. |
|
Ценность
|
value |
Значение настраиваемого поля. |
|
|
Текстовое значение
|
text_value | string |
Текстовое значение настраиваемого поля. |
|
Числовое значение
|
number_value | integer |
Числовое значение настраиваемого поля. |
|
Значение даты
|
date_value | date |
Значение даты настраиваемого поля. |
|
Значение валюты
|
currency_value | double |
Значение валюты настраиваемого поля. |
|
Логическое значение
|
boolean_value | boolean |
Логическое значение настраиваемого поля. |
|
Значение записи таблицы
|
codetableentry_value | string |
Значение записи таблицы настраиваемого поля. |
|
Значение составного идентификатора
|
constituentid_value | string |
Значение составного идентификатора настраиваемого поля. |
|
day
|
fuzzydate_value.d | integer |
День в нечеткой дате. |
|
month
|
fuzzydate_value.m | integer |
Месяц в нечеткой дате. |
|
год
|
fuzzydate_value.y | integer |
Год в нечеткой дате. |
|
Date
|
date | date |
Дата настраиваемого поля. |
|
Комментарий
|
comment | string |
Комментарий к пользовательскому полю. Ограничение символов: 50. |
|
Дата добавления
|
date_added | date-time |
Дата создания настраиваемого поля. |
|
Дата изменения
|
date_modified | date-time |
Дата последнего изменения настраиваемого поля. |
Сбор средствApi.FundRead
Фонд
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Системный идентификатор фонда. |
|
Категория
|
category | string |
Категория фонда. |
|
Дата добавления
|
date_added | date-time |
Дата создания фонда. |
|
Дата изменения
|
date_modified | date-time |
Дата последнего изменения фонда. |
|
Description
|
description | string |
Отображаемое имя фонда. |
|
Дата окончания
|
end_date | date-time |
Дата окончания фонда. |
|
value
|
goal.value | double |
Денежное значение. |
|
Неактивный?
|
inactive | boolean |
Неактивен ли фонд (то есть текущая дата после любой даты начала и до любой даты окончания)? |
|
Идентификатор подстановки
|
lookup_id | string |
Определяемый пользователем идентификатор для фонда. |
|
Начальная дата
|
start_date | date-time |
Дата начала фонда. |
|
Тип
|
type | string |
Тип фонда. |
Сбор средствApi.PackageRead
Package
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор системной записи пакета. |
|
Идентификатор апелляции
|
appeal_id | string |
Системный идентификатор апелляции, связанной с этим пакетом. |
|
Категория
|
category | string |
Категория пакета. |
|
Дата добавления
|
date_added | date-time |
Дата создания пакета. |
|
Дата изменения
|
date_modified | date-time |
Дата последнего изменения пакета. |
|
value
|
default_gift_amount.value | double |
Денежное значение. |
|
Description
|
description | string |
Отображаемое имя пакета. |
|
Дата окончания
|
end | date-time |
Дата окончания пакета. |
|
value
|
goal.value | double |
Денежное значение. |
|
Неактивный?
|
inactive | boolean |
Неактивен ли пакет (то есть текущая дата после любой даты начала и до любой даты окончания)? |
|
Идентификатор подстановки
|
lookup_id | string |
Определяемый пользователем идентификатор пакета. |
|
Примечания.
|
notes | string |
Заметки о пакете. |
|
Число получателей
|
recipient_count | integer |
Число получателей пакета. |
|
Начальная дата
|
start | date-time |
Дата начала пакета. |
NXTDataIntegrationApi.ConstituentRelationship
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Составной идентификатор
|
relation_id | integer |
Идентификатор системной записи связанного компонента. |
|
Описание отношения
|
relation_description | string |
Описание отношения. |
|
Тип связи
|
relationship_type | string |
Тип связи. |
|
Тип взаимной связи
|
reciprocal_relationship_type | string |
Тип взаимной связи. |
|
Дата из
|
date_from | date-time |
Дата начала связи. |
|
Дата до
|
date_to | date-time |
Дата окончания связи. |
|
Примечания.
|
notes | string |
Заметки о связях. |
NXTDataIntegrationApi.ConstituentRelationshipCollection
Составляющие связи
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений. |
|
value
|
value | array of NXTDataIntegrationApi.ConstituentRelationship |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
NXTDataIntegrationApi.CreatedAppeal
Созданная апелляция
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор только что созданной апелляции. |
NXTDataIntegrationApi.CreatedCampaign
Созданная кампания
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор созданной кампании. |
NXTDataIntegrationApi.CreatedConstituentAppeal
Созданная составная апелляция
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор только что созданного конституционного апелляции. |
NXTDataIntegrationApi.CreatedFund
Созданный фонд
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор только что созданного фонда. |
NXTDataIntegrationApi.FundRelationship
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор фонда
|
relation_id | integer |
Системный идентификатор записи связанного фонда. |
|
Описание отношения
|
relation_description | string |
Описание отношения. |
|
Тип связи
|
relationship_type | string |
Тип связи. |
|
Тип взаимной связи
|
reciprocal_relationship_type | string |
Тип взаимной связи. |
|
Дата из
|
date_from | date-time |
Дата начала связи. |
|
Дата до
|
date_to | date-time |
Дата окончания связи. |
|
Примечания.
|
notes | string |
Заметки о связях. |
NXTDataIntegrationApi.FundRelationshipCollection
Отношения фонда
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений. |
|
value
|
value | array of NXTDataIntegrationApi.FundRelationship |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |