Управление Церковью Blackbaud [НЕ РЕКОМЕНДУЕТСЯ]
Управление Церковью Blackbaud предназначено для эффективного управления людьми, подарками, коммуникациями, событиями, небольшими группами, министерствами и платежами, все в одном месте.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | 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/solutions/organizational-and-program-management/church-management |
| Политика конфиденциальности | https://www.blackbaud.com/privacy-shield |
| Категории | Продажи и CRM; Продуктивность |
Этот соединитель предоставляет операции для управления сущностями, найденными в Blackbaud Church Management, который больше не находится в службе. Поэтому этот соединитель не рекомендуется.
Необходимые условия для использования этого соединителя должны иметь учетную запись Blackbaud ID с доступом к одной или нескольким средам Blackbaud.
Кроме того, администратор вашей организации также должен выполнять действия уровня администратора в системе, чтобы этот соединитель мог получить доступ к Управлению Церковью Blackbaud. Дополнительные сведения об этих предварительных требованиях см. в документации по начальной настройке.
Как получить учетные данные? Администратор вашей организации отправит вам приглашение в среду управления церковью Blackbaud организации и настроит разрешения учетной записи пользователя в среде. Для использования этого соединителя дополнительные учетные данные не требуются.
Известные проблемы и ограничения Соединитель будет работать в контексте учетной записи пользователя и, следовательно, будет подвергаться разрешениям пользователя в среде.
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Вывод списка адресов электронной почты (не рекомендуется) [DEPRECATED] |
Перечисляет адреса электронной почты для компонента (не рекомендуется). |
| Вывод списка вложений апелляции (не рекомендуется) [DEPRECATED] |
Перечисляет вложения для апелляции (не рекомендуется). |
| Вывод списка вложений действий (не рекомендуется) [DEPRECATED] |
Перечисляет вложения для действия (не рекомендуется). |
| Вывод списка вложений кампании (не рекомендуется) [DEPRECATED] |
Выводит вложения для кампании (не рекомендуется). |
| Вывод списка вложений подарков (не рекомендуется) [DEPRECATED] |
Перечисляет вложения для подарка (не рекомендуется). |
| Вывод списка вложений фонда (не рекомендуется) [DEPRECATED] |
Перечисляет вложения для фонда (не рекомендуется). |
| Вывод списка записей о согласии (не рекомендуется) [DEPRECATED] |
Перечисляет записи согласия для компонента (не рекомендуется). |
| Вывод списка настраиваемых полей (не рекомендуется) [DEPRECATED] |
Перечисляет настраиваемые поля для призыва (не рекомендуется). |
| Вывод списка настраиваемых полей (не рекомендуется) [DEPRECATED] |
Перечисляет настраиваемые поля для компонента (не рекомендуется). |
| Вывод списка настраиваемых полей кампании (не рекомендуется) [DEPRECATED] |
Выводит настраиваемые поля для кампании (не рекомендуется). |
| Вывод списка настраиваемых полей подарка (не рекомендуется) [DEPRECATED] |
Перечисляет настраиваемые поля для подарка (не рекомендуется). |
| Вывод списка настраиваемых полей фонда (не рекомендуется) [DEPRECATED] |
Перечисляет настраиваемые поля для фонда (не рекомендуется). |
| Вывод списка пакетов подарков (не рекомендуется) [DEPRECATED] |
Вывод списка пакетов подарков (не рекомендуется). |
| Вывод списка подарков (не рекомендуется) [DEPRECATED] |
Возвращает список подарков (не рекомендуется). |
| Вывод списка руководителей связей (не рекомендуется) [DEPRECATED] |
Выводит список назначений диспетчера связей для компонента (не рекомендуется). |
| Вывод списка составляющих адресов (не рекомендуется) [DEPRECATED] |
Перечисляет адреса для компонента (не рекомендуется). |
| Вывод списка составляющих вложений (не рекомендуется) [DEPRECATED] |
Перечисляет вложения для компонента (не рекомендуется). |
| Вывод списка составляющих онлайн-присутствий (не рекомендуется) [DEPRECATED] |
Выводит список присутствия в Интернете для компонента (не рекомендуется). |
| Вывод списка составляющих примечаний (не рекомендуется) [DEPRECATED] |
Выводит заметки для компонента (не рекомендуется). |
| Вывод списка составных кодов (не рекомендуется) [DEPRECATED] |
Перечисляет составные коды для компонента (не рекомендуется). |
| Действия списка (не рекомендуется) [DEPRECATED] |
Возвращает список действий (не рекомендуется). |
| Добавление записей в список (не рекомендуется) [DEPRECATED] |
Добавьте набор записей в существующий список (не рекомендуется). |
| Добавление подарка в пакет (не рекомендуется) [DEPRECATED] |
Добавьте подарок в указанный пакет подарков (не рекомендуется). |
| Обновление вложения апелляции (не рекомендуется) [DEPRECATED] |
Обновляет вложение апелляции (не рекомендуется). |
| Обновление вложения действия (не рекомендуется) [DEPRECATED] |
Обновляет вложение действия (не рекомендуется). |
| Обновление вложения кампании (не рекомендуется) [DEPRECATED] |
Обновляет вложение кампании (не рекомендуется). |
| Обновление вложения подарка (не рекомендуется) [DEPRECATED] |
Обновляет вложение подарка (не рекомендуется). |
| Обновление вложения фонда (не рекомендуется) [DEPRECATED] |
Обновляет вложение фонда (не рекомендуется). |
| Обновление кода для составного запроса (не рекомендуется) [DEPRECATED] |
Обновляет исходный код запроса (не рекомендуется). |
| Обновление компонента (не рекомендуется) [DEPRECATED] |
Обновляет компонент (не рекомендуется). |
| Обновление компонента присутствия в Интернете (не рекомендуется) [DEPRECATED] |
Обновляет составное онлайн-присутствие (не рекомендуется). |
| Обновление компонента телефона (не рекомендуется) [DEPRECATED] |
Обновляет составной телефон (не рекомендуется). |
| Обновление настраиваемого поля действия (не рекомендуется) [DEPRECATED] |
Обновляет настраиваемое поле действия (не рекомендуется). |
| Обновление настраиваемого поля кампании (не рекомендуется) [DEPRECATED] |
Обновляет настраиваемое поле кампании (не рекомендуется). |
| Обновление настраиваемого поля подарка (не рекомендуется) [DEPRECATED] |
Обновляет настраиваемое поле подарка (не рекомендуется). |
| Обновление настраиваемого поля призыва (не рекомендуется) [DEPRECATED] |
Обновляет настраиваемое поле апелляции (не рекомендуется). |
| Обновление настраиваемого поля фонда (не рекомендуется) [DEPRECATED] |
Обновляет настраиваемое поле фонда (не рекомендуется). |
| Обновление основного формата имени (не рекомендуется) [DEPRECATED] |
Обновляет формат основного имени для компонента (не рекомендуется). |
| Обновление рисунка составного профиля (не рекомендуется) [DEPRECATED] |
Обновляет текущее изображение профиля для компонента (не рекомендуется). |
| Обновление сведений о подтверждении подарков (не рекомендуется) [DEPRECATED] |
Обновляет сведения о подтверждении для подарка (не рекомендуется). |
| Обновление сведений о получении подарков (не рекомендуется) [DEPRECATED] |
Обновляет сведения о получении подарка (не рекомендуется). |
| Обновление составного адреса (не рекомендуется) [DEPRECATED] |
Обновляет составной адрес (не рекомендуется). |
| Обновление составного адреса электронной почты (не рекомендуется) [DEPRECATED] |
Обновляет составной адрес электронной почты (не рекомендуется). |
| Обновление составного вложения (не рекомендуется) [DEPRECATED] |
Обновляет составное вложение (не рекомендуется). |
| Обновление составного действия (не рекомендуется) [DEPRECATED] |
Обновляет составное действие (не рекомендуется). |
| Обновление составного кода (не рекомендуется) [DEPRECATED] |
Обновляет составной код (не рекомендуется). |
| Обновление составного настраиваемого поля (не рекомендуется) [DEPRECATED] |
Обновляет составное настраиваемое поле (не рекомендуется). |
| Обновление составного образования (не рекомендуется) [DEPRECATED] |
Обновляет составное образование (не рекомендуется). |
| Обновление составного псевдонима (не рекомендуется) [DEPRECATED] |
Обновляет составной псевдоним (не рекомендуется). |
| Обновление составной заметки (не рекомендуется) [DEPRECATED] |
Обновляет составную заметку (не рекомендуется). |
| Обновление составной связи (не рекомендуется) [DEPRECATED] |
Обновляет связь для составляющих. Если существует взаимная связь, она также изменяется, чтобы отразить изменения. Это не включает изменения в свойство "комментарии", которое относится к каждой записи и может быть изменено независимо для каждой записи (не рекомендуется). |
| Обновление формата составного имени (не рекомендуется) [DEPRECATED] |
Обновляет формат составного имени (не рекомендуется). |
| Перечисление апелляций (не рекомендуется) [DEPRECATED] |
Возвращает список апелляций (не рекомендуется). |
| Перечисление компонентов (не рекомендуется) [DEPRECATED] |
Возвращает список компонентов (не рекомендуется). |
| Перечисление назначений диспетчера связей (не рекомендуется) [DEPRECATED] |
Вывод списка назначений для диспетчера связей (не рекомендуется). |
| Перечисление псевдонимов компонентов (не рекомендуется) [DEPRECATED] |
Перечисляет псевдонимы для компонента (не рекомендуется). |
| Перечисление составляющих действий (не рекомендуется) [DEPRECATED] |
Выводит список действий для компонента (не рекомендуется). |
| Перечисление составляющих образования (не рекомендуется) [DEPRECATED] |
Перечисляет записи об образовании для компонента (не рекомендуется). |
| Перечисление составляющих связей (не рекомендуется) [DEPRECATED] |
Выводит список связей для компонента (не рекомендуется). |
| Перечисление составных апелляций (не рекомендуется) [DEPRECATED] |
Перечисляет апелляции на составную (нерекомендуемую). |
| Перечисление средств (не рекомендуется) [DEPRECATED] |
Возвращает список средств (не рекомендуется). |
| Поиск составляющих (нерекомендуемых) [DEPRECATED] |
Выполняет составной поиск на основе предоставленного текста поиска. Поддерживает имя, фамилию, предпочтительное имя, прежнее имя, псевдоним, адрес электронной почты, номер телефона, адрес или идентификатор подстановки. Допустимы такие сочетания имен, как имя и фамилия или предпочтительное имя и фамилия, но в противном случае поиск поддерживает только один параметр одновременно. По умолчанию поиски включают результаты, аналогичные вашим критериям. Например, поиски "Смит" включают совпадения для "Smyth" и других альтернативных орфографических выражений. Этот поиск не поддерживает подстановочные знаки, такие как * или ?. Результаты поиска ограничены 500 записями (не рекомендуется). |
| Получение апелляции (не рекомендуется) [DEPRECATED] |
Возвращает сведения об апелляции (не рекомендуется). |
| Получение кампании (не рекомендуется) [DEPRECATED] |
Возвращает сведения о кампании (не рекомендуется). |
| Получение компонента (не рекомендуется) [DEPRECATED] |
Возвращает сведения об составляющих (нерекомендуемых). |
| Получение наибольшего подарка (не рекомендуется) [DEPRECATED] |
Возвращает величайший подарок для компонента (не рекомендуется). |
| Получение отложенного времени существования (не рекомендуется) [DEPRECATED] |
Возвращает время существования, предоставляющее сводку для компонента (не рекомендуется). |
| Получение пакета (не рекомендуется) [DEPRECATED] |
Возвращает сведения о пакете (не рекомендуется). |
| Получение первого подарка (не рекомендуется) [DEPRECATED] |
Возвращает первый подарок для компонента (не рекомендуется). |
| Получение подарка (не рекомендуется) [DEPRECATED] |
Возвращает сведения о подарке (не рекомендуется). |
| Получение последнего подарка (не рекомендуется) [DEPRECATED] |
Возвращает последний подарок для компонента (не рекомендуется). |
| Получение рисунка из составного профиля (не рекомендуется) [DEPRECATED] |
Возвращает текущее изображение профиля для компонента (не рекомендуется). |
| Получение сводки формата составного имени (не рекомендуется) [DEPRECATED] |
Возвращает сводку формата имен для компонента (не рекомендуется). |
| Получение составного действия (не рекомендуется) [DEPRECATED] |
Возвращает сведения о составном действии (не рекомендуется). |
| Получение фонда (не рекомендуется) [DEPRECATED] |
Возвращает сведения о фонде (не рекомендуется). |
| Преобразование в составную (нерекомендуемую) [DEPRECATED] |
Преобразует нерекомендуемый в состав (нерекомендуемый). |
| Проверка маркера удостоверения пользователя (не рекомендуется) [DEPRECATED] |
Проверяет маркер удостоверения пользователя (не рекомендуется). |
| Создание вложения апелляции (не рекомендуется) [DEPRECATED] |
Создает новое вложение апелляции (не рекомендуется). |
| Создание вложения действия (не рекомендуется) [DEPRECATED] |
Создает новое вложение действия (не рекомендуется). |
| Создание вложения кампании (не рекомендуется) [DEPRECATED] |
Создает новое вложение кампании (не рекомендуется). |
| Создание вложения подарка (не рекомендуется) [DEPRECATED] |
Создает новое вложение подарка (не рекомендуется). |
| Создание вложения фонда (не рекомендуется) [DEPRECATED] |
Создает новое вложение фонда (не рекомендуется). |
| Создание записи согласия (не рекомендуется) [DEPRECATED] |
Создает новую запись о согласии на создание компонента (не рекомендуется). |
| Создание кода для создания составного запроса (не рекомендуется) [DEPRECATED] |
Создает новый составной код запроса (не рекомендуется). |
| Создание компонента организации (не рекомендуется) [DEPRECATED] |
Создает новую составную организацию (не рекомендуется). |
| Создание назначения диспетчера связей (не рекомендуется) [DEPRECATED] |
Создает новое назначение диспетчера связей (не рекомендуется). |
| Создание настраиваемого поля действия (не рекомендуется) [DEPRECATED] |
Создает настраиваемое поле действия (не рекомендуется). |
| Создание настраиваемого поля кампании (не рекомендуется) [DEPRECATED] |
Создает настраиваемое поле кампании (не рекомендуется). |
| Создание настраиваемого поля подарка (не рекомендуется) [DEPRECATED] |
Создает новое настраиваемое поле подарка (не рекомендуется). |
| Создание настраиваемого поля призыва (не рекомендуется) [DEPRECATED] |
Создает новое настраиваемое поле привлекательности (не рекомендуется). |
| Создание настраиваемого поля фонда (не рекомендуется) [DEPRECATED] |
Создает новое настраиваемое поле фонда (не рекомендуется). |
| Создание основного формата имени (не рекомендуется) [DEPRECATED] |
Создает основной формат имени для компонента (не рекомендуется). |
| Создание отдельного компонента (не рекомендуется) [DEPRECATED] |
Создает новый отдельный компонент (не рекомендуется). |
| Создание отдельной связи (не рекомендуется) [DEPRECATED] |
Создает новую отдельную связь. Если отношения связаны с другим компонентом, для этого компонента создается взаимная связь (не рекомендуется). |
| Создание пакета подарков (не рекомендуется) [DEPRECATED] |
Создает новый пакет подарков (не рекомендуется). |
| Создание подарка (не рекомендуется) [DEPRECATED] |
Создает новый подарок (не рекомендуется). |
| Создание расположения документа (не рекомендуется) [DEPRECATED] |
Создает новый уникальный идентификатор документа и расположение отправки для использования с физическими вложениями. Ответ будет содержать инструкции по тому, где и как отправить содержимое документа (не рекомендуется). |
| Создание связи организации (не рекомендуется) [DEPRECATED] |
Создает связь организации. Если отношения связаны с другим компонентом, для этого компонента создается взаимная связь (не рекомендуется). |
| Создание составного адреса (не рекомендуется) [DEPRECATED] |
Создает новый составной адрес (не рекомендуется). |
| Создание составного адреса электронной почты (не рекомендуется) [DEPRECATED] |
Создает новый составной адрес электронной почты (не рекомендуется). |
| Создание составного вложения (не рекомендуется) [DEPRECATED] |
Создает новое составное вложение (не рекомендуется). |
| Создание составного действия (не рекомендуется) [DEPRECATED] |
Создает новое составное действие (не рекомендуется). |
| Создание составного кода (не рекомендуется) [DEPRECATED] |
Создает новый составной код (не рекомендуется). |
| Создание составного настраиваемого поля (не рекомендуется) [DEPRECATED] |
Создает новое составное настраиваемое поле (не рекомендуется). |
| Создание составного образования (не рекомендуется) [DEPRECATED] |
Создает новое составное образование (не рекомендуется). |
| Создание составного псевдонима (не рекомендуется) [DEPRECATED] |
Создает новый составной псевдоним (нерекомендуемый). |
| Создание составного сетевого присутствия (не рекомендуется) [DEPRECATED] |
Создает новое составное онлайн-присутствие (не рекомендуется). |
| Создание составного телефона (не рекомендуется) [DEPRECATED] |
Создает новый составной телефон (не рекомендуется). |
| Создание составной заметки (не рекомендуется) [DEPRECATED] |
Создает новую составную заметку (не рекомендуется). |
| Создание составной оценки (не рекомендуется) [DEPRECATED] |
Создает новый составной рейтинг (не рекомендуется). |
| Создание списка из набора записей (не рекомендуется) [DEPRECATED] |
Создает список, отфильтрованный по указанному набору записей (не рекомендуется). |
| Создание формата составного имени (не рекомендуется) [DEPRECATED] |
Создает новый формат составного имени (не рекомендуется). |
| Список кампаний (не рекомендуется) [DEPRECATED] |
Возвращает список кампаний (не рекомендуется). |
| Список настраиваемых полей действия (не рекомендуется) [DEPRECATED] |
Перечисляет настраиваемые поля для действия (не рекомендуется). |
| Список пакетов (не рекомендуется) [DEPRECATED] |
Возвращает список пакетов (не рекомендуется). |
| Список составляющих телефонов (не рекомендуется) [DEPRECATED] |
Выводит список телефонов для компонента (не рекомендуется). |
| Список составных кодов запроса (не рекомендуется) [DEPRECATED] |
Перечисляет коды запроса для компонента (не рекомендуется). |
| Список составных рейтингов (не рекомендуется) [DEPRECATED] |
Возвращает список оценок для компонента (не рекомендуется). |
| Удаление составного кода (не рекомендуется) [DEPRECATED] |
Удаляет составной код (не рекомендуется). |
Вывод списка адресов электронной почты (не рекомендуется) [DEPRECATED]
Перечисляет адреса электронной почты для компонента (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Составной идентификатор
|
constituent_id | True | string |
Системный идентификатор записи компонента. |
|
Включить неактивное?
|
include_inactive | boolean |
Включите неактивные адреса электронной почты? |
Возвращаемое значение
Адреса электронной почты
Вывод списка вложений апелляции (не рекомендуется) [DEPRECATED]
Перечисляет вложения для апелляции (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор апелляции
|
appeal_id | True | string |
Идентификатор системной записи апелляции. |
Возвращаемое значение
Attachments
Вывод списка вложений действий (не рекомендуется) [DEPRECATED]
Перечисляет вложения для действия (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор действия
|
action_id | True | string |
Идентификатор системной записи действия. |
Возвращаемое значение
Attachments
Вывод списка вложений кампании (не рекомендуется) [DEPRECATED]
Выводит вложения для кампании (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор кампании
|
campaign_id | True | string |
Идентификатор системной записи кампании. |
Возвращаемое значение
Attachments
Вывод списка вложений подарков (не рекомендуется) [DEPRECATED]
Перечисляет вложения для подарка (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор подарка
|
gift_id | True | string |
Системный идентификатор записи подарка. |
Возвращаемое значение
Attachments
Вывод списка вложений фонда (не рекомендуется) [DEPRECATED]
Перечисляет вложения для фонда (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор фонда
|
fund_id | True | string |
Системный идентификатор фонда. |
Возвращаемое значение
Attachments
Вывод списка записей о согласии (не рекомендуется) [DEPRECATED]
Перечисляет записи согласия для компонента (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Составной идентификатор
|
constituent_id | True | string |
Системный идентификатор записи компонента. |
|
Последнее только?
|
most_recent_only | boolean |
Включите только последние записи согласия для каждой комбинации категорий каналов в ответе? |
Возвращаемое значение
Записи согласия
Вывод списка настраиваемых полей (не рекомендуется) [DEPRECATED]
Перечисляет настраиваемые поля для призыва (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор апелляции
|
appeal_id | True | string |
Идентификатор системной записи апелляции. |
Возвращаемое значение
Пользовательские поля
Вывод списка настраиваемых полей (не рекомендуется) [DEPRECATED]
Перечисляет настраиваемые поля для компонента (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Составной идентификатор
|
constituent_id | True | string |
Системный идентификатор записи компонента. |
Возвращаемое значение
Пользовательские поля
Вывод списка настраиваемых полей кампании (не рекомендуется) [DEPRECATED]
Выводит настраиваемые поля для кампании (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор кампании
|
campaign_id | True | string |
Идентификатор системной записи кампании. |
Возвращаемое значение
Пользовательские поля
Вывод списка настраиваемых полей подарка (не рекомендуется) [DEPRECATED]
Перечисляет настраиваемые поля для подарка (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор подарка
|
gift_id | True | string |
Системный идентификатор записи подарка. |
Возвращаемое значение
Пользовательские поля
Вывод списка настраиваемых полей фонда (не рекомендуется) [DEPRECATED]
Перечисляет настраиваемые поля для фонда (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор фонда
|
fund_id | True | string |
Системный идентификатор фонда. |
Возвращаемое значение
Пользовательские поля
Вывод списка пакетов подарков (не рекомендуется) [DEPRECATED]
Вывод списка пакетов подарков (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Номер пакета
|
batch_number | string |
Представляет фильтр для результатов, соответствующих указанному числу. |
|
|
Одобренный?
|
approved | boolean |
Представляет фильтр для состояния пакета подарков. |
|
|
Есть ли исключения?
|
has_exceptions | boolean |
Представляет фильтр, содержащий ли пакет подарков исключения. |
|
|
Лимит
|
limit | integer |
Представляет количество возвращаемых записей. Значение по умолчанию — 500. Максимальное значение — 5000. |
|
|
Смещение
|
offset | integer |
Представляет количество пропускаемых записей. Для использования с разбивкой на страницы. |
|
|
Поиск текста
|
search_text | string |
Представляет фильтр для текста, включенного в описание пакета или поля номера пакета. |
|
|
Кем создано:
|
created_by | string |
Представляет фильтр для пакетов подарков, созданных указанным пользователем. |
Возвращаемое значение
Пакеты подарков
Вывод списка подарков (не рекомендуется) [DEPRECATED]
Возвращает список подарков (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
List
|
list_id | string |
Определяет идентификатор списка, используемый для фильтрации набора подарков в указанный список. Если это значение задано, другие указанные фильтры будут игнорироваться. |
|
|
Тип
|
gift_type | string |
Представляет разделенный запятыми список типов подарков для фильтрации результатов. Например, "MatchingGiftPledge,RecurringGift" возвращает только подарки типа MatchingGiftPledge или ПовторяющийсяGift. |
|
|
Составной идентификатор
|
constituent_id | string |
Представляет разделенный запятыми список составляющих идентификаторов для фильтрации результатов. Например, "280,1232" возвращает только подарки от составляющих 280 или составляющих 1232. |
|
|
Идентификатор кампании
|
campaign_id | string |
Представляет разделенный запятыми список идентификаторов кампании для фильтрации результатов. Например, "506,918" возвращает только подарки кампании 506 или кампании 918. |
|
|
Идентификатор фонда
|
fund_id | string |
Представляет разделенный запятыми список идентификаторов фонда для фильтрации результатов. Например, "506 918" возвращает только подарки для финансирования 506 или фонда 918. |
|
|
Идентификатор апелляции
|
appeal_id | string |
Представляет разделенный запятыми список идентификаторов апелляций для фильтрации результатов. Например, "506 918" возвращает только подарки для обращения 506 или апелляции 918. |
|
|
Лимит
|
limit | integer |
Представляет количество возвращаемых записей. Значение по умолчанию — 500. Максимальное значение — 5000. |
|
|
Смещение
|
offset | integer |
Представляет количество пропускаемых записей. Для использования с разбивкой на страницы. |
|
|
Дата начала подарка
|
start_gift_date | date-time |
Представляет фильтр для подарков с датой подарка или после указанной даты (например, "2020-09-18T04:13:56Z"). |
|
|
Дата окончания подарка
|
end_gift_date | date-time |
Представляет фильтр для подарков с датой подарка или до указанной даты (например, "2020-09-18T04:13:56Z"). |
|
|
Начать сумму подарка
|
start_gift_amount | double |
Представляет фильтр для подарков с суммой больше или равно указанной сумме. |
|
|
Сумма подарка
|
end_gift_amount | double |
Представляет фильтр для подарков с суммой меньше или равно указанной сумме. |
|
|
Состояние публикации
|
post_status | string |
Представляет разделенный запятыми список состояний отправки подарков для фильтрации результатов. Например, "DoNotPost,Posted" возвращает только подарки, помеченные как DoNotPost или Posted. |
|
|
Состояние квитанции
|
receipt_status | string |
Представляет разделенный запятыми список состояний получения подарков для фильтрации результатов. Например, "DoNotReceipt,Receipted" возвращает только подарки, помеченные как DoNotReceipt или Receipted. |
|
|
Состояние подтверждения
|
acknowledgement_status | string |
Представляет разделенный запятыми список состояний подтверждения подарка для фильтрации результатов. Например, "DoNotAcknowledge" возвращает только подарки, помеченные как DoNotAcknowledge или Acknowledged. |
|
|
Сортировка по
|
sort | string |
Представляет список полей для сортировки результатов по. Результаты по умолчанию находятся в порядке возрастания, а знак "-" обозначает убывание. Например, "date_added,-date" сортирует подарки по полю "date_added" по возрастанию, а затем по полю "дата подарка" в порядке убывания. Если предоставляется только поле date_modified или только поле date_added, то это добавляет параметр sort_token в URL-адрес next_link, чтобы убедиться, что подарки сортируются стабильно. |
|
|
Добавлен или после
|
date_added | date-time |
Отфильтруйте результаты по подаркам, созданным по указанной дате (например, "2020-09-18T04:13:56Z"). |
|
|
Изменено или после
|
last_modified | date-time |
Отфильтруйте результаты до подарков, измененных по указанной дате (например, "2020-09-18T04:13:56Z"). |
Возвращаемое значение
Подарки
Вывод списка руководителей связей (не рекомендуется) [DEPRECATED]
Выводит список назначений диспетчера связей для компонента (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Составной идентификатор
|
constituent_id | True | string |
Системный идентификатор записи компонента. |
|
Включить неактивное?
|
include_inactive | boolean |
Включите неактивные назначения диспетчера связей? |
Возвращаемое значение
Назначения диспетчера связей
Вывод списка составляющих адресов (не рекомендуется) [DEPRECATED]
Перечисляет адреса для компонента (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Составной идентификатор
|
constituent_id | True | string |
Системный идентификатор записи компонента. |
|
Включить неактивное?
|
include_inactive | boolean |
Включите неактивные адреса? |
Возвращаемое значение
Адреса
Вывод списка составляющих вложений (не рекомендуется) [DEPRECATED]
Перечисляет вложения для компонента (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Составной идентификатор
|
constituent_id | True | string |
Системный идентификатор записи компонента. |
Возвращаемое значение
Attachments
Вывод списка составляющих онлайн-присутствий (не рекомендуется) [DEPRECATED]
Выводит список присутствия в Интернете для компонента (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Составной идентификатор
|
constituent_id | True | string |
Системный идентификатор записи компонента. |
|
Включить неактивное?
|
include_inactive | boolean |
Включить неактивное присутствие в Интернете? |
Возвращаемое значение
Присутствие в Сети
Вывод списка составляющих примечаний (не рекомендуется) [DEPRECATED]
Выводит заметки для компонента (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Составной идентификатор
|
constituent_id | True | string |
Системный идентификатор записи компонента. |
Возвращаемое значение
Примечания.
Вывод списка составных кодов (не рекомендуется) [DEPRECATED]
Перечисляет составные коды для компонента (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Составной идентификатор
|
constituent_id | True | string |
Системный идентификатор записи компонента. |
Возвращаемое значение
Составные коды
Действия списка (не рекомендуется) [DEPRECATED]
Возвращает список действий (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
List
|
list_id | string |
Определяет идентификатор списка, используемый для фильтрации набора действий для тех, кто включен в указанный список. Если это значение задано, другие указанные фильтры будут игнорироваться. |
|
|
Вычисленное состояние
|
computed_status | string |
Представляет фильтр результатов на основе состояния вычисляемого действия. Доступные значения: Open, Completed или PastDue. |
|
|
Состояние
|
status_code | string |
Представляет код состояния действия для фильтрации результатов (применимо только в том случае, если система настроена для использования кодов состояния действия). Например, "Ожидание" возвращает действия с состоянием "Ожидание". |
|
|
Лимит
|
limit | integer |
Представляет количество возвращаемых записей. Значение по умолчанию — 500. Максимальное значение — 5000. |
|
|
Смещение
|
offset | integer |
Представляет количество пропускаемых записей. Для использования с разбивкой на страницы. |
|
|
Добавлен или после
|
date_added | date-time |
Отфильтруйте результаты для действий, созданных по указанной дате (например, "2020-09-18T04:13:56Z"). |
|
|
Изменено или после
|
last_modified | date-time |
Отфильтруйте результаты для действий, измененных по указанной дате (например, "2020-09-18T04:13:56Z"). |
Возвращаемое значение
Действия
Добавление записей в список (не рекомендуется) [DEPRECATED]
Добавьте набор записей в существующий список (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Тип списка
|
list_type | True | string |
Тип списка. |
|
List
|
list_id | True | string |
Идентификатор системной записи списка. |
|
Идентификаторы
|
ids | True | array of string |
Уникальные идентификаторы записей, добавляемых в список (максимум 100 000 значений). |
Добавление подарка в пакет (не рекомендуется) [DEPRECATED]
Добавьте подарок в указанный пакет подарков (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Batch
|
batch_id | True | string |
Пакет, в который будет добавлен подарок. |
|
Составной идентификатор
|
constituent_id | True | string |
Системный идентификатор записи компонента, связанного с подарком. |
|
Сумма
|
value | True | double |
Денежный объем подарка. |
|
Date
|
date | True | date |
Дата подарка (например, '2020-09-18'). |
|
Тип
|
type | True | string |
Тип подарка. |
|
Идентификатор кампании
|
campaign_id | string |
Системный идентификатор кампании, связанной с разделением подарка. |
|
|
Идентификатор фонда
|
fund_id | True | string |
Системный идентификатор фонда, связанного с разделением подарка. |
|
Идентификатор апелляции
|
appeal_id | string |
Системный идентификатор апелляции, связанной с разделением подарка. |
|
|
Идентификатор пакета
|
package_id | string |
Системный идентификатор пакета, связанного с разделением подарка. |
|
|
количество
|
value | True | double |
Денежный объем разделенного подарка. |
|
Метод оплаты
|
payment_method | True | string |
Метод оплаты. |
|
Контрольный номер
|
check_number | string |
Номер проверки (применяется только при использовании метода оплаты "PersonalCheck"). |
|
|
day
|
d | integer |
День в нечеткой дате. |
|
|
month
|
m | integer |
Месяц в нечеткой дате. |
|
|
год
|
y | integer |
Год в нечеткой дате. |
|
|
Reference
|
reference | string |
Ссылка на оплату (применимо только при использовании метода оплаты — "Other"). |
|
|
day
|
d | integer |
День в нечеткой дате. |
|
|
month
|
m | integer |
Месяц в нечеткой дате. |
|
|
год
|
y | integer |
Год в нечеткой дате. |
|
|
Является ли анонимным?
|
is_anonymous | boolean |
Является ли подарок анонимным? Если значение не указано, будет использоваться анонимность донора по умолчанию. |
|
|
Подтип
|
subtype | string |
Подтип подарка. |
|
|
Комментарий
|
reference | string |
Примечания для отслеживания специальных сведений о подарке, например мотивации за ним или подробное описание подарка в виде. |
|
|
Идентификатор подстановки
|
lookup_id | string |
Определяемый пользователем идентификатор для подарка. |
|
|
Используйте кредиты диспетчера связей?
|
default_fundraiser_credits | boolean |
Используйте кредиты диспетчера связей по умолчанию? |
|
|
Используйте мягкие кредиты?
|
default_soft_credits | boolean |
Используйте мягкие кредиты по умолчанию? |
|
|
Избирательный округ
|
constituency | string |
Избирательный округ подарка. |
|
|
Состояние публикации
|
post_status | string |
Состояние записи подарка. |
|
|
Дата публикации
|
post_date | date |
Дата отправки подарка (например, "2020-09-18"). |
|
|
Состояние квитанции
|
status | True | string |
Состояние получения подарка. |
|
Сумма по чеку
|
value | True | double |
Денежный объем квитанции для подарка. |
|
Дата прихода
|
date | date |
Дата получения подарка (например, "2020-09-18"). |
Возвращаемое значение
Содержит коллекцию записей об ошибках пакетного подарка и пакетных подарков, добавленных операцией.
- Results
- GiftApi.BatchGiftAddResults
Обновление вложения апелляции (не рекомендуется) [DEPRECATED]
Обновляет вложение апелляции (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор вложения
|
attachment_id | True | string |
Идентификатор системной записи для обновления вложения. |
|
Имя
|
name | string |
Имя вложения. Ограничение символов: 150. |
|
|
Date
|
date | date-time |
Дата вложения (например, '2020-09-18T04:13:56Z'). |
|
|
URL
|
url | string |
URL-адрес для вложения. Это необходимо для вложений ссылок и неприменимо для физических вложений. |
Обновление вложения действия (не рекомендуется) [DEPRECATED]
Обновляет вложение действия (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор вложения
|
attachment_id | True | string |
Идентификатор системной записи для обновления вложения. |
|
Имя
|
name | string |
Имя вложения. Ограничение символов: 150. |
|
|
Date
|
date | date-time |
Дата вложения (например, '2020-09-18T04:13:56Z'). |
|
|
URL
|
url | string |
URL-адрес для вложения. Это необходимо для вложений ссылок и неприменимо для физических вложений. |
Обновление вложения кампании (не рекомендуется) [DEPRECATED]
Обновляет вложение кампании (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор вложения
|
attachment_id | True | string |
Идентификатор системной записи для обновления вложения. |
|
Имя
|
name | string |
Имя вложения. Ограничение символов: 150. |
|
|
Date
|
date | date-time |
Дата вложения (например, '2020-09-18T04:13:56Z'). |
|
|
URL
|
url | string |
URL-адрес для вложения. Это необходимо для вложений ссылок и неприменимо для физических вложений. |
Обновление вложения подарка (не рекомендуется) [DEPRECATED]
Обновляет вложение подарка (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор вложения
|
attachment_id | True | string |
Идентификатор системной записи для обновления вложения. |
|
Имя
|
name | string |
Имя вложения. Ограничение символов: 150. |
|
|
Date
|
date | date-time |
Дата вложения (например, '2020-09-18T04:13:56Z'). |
|
|
URL
|
url | string |
URL-адрес для вложения. Это необходимо для вложений ссылок и неприменимо для физических вложений. |
Обновление вложения фонда (не рекомендуется) [DEPRECATED]
Обновляет вложение фонда (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор вложения
|
attachment_id | True | string |
Идентификатор системной записи для обновления вложения. |
|
Имя
|
name | string |
Имя вложения. Ограничение символов: 150. |
|
|
Date
|
date | date-time |
Дата вложения (например, '2020-09-18T04:13:56Z'). |
|
|
URL
|
url | string |
URL-адрес для вложения. Это необходимо для вложений ссылок и неприменимо для физических вложений. |
Обновление кода для составного запроса (не рекомендуется) [DEPRECATED]
Обновляет исходный код запроса (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор кода запроса
|
constituent_solicit_code_id | True | string |
Идентификатор системной записи кода запроса для обновления. |
|
Код запроса
|
solicit_code | string |
Инструкции по обмену данными и /или ограничения для составляющих. |
|
|
Начальная дата
|
start_date | date |
Дата начала кода запроса (например, "2005-09-18"). |
|
|
Дата окончания
|
end_date | date |
Дата окончания кода запроса (например, "2005-09-18"). |
Обновление компонента (не рекомендуется) [DEPRECATED]
Обновляет компонент (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Составной идентификатор
|
constituent_id | True | string |
Идентификатор системной записи компонента для обновления. |
|
Название
|
title | string |
Основной титул избирателя (только для отдельных лиц). |
|
|
Имя (первое имя)
|
first | string |
Первое имя избирателя (только для отдельных лиц). Ограничение символов: 50. |
|
|
Фамилия
|
last | string |
Фамилия избирателя (только для отдельных лиц). Ограничение символов: 100. |
|
|
Название организации
|
name | string |
Для отдельных лиц это вычисляемое поле, которое неприменимо для операций редактирования. Для организации это поле является обязательным и представляет имя организации. Ограничение символов: 100. |
|
|
Суффикс
|
suffix | string |
Основной суффикс избирателя (только для отдельных лиц). |
|
|
Предпочтительное имя
|
preferred_name | string |
Предпочтительное имя избирателя (только для отдельных лиц). Ограничение символов: 50. |
|
|
Идентификатор подстановки
|
lookup_id | string |
Определяемый пользователем идентификатор для компонента. |
|
|
Gender
|
gender | string |
Пол избирателей (только для отдельных лиц). |
|
|
Отчество/второе имя
|
middle | string |
Среднее имя избирателя (только для отдельных лиц). Ограничение символов: 50. |
|
|
Прежнее имя
|
former_name | string |
Прежнее имя избирателя (только для отдельных лиц). Ограничение символов: 100. |
|
|
Заголовок 2
|
title_2 | string |
Вторичный титул избирателя (только для отдельных лиц). |
|
|
Суффикс 2
|
suffix_2 | string |
Вторичный суффикс компонента (только для отдельных лиц). |
|
|
Семейное положение
|
marital_status | string |
Семейное состояние избирателя (только для отдельных лиц). |
|
|
Дает анонимно?
|
gives_anonymously | boolean |
Дает ли избиратель анонимно? |
|
|
Неактивный?
|
inactive | boolean |
Неактивен ли компонент? |
|
|
day
|
d | integer |
День в нечеткой дате. |
|
|
month
|
m | integer |
Месяц в нечеткой дате. |
|
|
год
|
y | integer |
Год в нечеткой дате. |
|
|
Родина
|
birthplace | string |
Место рождения компонента (только для отдельных лиц). |
|
|
Этнос
|
ethnicity | string |
Этническое происхождение составляющих (только для отдельных лиц). |
|
|
доход
|
income | string |
Доход для составляющих (только для физических лиц). |
|
|
Религиозная деятельность
|
religion | string |
Религия составляющих (только для отдельных лиц). |
|
|
Промышленность
|
industry | string |
Отрасль составляющих (только для организаций). |
|
|
Количество сотрудников
|
num_employees | integer |
Количество сотрудников в организации. |
|
|
Соответствует подаркам?
|
matches_gifts | boolean |
Соответствует ли организация подаркам? |
|
|
Соответствующий фактор подарка
|
matching_gift_factor | double |
Соответствующий фактор подарка (только для организаций). |
|
|
Минимальное совпадение за подарок
|
value | double |
Минимальная сумма соответствия за подарок для составляющих (только для организаций). |
|
|
Максимальное количество совпадений на подарок
|
value | double |
Максимальное количество совпадений за подарок для составляющих (только для организаций). |
|
|
Минимальное совпадение на констит
|
value | double |
Минимальный итог соответствия для составляющих (только для организаций). |
|
|
Максимальное совпадение на констит
|
value | double |
Максимальное количество совпадений для составляющих (только для организаций). |
|
|
Сопоставление примечаний к подаркам
|
matching_gift_notes | string |
Соответствующие заметки о подарках для составляющих (только для организаций). |
|
|
Покойный?
|
deceased | boolean |
Является ли составляющий умершего (только для физических лиц)? |
|
|
day
|
d | integer |
День в нечеткой дате. |
|
|
month
|
m | integer |
Месяц в нечеткой дате. |
|
|
год
|
y | integer |
Год в нечеткой дате. |
Обновление компонента присутствия в Интернете (не рекомендуется) [DEPRECATED]
Обновляет составное онлайн-присутствие (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор присутствия в Сети
|
online_presence_id | True | string |
Идентификатор системной записи для обновления присутствия в Сети. |
|
Тип
|
type | string |
Тип присутствия в Интернете. |
|
|
Link
|
address | string |
Веб-адрес для присутствия в Интернете. |
|
|
Первичный?
|
primary | boolean |
Это основное онлайн-присутствие составляющих? |
|
|
Неактивный?
|
inactive | boolean |
Неактивно ли это присутствие в Интернете? |
Обновление компонента телефона (не рекомендуется) [DEPRECATED]
Обновляет составной телефон (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор телефона
|
phone_id | True | string |
Идентификатор системной записи телефона для обновления. |
|
Тип
|
type | string |
Тип телефона. |
|
|
Number
|
number | string |
Номер телефона. |
|
|
Первичный?
|
primary | boolean |
Это основной телефон избирателя? |
|
|
Не вызывайте?
|
do_not_call | boolean |
Можно ли связаться с компонентом по этому номеру? |
|
|
Неактивный?
|
inactive | boolean |
Неактивен ли этот номер телефона? |
Обновление настраиваемого поля действия (не рекомендуется) [DEPRECATED]
Обновляет настраиваемое поле действия (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор настраиваемого поля
|
custom_field_id | True | string |
Идентификатор системной записи настраиваемого поля для обновления. |
|
body
|
body | True | dynamic |
Объект, представляющий свойства настраиваемого поля для обновления. |
Обновление настраиваемого поля кампании (не рекомендуется) [DEPRECATED]
Обновляет настраиваемое поле кампании (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор настраиваемого поля
|
custom_field_id | True | string |
Идентификатор системной записи настраиваемого поля для обновления. |
|
body
|
body | True | dynamic |
Объект, представляющий свойства настраиваемого поля для обновления. |
Обновление настраиваемого поля подарка (не рекомендуется) [DEPRECATED]
Обновляет настраиваемое поле подарка (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор настраиваемого поля
|
custom_field_id | True | string |
Идентификатор системной записи настраиваемого поля для обновления. |
|
body
|
body | True | dynamic |
Объект, представляющий свойства настраиваемого поля для обновления. |
Обновление настраиваемого поля призыва (не рекомендуется) [DEPRECATED]
Обновляет настраиваемое поле апелляции (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор настраиваемого поля
|
custom_field_id | True | string |
Идентификатор системной записи настраиваемого поля для обновления. |
|
body
|
body | True | dynamic |
Объект, представляющий свойства настраиваемого поля для обновления. |
Обновление настраиваемого поля фонда (не рекомендуется) [DEPRECATED]
Обновляет настраиваемое поле фонда (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор настраиваемого поля
|
custom_field_id | True | string |
Идентификатор системной записи настраиваемого поля для обновления. |
|
body
|
body | True | dynamic |
Объект, представляющий свойства настраиваемого поля для обновления. |
Обновление основного формата имени (не рекомендуется) [DEPRECATED]
Обновляет формат основного имени для компонента (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор формата имени
|
primary_name_format_id | True | string |
Идентификатор системной записи основного формата имени для обновления. |
|
Формат пользовательского имени?
|
custom_format | boolean |
Является ли настраиваемый формат? |
|
|
Формат
|
configuration_id | string |
Конфигурация формата имени (требуется, если не используется пользовательский формат). |
|
|
Пользовательское имя
|
formatted_name | string |
Отформатированное имя (обязательно, если используется пользовательский формат). Ограничение символов: 255. |
Обновление рисунка составного профиля (не рекомендуется) [DEPRECATED]
Обновляет текущее изображение профиля для компонента (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Составной идентификатор
|
constituent_id | True | string |
Системный идентификатор записи компонента, изображение профиля которого необходимо обновить. |
|
Имя файла
|
file_name | True | string |
Имя файла. |
|
Идентификатор документа
|
document_id | True | uuid |
Идентификатор документа. |
|
Идентификатор эскиза
|
thumbnail_id | True | uuid |
Идентификатор документа эскиза. |
Обновление сведений о подтверждении подарков (не рекомендуется) [DEPRECATED]
Обновляет сведения о подтверждении для подарка (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор подтверждения
|
acknowledgement_id | True | string |
Системный идентификатор подтверждения подарка для обновления. Он использует идентификатор родительского подарка в качестве значения. |
|
Состояние
|
status | string |
Состояние подтверждения. Если для параметра состояния задано значение DoNotAcknowledge, буква и дата должны иметь значение NULL. Если для параметра состояния задано значение NeedsAcknowledgement, дата должна иметь значение NULL. |
|
|
Date
|
date | date-time |
Дата, связанная с подтверждением (например, '2020-09-18T04:13:56Z'). |
|
|
Письмо
|
letter | string |
Письмо, связанное с подтверждением. |
Обновление сведений о получении подарков (не рекомендуется) [DEPRECATED]
Обновляет сведения о получении подарка (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор квитанции
|
receipt_id | True | string |
Системный идентификатор квитанции о подарке для обновления. Он использует идентификатор родительского подарка в качестве значения. |
|
Состояние
|
status | string |
Состояние получения подарка. Если для параметра status задано значение NeedsReceipt или DoNotReceipt, дата получения должна иметь значение NULL. |
|
|
value
|
value | double |
Денежное значение. |
|
|
Date
|
date | date-time |
Дата получения (например, '2020-09-18T04:13:56Z'). |
|
|
Number
|
number | integer |
Номер квитанции. |
Обновление составного адреса (не рекомендуется) [DEPRECATED]
Обновляет составной адрес (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор адреса
|
address_id | True | string |
Идентификатор системной записи адреса для обновления. |
|
Тип адреса
|
type | string |
Тип адреса. |
|
|
Страна
|
country | string |
Страна адреса (может быть идентификатором, именем или сокращением). |
|
|
Линии адресов
|
address_lines | string |
Адресные строки. |
|
|
Город
|
city | string |
Город адреса (не используется в сочетании с полем "Пригород"). |
|
|
Государство
|
state | string |
Регион в адресе. |
|
|
Почтовый индекс
|
postal_code | string |
Почтовый индекс адреса. |
|
|
Пригород
|
suburb | string |
Пригород адреса (не используется в сочетании с полем "Город"). |
|
|
Округ
|
county | string |
Район в адресе. |
|
|
Источник информации
|
information_source | string |
Источник сведений для адреса. |
|
|
Регион
|
region | string |
Регион для адреса. |
|
|
ТЕЛЕГА
|
cart | string |
Маршрут перевозчика (CART) для адреса. |
|
|
ЛОТ
|
lot | string |
Строка путешествия (LOT) для адреса. |
|
|
DPC
|
dpc | string |
Код точки доставки (DPC) для адреса. |
|
|
Допустимый из
|
start | date |
Дата начала пребывания на этом адресе (например, "2005-09-18"). |
|
|
Допустимо
|
end | date |
Дата прекращения проживания в этом адресе (например, "2005-09-18"). |
|
|
Первичный?
|
preferred | boolean |
Это предпочтительный адрес избирателя? |
|
|
Не почта?
|
do_not_mail | boolean |
Можно ли связаться с избирателем по этому адресу? |
|
|
day
|
d | integer |
День в нечеткой дате. |
|
|
month
|
m | integer |
Месяц в нечеткой дате. |
|
|
год
|
y | integer |
Год в нечеткой дате. |
|
|
day
|
d | integer |
День в нечеткой дате. |
|
|
month
|
m | integer |
Месяц в нечеткой дате. |
|
|
год
|
y | integer |
Год в нечеткой дате. |
Обновление составного адреса электронной почты (не рекомендуется) [DEPRECATED]
Обновляет составной адрес электронной почты (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор адреса электронной почты
|
email_address_id | True | string |
Идентификатор системной записи для обновления адреса электронной почты. |
|
Тип электронной почты
|
type | string |
Тип адреса электронной почты. |
|
|
Адрес электронной почты
|
address | string |
Адрес электронной почты. |
|
|
Первичный?
|
primary | boolean |
Это основной адрес электронной почты компонента? |
|
|
Не отправлять сообщения электронной почты?
|
do_not_email | boolean |
Можно ли связаться с компонентами по этому адресу электронной почты? |
|
|
Неактивный?
|
inactive | boolean |
Неактивен ли адрес электронной почты? |
Обновление составного вложения (не рекомендуется) [DEPRECATED]
Обновляет составное вложение (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор вложения
|
attachment_id | True | string |
Идентификатор системной записи для обновления вложения. |
|
Имя
|
name | string |
Имя вложения. Ограничение символов: 150. |
|
|
Date
|
date | date-time |
Дата вложения (например, '2020-09-18T04:13:56Z'). |
|
|
URL
|
url | string |
URL-адрес для вложения. Это необходимо для вложений ссылок и неприменимо для физических вложений. |
Обновление составного действия (не рекомендуется) [DEPRECATED]
Обновляет составное действие (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор действия
|
action_id | True | string |
Идентификатор системной записи действия для обновления. |
|
Date
|
date | date-time |
Дата действия (например, '2020-09-18T04:13:56Z'). |
|
|
Категория
|
category | string |
Канал или намерение составного взаимодействия. |
|
|
Тип
|
type | string |
Дополнительное описание действия для дополнения категории. |
|
|
Сводка
|
summary | string |
Краткое описание действия, которое отображается в верхней части записи. Ограничение символов: 255. |
|
|
Замечание
|
description | string |
Подробное объяснение, подробное описание сводки действий. |
|
|
Завершённый?
|
completed | boolean |
Завершено ли действие? Если система настроена для использования пользовательских состояний действий, это значение основано на значении состояния действия. |
|
|
Дата завершения
|
completed_date | date-time |
Дата завершения действия (например, "2020-09-18T04:13:56Z"). |
|
|
Состояние
|
status | string |
Состояние действия. |
|
|
Направление
|
direction | string |
Направление действия. |
|
|
Местоположение
|
location | string |
Расположение действия. |
|
|
Результат
|
outcome | string |
Результат действия. |
|
|
Priority
|
priority | string |
Приоритет действия. |
|
|
Время запуска
|
start_time | string |
Время начала действия. Используется 24-часовое время в формате HH:mm. |
|
|
Время окончания
|
end_time | string |
Время окончания действия. Используется 24-часовое время в формате HH:mm. |
|
|
Диспетчеры связей
|
fundraisers | array of string |
Набор идентификаторов системных записей для диспетчеров связей, связанных с действием. |
Обновление составного кода (не рекомендуется) [DEPRECATED]
Обновляет составной код (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор составного кода
|
constituent_code_id | True | string |
Идентификатор системной записи в составном коде для обновления. |
|
day
|
d | integer |
День в нечеткой дате. |
|
|
month
|
m | integer |
Месяц в нечеткой дате. |
|
|
год
|
y | integer |
Год в нечеткой дате. |
|
|
day
|
d | integer |
День в нечеткой дате. |
|
|
month
|
m | integer |
Месяц в нечеткой дате. |
|
|
год
|
y | integer |
Год в нечеткой дате. |
|
|
Последовательность
|
sequence | integer |
Числовая последовательность, связанная с составным кодом. |
Обновление составного настраиваемого поля (не рекомендуется) [DEPRECATED]
Обновляет составное настраиваемое поле (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор настраиваемого поля
|
custom_field_id | True | string |
Идентификатор системной записи настраиваемого поля для обновления. |
|
body
|
body | True | dynamic |
Объект, представляющий свойства настраиваемого поля для обновления. |
Обновление составного образования (не рекомендуется) [DEPRECATED]
Обновляет составное образование (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор образования
|
education_id | True | string |
Идентификатор системной записи записи образования для обновления. |
|
Школа
|
school | string |
Имя школы или учреждения. |
|
|
Тип
|
type | string |
Тип образования. |
|
|
Класс
|
class_of | string |
Год, который окончил составной элемент. |
|
|
Состояние
|
status | string |
Состояние образования. |
|
|
day
|
d | integer |
День в нечеткой дате. |
|
|
month
|
m | integer |
Месяц в нечеткой дате. |
|
|
год
|
y | integer |
Год в нечеткой дате. |
|
|
day
|
d | integer |
День в нечеткой дате. |
|
|
month
|
m | integer |
Месяц в нечеткой дате. |
|
|
год
|
y | integer |
Год в нечеткой дате. |
|
|
day
|
d | integer |
День в нечеткой дате. |
|
|
month
|
m | integer |
Месяц в нечеткой дате. |
|
|
год
|
y | integer |
Год в нечеткой дате. |
|
|
Градус
|
degree | string |
Степень получена. |
|
|
GPA
|
gpa | double |
Среднее значение точки оценки. |
|
|
Тема исследования
|
subject_of_study | string |
Тема исследования. |
|
|
Первичный?
|
primary | boolean |
Это ассоциация начальной школы избирателей? |
|
|
Специальности
|
majors | array of string |
Основные курсы изучения. |
|
|
Несовершеннолетних
|
minors | array of string |
Незначительные курсы обучения. |
|
|
Campus
|
campus | string |
Кампус. Ограничение символов: 50. |
|
|
Социальная организация
|
social_organization | string |
Социальная организация. Ограничение символов: 50. |
|
|
Известное имя
|
known_name | string |
Известное имя. Ограничение символов: 50. |
|
|
Класс степени
|
class_of_degree | string |
Класс степени. |
|
|
Отдел
|
department | string |
Имя департамента образования. |
|
|
Способность
|
faculty | string |
Имя преподавателя. |
|
|
Регистрационный номер
|
registration_number | string |
Номер регистрации. Ограничение символов: 50. |
Обновление составного псевдонима (не рекомендуется) [DEPRECATED]
Обновляет составной псевдоним (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор псевдонима
|
alias_id | True | string |
Идентификатор системной записи псевдонима для обновления. |
|
Псевдоним
|
name | string |
Имя, используемое в качестве псевдонима компонента. Ограничение символов: 100. |
|
|
Тип
|
type | string |
Тип псевдонима. |
Обновление составной заметки (не рекомендуется) [DEPRECATED]
Обновляет составную заметку (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор заметки
|
note_id | True | string |
Идентификатор системной записи для обновления заметки. |
|
Тип
|
type | string |
Тип заметки. |
|
|
day
|
d | integer |
День в нечеткой дате. |
|
|
month
|
m | integer |
Месяц в нечеткой дате. |
|
|
год
|
y | integer |
Год в нечеткой дате. |
|
|
Сводка
|
summary | string |
Сводка по заметкам. Ограничение символов: 50. |
|
|
Замечание
|
text | string |
Текст заметки. |
Обновление составной связи (не рекомендуется) [DEPRECATED]
Обновляет связь для составляющих. Если существует взаимная связь, она также изменяется, чтобы отразить изменения. Это не включает изменения в свойство "комментарии", которое относится к каждой записи и может быть изменено независимо для каждой записи (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор связи
|
relationship_id | True | string |
Идентификатор системной записи для обновления связи. |
|
Тип
|
type | string |
Тип отношения, который представляет связь. |
|
|
Обратный тип
|
reciprocal_type | string |
Описывает отношение компонента к связанному компоненту. Например, в отношениях между мужским составляющим и женским братом, тип взаимной связи будет братом. |
|
|
day
|
d | integer |
День в нечеткой дате. |
|
|
month
|
m | integer |
Месяц в нечеткой дате. |
|
|
год
|
y | integer |
Год в нечеткой дате. |
|
|
day
|
d | integer |
День в нечеткой дате. |
|
|
month
|
m | integer |
Месяц в нечеткой дате. |
|
|
год
|
y | integer |
Год в нечеткой дате. |
|
|
Является ли супруг?
|
is_spouse | boolean |
Является ли связанный супруг избирателя (только относится к отношениям между лицами)? |
|
|
Является ли составной главой семьи?
|
is_constituent_head_of_household | boolean |
Является ли составной частью семьи? |
|
|
Является ли глава семьи супругом?
|
is_spouse_head_of_household | boolean |
Является ли супруг главой семьи? |
|
|
Примечания.
|
comment | string |
Дополнительные заметки о связи. |
|
|
Контакт?
|
is_organization_contact | boolean |
Представляет ли составная организация как контакт (применяется только к отношениям между организациями и отдельными лицами)? |
|
|
Основной бизнес?
|
is_primary_business | boolean |
Это основной бизнес компонента (применяется только к отношениям между организациями и отдельными лицами)? |
|
|
Тип контакта
|
organization_contact_type | string |
Предоставляет контекст для взаимодействия с соответствующим человеком, который представляет организацию в качестве контакта. Применяется только к отношениям между организациями и отдельными лицами. |
|
|
Position
|
position | string |
Позиция человека в организации. Применяется только к отношениям между организациями и отдельными лицами. Ограничение символов: 50. |
Обновление формата составного имени (не рекомендуется) [DEPRECATED]
Обновляет формат составного имени (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор формата имени
|
name_format_id | True | string |
Идентификатор системной записи формата имени для обновления. |
|
Тип
|
type | string |
Тип формата имени. |
|
|
Формат пользовательского имени?
|
custom_format | boolean |
Является ли настраиваемый формат? |
|
|
Формат
|
configuration_id | string |
Конфигурация формата имени (требуется, если не используется пользовательский формат). |
|
|
Пользовательское имя
|
formatted_name | string |
Отформатированное имя (обязательно, если используется пользовательский формат). Ограничение символов: 255. |
Перечисление апелляций (не рекомендуется) [DEPRECATED]
Возвращает список апелляций (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Лимит
|
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"). |
Возвращаемое значение
Апелляция
Перечисление компонентов (не рекомендуется) [DEPRECATED]
Возвращает список компонентов (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
List
|
list_id | string |
Определяет идентификатор списка, используемый для фильтрации набора компонентов, включенных в указанный список. Если это значение задано, другие указанные фильтры будут игнорироваться. |
|
|
Лимит
|
limit | integer |
Представляет количество возвращаемых записей. Значение по умолчанию — 500. Максимальное значение — 5000. |
|
|
Смещение
|
offset | integer |
Представляет количество пропускаемых записей. Для использования с разбивкой на страницы. |
|
|
Составной код
|
constituent_code | string |
Представляет составной код для фильтрации списка. Например, "Член совета" возвращает только избиратели с составным кодексом совета. |
|
|
Составной идентификатор
|
constituent_id | string |
Представляет разделенный запятыми список составляющих идентификаторов для фильтрации результатов. Например, "280,1232" возвращает только составляющие 280 или составляющие 1232. |
|
|
Категория настраиваемого поля
|
custom_field_category | string |
Представляет пользовательскую категорию полей для фильтрации результатов. Например, "Годовщина" возвращает только компоненты с активным пользовательским полем "Годовщина". |
|
|
Состояние диспетчера связей
|
fundraiser_status | string |
Представляет разделенный запятыми список состояний диспетчера связей для фильтрации результатов. Например, "Активный", None возвращает только компоненты, состояние диспетчера связей которых — "Активный" или "Нет". Допустимые значения для этого фильтра: "Активный", "Неактивный" и "Нет". |
|
|
Включить умершего?
|
include_deceased | boolean |
Включите погибших избирателей в ответ? |
|
|
Включить неактивное?
|
include_inactive | boolean |
Включите неактивные компоненты в ответ? |
|
|
Почтовый индекс
|
postal_code | string |
Представляет разделенный запятыми список почтовых кодов для фильтрации результатов. Например, "29466 29492" возвращает только избиратели, предпочитаемые адреса которых имеют почтовый индекс, который начинается с 29466 или 29492, например 29466, 29492 или 29492-0727. |
|
|
Добавлен или после
|
date_added | date-time |
Отфильтруйте результаты по компонентам, созданным по указанной дате (например, "2020-09-18T04:13:56Z"). |
|
|
Изменено или после
|
last_modified | date-time |
Отфильтруйте результаты до компонентов, измененных по указанной дате (например, "2020-09-18T04:13:56Z"). |
|
|
Сортировка по
|
sort | string |
Представляет список полей для сортировки результатов по. Результаты по умолчанию находятся в порядке возрастания, а знак "-" обозначает убывание. Например, "date_added",-last" сортирует составляющие по полю "date_added" в порядке возрастания, а затем по полю "last" в порядке убывания. |
Возвращаемое значение
Составляющих
Перечисление назначений диспетчера связей (не рекомендуется) [DEPRECATED]
Вывод списка назначений для диспетчера связей (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор диспетчера связей
|
fundraiser_id | True | string |
Системный идентификатор диспетчера связей, для которого возвращаются назначения. |
|
Лимит
|
limit | integer |
Представляет количество возвращаемых записей. Значение по умолчанию — 500. Максимальное значение — 5000. |
|
|
Смещение
|
offset | integer |
Представляет количество пропускаемых записей. Для использования с разбивкой на страницы. |
Возвращаемое значение
Assignments
Перечисление псевдонимов компонентов (не рекомендуется) [DEPRECATED]
Перечисляет псевдонимы для компонента (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Составной идентификатор
|
constituent_id | True | string |
Системный идентификатор записи компонента. |
Возвращаемое значение
Aliases
Перечисление составляющих действий (не рекомендуется) [DEPRECATED]
Выводит список действий для компонента (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Составной идентификатор
|
constituent_id | True | string |
Системный идентификатор записи компонента. |
Возвращаемое значение
Действия
Перечисление составляющих образования (не рекомендуется) [DEPRECATED]
Перечисляет записи об образовании для компонента (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Составной идентификатор
|
constituent_id | True | string |
Системный идентификатор записи компонента. |
Возвращаемое значение
Образования
Перечисление составляющих связей (не рекомендуется) [DEPRECATED]
Выводит список связей для компонента (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Составной идентификатор
|
constituent_id | True | string |
Системный идентификатор записи компонента. |
|
Лимит
|
limit | integer |
Представляет количество возвращаемых записей. Значение по умолчанию — 500. Максимальное значение не существует. |
|
|
Смещение
|
offset | integer |
Представляет количество пропускаемых записей. Для использования с разбивкой на страницы. |
Возвращаемое значение
Отношения
Перечисление составных апелляций (не рекомендуется) [DEPRECATED]
Перечисляет апелляции на составную (нерекомендуемую).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Составной идентификатор
|
constituent_id | True | string |
Системный идентификатор записи компонента. |
Возвращаемое значение
Составные апелляции
Перечисление средств (не рекомендуется) [DEPRECATED]
Возвращает список средств (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Лимит
|
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"). |
Возвращаемое значение
Денежные средства
Поиск составляющих (нерекомендуемых) [DEPRECATED]
Выполняет составной поиск на основе предоставленного текста поиска. Поддерживает имя, фамилию, предпочтительное имя, прежнее имя, псевдоним, адрес электронной почты, номер телефона, адрес или идентификатор подстановки. Допустимы такие сочетания имен, как имя и фамилия или предпочтительное имя и фамилия, но в противном случае поиск поддерживает только один параметр одновременно. По умолчанию поиски включают результаты, аналогичные вашим критериям. Например, поиски "Смит" включают совпадения для "Smyth" и других альтернативных орфографических выражений. Этот поиск не поддерживает подстановочные знаки, такие как * или ?. Результаты поиска ограничены 500 записями (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Поиск текста
|
search_text | True | string |
Текст для поиска. Поддерживает имя, фамилию, предпочтительное имя, прежнее имя, псевдоним, адрес электронной почты, номер телефона, адрес или идентификатор подстановки. Допустимы такие сочетания имен, как имя и фамилия или предпочтительное имя и фамилия, но в противном случае поиск поддерживает только один параметр одновременно. По умолчанию поиски включают результаты, аналогичные вашим критериям. Например, поиски "Смит" включают совпадения для "Smyth" и других альтернативных орфографических выражений. Этот поиск не поддерживает подстановочные знаки, такие как * или ?. Результаты поиска ограничены 500 записями. |
|
Состояния диспетчера связей
|
fundraiser_status | string |
Представляет разделенный запятыми список состояний диспетчера связей для фильтрации результатов. Например, "Активный", None возвращает только компоненты, состояние диспетчера связей которых — "Активный" или "Нет". Допустимые значения для этого фильтра: "Активный", "Неактивный" и "Нет". |
|
|
Включить неактивное?
|
include_inactive | boolean |
Включите неактивные компоненты в ответ? |
|
|
Поле поиска
|
search_field | string |
Представляет поле для поиска. В настоящее время она поддерживает только lookup_id. Если он предоставляется с search_text, будет возвращен компонент с lookup_id, соответствующий search_text. |
|
|
Используйте строгий поиск?
|
strict_search | boolean |
Исключите компоненты, имена которых звучат как текст поиска, но написаны по-другому? |
|
|
Лимит
|
limit | integer |
Представляет количество возвращаемых записей. Значение по умолчанию — 500. Максимальное значение — 5000. |
|
|
Смещение
|
offset | integer |
Представляет количество пропускаемых записей. Для использования с разбивкой на страницы. |
Возвращаемое значение
Результаты поиска
Получение апелляции (не рекомендуется) [DEPRECATED]
Возвращает сведения об апелляции (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор апелляции
|
appeal_id | True | string |
Идентификатор системной записи для получения апелляции. |
Возвращаемое значение
Appeal
Получение кампании (не рекомендуется) [DEPRECATED]
Возвращает сведения о кампании (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор кампании
|
campaign_id | True | string |
Системный идентификатор записи кампании для получения. |
Возвращаемое значение
кампания
Получение компонента (не рекомендуется) [DEPRECATED]
Возвращает сведения об составляющих (нерекомендуемых).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Составной идентификатор
|
constituent_id | True | string |
Системный идентификатор записи компонента, который требуется получить. |
Возвращаемое значение
Составляющая
Получение наибольшего подарка (не рекомендуется) [DEPRECATED]
Возвращает величайший подарок для компонента (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Составной идентификатор
|
constituent_id | True | string |
Системный идентификатор записи компонента. |
Возвращаемое значение
Предоставление сводки
Получение отложенного времени существования (не рекомендуется) [DEPRECATED]
Возвращает время существования, предоставляющее сводку для компонента (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Составной идентификатор
|
constituent_id | True | string |
Системный идентификатор записи компонента. |
Возвращаемое значение
Время существования
Получение пакета (не рекомендуется) [DEPRECATED]
Возвращает сведения о пакете (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пакета
|
package_id | True | string |
Идентификатор системной записи пакета, который требуется получить. |
Возвращаемое значение
Package
Получение первого подарка (не рекомендуется) [DEPRECATED]
Возвращает первый подарок для компонента (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Составной идентификатор
|
constituent_id | True | string |
Системный идентификатор записи компонента. |
Возвращаемое значение
Предоставление сводки
Получение подарка (не рекомендуется) [DEPRECATED]
Возвращает сведения о подарке (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор подарка
|
gift_id | True | string |
Системный идентификатор записи подарка для получения. |
Возвращаемое значение
Подарок
- Тело
- GiftApi.GiftRead
Получение последнего подарка (не рекомендуется) [DEPRECATED]
Возвращает последний подарок для компонента (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Составной идентификатор
|
constituent_id | True | string |
Системный идентификатор записи компонента. |
Возвращаемое значение
Предоставление сводки
Получение рисунка из составного профиля (не рекомендуется) [DEPRECATED]
Возвращает текущее изображение профиля для компонента (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Составной идентификатор
|
constituent_id | True | string |
Системный идентификатор записи компонента, для которого требуется получить рисунок профиля. |
Возвращаемое значение
Изображение профиля
Получение сводки формата составного имени (не рекомендуется) [DEPRECATED]
Возвращает сводку формата имен для компонента (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Составной идентификатор
|
constituent_id | True | string |
Системный идентификатор записи компонента. |
Возвращаемое значение
Сводка по формату имени
Получение составного действия (не рекомендуется) [DEPRECATED]
Возвращает сведения о составном действии (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор действия
|
action_id | True | string |
Идентификатор системной записи действия для получения. |
Возвращаемое значение
Действие
Получение фонда (не рекомендуется) [DEPRECATED]
Возвращает сведения о фонде (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор фонда
|
fund_id | True | string |
Системный идентификатор фонда для получения. |
Возвращаемое значение
Фонд
Преобразование в составную (нерекомендуемую) [DEPRECATED]
Преобразует нерекомендуемый в состав (нерекомендуемый).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Неисключающий идентификатор
|
non_constituent_id | True | string |
Идентификатор системной записи преобразуемой нефиксной записи. |
|
Идентификатор
|
id | string |
Системный идентификатор записи в составном коде. |
|
|
day
|
d | integer |
День в нечеткой дате. |
|
|
month
|
m | integer |
Месяц в нечеткой дате. |
|
|
год
|
y | integer |
Год в нечеткой дате. |
|
|
day
|
d | integer |
День в нечеткой дате. |
|
|
month
|
m | integer |
Месяц в нечеткой дате. |
|
|
год
|
y | integer |
Год в нечеткой дате. |
|
|
последовательность
|
sequence | integer |
Последовательность составного кода. |
Возвращаемое значение
Преобразованные составляющие
Проверка маркера удостоверения пользователя (не рекомендуется) [DEPRECATED]
Проверяет маркер удостоверения пользователя (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Маркер удостоверения пользователя
|
uit | True | string |
Строка маркера удостоверения пользователя. |
|
Идентификатор приложения
|
application_id | True | uuid |
Ожидаемый идентификатор приложения SKY, к которому был выдан маркер удостоверения пользователя. |
Возвращаемое значение
Сведения о маркере удостоверения пользователя
Создание вложения апелляции (не рекомендуется) [DEPRECATED]
Создает новое вложение апелляции (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор апелляции
|
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. Только для физических вложений. |
Возвращаемое значение
Созданное вложение апелляции
Создание вложения действия (не рекомендуется) [DEPRECATED]
Создает новое вложение действия (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор действия
|
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. Только для физических вложений. |
Возвращаемое значение
Созданное вложение действия
Создание вложения кампании (не рекомендуется) [DEPRECATED]
Создает новое вложение кампании (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор кампании
|
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. Только для физических вложений. |
Возвращаемое значение
Созданное вложение кампании
Создание вложения подарка (не рекомендуется) [DEPRECATED]
Создает новое вложение подарка (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор подарка
|
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. Только для физических вложений. |
Возвращаемое значение
Созданное вложение подарка
Создание вложения фонда (не рекомендуется) [DEPRECATED]
Создает новое вложение фонда (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор фонда
|
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. Только для физических вложений. |
Возвращаемое значение
Созданное вложение фонда
Создание записи согласия (не рекомендуется) [DEPRECATED]
Создает новую запись о согласии на создание компонента (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Составной идентификатор
|
constituent_id | True | string |
Системный идентификатор компонента, связанного с записью согласия. |
|
Channel
|
channel | True | string |
Канал, к которому применяется ответ согласия. |
|
Категория
|
category | string |
Категория, к которую применяется ответ согласия. |
|
|
Исходный материал
|
source | string |
Источник ответа на согласие со стороны избирателей. |
|
|
Ответ
|
constituent_consent_response | True | string |
Как компонент ответил на согласие для указанного канала или категории. |
|
Date
|
consent_date | True | date-time |
Дата получения ответа согласия (например, "2020-09-18T04:13:56Z"). |
|
Оператор "Согласие"
|
consent_statement | string |
Заявление, на котором избиратель ответил при предоставлении согласия. |
|
|
Уведомление о конфиденциальности
|
privacy_notice | string |
Уведомление о конфиденциальности, предоставленное избирателю. |
Возвращаемое значение
Созданное согласие на создание компонента
Создание кода для создания составного запроса (не рекомендуется) [DEPRECATED]
Создает новый составной код запроса (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Составной идентификатор
|
constituent_id | True | string |
Системный идентификатор записи компонента, связанного с кодом запроса. |
|
Код запроса
|
solicit_code | True | string |
Инструкции по обмену данными и /или ограничения для составляющих. |
|
Начальная дата
|
start_date | date |
Дата начала кода запроса (например, "2005-09-18"). |
|
|
Дата окончания
|
end_date | date |
Дата окончания кода запроса (например, "2005-09-18"). |
Возвращаемое значение
Созданный код для создания составного запроса
Создание компонента организации (не рекомендуется) [DEPRECATED]
Создает новую составную организацию (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя
|
name | True | string |
Имя организации. Ограничение символов: 100. |
|
Идентификатор подстановки
|
lookup_id | string |
Определяемый пользователем идентификатор для компонента. |
|
|
type
|
type | True | string |
Тип адреса. |
|
country
|
country | string |
Страна адреса (может быть идентификатором, именем или сокращением). |
|
|
обводы
|
address_lines | string |
Адресные строки. Ограничение символов: 150. |
|
|
city
|
city | string |
Город адреса (не используется в сочетании с полем "Пригород"). |
|
|
государство
|
state | string |
Регион в адресе. |
|
|
почтовый индекс
|
postal_code | string |
Почтовый индекс адреса. Ограничение символов: 12. |
|
|
пригород
|
suburb | string |
Пригород адреса (не используется в сочетании с полем "Город"). |
|
|
графство
|
county | string |
Район в адресе. |
|
|
start
|
start | date |
Дата начала пребывания на этом адресе (например, "2005-09-18"). |
|
|
конец
|
end | date |
Дата прекращения проживания в этом адресе (например, "2005-09-18"). |
|
|
type
|
type | True | string |
Тип телефона. |
|
число/номер
|
number | True | string |
Номер телефона. |
|
является основным?
|
primary | boolean |
Это основной номер телефона компонента? |
|
|
type
|
type | True | string |
Тип адреса электронной почты. |
|
address
|
address | True | string |
Адрес электронной почты. |
|
является основным?
|
primary | boolean |
Это основной адрес электронной почты компонента? |
|
|
type
|
type | True | string |
Тип присутствия в Интернете. |
|
address
|
address | True | string |
Веб-адрес для присутствия в Интернете. |
|
является основным?
|
primary | boolean |
Это основное онлайн-присутствие составляющих? |
|
|
Дает анонимно?
|
gives_anonymously | boolean |
Дает ли избиратель анонимно? |
|
|
Промышленность
|
industry | string |
Отрасль составляющих. |
|
|
Количество сотрудников
|
num_employees | integer |
Количество сотрудников в организации. |
|
|
Соответствует подаркам?
|
matches_gifts | boolean |
Соответствует ли организация подаркам? |
|
|
Соответствующий фактор подарка
|
matching_gift_factor | double |
Соответствующий фактор подарка. |
|
|
Минимальное совпадение за подарок
|
value | double |
Минимальная сумма соответствия за подарок для составляющих. |
|
|
Максимальное количество совпадений на подарок
|
value | double |
Максимальное количество совпадений за подарок для составляющих. |
|
|
Минимальное совпадение на констит
|
value | double |
Минимальный итог соответствия для составляющих. |
|
|
Максимальное совпадение на констит
|
value | double |
Максимальное количество совпадений для составляющих. |
|
|
Сопоставление примечаний к подаркам
|
matching_gift_notes | string |
Соответствующие подарочные заметки для составляющих. |
Возвращаемое значение
Созданная организация
Создание назначения диспетчера связей (не рекомендуется) [DEPRECATED]
Создает новое назначение диспетчера связей (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор сборов средств
|
fundraiser_id | True | string |
Системный идентификатор сборов средств. |
|
Составной идентификатор
|
constituent_id | True | string |
Идентификатор системной записи назначенного компонента. |
|
Тип
|
type | string |
Тип сборов средств. |
|
|
Начало назначения
|
start | date-time |
Дата начала назначения (например, "2020-09-18T04:13:56Z"). |
|
|
Окончание назначения
|
end | date-time |
Дата начала назначения (например, "2020-09-18T04:13:56Z"). |
|
|
Сумма
|
value | True | double |
Сумма цели для сборов средств, чтобы запрашивать от назначенного избирателя. |
|
Идентификатор кампании
|
campaign_id | string |
Системный идентификатор кампании, к которой будут применены полученные подарки. |
|
|
Идентификатор фонда
|
fund_id | string |
Системный идентификатор фонда, к которому будут применены полученные подарки. |
|
|
Идентификатор апелляции
|
appeal_id | string |
Системный идентификатор обращения, к которому будут применены полученные подарки. |
Возвращаемое значение
Создание назначения сборов средств
Создание настраиваемого поля действия (не рекомендуется) [DEPRECATED]
Создает настраиваемое поле действия (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
Объект, представляющий настраиваемое поле для создания. |
Возвращаемое значение
Созданное настраиваемое поле действия
Создание настраиваемого поля кампании (не рекомендуется) [DEPRECATED]
Создает настраиваемое поле кампании (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
Объект, представляющий настраиваемое поле для создания. |
Возвращаемое значение
Созданное настраиваемое поле кампании
Создание настраиваемого поля подарка (не рекомендуется) [DEPRECATED]
Создает новое настраиваемое поле подарка (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
Объект, представляющий настраиваемое поле для создания. |
Возвращаемое значение
Созданное настраиваемое поле подарка
Создание настраиваемого поля призыва (не рекомендуется) [DEPRECATED]
Создает новое настраиваемое поле привлекательности (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
Объект, представляющий настраиваемое поле для создания. |
Возвращаемое значение
Созданное настраиваемое поле для обращения
Создание настраиваемого поля фонда (не рекомендуется) [DEPRECATED]
Создает новое настраиваемое поле фонда (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
Объект, представляющий настраиваемое поле для создания. |
Возвращаемое значение
Созданное настраиваемое поле фонда
Создание основного формата имени (не рекомендуется) [DEPRECATED]
Создает основной формат имени для компонента (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Составной идентификатор
|
constituent_id | True | string |
Системный идентификатор записи компонента. |
|
Тип
|
primary_type | True | string |
Тип формата основного имени. |
|
Формат пользовательского имени?
|
custom_format | boolean |
Является ли настраиваемый формат? |
|
|
Формат
|
configuration_id | string |
Конфигурация формата имени (требуется, если не используется пользовательский формат). |
|
|
Пользовательское имя
|
formatted_name | string |
Отформатированное имя (обязательно, если используется пользовательский формат). Ограничение символов: 255. |
Возвращаемое значение
Формат созданного имени
Создание отдельного компонента (не рекомендуется) [DEPRECATED]
Создает новый отдельный компонент (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Название
|
title | string |
Основной титул избирателя. |
|
|
Имя (первое имя)
|
first | string |
Первое имя избирателя. Ограничение символов: 50. |
|
|
Фамилия
|
last | True | string |
Фамилия избирателя. Ограничение символов: 100. |
|
Суффикс
|
suffix | string |
Основной суффикс составляющих. |
|
|
Идентификатор подстановки
|
lookup_id | string |
Определяемый пользователем идентификатор для компонента. |
|
|
type
|
type | True | string |
Тип адреса. |
|
country
|
country | string |
Страна адреса (может быть идентификатором, именем или сокращением). |
|
|
обводы
|
address_lines | string |
Адресные строки. Ограничение символов: 150. |
|
|
city
|
city | string |
Город адреса (не используется в сочетании с полем "Пригород"). |
|
|
государство
|
state | string |
Регион в адресе. |
|
|
почтовый индекс
|
postal_code | string |
Почтовый индекс адреса. Ограничение символов: 12. |
|
|
пригород
|
suburb | string |
Пригород адреса (не используется в сочетании с полем "Город"). |
|
|
графство
|
county | string |
Район в адресе. |
|
|
start
|
start | date |
Дата начала пребывания на этом адресе (например, "2005-09-18"). |
|
|
конец
|
end | date |
Дата прекращения проживания в этом адресе (например, "2005-09-18"). |
|
|
type
|
type | True | string |
Тип телефона. |
|
число/номер
|
number | True | string |
Номер телефона. |
|
является основным?
|
primary | boolean |
Это основной номер телефона компонента? |
|
|
type
|
type | True | string |
Тип адреса электронной почты. |
|
address
|
address | True | string |
Адрес электронной почты. |
|
является основным?
|
primary | boolean |
Это основной адрес электронной почты компонента? |
|
|
type
|
type | True | string |
Тип присутствия в Интернете. |
|
address
|
address | True | string |
Веб-адрес для присутствия в Интернете. |
|
является основным?
|
primary | boolean |
Это основное онлайн-присутствие составляющих? |
|
|
Предпочтительное имя
|
preferred_name | string |
Предпочтительное имя компонента. Ограничение символов: 50. |
|
|
Отчество/второе имя
|
middle | string |
По промежуточному имени избирателя. Ограничение символов: 50. |
|
|
Прежнее имя
|
former_name | string |
Прежнее имя избирателя. Ограничение символов: 100. |
|
|
Заголовок 2
|
title_2 | string |
Вторичный титул избирателя. |
|
|
Суффикс 2
|
suffix_2 | string |
Вторичный суффикс компонента. |
|
|
Gender
|
gender | string |
Пол избирателей. |
|
|
Семейное положение
|
marital_status | string |
Семейное состояние избирателя. |
|
|
Дает анонимно?
|
gives_anonymously | boolean |
Дает ли избиратель анонимно? |
|
|
day
|
d | integer |
День в нечеткой дате. |
|
|
month
|
m | integer |
Месяц в нечеткой дате. |
|
|
год
|
y | integer |
Год в нечеткой дате. |
|
|
Родина
|
birthplace | string |
Место рождения составляющих. |
|
|
Этнос
|
ethnicity | string |
Этническое происхождение составляющих. |
|
|
доход
|
income | string |
Доход для составляющих. |
|
|
Религиозная деятельность
|
religion | string |
Религия составляющих. |
|
|
Пользовательский адрес?
|
custom_format | boolean |
Основной адрес настраиваемого формата? |
|
|
Формат адреса
|
configuration_id | string |
Конфигурация основного адреса (требуется, если не используется пользовательский формат). |
|
|
Адрес пользовательского имени
|
formatted_name | string |
Основное имя отформатированного адреса (необходимо, если используется пользовательский формат). Ограничение символов: 255. |
|
|
Настраиваемое приветствие?
|
custom_format | boolean |
Является ли основное приветствие настраиваемым форматом? |
|
|
Формат салютации
|
configuration_id | string |
Первичная конфигурация приветствия (требуется, если не используется пользовательский формат). |
|
|
Пользовательское имя приветствия
|
formatted_name | string |
Основное форматируемое имя салютации (необходимо, если используется пользовательский формат). Ограничение символов: 255. |
Возвращаемое значение
Создано отдельное составляющие
Создание отдельной связи (не рекомендуется) [DEPRECATED]
Создает новую отдельную связь. Если отношения связаны с другим компонентом, для этого компонента создается взаимная связь (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Составной идентификатор
|
constituent_id | True | string |
Системный идентификатор записи компонента, связанного с связью. |
|
Идентификатор отношения
|
relation_id | True | string |
Идентификатор системной записи связанного человека. |
|
Тип
|
type | string |
Тип отношения, который представляет связь. |
|
|
Обратный тип
|
reciprocal_type | string |
Описывает отношение компонента к связанному компоненту. Например, в отношениях между мужским составляющим и женским братом, тип взаимной связи будет братом. |
|
|
day
|
d | integer |
День в нечеткой дате. |
|
|
month
|
m | integer |
Месяц в нечеткой дате. |
|
|
год
|
y | integer |
Год в нечеткой дате. |
|
|
day
|
d | integer |
День в нечеткой дате. |
|
|
month
|
m | integer |
Месяц в нечеткой дате. |
|
|
год
|
y | integer |
Год в нечеткой дате. |
|
|
Является ли супруг?
|
is_spouse | boolean |
Является ли связанный отдельный супруг избирателя? |
|
|
Является ли составной главой семьи?
|
is_constituent_head_of_household | boolean |
Является ли составной частью семьи? |
|
|
Является ли глава семьи супругом?
|
is_spouse_head_of_household | boolean |
Является ли супруг главой семьи? |
|
|
Примечания.
|
comment | string |
Дополнительные заметки о связи. |
Возвращаемое значение
Созданная отдельная связь
Создание пакета подарков (не рекомендуется) [DEPRECATED]
Создает новый пакет подарков (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Description
|
batch_description | string |
Описание пакета. |
|
|
Ожидаемое число
|
expected_number | integer |
Количество подарков, ожидаемых в пакете. |
|
|
Ожидаемый итог
|
expected_batch_total | double |
Общее значение подарков в пакете. |
|
|
Номер пакета
|
batch_number | string |
Уникальный идентификатор, характерный для пакета. |
Возвращаемое значение
Создан пакет подарков
Создание подарка (не рекомендуется) [DEPRECATED]
Создает новый подарок (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Составной идентификатор
|
constituent_id | True | string |
Системный идентификатор записи компонента, связанного с подарком. |
|
Сумма
|
value | True | double |
Денежный объем подарка. |
|
Date
|
date | True | date |
Дата подарка (например, '2020-09-18'). |
|
Тип
|
type | True | string |
Тип подарка. |
|
Идентификатор кампании
|
campaign_id | string |
Системный идентификатор кампании, связанной с разделением подарка. |
|
|
Идентификатор фонда
|
fund_id | True | string |
Системный идентификатор фонда, связанного с разделением подарка. |
|
Идентификатор апелляции
|
appeal_id | string |
Системный идентификатор апелляции, связанной с разделением подарка. |
|
|
Идентификатор пакета
|
package_id | string |
Системный идентификатор пакета, связанного с разделением подарка. |
|
|
количество
|
value | True | double |
Денежный объем разделенного подарка. |
|
Метод оплаты
|
payment_method | True | string |
Метод оплаты. |
|
Контрольный номер
|
check_number | string |
Номер проверки (применяется только при использовании метода оплаты "PersonalCheck"). |
|
|
day
|
d | integer |
День в нечеткой дате. |
|
|
month
|
m | integer |
Месяц в нечеткой дате. |
|
|
год
|
y | integer |
Год в нечеткой дате. |
|
|
Reference
|
reference | string |
Ссылка на оплату (применимо только при использовании метода оплаты — "Other"). |
|
|
day
|
d | integer |
День в нечеткой дате. |
|
|
month
|
m | integer |
Месяц в нечеткой дате. |
|
|
год
|
y | integer |
Год в нечеткой дате. |
|
|
Является ли анонимным?
|
is_anonymous | boolean |
Является ли подарок анонимным? Если значение не указано, будет использоваться анонимность донора по умолчанию. |
|
|
Подтип
|
subtype | string |
Подтип подарка. |
|
|
Комментарий
|
reference | string |
Примечания для отслеживания специальных сведений о подарке, например мотивации за ним или подробное описание подарка в виде. |
|
|
Идентификатор подстановки
|
lookup_id | string |
Определяемый пользователем идентификатор для подарка. |
|
|
Используйте кредиты диспетчера связей?
|
default_fundraiser_credits | boolean |
Используйте кредиты диспетчера связей по умолчанию? |
|
|
Используйте мягкие кредиты?
|
default_soft_credits | boolean |
Используйте мягкие кредиты по умолчанию? |
|
|
Избирательный округ
|
constituency | string |
Избирательный округ подарка. |
|
|
Префикс пакетной службы
|
batch_prefix | string |
Префикс, используемый для пакетных подарков. Это должно содержать по крайней мере одну букву и требуется, если "Номер пакетной службы" имеет значение. |
|
|
Номер пакета
|
batch_number | string |
Номер пакета. Ограничение символов: 50 (включая префикс пакетной службы). |
|
|
Состояние публикации
|
post_status | string |
Состояние записи подарка. |
|
|
Дата публикации
|
post_date | date |
Дата отправки подарка (например, "2020-09-18"). |
|
|
Состояние квитанции
|
status | True | string |
Состояние получения подарка. |
|
Сумма по чеку
|
value | True | double |
Денежный объем квитанции для подарка. |
|
Дата прихода
|
date | date |
Дата получения подарка (например, "2020-09-18"). |
Возвращаемое значение
Созданный подарок
- Тело
- GiftApi.CreatedGift
Создание расположения документа (не рекомендуется) [DEPRECATED]
Создает новый уникальный идентификатор документа и расположение отправки для использования с физическими вложениями. Ответ будет содержать инструкции по тому, где и как отправить содержимое документа (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя файла
|
file_name | string |
Имя файла для отправки документа. |
|
|
Включить эскиз?
|
upload_thumbnail | boolean |
Включите расположение эскиза документа? |
Возвращаемое значение
Определение файла
Создание связи организации (не рекомендуется) [DEPRECATED]
Создает связь организации. Если отношения связаны с другим компонентом, для этого компонента создается взаимная связь (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Составной идентификатор
|
constituent_id | True | string |
Системный идентификатор записи компонента, связанного с связью. |
|
Идентификатор отношения
|
relation_id | True | string |
Системный идентификатор записи связанной организации. |
|
Тип
|
type | string |
Тип отношения, который представляет связь. |
|
|
Обратный тип
|
reciprocal_type | string |
Описывает связь компонента с связанной организацией. |
|
|
day
|
d | integer |
День в нечеткой дате. |
|
|
month
|
m | integer |
Месяц в нечеткой дате. |
|
|
год
|
y | integer |
Год в нечеткой дате. |
|
|
day
|
d | integer |
День в нечеткой дате. |
|
|
month
|
m | integer |
Месяц в нечеткой дате. |
|
|
год
|
y | integer |
Год в нечеткой дате. |
|
|
Контакт?
|
is_organization_contact | boolean |
Представляет ли составная организация в качестве контакта? |
|
|
Тип контакта
|
organization_contact_type | string |
Предоставляет контекст для взаимодействия с соответствующим человеком, который представляет организацию в качестве контакта. |
|
|
Position
|
position | string |
Позиция человека в организации. Ограничение символов: 50. |
|
|
Основной бизнес?
|
is_primary_business | boolean |
Это основной бизнес составляющих? |
|
|
Примечания.
|
comment | string |
Дополнительные заметки о связи. |
Возвращаемое значение
Созданная связь организации
Создание составного адреса (не рекомендуется) [DEPRECATED]
Создает новый составной адрес (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Составной идентификатор
|
constituent_id | True | string |
Системный идентификатор записи компонента, связанного с адресом. |
|
Тип адреса
|
type | True | string |
Тип адреса. |
|
Страна
|
country | string |
Страна адреса (может быть идентификатором, именем или сокращением). |
|
|
Линии адресов
|
address_lines | string |
Адресные строки. |
|
|
Город
|
city | string |
Город адреса (не используется в сочетании с полем "Пригород"). |
|
|
Государство
|
state | string |
Регион в адресе. |
|
|
Почтовый индекс
|
postal_code | string |
Почтовый индекс адреса. |
|
|
Пригород
|
suburb | string |
Пригород адреса (не используется в сочетании с полем "Город"). |
|
|
Округ
|
county | string |
Район в адресе. |
|
|
Источник информации
|
information_source | string |
Источник сведений для адреса. |
|
|
Регион
|
region | string |
Регион для адреса. |
|
|
ТЕЛЕГА
|
cart | string |
Маршрут перевозчика (CART) для адреса. |
|
|
ЛОТ
|
lot | string |
Строка путешествия (LOT) для адреса. |
|
|
DPC
|
dpc | string |
Код точки доставки (DPC) для адреса. |
|
|
Допустимый из
|
start | date |
Дата начала пребывания на этом адресе (например, "2005-09-18"). |
|
|
Допустимо
|
end | date |
Дата прекращения проживания в этом адресе (например, "2005-09-18"). |
|
|
Первичный?
|
preferred | boolean |
Это предпочтительный адрес избирателя? |
|
|
Не почта?
|
do_not_mail | boolean |
Можно ли связаться с избирателем по этому адресу? |
|
|
day
|
d | integer |
День в нечеткой дате. |
|
|
month
|
m | integer |
Месяц в нечеткой дате. |
|
|
год
|
y | integer |
Год в нечеткой дате. |
|
|
day
|
d | integer |
День в нечеткой дате. |
|
|
month
|
m | integer |
Месяц в нечеткой дате. |
|
|
год
|
y | integer |
Год в нечеткой дате. |
Возвращаемое значение
Созданный составной адрес
Создание составного адреса электронной почты (не рекомендуется) [DEPRECATED]
Создает новый составной адрес электронной почты (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Составной идентификатор
|
constituent_id | True | string |
Системный идентификатор записи компонента, связанного с адресом электронной почты. |
|
Тип электронной почты
|
type | True | string |
Тип адреса электронной почты. |
|
Адрес электронной почты
|
address | True | string |
Адрес электронной почты. |
|
Первичный?
|
primary | boolean |
Это основной адрес электронной почты компонента? |
|
|
Не отправлять сообщения электронной почты?
|
do_not_email | boolean |
Можно ли связаться с компонентами по этому адресу электронной почты? |
|
|
Неактивный?
|
inactive | boolean |
Неактивен ли адрес электронной почты? |
Возвращаемое значение
Созданный составной адрес электронной почты
Создание составного вложения (не рекомендуется) [DEPRECATED]
Создает новое составное вложение (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Составной идентификатор
|
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. Только для физических вложений. |
Возвращаемое значение
Созданное составное вложение
Создание составного действия (не рекомендуется) [DEPRECATED]
Создает новое составное действие (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Составной идентификатор
|
constituent_id | True | string |
Системный идентификатор записи компонента, связанного с действием. |
|
Date
|
date | True | date-time |
Дата действия (например, '2020-09-18T04:13:56Z'). |
|
Категория
|
category | True | string |
Канал или намерение составного взаимодействия. |
|
Тип
|
type | string |
Дополнительное описание действия для дополнения категории. |
|
|
Сводка
|
summary | string |
Краткое описание действия, которое отображается в верхней части записи. Ограничение символов: 255. |
|
|
Замечание
|
description | string |
Подробное объяснение, подробное описание сводки действий. |
|
|
Завершённый?
|
completed | boolean |
Завершено ли действие? Если система настроена для использования пользовательских состояний действий, это значение основано на значении состояния действия. |
|
|
Дата завершения
|
completed_date | date-time |
Дата завершения действия (например, "2020-09-18T04:13:56Z"). |
|
|
Состояние
|
status | string |
Состояние действия. |
|
|
Направление
|
direction | string |
Направление действия. |
|
|
Местоположение
|
location | string |
Расположение действия. |
|
|
Результат
|
outcome | string |
Результат действия. |
|
|
Priority
|
priority | string |
Приоритет действия. |
|
|
Время запуска
|
start_time | string |
Время начала действия. Используется 24-часовое время в формате HH:mm. |
|
|
Время окончания
|
end_time | string |
Время окончания действия. Используется 24-часовое время в формате HH:mm. |
|
|
Диспетчеры связей
|
fundraisers | array of string |
Набор идентификаторов системных записей для диспетчеров связей, связанных с действием. |
Возвращаемое значение
Созданное действие
Создание составного кода (не рекомендуется) [DEPRECATED]
Создает новый составной код (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Составной идентификатор
|
constituent_id | True | string |
Системный идентификатор записи компонента, связанного с составным кодом. |
|
Составной код
|
description | True | string |
Составной код. |
|
day
|
d | integer |
День в нечеткой дате. |
|
|
month
|
m | integer |
Месяц в нечеткой дате. |
|
|
год
|
y | integer |
Год в нечеткой дате. |
|
|
day
|
d | integer |
День в нечеткой дате. |
|
|
month
|
m | integer |
Месяц в нечеткой дате. |
|
|
год
|
y | integer |
Год в нечеткой дате. |
|
|
Последовательность
|
sequence | integer |
Числовая последовательность, связанная с составным кодом. |
Возвращаемое значение
Созданный составной код
Создание составного настраиваемого поля (не рекомендуется) [DEPRECATED]
Создает новое составное настраиваемое поле (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
Объект, представляющий настраиваемое поле для создания. |
Возвращаемое значение
Созданное настраиваемое поле
Создание составного образования (не рекомендуется) [DEPRECATED]
Создает новое составное образование (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Составной идентификатор
|
constituent_id | True | string |
Системный идентификатор записи компонента, связанного с образованием. |
|
Школа
|
school | True | string |
Имя школы или учреждения. |
|
Тип
|
type | string |
Тип образования. |
|
|
Класс
|
class_of | string |
Год, который окончил составной элемент. |
|
|
Состояние
|
status | string |
Состояние образования. |
|
|
day
|
d | integer |
День в нечеткой дате. |
|
|
month
|
m | integer |
Месяц в нечеткой дате. |
|
|
год
|
y | integer |
Год в нечеткой дате. |
|
|
day
|
d | integer |
День в нечеткой дате. |
|
|
month
|
m | integer |
Месяц в нечеткой дате. |
|
|
год
|
y | integer |
Год в нечеткой дате. |
|
|
day
|
d | integer |
День в нечеткой дате. |
|
|
month
|
m | integer |
Месяц в нечеткой дате. |
|
|
год
|
y | integer |
Год в нечеткой дате. |
|
|
Градус
|
degree | string |
Степень получена. |
|
|
GPA
|
gpa | double |
Среднее значение точки оценки. |
|
|
Тема исследования
|
subject_of_study | string |
Тема исследования. |
|
|
Первичный?
|
primary | boolean |
Это ассоциация начальной школы избирателей? |
|
|
Специальности
|
majors | array of string |
Основные курсы изучения. |
|
|
Несовершеннолетних
|
minors | array of string |
Незначительные курсы обучения. |
|
|
Campus
|
campus | string |
Кампус. Ограничение символов: 50. |
|
|
Социальная организация
|
social_organization | string |
Социальная организация. Ограничение символов: 50. |
|
|
Известное имя
|
known_name | string |
Известное имя. Ограничение символов: 50. |
|
|
Класс степени
|
class_of_degree | string |
Класс степени (применимо только для версий Великобритании). |
|
|
Отдел
|
department | string |
Имя отдела образования (применимо только для версий Великобритании). |
|
|
Способность
|
faculty | string |
Имя преподавателя (применимо только для версий Великобритании). |
|
|
Регистрационный номер
|
registration_number | string |
Номер регистрации (применимо только для версий Великобритании). Ограничение символов: 50. |
Возвращаемое значение
Создание составного образования
Создание составного псевдонима (не рекомендуется) [DEPRECATED]
Создает новый составной псевдоним (нерекомендуемый).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Составной идентификатор
|
constituent_id | True | string |
Системный идентификатор записи компонента, связанного с псевдонимом. |
|
Псевдоним
|
name | True | string |
Имя, используемое в качестве псевдонима компонента. Ограничение символов: 100. |
|
Тип
|
type | string |
Тип псевдонима. |
Возвращаемое значение
Созданный псевдоним компонентов
Создание составного сетевого присутствия (не рекомендуется) [DEPRECATED]
Создает новое составное онлайн-присутствие (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Составной идентификатор
|
constituent_id | True | string |
Системный идентификатор записи компонента, связанного с присутствием в Интернете. |
|
Тип
|
type | True | string |
Тип присутствия в Интернете. |
|
Link
|
address | True | string |
Веб-адрес для присутствия в Интернете. |
|
Первичный?
|
primary | boolean |
Это основное онлайн-присутствие составляющих? |
|
|
Неактивный?
|
inactive | boolean |
Неактивно ли это присутствие в Интернете? |
Возвращаемое значение
Создание составляющих онлайн-присутствия
Создание составного телефона (не рекомендуется) [DEPRECATED]
Создает новый составной телефон (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Составной идентификатор
|
constituent_id | True | string |
Системный идентификатор записи компонента, связанного с телефоном. |
|
Тип
|
type | True | string |
Тип телефона. |
|
Number
|
number | True | string |
Номер телефона. |
|
Первичный?
|
primary | boolean |
Это основной телефон избирателя? |
|
|
Не вызывайте?
|
do_not_call | boolean |
Можно ли связаться с компонентом по этому номеру? |
|
|
Неактивный?
|
inactive | boolean |
Неактивен ли этот номер телефона? |
Возвращаемое значение
Созданный составной телефон
Создание составной заметки (не рекомендуется) [DEPRECATED]
Создает новую составную заметку (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Составной идентификатор
|
constituent_id | True | string |
Системный идентификатор записи компонента, связанного с примечанием. |
|
Тип
|
type | True | string |
Тип заметки. |
|
day
|
d | integer |
День в нечеткой дате. |
|
|
month
|
m | integer |
Месяц в нечеткой дате. |
|
|
год
|
y | integer |
Год в нечеткой дате. |
|
|
Сводка
|
summary | string |
Сводка по заметкам. Ограничение символов: 50. |
|
|
Замечание
|
text | string |
Текст заметки. |
Возвращаемое значение
Созданная составная заметка
Создание составной оценки (не рекомендуется) [DEPRECATED]
Создает новый составной рейтинг (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
Объект, представляющий создаваемый рейтинг. |
Возвращаемое значение
Созданная оценка компонентов
Создание списка из набора записей (не рекомендуется) [DEPRECATED]
Создает список, отфильтрованный по указанному набору записей (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя
|
name | True | string |
Имя списка. Ограничение символов: 50. |
|
Description
|
description | True | string |
Описание списка. |
|
Тип списка
|
list_type | True | string |
Определяет тип создаваемого списка. |
|
Permissions
|
list_permissions | True | string |
Определяет, могут ли другие пользователи получить доступ к списку. |
|
Идентификаторы
|
ids | True | array of string |
Уникальные идентификаторы записей, содержащихся в списке (максимум 100 000 значений). |
Возвращаемое значение
Создан список
- Тело
- ListApi.CreatedList
Создание формата составного имени (не рекомендуется) [DEPRECATED]
Создает новый формат составного имени (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Составной идентификатор
|
constituent_id | True | string |
Системный идентификатор записи компонента. |
|
Тип
|
type | True | string |
Тип формата имени. |
|
Формат пользовательского имени?
|
custom_format | boolean |
Является ли настраиваемый формат? |
|
|
Формат
|
configuration_id | string |
Конфигурация формата имени (требуется, если не используется пользовательский формат). |
|
|
Пользовательское имя
|
formatted_name | string |
Отформатированное имя (обязательно, если используется пользовательский формат). Ограничение символов: 255. |
Возвращаемое значение
Формат созданного имени
Список кампаний (не рекомендуется) [DEPRECATED]
Возвращает список кампаний (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Лимит
|
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"). |
Возвращаемое значение
Кампании
Список настраиваемых полей действия (не рекомендуется) [DEPRECATED]
Перечисляет настраиваемые поля для действия (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор действия
|
action_id | True | string |
Идентификатор системной записи действия. |
Возвращаемое значение
Пользовательские поля
Список пакетов (не рекомендуется) [DEPRECATED]
Возвращает список пакетов (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор апелляции
|
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
Список составляющих телефонов (не рекомендуется) [DEPRECATED]
Выводит список телефонов для компонента (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Составной идентификатор
|
constituent_id | True | string |
Системный идентификатор записи компонента. |
|
Включить неактивное?
|
include_inactive | boolean |
Включить неактивные телефоны? |
Возвращаемое значение
Телефоны
Список составных кодов запроса (не рекомендуется) [DEPRECATED]
Перечисляет коды запроса для компонента (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Составной идентификатор
|
constituent_id | True | string |
Системный идентификатор записи компонента. |
Возвращаемое значение
Коды запроса
Список составных рейтингов (не рекомендуется) [DEPRECATED]
Возвращает список оценок для компонента (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Составной идентификатор
|
constituent_id | True | string |
Идентификатор системной записи компонента |
|
Включить неактивное?
|
include_inactive | boolean |
Включить неактивные оценки? |
|
|
Только последние?
|
most_recent_only | boolean |
Включите только последние рейтинги? |
Возвращаемое значение
Рейтинги
Удаление составного кода (не рекомендуется) [DEPRECATED]
Удаляет составной код (не рекомендуется).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор составного кода
|
constituent_code_id | True | string |
Идентификатор системной записи для удаления составного кода. |
Определения
CommPrefApi.ConstituentConsentRead
Представляет сущность согласия для составляющих.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор системной записи согласия. |
|
Channel
|
channel | string |
Канал, к которому применяется ответ согласия. |
|
Категория
|
category | string |
Категория, к которую применяется ответ согласия. |
|
Исходный материал
|
source | string |
Источник ответа на согласие со стороны избирателей. |
|
Ответ
|
constituent_consent_response | string |
Как компонент ответил на согласие для указанного канала или категории. |
|
Date
|
consent_date | date-time |
Дата получения ответа на согласие. |
|
Оператор "Согласие"
|
consent_statement | string |
Заявление, на котором избиратель ответил при предоставлении согласия. |
|
Уведомление о конфиденциальности
|
privacy_notice | string |
Уведомление о конфиденциальности, предоставленное избирателю. |
|
Дата добавления
|
date_added | date-time |
Дата добавления ответа согласия. |
|
Кем добавлено
|
user_name | string |
Пользователь, который добавил ответ на согласие. |
CommPrefApi.ConstituentConsentReadCollection
Записи согласия
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество записей согласия в списке. |
|
value
|
value | array of CommPrefApi.ConstituentConsentRead |
Набор записей согласия, включенных в ответ. |
CommPrefApi.ConstituentSolicitCodeRead
Код запроса
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор системной записи в коде для составного запроса. |
|
Код запроса
|
solicit_code | string |
Инструкции по обмену данными и /или ограничения для составляющих. |
|
Начальная дата
|
start_date | date |
Дата начала кода запроса (например, "2005-09-18"). |
|
Дата окончания
|
end_date | date |
Дата окончания кода запроса (например, "2005-09-18"). |
CommPrefApi.ConstituentSolicitCodeReadCollection
Коды запроса
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество составных кодов запроса в списке. |
|
value
|
value | array of CommPrefApi.ConstituentSolicitCodeRead |
Набор составных кодов запроса, включенных в ответ. |
CommPrefApi.CreatedConstituentConsent
Созданное согласие на создание компонента
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор только что созданной записи согласия. |
CommPrefApi.CreatedConstituentSolicitCode
Созданный код для создания составного запроса
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор только что созданного созданного кода запроса. |
ConstituentApi.ActionAttachmentRead
Вложение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
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 |
Размер файла в байтах. Только для физических вложений. |
ConstituentApi.ActionCustomFieldRead
Настраиваемое поле
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор системной записи настраиваемого поля. |
|
Идентификатор действия
|
parent_id | string |
Идентификатор системной записи действия, связанного с настраиваемым полем. |
|
Категория
|
category | string |
Категория настраиваемого поля. |
|
Тип
|
type | string |
Тип данных, которые представляет настраиваемое поле. |
|
Ценность
|
value |
Значение настраиваемого поля. |
|
|
Date
|
date | date |
Дата настраиваемого поля. |
|
Комментарий
|
comment | string |
Комментарий к пользовательскому полю. Ограничение символов: 50. |
|
Дата добавления
|
date_added | date-time |
Дата создания настраиваемого поля. |
|
Дата изменения
|
date_modified | date-time |
Дата последнего изменения настраиваемого поля. |
ConstituentApi.ActionRead
Действие
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор системной записи действия. |
|
Составной идентификатор
|
constituent_id | string |
Системный идентификатор записи компонента, связанного с действием. |
|
Категория
|
category | string |
Канал или намерение составного взаимодействия. |
|
Завершённый?
|
completed | boolean |
Завершено ли действие? Если система настроена для использования пользовательских состояний действий, это значение основано на значении состояния действия. |
|
Дата завершения
|
completed_date | date-time |
Дата завершения действия. |
|
Date
|
date | date-time |
Дата действия. |
|
Замечание
|
description | string |
Подробное объяснение, подробное описание сводки действий. |
|
Направление
|
direction | string |
Направление действия. |
|
Диспетчеры связей
|
fundraisers | array of string |
Набор идентификаторов системных записей для диспетчеров связей, связанных с действием. |
|
Местоположение
|
location | string |
Расположение действия. |
|
Результат
|
outcome | string |
Результат действия. |
|
Priority
|
priority | string |
Приоритет действия. |
|
Время запуска
|
start_time | string |
Время начала действия. Используется 24-часовое время в формате HH:mm. |
|
Время окончания
|
end_time | string |
Время окончания действия. Используется 24-часовое время в формате HH:mm. |
|
Состояние
|
status | string |
Состояние действия. |
|
Код состояния
|
status_code | string |
Код состояния действия. Это свойство возвращается только в том случае, если система настроена на использование пользовательских состояний действий. |
|
Вычисленное состояние
|
computed_status | string |
Состояние вычисляемого действия. Если система не настроена на использование пользовательских состояний действий, это поле вычисляет состояние на основе свойств завершенных и дат. Если нет, поле вычисляет состояние на основе свойства даты действия и указывает, настроено ли свойство действия "Состояние действия" как завершено. |
|
Сводка
|
summary | string |
Краткое описание действия, которое отображается в верхней части записи. Ограничение символов: 255. |
|
Тип
|
type | string |
Дополнительное описание действия для дополнения категории. |
|
Дата добавления
|
date_added | date-time |
Дата создания действия. |
|
Дата изменения
|
date_modified | date-time |
Дата последнего изменения действия. |
ConstituentApi.AddressRead
Address
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор системной записи адреса. |
|
Тип
|
type | string |
Тип адреса. |
|
Страна
|
country | string |
Страна адреса (может быть идентификатором, именем или сокращением). |
|
Линии адресов
|
address_lines | string |
Адресные строки. |
|
Город
|
city | string |
Город адреса (не используется в сочетании с полем "Пригород"). |
|
Государство
|
state | string |
Регион в адресе. |
|
Почтовый индекс
|
postal_code | string |
Почтовый индекс адреса. |
|
Пригород
|
suburb | string |
Пригород адреса (не используется в сочетании с полем "Город"). |
|
Округ
|
county | string |
Район в адресе. |
|
Форматированный адрес
|
formatted_address | string |
Отформатированный адрес в настроенном формате страны. |
|
Источник информации
|
information_source | string |
Источник сведений для адреса. |
|
Регион
|
region | string |
Регион для адреса. |
|
ТЕЛЕГА
|
cart | string |
Маршрут перевозчика (CART) для адреса. |
|
ЛОТ
|
lot | string |
Строка путешествия (LOT) для адреса. |
|
DPC
|
dpc | string |
Код точки доставки (DPC) для адреса. |
|
Допустимый из
|
start | date-time |
Дата начала пребывания в этом адресе. |
|
Допустимо
|
end | date-time |
Дата прекращения проживания в этом адресе. |
|
Первичный?
|
preferred | boolean |
Это предпочтительный адрес избирателя? |
|
Неактивный?
|
inactive | boolean |
Неактивен ли адрес (то есть текущая дата до любой даты окончания)? |
|
Не почта?
|
do_not_mail | boolean |
Можно ли связаться с избирателем по этому адресу? |
|
day
|
seasonal_start.d | integer |
День в нечеткой дате. |
|
month
|
seasonal_start.m | integer |
Месяц в нечеткой дате. |
|
год
|
seasonal_start.y | integer |
Год в нечеткой дате. |
|
day
|
seasonal_end.d | integer |
День в нечеткой дате. |
|
month
|
seasonal_end.m | integer |
Месяц в нечеткой дате. |
|
год
|
seasonal_end.y | integer |
Год в нечеткой дате. |
|
Дата добавления
|
date_added | date-time |
Дата создания адреса. |
|
Дата изменения
|
date_modified | date-time |
Дата последнего изменения адреса. |
ConstituentApi.AliasRead
Псевдоним
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор системной записи псевдонима. |
|
Псевдоним
|
name | string |
Имя, используемое в качестве псевдонима компонента. |
|
Тип
|
type | string |
Тип псевдонима. |
ConstituentApi.ApiCollectionOfAddressRead
Адреса
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений. |
|
value
|
value | array of ConstituentApi.AddressRead |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
ConstituentApi.ApiCollectionOfActionAttachmentRead
Attachments
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений. |
|
value
|
value | array of ConstituentApi.ActionAttachmentRead |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
ConstituentApi.ApiCollectionOfActionCustomFieldRead
Пользовательские поля
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений. |
|
value
|
value | array of ConstituentApi.ActionCustomFieldRead |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
ConstituentApi.ApiCollectionOfActionRead
Действия
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений. |
|
value
|
value | array of ConstituentApi.ActionRead |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
ConstituentApi.ApiCollectionOfAliasRead
Aliases
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений. |
|
value
|
value | array of ConstituentApi.AliasRead |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
ConstituentApi.ApiCollectionOfConstituentAppealRead
Составные апелляции
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений. |
|
value
|
value | array of ConstituentApi.ConstituentAppealRead |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
ConstituentApi.ApiCollectionOfConstituentAttachmentRead
Attachments
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений. |
|
value
|
value | array of ConstituentApi.ConstituentAttachmentRead |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
ConstituentApi.ApiCollectionOfConstituentCodeRead
Составные коды
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений. |
|
value
|
value | array of ConstituentApi.ConstituentCodeRead |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
ConstituentApi.ApiCollectionOfConstituentCustomFieldRead
Пользовательские поля
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений. |
|
value
|
value | array of ConstituentApi.ConstituentCustomFieldRead |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
ConstituentApi.ApiCollectionOfConstituentRead
Составляющих
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений. |
|
value
|
value | array of ConstituentApi.ConstituentRead |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
ConstituentApi.ApiCollectionOfEducationRead
Образования
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений. |
|
value
|
value | array of ConstituentApi.EducationRead |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
ConstituentApi.ApiCollectionOfEmailAddressRead
Адреса электронной почты
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений. |
|
value
|
value | array of ConstituentApi.EmailAddressRead |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
ConstituentApi.ApiCollectionOfFundraiserAssignmentRead
Назначения диспетчера связей
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений. |
|
value
|
value | array of ConstituentApi.FundraiserAssignmentRead |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
ConstituentApi.ApiCollectionOfNoteRead
Примечания.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений. |
|
value
|
value | array of ConstituentApi.NoteRead |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
ConstituentApi.ApiCollectionOfOnlinePresenceRead
Присутствие в Сети
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений. |
|
value
|
value | array of ConstituentApi.OnlinePresenceRead |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
ConstituentApi.ApiCollectionOfPhoneRead
Телефоны
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений. |
|
value
|
value | array of ConstituentApi.PhoneRead |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
ConstituentApi.ApiCollectionOfRatingRead
Рейтинги
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений. |
|
value
|
value | array of ConstituentApi.RatingRead |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
ConstituentApi.ApiCollectionOfRelationshipRead
Отношения
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений. |
|
value
|
value | array of ConstituentApi.RelationshipRead |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
ConstituentApi.ApiCollectionOfSearchResultRead
Результаты поиска
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений. |
|
value
|
value | array of ConstituentApi.SearchResultRead |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
ConstituentApi.AppealRead
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор системной записи апелляции. |
|
описание
|
description | string |
Описание апелляции. |
ConstituentApi.CampaignRead
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор системной записи кампании. |
|
описание
|
description | string |
Описание кампании. |
ConstituentApi.ConstituentAttachmentRead
Вложение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
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 |
Размер файла в байтах. Только для физических вложений. |
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 |
Комментарии пользователей к составной апелляции. |
ConstituentApi.ConstituentCodeRead
Составной код
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Системный идентификатор записи в составном коде. |
|
Составной идентификатор
|
constituent_id | string |
Системный идентификатор записи компонента, связанного с составным кодом. |
|
Составной код
|
description | string |
Составной код. |
|
day
|
start.d | integer |
День в нечеткой дате. |
|
month
|
start.m | integer |
Месяц в нечеткой дате. |
|
год
|
start.y | integer |
Год в нечеткой дате. |
|
day
|
end.d | integer |
День в нечеткой дате. |
|
month
|
end.m | integer |
Месяц в нечеткой дате. |
|
год
|
end.y | integer |
Год в нечеткой дате. |
|
Неактивный?
|
inactive | boolean |
Неактивен ли составной код? |
|
Последовательность
|
sequence | integer |
Числовая последовательность, связанная с составным кодом. |
|
Дата добавления
|
date_added | date-time |
Дата создания составного кода. |
|
Дата изменения
|
date_modified | date-time |
Дата последнего изменения составного кода. |
ConstituentApi.ConstituentCustomFieldRead
Настраиваемое поле
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор системной записи настраиваемого поля. |
|
Составной идентификатор
|
parent_id | string |
Идентификатор системной записи компонента, связанного с настраиваемым полем. |
|
Категория
|
category | string |
Категория настраиваемого поля. |
|
Тип
|
type | string |
Тип данных, которые представляет настраиваемое поле. |
|
Ценность
|
value |
Значение настраиваемого поля. |
|
|
Date
|
date | date |
Дата настраиваемого поля. |
|
Комментарий
|
comment | string |
Комментарий к пользовательскому полю. Ограничение символов: 50. |
|
Дата добавления
|
date_added | date-time |
Дата создания настраиваемого поля. |
|
Дата изменения
|
date_modified | date-time |
Дата последнего изменения настраиваемого поля. |
ConstituentApi.ConstituentRead
Составляющая
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор системной записи для составляющих. Это не то же самое, что и определяемый пользователем составной идентификатор, который хранится в lookup_id. |
|
Тип
|
type | string |
Тип составляющих. |
|
Название
|
title | string |
Основной титул избирателя (только для отдельных лиц). |
|
Имя (первое имя)
|
first | string |
Первое имя избирателя (только для отдельных лиц). |
|
Фамилия
|
last | string |
Фамилия избирателя (только для отдельных лиц). |
|
Имя
|
name | string |
Для отдельных лиц это полное имя компонента на основе параметров отображаемого имени целевой организации. Для организаций это имя организации. |
|
Предпочтительное имя
|
preferred_name | string |
Предпочтительное имя избирателя (только для отдельных лиц). |
|
Суффикс
|
suffix | string |
Основной суффикс избирателя (только для отдельных лиц). |
|
Идентификатор подстановки
|
lookup_id | string |
Определяемый пользователем идентификатор для компонента. |
|
Идентификатор
|
email.id | string |
Идентификатор системной записи адреса электронной почты. |
|
type
|
email.type | string |
Тип адреса электронной почты. |
|
address
|
email.address | string |
Адрес электронной почты. |
|
не отправлять сообщения электронной почты?
|
email.do_not_email | boolean |
Можно ли связаться с компонентами по этому адресу электронной почты? |
|
неактивный?
|
email.inactive | boolean |
Неактивен ли адрес электронной почты? |
|
Добавлено
|
email.date_added | date-time |
Дата создания адреса электронной почты. |
|
дата изменения
|
email.date_modified | date-time |
Дата последнего изменения адреса электронной почты. |
|
Идентификатор
|
phone.id | string |
Идентификатор системной записи телефона. |
|
type
|
phone.type | string |
Тип телефона. |
|
число/номер
|
phone.number | string |
Номер телефона. |
|
не звонит?
|
phone.do_not_call | boolean |
Можно ли связаться с компонентом по этому номеру? |
|
неактивный?
|
phone.inactive | boolean |
Неактивен ли этот номер телефона? |
|
Добавлено
|
phone.date_added | date-time |
Дата создания телефона. |
|
дата изменения
|
phone.date_modified | date-time |
Дата последнего изменения телефона. |
|
Идентификатор
|
online_presence.id | string |
Идентификатор системной записи присутствия в Интернете. |
|
type
|
online_presence.type | string |
Тип присутствия в Интернете. |
|
link
|
online_presence.address | string |
Веб-адрес для присутствия в Интернете. |
|
неактивный?
|
online_presence.inactive | boolean |
Неактивно ли это присутствие в Интернете? |
|
Добавлено
|
online_presence.date_added | date-time |
Дата создания присутствия в Интернете. |
|
дата изменения
|
online_presence.date_modified | date-time |
Дата последнего изменения присутствия в Интернете. |
|
Идентификатор
|
address.id | string |
Идентификатор системной записи адреса. |
|
type
|
address.type | string |
Тип адреса. |
|
country
|
address.country | string |
Страна адреса (может быть идентификатором, именем или сокращением). |
|
обводы
|
address.address_lines | string |
Адресные строки. |
|
city
|
address.city | string |
Город адреса (не используется в сочетании с полем "Пригород"). |
|
государство
|
address.state | string |
Регион в адресе. |
|
почтовый индекс
|
address.postal_code | string |
Почтовый индекс адреса. |
|
пригород
|
address.suburb | string |
Пригород адреса (не используется в сочетании с полем "Город"). |
|
графство
|
address.county | string |
Район в адресе. |
|
Форматированные
|
address.formatted_address | string |
Отформатированный адрес в настроенном формате страны. |
|
допустимый из
|
address.start | date-time |
Дата начала пребывания в этом адресе. |
|
допустимый
|
address.end | date-time |
Дата прекращения проживания в этом адресе. |
|
неактивный?
|
address.inactive | boolean |
Неактивен ли адрес (то есть текущая дата до любой даты окончания)? |
|
не почта?
|
address.do_not_mail | boolean |
Можно ли связаться с избирателем по этому адресу? |
|
day
|
address.seasonal_start.d | integer |
День в нечеткой дате. |
|
month
|
address.seasonal_start.m | integer |
Месяц в нечеткой дате. |
|
год
|
address.seasonal_start.y | integer |
Год в нечеткой дате. |
|
day
|
address.seasonal_end.d | integer |
День в нечеткой дате. |
|
month
|
address.seasonal_end.m | integer |
Месяц в нечеткой дате. |
|
год
|
address.seasonal_end.y | integer |
Год в нечеткой дате. |
|
Добавлено
|
address.date_added | date-time |
Дата создания адреса. |
|
дата изменения
|
address.date_modified | date-time |
Дата последнего изменения адреса. |
|
Gender
|
gender | string |
Пол избирателей (только для отдельных лиц). |
|
Отчество/второе имя
|
middle | string |
Среднее имя избирателя (только для отдельных лиц). |
|
Прежнее имя
|
former_name | string |
Прежнее имя избирателя (только для отдельных лиц). |
|
Заголовок 2
|
title_2 | string |
Вторичный титул избирателя (только для отдельных лиц). |
|
Суффикс 2
|
suffix_2 | string |
Вторичный суффикс компонента (только для отдельных лиц). |
|
Мариальный стаус
|
marital_status | string |
Семейное состояние избирателя (только для отдельных лиц). |
|
Дает анонимно?
|
gives_anonymously | boolean |
Дает ли избиратель анонимно? |
|
Неактивный?
|
inactive | boolean |
Неактивен ли компонент? |
|
day
|
birthdate.d | integer |
День в нечеткой дате. |
|
month
|
birthdate.m | integer |
Месяц в нечеткой дате. |
|
год
|
birthdate.y | integer |
Год в нечеткой дате. |
|
Родина
|
birthplace | string |
Место рождения компонента (только для отдельных лиц). |
|
Этнос
|
ethnicity | string |
Этническое происхождение составляющих (только для отдельных лиц). |
|
доход
|
income | string |
Доход для составляющих (только для физических лиц). |
|
Религиозная деятельность
|
religion | string |
Религия составляющих (только для отдельных лиц). |
|
Промышленность
|
industry | string |
Отрасль составляющих (только для организаций). |
|
Количество сотрудников
|
num_employees | integer |
Количество сотрудников в организации. |
|
Соответствует подаркам?
|
matches_gifts | boolean |
Соответствует ли организация подаркам? |
|
Соответствующий фактор подарка
|
matching_gift_factor | double |
Соответствующий фактор подарка (только для организаций). |
|
Минимальное совпадение за подарок
|
matching_gift_per_gift_min.value | double |
Минимальная сумма соответствия за подарок для составляющих (только для организаций). |
|
Максимальное количество совпадений на подарок
|
matching_gift_per_gift_max.value | double |
Максимальное количество совпадений за подарок для составляющих (только для организаций). |
|
Минимальное совпадение на констит
|
matching_gift_total_min.value | double |
Минимальный итог соответствия для составляющих (только для организаций). |
|
Максимальное совпадение на констит
|
matching_gift_total_max.value | double |
Максимальное количество совпадений для составляющих (только для организаций). |
|
Сопоставление примечаний к подаркам
|
matching_gift_notes | string |
Соответствующие заметки о подарках для составляющих (только для организаций). |
|
Возраст
|
age | integer |
Возраст компонента, как вычисляется на основе свойства рождения (только для отдельных лиц). |
|
Покойный?
|
deceased | boolean |
Является ли составляющий умершего (только для физических лиц)? |
|
day
|
deceased_date.d | integer |
День в нечеткой дате. |
|
month
|
deceased_date.m | integer |
Месяц в нечеткой дате. |
|
год
|
deceased_date.y | integer |
Год в нечеткой дате. |
|
Состояние диспетчера связей
|
fundraiser_status | string |
Указывает, является ли компонент руководителем отношений (только для отдельных лиц). |
|
Идентификатор
|
spouse.id | string |
Системный идентификатор записи супруга. |
|
имя
|
spouse.first | string |
Имя супруга. |
|
фамилия
|
spouse.last | string |
Фамилия супруга. |
|
является главой семьи?
|
spouse.is_head_of_household | boolean |
Является ли супруг главой семьи? |
|
Дата добавления
|
date_added | date-time |
Дата создания компонента. |
|
Дата изменения
|
date_modified | date-time |
Дата последнего изменения компонента. |
ConstituentApi.ConvertedConstituent
Преобразованные составляющие
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор преобразованного компонента. |
ConstituentApi.CreatedAction
Созданное действие
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор только что созданного действия. |
ConstituentApi.CreatedActionAttachment
Созданное вложение действия
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор только что созданного вложения действия. |
ConstituentApi.CreatedActionCustomField
Созданное настраиваемое поле действия
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор только что созданного настраиваемого поля действия. |
ConstituentApi.CreatedConstituentAddress
Созданный составной адрес
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор только что созданного созданного адреса. |
ConstituentApi.CreatedConstituentAlias
Созданный псевдоним компонентов
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор только что созданного созданного псевдонима. |
ConstituentApi.CreatedConstituentAttachment
Созданное составное вложение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор только что созданного составного вложения. |
ConstituentApi.CreatedConstituentCode
Созданный составной код
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор только что созданного составного кода. |
ConstituentApi.CreatedConstituentCustomField
Созданное настраиваемое поле
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор только что созданного настраиваемого поля. |
ConstituentApi.CreatedConstituentEducation
Создание составного образования
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор только что созданного образования. |
ConstituentApi.CreatedConstituentEmailAddress
Созданный составной адрес электронной почты
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор нового созданного адреса электронной почты. |
ConstituentApi.CreatedConstituentNote
Созданная составная заметка
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор только что созданной составной заметки. |
ConstituentApi.CreatedConstituentOnlinePresence
Создание составляющих онлайн-присутствия
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор только что созданного присутствия в Интернете. |
ConstituentApi.CreatedConstituentPhone
Созданный составной телефон
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор только что созданного созданного телефона. |
ConstituentApi.CreatedConstituentRating
Созданная оценка компонентов
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор только что созданного рейтинга составляющих. |
ConstituentApi.CreatedIndividualConstituent
Создано отдельное составляющие
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор только что созданного отдельного компонента. |
ConstituentApi.CreatedIndividualRelationship
Созданная отдельная связь
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор только что созданной отдельной связи. |
ConstituentApi.CreatedNameFormat
Формат созданного имени
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор только что созданного формата имени. |
ConstituentApi.CreatedOrganizationConstituent
Созданная организация
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор только что созданной организации. |
ConstituentApi.CreatedOrganizationRelationship
Созданная связь организации
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор только что созданной связи организации. |
ConstituentApi.EducationRead
Education
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Системный идентификатор записи образования. |
|
Составной идентификатор
|
constituent_id | string |
Системный идентификатор записи компонента, связанного с образованием. |
|
Школа
|
school | string |
Имя школы или учреждения. |
|
Тип
|
type | string |
Тип образования. |
|
Класс
|
class_of | string |
Год, который окончил составной элемент. |
|
Состояние
|
status | string |
Состояние образования. |
|
day
|
date_entered.d | integer |
День в нечеткой дате. |
|
month
|
date_entered.m | integer |
Месяц в нечеткой дате. |
|
год
|
date_entered.y | integer |
Год в нечеткой дате. |
|
day
|
date_left.d | integer |
День в нечеткой дате. |
|
month
|
date_left.m | integer |
Месяц в нечеткой дате. |
|
год
|
date_left.y | integer |
Год в нечеткой дате. |
|
day
|
date_graduated.d | integer |
День в нечеткой дате. |
|
month
|
date_graduated.m | integer |
Месяц в нечеткой дате. |
|
год
|
date_graduated.y | integer |
Год в нечеткой дате. |
|
Градус
|
degree | string |
Степень получена. |
|
GPA
|
gpa | double |
Среднее значение точки оценки. |
|
Специальности
|
majors | array of string |
Основные курсы изучения. |
|
Несовершеннолетних
|
minors | array of string |
Незначительные курсы обучения. |
|
Является ли начальное образование?
|
primary | boolean |
Это ассоциация начальной школы избирателей? |
|
Campus
|
campus | string |
Кампус. |
|
Социальная организация
|
social_organization | string |
Социальная организация. |
|
Известное имя
|
known_name | string |
Известное имя. |
|
Класс степени
|
class_of_degree | string |
Класс степени. |
|
Отдел
|
department | string |
Имя департамента образования. |
|
Способность
|
faculty | string |
Имя преподавателя. |
|
Регистрационный номер
|
registration_number | string |
Номер регистрации. |
|
Тема исследования
|
subject_of_study | string |
Тема исследования. |
|
Дата добавления
|
date_added | date-time |
Дата создания образования. |
|
Дата изменения
|
date_modified | date-time |
Дата последнего изменения образования. |
ConstituentApi.EmailAddressRead
Адрес электронной почты
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор системной записи адреса электронной почты. |
|
Составной идентификатор
|
constituent_id | string |
Системный идентификатор записи компонента, связанного с адресом электронной почты. |
|
Тип электронной почты
|
type | string |
Тип адреса электронной почты. |
|
Адрес электронной почты
|
address | string |
Адрес электронной почты. |
|
Первичный?
|
primary | boolean |
Это основной адрес электронной почты компонента? |
|
Не отправлять сообщения электронной почты?
|
do_not_email | boolean |
Можно ли связаться с компонентами по этому адресу электронной почты? |
|
Неактивный?
|
inactive | boolean |
Неактивен ли адрес электронной почты? |
|
Дата добавления
|
date_added | date-time |
Дата создания адреса электронной почты. |
|
Дата изменения
|
date_modified | date-time |
Дата последнего изменения адреса электронной почты. |
ConstituentApi.FileDefinition
Определение файла
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор файла
|
file_id | string |
Идентификатор файла. |
|
URL
|
file_upload_request.url | string |
URL-адрес, используемый для запроса на отправку. |
|
method
|
file_upload_request.method | string |
Метод HTTP, используемый с запросом на отправку. |
|
headers
|
file_upload_request.headers | array of ConstituentApi.Header |
Заголовки, которые необходимо указать при выполнении запроса. |
|
Идентификатор эскиза
|
thumbnail_id | string |
Идентификатор эскиза. |
|
URL
|
thumbnail_upload_request.url | string |
URL-адрес, используемый для запроса на отправку. |
|
method
|
thumbnail_upload_request.method | string |
Метод HTTP, используемый с запросом на отправку. |
|
headers
|
thumbnail_upload_request.headers | array of ConstituentApi.Header |
Заголовки, которые необходимо указать при выполнении запроса. |
ConstituentApi.FundraiserAssignmentRead
Назначение диспетчера связей
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор системной записи назначения диспетчера связей. |
|
Составной идентификатор
|
constituent_id | string |
Системный идентификатор записи компонента, назначенного диспетчеру связей. |
|
Идентификатор диспетчера связей
|
fundraiser_id | string |
Идентификатор системной записи диспетчера связей. |
|
Тип
|
type | string |
Тип диспетчера связей. |
|
value
|
amount.value | double |
Денежное значение. |
|
Идентификатор кампании
|
campaign_id | string |
Системный идентификатор кампании для применения полученных подарков. |
|
Идентификатор фонда
|
fund_id | string |
К системным идентификаторам фонда должны применяться любые полученные подарки. Если выбран ограниченный фонд, можно выбрать только кампании и апелляции, связанные с этим фондом. |
|
Идентификатор апелляции
|
appeal_id | string |
Системный идентификатор системной записи для диспетчера связей должен использовать для запроса подарков. |
|
Начальная дата
|
start | date-time |
Дата начала назначения диспетчера связей. |
|
Дата окончания
|
end | date-time |
Дата окончания назначения диспетчера связей. |
ConstituentApi.FundRead
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Системный идентификатор фонда. |
|
описание
|
description | string |
Описание фонда. |
ConstituentApi.GivingSummaryRead
Предоставление сводки
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Системный идентификатор записи подарка. |
|
Тип
|
type | string |
Тип подарка. |
|
Date
|
date | date-time |
Дата подарка. |
|
value
|
amount.value | double |
Денежное значение. |
|
Appeal
|
appeals | array of ConstituentApi.AppealRead |
Набор апелляций, связанных с подарком. |
|
кампания
|
campaigns | array of ConstituentApi.CampaignRead |
Набор кампаний, связанных с подарком. |
|
Фонд
|
funds | array of ConstituentApi.FundRead |
Набор средств, связанных с подарком. |
ConstituentApi.Header
Заголовок запроса, используемый для отправки физического вложения.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
имя
|
name | string |
Имя заголовка. |
|
value
|
value | string |
Значение заголовка. |
ConstituentApi.LifetimeGivingRead
Время существования
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
За несколько лет подряд
|
consecutive_years_given | integer |
Число последовательных лет, которое дало составная часть. |
|
Общее количество лет, указанных
|
total_years_given | integer |
Общее количество лет, которое дало составная часть. |
|
value
|
total_giving.value | double |
Денежное значение. |
|
value
|
total_pledge_balance.value | double |
Денежное значение. |
|
value
|
total_received_giving.value | double |
Денежное значение. |
|
value
|
total_committed_matching_gifts.value | double |
Денежное значение. |
|
value
|
total_received_matching_gifts.value | double |
Денежное значение. |
|
value
|
total_soft_credits.value | double |
Денежное значение. |
ConstituentApi.NameFormatRead
Форматы имен определяют, как устранять составляющие в обмене данными. Как вы ссылаетесь на людей задает тон ваших коммуникаций с ними и насколько хорошо они получают ваши взаимодействия.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор системной записи формата имени. |
|
type
|
type | string |
Тип формата имени. |
|
настраиваемый формат?
|
custom_format | boolean |
Это настраиваемый формат? |
|
Идентификатор конфигурации
|
configuration_id | string |
Идентификатор конфигурации формата имени (для не настраиваемых форматов). |
|
отформатированный имя
|
formatted_name | string |
Отформатированное имя (для пользовательских форматов). |
ConstituentApi.NameFormatSummaryRead
Сводка по формату имени
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
primary_addressee.id | string |
Идентификатор системной записи формата имени. |
|
type
|
primary_addressee.primary_type | string |
Тип формата имени. |
|
настраиваемый формат?
|
primary_addressee.custom_format | boolean |
Это настраиваемый формат? |
|
Идентификатор конфигурации
|
primary_addressee.configuration_id | string |
Идентификатор конфигурации формата имени (для не настраиваемых форматов). |
|
отформатированный имя
|
primary_addressee.formatted_name | string |
Отформатированное имя (для пользовательских форматов). |
|
Идентификатор
|
primary_salutation.id | string |
Идентификатор системной записи формата имени. |
|
type
|
primary_salutation.primary_type | string |
Тип формата имени. |
|
настраиваемый формат?
|
primary_salutation.custom_format | boolean |
Это настраиваемый формат? |
|
Идентификатор конфигурации
|
primary_salutation.configuration_id | string |
Идентификатор конфигурации формата имени (для не настраиваемых форматов). |
|
отформатированный имя
|
primary_salutation.formatted_name | string |
Отформатированное имя (для пользовательских форматов). |
|
Дополнительные форматы имен
|
additional_name_formats | array of ConstituentApi.NameFormatRead |
Дополнительные форматы имен составляющих. |
ConstituentApi.NoteRead
Замечание
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор системной записи заметки. |
|
Составной идентификатор
|
constituent_id | string |
Системный идентификатор записи компонента, связанного с примечанием. |
|
Тип
|
type | string |
Тип заметки. |
|
day
|
date.d | integer |
День в нечеткой дате. |
|
month
|
date.m | integer |
Месяц в нечеткой дате. |
|
год
|
date.y | integer |
Год в нечеткой дате. |
|
Сводка
|
summary | string |
Сводка по заметкам. |
|
Замечание
|
text | string |
Текст заметки. |
|
Дата добавления
|
date_added | date-time |
Дата создания заметки. |
|
Дата изменения
|
date_modified | date-time |
Дата последнего изменения заметки. |
ConstituentApi.OnlinePresenceRead
Присутствие в Интернете
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор системной записи присутствия в Интернете. |
|
Составной идентификатор
|
constituent_id | string |
Системный идентификатор записи компонента, связанного с присутствием в Интернете. |
|
Тип
|
type | string |
Тип присутствия в Интернете. |
|
Link
|
address | string |
Веб-адрес для присутствия в Интернете. |
|
Первичный?
|
primary | boolean |
Это основное онлайн-присутствие составляющих? |
|
Неактивный?
|
inactive | boolean |
Неактивно ли это присутствие в Интернете? |
|
Дата добавления
|
date_added | date-time |
Дата создания присутствия в Интернете. |
|
Дата изменения
|
date_modified | date-time |
Дата последнего изменения присутствия в Интернете. |
ConstituentApi.PhoneRead
Телефон
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор системной записи телефона. |
|
Составной идентификатор
|
constituent_id | string |
Системный идентификатор записи компонента, связанного с телефоном. |
|
Тип
|
type | string |
Тип телефона. |
|
Number
|
number | string |
Номер телефона. |
|
Первичный?
|
primary | boolean |
Это основной телефон избирателя? |
|
Не вызывайте?
|
do_not_call | boolean |
Можно ли связаться с компонентом по этому номеру? |
|
Неактивный?
|
inactive | boolean |
Неактивен ли этот номер телефона? |
|
Дата добавления
|
date_added | date-time |
Дата создания телефона. |
|
Дата изменения
|
date_modified | date-time |
Дата последнего изменения телефона. |
ConstituentApi.ProfilePictureRead
Изображение профиля
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Составной идентификатор
|
constituent_id | string |
Идентификатор системной записи компонента, связанного с изображением профиля. |
|
URL
|
url | string |
URL-адрес рисунка профиля. URL-адрес содержит сигнатуру с привязкой к времени, которая ограничивает доступ к 60 минутам. |
|
URL-адрес эскиза
|
thumbnail_url | string |
URL-адрес эскиза рисунка профиля. Содержит сигнатуру с привязкой к времени, которая ограничивает доступ к 60 минутам. |
ConstituentApi.RatingRead
Rating
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор системной записи рейтинга. |
|
Составной идентификатор
|
constituent_id | string |
Системный идентификатор записи компонента, связанного с рейтингом. |
|
Исходный материал
|
source | string |
Источник нового рейтинга. |
|
Категория
|
category | string |
Категория рейтинга. |
|
Date
|
date | date-time |
Дата оценки. |
|
Description
|
value |
Значение оценки. |
|
|
Comments
|
comment | string |
Комментарий о рейтинге. |
|
Неактивный?
|
inactive | boolean |
Неактивна ли оценка? |
|
Тип
|
type | string |
Это вычисляемое поле указывает тип данных, представленных рейтингом на основе свойства категории. |
ConstituentApi.RelationshipRead
Relationship
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор системной записи связи. |
|
Составной идентификатор
|
constituent_id | string |
Системный идентификатор записи компонента, связанного с связью. |
|
Идентификатор отношения
|
relation_id | string |
Идентификатор системной записи связанного человека или организации. |
|
Идентификатор взаимной связи
|
reciprocal_relationship_id | string |
Идентификатор записи взаимной связи. Это значение доступно только для чтения и автоматически создается при создании связи. Изменения, внесенные в эту запись, также будут отражены на взаимной основе, за исключением свойства примечаний. |
|
Имя
|
name | string |
Имя связанного компонента. Если связанный компонент является отдельным, это будет полное имя компонента на основе параметров отображаемого имени целевой организации. |
|
Тип
|
type | string |
Тип отношения, который представляет связь. |
|
Обратный тип
|
reciprocal_type | string |
Описывает отношение компонента к связанному компоненту. Например, в отношениях между мужским составляющим и женским братом, тип взаимной связи будет братом. |
|
day
|
start.d | integer |
День в нечеткой дате. |
|
month
|
start.m | integer |
Месяц в нечеткой дате. |
|
год
|
start.y | integer |
Год в нечеткой дате. |
|
day
|
end.d | integer |
День в нечеткой дате. |
|
month
|
end.m | integer |
Месяц в нечеткой дате. |
|
год
|
end.y | integer |
Год в нечеткой дате. |
|
Является ли супруг?
|
is_spouse | boolean |
Является ли связанный супруг избирателя (только относится к отношениям между лицами)? |
|
Является ли составной главой семьи?
|
is_constituent_head_of_household | boolean |
Является ли составной частью семьи? |
|
Является ли глава семьи супругом?
|
is_spouse_head_of_household | boolean |
Является ли супруг главой семьи? |
|
Примечания.
|
comment | string |
Комментарий о связи. |
|
Контакт?
|
is_organization_contact | boolean |
Представляет ли составная организация как контакт (применяется только к отношениям между организациями и отдельными лицами)? |
|
Основной бизнес?
|
is_primary_business | boolean |
Это основной бизнес компонента (применяется только к отношениям между организациями и отдельными лицами)? |
|
Тип контакта
|
organization_contact_type | string |
Предоставляет контекст для взаимодействия с соответствующим человеком, который представляет организацию в качестве контакта. Применяется только к отношениям между организациями и отдельными лицами. |
|
Position
|
position | string |
Позиция человека в организации. Применяется только к отношениям между организациями и отдельными лицами. |
|
Дата добавления
|
date_added | date-time |
Дата создания связи. |
|
Дата изменения
|
date_modified | date-time |
Дата последнего изменения связи. |
ConstituentApi.SearchResultRead
Результат поиска
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Системный идентификатор записи компонента. |
|
Имя
|
name | string |
Имя составляющих. Для отдельных лиц это вычисляемое поле указывает полное имя компонента на основе параметров отображаемого имени целевой организации. |
|
Address
|
address | string |
Предпочтительный адрес избирателя. |
|
Покойный?
|
deceased | boolean |
Умер ли компонент? |
|
Адрес электронной почты
|
string |
Адрес электронной почты избирателя. |
|
|
Состояние диспетчера связей
|
fundraiser_status | string |
Статус руководителя связей компонента. Для отдельных лиц это вычисляемое поле указывает, является ли компонент активным, неактивным или нет. Для организаций это значение всегда будет равно None. |
|
Неактивный?
|
inactive | boolean |
Неактивен ли компонент? |
|
Идентификатор подстановки
|
lookup_id | 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.ApiCollectionOfFundraiserAssignmentRead
Assignments
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений. |
|
value
|
value | array of FundraisingApi.FundraiserAssignmentRead |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
Сбор средств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 |
Размер файла в байтах. Только для физических вложений. |
Сбор средствApi.AppealCustomFieldRead
Настраиваемое поле
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор системной записи настраиваемого поля. |
|
Идентификатор апелляции
|
parent_id | string |
Идентификатор системной записи апелляции, связанной с настраиваемым полем. |
|
Категория
|
category | string |
Категория настраиваемого поля. |
|
Тип
|
type | string |
Тип данных, которые представляет настраиваемое поле. |
|
Ценность
|
value |
Значение настраиваемого поля. |
|
|
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 |
Размер файла в байтах. Только для физических вложений. |
Сбор средствApi.CampaignCustomFieldRead
Настраиваемое поле
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор системной записи настраиваемого поля. |
|
Идентификатор кампании
|
parent_id | string |
Идентификатор системной записи кампании, связанной с настраиваемым полем. |
|
Категория
|
category | string |
Категория настраиваемого поля. |
|
Тип
|
type | string |
Тип данных, которые представляет настраиваемое поле. |
|
Ценность
|
value |
Значение настраиваемого поля. |
|
|
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 |
Идентификатор созданного настраиваемого поля кампании. |
FundraisingApi.CreatedFundraiserAssignment
Создание назначения сборов средств
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор только что созданного назначения сборов средств. |
Сбор средствApi.CreatedFundAttachment
Созданное вложение фонда
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор только что созданного вложения фонда. |
Сбор средствApi.CreatedFundCustomField
Созданное настраиваемое поле фонда
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор только что созданного настраиваемого поля фонда. |
FundraisingApi.FundraiserAssignmentRead
Assignment
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Системный идентификатор назначения сборов средств. |
|
Составной идентификатор
|
constituent_id | string |
Идентификатор системной записи назначенного компонента. |
|
Тип
|
type | string |
Тип сборов средств. |
|
Начало назначения
|
start | date-time |
Дата начала назначения. |
|
Окончание назначения
|
end | date-time |
Дата окончания назначения. |
|
value
|
amount.value | double |
Денежное значение. |
|
Идентификатор кампании
|
campaign_id | string |
Системный идентификатор кампании, к которой будут применены полученные подарки. |
|
Идентификатор фонда
|
fund_id | string |
Системный идентификатор фонда, к которому будут применены полученные подарки. |
|
Идентификатор апелляции
|
appeal_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 |
Размер файла в байтах. Только для физических вложений. |
Сбор средствApi.FundCustomFieldRead
Настраиваемое поле
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор системной записи настраиваемого поля. |
|
Идентификатор фонда
|
parent_id | string |
Системный идентификатор фонда, связанного с настраиваемым полем. |
|
Категория
|
category | string |
Категория настраиваемого поля. |
|
Тип
|
type | string |
Тип данных, которые представляет настраиваемое поле. |
|
Ценность
|
value |
Значение настраиваемого поля. |
|
|
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 |
Дата начала пакета. |
GiftApi.AcknowledgementRead
Признание
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
date
|
date | date-time |
Дата, связанная с подтверждением. |
|
буква
|
letter | string |
Письмо, связанное с подтверждением. |
|
статус
|
status | string |
Состояние подтверждения. Доступные значения: ACKNOWLEDGED, NEEDSACKNOWLEDGEMENT и DONOTACKNOWLEDGE. |
GiftApi.ApiCollectionOfGiftAttachmentRead
Attachments
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений. |
|
value
|
value | array of GiftApi.GiftAttachmentRead |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
GiftApi.ApiCollectionOfGiftCustomFieldRead
Пользовательские поля
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений. |
|
value
|
value | array of GiftApi.GiftCustomFieldRead |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
GiftApi.ApiCollectionOfGiftRead
Подарки
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений. |
|
value
|
value | array of GiftApi.GiftRead |
Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции. |
GiftApi.BatchGiftAddResults
Содержит коллекцию записей об ошибках пакетного подарка и пакетных подарков, добавленных операцией.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Ошибки
|
errors | array of GiftApi.GiftBatchGiftError |
Ошибки пакетного подарка, связанные с операцией добавления пакетного подарка |
|
Подарки
|
gifts | array of GiftApi.BatchGiftRead |
Коллекция пакетных подарков, добавленных операцией добавления пакетного подарка |
GiftApi.GiftBatchGiftError
Представляет исключения, предотвращающие добавление элементов в пакет.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
затронутого поля
|
affected_field | string |
Поле, затронутого ошибкой |
|
идентификатор пакетной службы
|
batch_id | string |
Идентификатор системной записи пакета |
|
Код ошибки исключения
|
exception_error_code | integer |
Код ошибки исключения |
|
Сообщение об ошибке исключения
|
exception_error_message | string |
Сообщение об ошибке исключения |
|
Имя ошибки исключения
|
exception_error_name | string |
Имя ошибки исключения |
|
Идентификатор подарка
|
gift_id | string |
Системный идентификатор записи подарка |
|
Идентификатор подстановки
|
lookup_id | string |
Определяемый пользователем идентификатор для подарка. |
GiftApi.BatchGiftRead
Пакетный подарок
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
идентификатор пакетной службы
|
batch_id | string |
Идентификатор пакета, к которому был добавлен подарок. |
|
Ошибки
|
errors | array of GiftApi.GiftBatchGiftError |
Ошибки, связанные с пакетным подарком. |
|
Идентификатор
|
id | string |
Системный идентификатор записи пакетного подарка. |
|
составной идентификатор
|
constituent_id | string |
Системный идентификатор записи компонента, связанного с подарком. |
|
type
|
type | string |
Тип подарка. |
|
подтип
|
subtype | string |
Подтип подарка. |
|
date
|
date | date-time |
Дата подарка. |
|
value
|
amount.value | double |
Денежное значение. |
|
value
|
balance.value | double |
Денежное значение. |
|
номер пакета
|
batch_number | string |
Номер пакета, связанный с этим подарком. |
|
статус
|
gift_status | string |
Состояние подарка. |
|
анонимный?
|
is_anonymous | boolean |
Является ли подарок анонимным? |
|
избирательный округ
|
constituency | string |
Избирательный округ подарка. |
|
Идентификатор подстановки
|
lookup_id | string |
Определяемый пользователем идентификатор для подарка. |
|
origin
|
origin | string |
Происхождение подарка. |
|
состояние записи
|
post_status | string |
Общее состояние записи реестра подарка. Доступные значения: Posted, NotPosted и DoNotPost. Если для post_status задано значение DoNotPost>, post_date должно иметь значение NULL. Если для него задано значение NotPosted, post_date требуется, но остается редактируемым. Если задано значение Posted, post_date требуется и больше не редактируется. |
|
дата публикации
|
post_date | date-time |
Дата, когда подарок был размещен в общем реестре. |
|
справочник
|
reference | string |
Примечания для отслеживания специальных сведений о подарке, например мотивации за ним или подробное описание подарка в виде. |
|
day
|
recurring_gift_status_date.d | integer |
День в нечеткой дате. |
|
month
|
recurring_gift_status_date.m | integer |
Месяц в нечеткой дате. |
|
год
|
recurring_gift_status_date.y | integer |
Год в нечеткой дате. |
|
frequency
|
recurring_gift_schedule.frequency | string |
Частота установки повторяющегося подарка для просмотра. Доступные значения: WEEKLY, EVERY_TWO_WEEKS, EVERY_FOUR_WEEKS, MONTHLY, ЕЖЕКВАРТАЛЬНО, ЕЖЕГОДНО. |
|
start
|
recurring_gift_schedule.start_date | date-time |
Дата начала повторяющегося подарка. |
|
конец
|
recurring_gift_schedule.end_date | date-time |
Дата окончания повторяющегося подарка. |
|
value
|
gift_aid_amount.value | double |
Денежное значение. |
|
Статус квалификации подарочной помощи
|
gift_aid_qualification_status | string |
Это вычисляемое поле определяет состояние квалификации "Помощь подарка" на основе сведений о налоговом объявлении и формате базы данных. Доступные значения: Qualified, NotQualified и PartlyQualified. Только для Великобритании. |
|
подарочный код
|
gift_code | string |
Значение кода подарка, связанное с подарком. |
|
разделение подарков
|
gift_splits | array of GiftApi.GiftSplitRead |
Набор подарков расщепляется, связанный с подарком. |
|
Диспетчеры связей
|
fundraisers | array of GiftApi.GiftFundraiserRead |
Набор менеджеров отношений, которые получают кредит на подарок. |
|
Мягкие кредиты
|
soft_credits | array of GiftApi.SoftCreditRead |
Набор мягких кредитов, связанных с подарком. |
|
Получения
|
receipts | array of GiftApi.ReceiptRead |
Набор квитанций, связанных с подарком. |
|
Благодарности
|
acknowledgements | array of GiftApi.AcknowledgementRead |
Набор подтверждений, связанных с подарком. |
|
Payments
|
payments | array of GiftApi.PaymentRead |
Платежи по подароку. |
|
Связанные подарки
|
linked_gifts | array of string |
Идентификаторы других подарков, связанных с этим подарком. |
|
Дата добавления
|
date_added | date-time |
Дата создания подарка. |
|
Дата изменения
|
date_modified | date-time |
Дата последнего изменения подарка. |
GiftApi.CreatedGift
Созданный подарок
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор только что созданного подарка. |
GiftApi.CreatedGiftAttachment
Созданное вложение подарка
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор только что созданного вложения подарка. |
GiftApi.CreatedGiftCustomField
Созданное настраиваемое поле подарка
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор только что созданного настраиваемого поля подарка. |
GiftApi.GiftAttachmentRead
Вложение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
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 |
Размер файла в байтах. Только для физических вложений. |
GiftApi.GiftCustomFieldRead
Настраиваемое поле
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор системной записи настраиваемого поля. |
|
Идентификатор подарка
|
parent_id | string |
Идентификатор системной записи подарка, связанного с настраиваемым полем. |
|
Категория
|
category | string |
Категория настраиваемого поля. |
|
Тип
|
type | string |
Тип данных, которые представляет настраиваемое поле. |
|
Ценность
|
value |
Значение настраиваемого поля. |
|
|
Date
|
date | date |
Дата настраиваемого поля. |
|
Комментарий
|
comment | string |
Комментарий к пользовательскому полю. Ограничение символов: 50. |
|
Дата добавления
|
date_added | date-time |
Дата создания настраиваемого поля. |
|
Дата изменения
|
date_modified | date-time |
Дата последнего изменения настраиваемого поля. |
GiftApi.GiftFundraiserRead
Диспетчер связей подарков
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
value
|
amount.value | double |
Денежное значение. |
|
Идентификатор диспетчера связей
|
constituent_id | string |
Идентификатор составной системы записи для диспетчера связей, связанного с подарком. |
GiftApi.GiftRead
Подарок
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Системный идентификатор записи подарка. |
|
Составной идентификатор
|
constituent_id | string |
Системный идентификатор записи компонента, связанного с подарком. |
|
Тип
|
type | string |
Тип подарка. |
|
Подтип
|
subtype | string |
Подтип подарка. |
|
Date
|
date | date-time |
Дата подарка. |
|
value
|
amount.value | double |
Денежное значение. |
|
value
|
balance.value | double |
Денежное значение. |
|
Номер пакета
|
batch_number | string |
Номер пакета, связанный с этим подарком. |
|
Состояние
|
gift_status | string |
Состояние подарка. |
|
Анонимный?
|
is_anonymous | boolean |
Является ли подарок анонимным? |
|
Избирательный округ
|
constituency | string |
Избирательный округ подарка. |
|
Идентификатор подстановки
|
lookup_id | string |
Определяемый пользователем идентификатор для подарка. |
|
Происхождение
|
origin | string |
Происхождение подарка. |
|
Состояние публикации
|
post_status | string |
Общее состояние записи реестра подарка. Доступные значения: Posted, NotPosted и DoNotPost. Если для post_status задано значение DoNotPost>, post_date должно иметь значение NULL. Если для него задано значение NotPosted, post_date требуется, но остается редактируемым. Если задано значение Posted, post_date требуется и больше не редактируется. |
|
Дата публикации
|
post_date | date-time |
Дата, когда подарок был размещен в общем реестре. |
|
Reference
|
reference | string |
Примечания для отслеживания специальных сведений о подарке, например мотивации за ним или подробное описание подарка в виде. |
|
day
|
recurring_gift_status_date.d | integer |
День в нечеткой дате. |
|
month
|
recurring_gift_status_date.m | integer |
Месяц в нечеткой дате. |
|
год
|
recurring_gift_status_date.y | integer |
Год в нечеткой дате. |
|
frequency
|
recurring_gift_schedule.frequency | string |
Частота установки повторяющегося подарка для просмотра. Доступные значения: WEEKLY, EVERY_TWO_WEEKS, EVERY_FOUR_WEEKS, MONTHLY, ЕЖЕКВАРТАЛЬНО, ЕЖЕГОДНО. |
|
start
|
recurring_gift_schedule.start_date | date-time |
Дата начала повторяющегося подарка. |
|
конец
|
recurring_gift_schedule.end_date | date-time |
Дата окончания повторяющегося подарка. |
|
value
|
gift_aid_amount.value | double |
Денежное значение. |
|
Статус квалификации по оказанию помощи в подарок
|
gift_aid_qualification_status | string |
Это вычисляемое поле определяет состояние квалификации "Помощь подарка" на основе сведений о налоговом объявлении и формате базы данных. Доступные значения: Qualified, NotQualified и PartlyQualified. Только для Великобритании. |
|
Подарочный код
|
gift_code | string |
Значение кода подарка, связанное с подарком. |
|
Разделение подарков
|
gift_splits | array of GiftApi.GiftSplitRead |
Набор подарков расщепляется, связанный с подарком. |
|
Диспетчеры связей
|
fundraisers | array of GiftApi.GiftFundraiserRead |
Набор менеджеров отношений, которые получают кредит на подарок. |
|
Мягкие кредиты
|
soft_credits | array of GiftApi.SoftCreditRead |
Набор мягких кредитов, связанных с подарком. |
|
Получения
|
receipts | array of GiftApi.ReceiptRead |
Набор квитанций, связанных с подарком. |
|
Благодарности
|
acknowledgements | array of GiftApi.AcknowledgementRead |
Набор подтверждений, связанных с подарком. |
|
Payments
|
payments | array of GiftApi.PaymentRead |
Платежи по подароку. |
|
Связанные подарки
|
linked_gifts | array of string |
Идентификаторы других подарков, связанных с этим подарком. |
|
Дата добавления
|
date_added | date-time |
Дата создания подарка. |
|
Дата изменения
|
date_modified | date-time |
Дата последнего изменения подарка. |
GiftApi.ReceiptRead
Приход
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
value
|
amount.value | double |
Денежное значение. |
|
date
|
date | date-time |
Дата получения. |
|
число/номер
|
number | integer |
Номер квитанции. |
|
статус
|
status | string |
Состояние квитанции. Доступные значения: RECEIPTED, NEEDSRECEIPT и DONOTRECEIPT. |
GiftApi.GiftSplitRead
Разделение подарков
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Системный идентификатор записи разделения подарка. |
|
value
|
amount.value | double |
Денежное значение. |
|
Идентификатор апелляции
|
appeal_id | string |
Системный идентификатор апелляции, связанной с разделением подарка. |
|
Идентификатор кампании
|
campaign_id | string |
Системный идентификатор кампании, связанной с разделением подарка. |
|
Идентификатор фонда
|
fund_id | string |
Системный идентификатор фонда, связанного с разделением подарка. |
|
value
|
gift_aid_amount.value | double |
Денежное значение. |
|
Статус квалификации подарочной помощи
|
gift_aid_qualification_status | string |
Статус подарочной помощи для разделения подарка. Доступные значения: "Квалифицировано" и "NotQualified". Только для Великобритании. |
|
Идентификатор пакета
|
package_id | string |
Системный идентификатор пакета, связанного с разделением подарка. |
GiftApi.PaymentRead
Уплата
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
маркер учетной записи
|
account_token | string |
Сведения о маркеризованной учетной записи (например, кредитная карта) от внешнего поставщика платежей. Применяется только к методам оплаты "CreditCard" и DirectDebit. |
|
Идентификатор конфигурации BBPS
|
bbps_configuration_id | string |
Идентификатор конфигурации BBPS. Применяется только к методам оплаты "CreditCard" и DirectDebit. |
|
Идентификатор транзакции BBPS
|
bbps_transaction_id | string |
Идентификатор транзакции BBPS. Применяется только к методам оплаты "CreditCard" и DirectDebit. |
|
day
|
check_date.d | integer |
День в нечеткой дате. |
|
month
|
check_date.m | integer |
Месяц в нечеткой дате. |
|
год
|
check_date.y | integer |
Год в нечеткой дате. |
|
контрольный номер
|
check_number | string |
Контрольный номер. Применяется только к методу оплаты "PersonalCheck". |
|
Идентификатор транзакции для выхода
|
checkout_transaction_id | string |
Идентификатор транзакции для вырезки. Применяется только к методам оплаты "CreditCard" и DirectDebit. |
|
Метод оплаты
|
payment_method | string |
Метод оплаты. Доступные значения перечислены ниже. |
|
справочник
|
reference | string |
Ссылка. Применяется только к методу оплаты "Other". |
|
day
|
reference_date.d | integer |
День в нечеткой дате. |
|
month
|
reference_date.m | integer |
Месяц в нечеткой дате. |
|
год
|
reference_date.y | integer |
Год в нечеткой дате. |
GiftApi.SoftCreditRead
Мягкий кредит
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Системный идентификатор записи мягкого кредита. |
|
value
|
amount.value | double |
Денежное значение. |
|
составной идентификатор
|
constituent_id | string |
Системный идентификатор записи компонента, связанного с мягким кредитом. |
|
Идентификатор подарка
|
gift_id | string |
Системный идентификатор подарка, связанного с мягким кредитом. |
GiftBatchApi.ApiCollectionOfGiftBatch
Пакеты подарков
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Общее количество пакетов подарков в ответе. |
|
value
|
value | array of GiftBatchApi.GiftBatch |
Набор элементов, включенных в ответ. |
GiftBatchApi.CreatedBatchCh
Создан пакет подарков
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
batch_id | string |
Системный идентификатор записей только что созданного пакета подарков. |
GiftBatchApi.GiftBatch
Представляет объект пакета подарков
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор системной записи пакета. |
|
описание
|
batch_description | string |
Описание пакета. |
|
номер пакета
|
batch_number | string |
Номер пакета |
|
проецируемый номер
|
projected_number_of_gifts | integer |
Прогнозируемый номер подарков в пакете. |
|
фактическое число
|
number_of_gifts | integer |
Фактическое количество подарков в пакете. |
|
прогнозируемый объем
|
projected_amount | double |
Проецируемого значения подарков в пакете. |
|
фактическая сумма
|
actual_amount | double |
Фактическое значение подарков в пакете. |
|
есть исключения?
|
has_exceptions | boolean |
Есть ли в пакете исключения? |
|
одобренный?
|
is_approved | boolean |
Утвержден ли пакет? |
|
Кем создано:
|
created_by | string |
Имя пользователя, создавшего пакет. |
|
Создано
|
created_on | date-time |
Дата создания пакета. |
ListApi.CreatedList
Создан список
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор только что созданного списка. |
PowerAutomateUIApi.ValidateUserIdentityTokenResponse
Сведения о маркере удостоверения пользователя
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор пользователя
|
user_id | string |
Идентификатор пользователя Blackbaud. |
|
Адрес электронной почты
|
string |
Адрес электронной почты пользователя Blackbaud. |
|
|
Фамилия
|
family_name | string |
Фамилия пользователя Blackbaud. |
|
Имя (первое имя)
|
given_name | string |
Имя пользователя Blackbaud. |
|
Идентификатор приложения SKY
|
application_id | string |
Идентификатор приложения SKY, для которого был выдан маркер удостоверения пользователя. |
|
Идентификатор среды
|
environment_id | string |
Идентификатор текущей среды. |