Blackbaud Raiser's Edge NXT (Блэкбауд Рейзерс Эдж NXT)

Blackbaud Raiser Edge NXT — это комплексное облачное решение для сбора средств и программного обеспечения для управления донорами, созданное специально для некоммерческих организаций и всего социального хорошего сообщества.

Этот соединитель доступен в следующих продуктах и регионах:

Услуга Class Регионы
Copilot Studio Премия Все регионы Power Automate за исключением следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Логические приложения Стандарт Все регионы Logic Apps , кроме следующих:
     - Azure Government регионы
     - Azure регионы Китая
     - Министерство обороны США (DoD)
Power Apps Премия Все регионы Power Apps кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Power Automate Премия Все регионы Power Automate за исключением следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Контакт
Имя Поддержка Blackbaud
URL https://www.blackbaud.com/support
Адрес электронной почты skyapi@blackbaud.com
Метаданные соединителя
Publisher Blackbaud, Inc.
Веб-сайт https://www.blackbaud.com/products/blackbaud-raisers-edge-nxt
Политика конфиденциальности https://www.blackbaud.com/privacy-shield
Категории Продажи и CRM; Продуктивность

Edge NXT Raiser — это комплексное облачное решение для сбора средств и программного обеспечения для управления донорами, созданное специально для некоммерческих организаций и всего социального хорошего сообщества.

Этот соединитель построен на основе API Sky Blackbaud и предоставляет операции для управления сущностями, найденными в NXT Edge Raiser, в том числе:

  • Составляющих
  • Подарки
  • Действия
  • Примечания.
  • Настраиваемые поля
  • Кампании
  • Денежные средства
  • Апелляция
  • и другие...

Дополнительные сведения см. в документации.

Предпосылки

Чтобы использовать этот соединитель, у вас должна быть учетная запись Blackbaud ID с доступом к одной или нескольким средам Blackbaud.

Кроме того, администратор вашей организации также должен выполнять действия уровня администратора в системе, чтобы этот соединитель мог получить доступ к пограничной NXT Edge Raiser. Дополнительные сведения об этих предварительных требованиях см. в документации по начальной настройке .

Как получить учетные данные?

Администратор вашей организации отправит вам приглашение в среду NXT edge организации и настроит разрешения учетной записи пользователя в среде. Для использования этого соединителя дополнительные учетные данные не требуются.

Известные проблемы и ограничения

Соединитель будет работать в контексте учетной записи пользователя и, следовательно, будет применяться к вашим разрешениям пользователя в среде.

Ограничения регулирования

Имя Вызовы Период обновления
Вызовы API для каждого подключения 500 60 секунд

Действия

Вывод списка вложений в апелляцию

Перечисляет вложения для апелляции.

Вывод списка вложений возможностей

Перечисляет вложения для возможности.

Вывод списка вложений действий

Выводит список вложений для действия.

Вывод списка вложений кампании

Выводит список вложений для кампании.

Вывод списка вложений подарков

Перечисляет вложения для подарка.

Вывод списка вложений фонда

Перечисляет вложения для фонда.

Вывод списка настраиваемых полей

Перечисляет настраиваемые поля для составляющих.

Вывод списка настраиваемых полей возможностей

Перечисляет настраиваемые поля для возможности.

Вывод списка настраиваемых полей для обращения

Перечисляет настраиваемые поля для призыва.

Вывод списка настраиваемых полей кампании

Перечисляет настраиваемые поля для кампании.

Вывод списка настраиваемых полей подарка

Перечисляет настраиваемые поля для подарка.

Вывод списка настраиваемых полей фонда

Перечисляет настраиваемые поля для фонда.

Вывод списка пакетов

Возвращает список пакетов.

Добавление записей в список

Добавьте набор записей в существующий список.

Добавление подарка в пакет

Добавьте подарок в указанный пакет подарков.

Обновление вложения апелляции

Обновляет вложение апелляции.

Обновление вложения возможностей

Обновляет вложение возможностей.

Обновление вложения действия

Обновляет вложение действия.

Обновление вложения кампании

Обновляет вложение кампании.

Обновление вложения подарка

Обновляет вложение подарка.

Обновление вложения фонда

Обновляет вложение фонда.

Обновление возможности

Обновляет возможность.

Обновление кода для составного запроса

Обновляет составной код запроса.

Обновление компонента

Обновляет составную часть.

Обновление компонента присутствия в Интернете

Обновляет составное онлайн-присутствие.

Обновление настраиваемого поля возможности

Обновляет настраиваемое поле возможности.

Обновление настраиваемого поля действия

Обновляет настраиваемое поле действия.

Обновление настраиваемого поля для привлекательности

Обновляет настраиваемое поле для обращения.

Обновление настраиваемого поля кампании

Обновляет настраиваемое поле кампании.

Обновление настраиваемого поля подарка

Обновляет настраиваемое поле подарка.

Обновление настраиваемого поля фонда

Обновляет настраиваемое поле фонда.

Обновление параметра участника

Обновляет сведения о параметре участника.

Обновление рисунка составного профиля

Обновляет текущую фотографию профиля для составной части.

Обновление сведений о подтверждении подарков

Обновляет сведения о подтверждении для подарка.

Обновление сведений о получении подарков

Обновляет сведения о квитанции для подарка.

Обновление события

Обновляет сведения о событии.

Обновление составного адреса

Обновляет составной адрес.

Обновление составного адреса электронной почты

Обновляет составной адрес электронной почты.

Обновление составного вложения

Обновляет составное вложение.

Обновление составного действия

Обновляет составное действие.

Обновление составного кода

Обновляет составной код.

Обновление составного настраиваемого поля

Обновляет составное настраиваемое поле.

Обновление составного образования

Обновляет составное образование.

Обновление составного псевдонима

Обновляет составной псевдоним.

Обновление составного телефона

Обновляет составной телефон.

Обновление составной заметки

Обновляет составную заметку.

Обновление составной связи

Обновляет связь для составляющих. Если существует взаимная связь, она также изменяется, чтобы отразить изменения. Это не включает изменения в свойство "комментарии", которое относится к каждой записи и может быть изменено независимо от каждой записи.

Обновление участника

Обновляет сведения об участнике.

Перечисление апелляций

Возвращает список апелляций.

Перечисление действий

Возвращает список действий.

Перечисление записей о согласии компонентов

Перечисляет записи согласия для составной части.

Перечисление назначений сборов средств

Выведите список назначений для сборщика средств.

Перечисление пакетов подарков

Перечисление пакетов подарков.

Перечисление параметров участника события

Выводит список параметров участника для события.

Перечисление платежей за сбор участников

Перечисляет платежи за плату для участника.

Перечисление пожертвований участников

Перечисляет пожертвования для участника.

Перечисление сборов за события

Выводит список сборов за событие.

Перечисление сборов участников

Перечисляет сборы за участника.

Перечисление составляющих

Возвращает список составляющих.

Перечисление составляющих адресов

Перечисляет адреса для составной части.

Перечисление составляющих адресов электронной почты

Перечисляет адреса электронной почты для составляющих.

Перечисление составляющих вложений

Перечисляет вложения для составного компонента.

Перечисление составляющих действий

Перечисляет действия для составного элемента.

Перечисление составляющих образования

Список записей образования для составляющих.

Перечисление составляющих онлайн-присутствия

Перечисляет сведения о присутствии в Интернете для составляющих.

Перечисление составляющих примечаний

Перечисляет заметки для составного компонента.

Перечисление составляющих сбор средств

Выводит список назначений сборов средств для составляющих.

Перечисление составляющих связей

Выводит список связей для составляющих.

Перечисление составляющих телефонов

Перечисляет телефоны для составляющих.

Перечисление составных кодов

Перечисляет составные коды для составляющих.

Перечисление составных оценок

Возвращает список рейтингов для составляющих.

Перечисление составных псевдонимов

Перечисляет псевдонимы для составляющих.

Перечисление средств

Возвращает список средств.

Перечисление участников события

Выводит список участников для события.

Поиск составляющих

Выполняет составной поиск на основе предоставленного текста поиска. Поддерживает имя, фамилию, предпочтительное имя, прежнее имя, псевдоним, адрес электронной почты, номер телефона, адрес или идентификатор подстановки. Допустимы такие сочетания имен, как имя и фамилия или предпочтительное имя и фамилия, но в противном случае поиск поддерживает только один параметр одновременно. По умолчанию поиски включают результаты, аналогичные вашим критериям. Например, поиски "Смит" включают совпадения для "Smyth" и других альтернативных орфографических выражений. Этот поиск не поддерживает подстановочные знаки, такие как * или ?. Результаты поиска ограничены 500 записями.

Получение апелляции

Возвращает сведения об апелляции.

Получение возможности

Возвращает сведения о возможности. Примечание. Эта конечная точка возвращает свойство состояния с задержкой около 10 минут.

Получение изображения составляющих профилей

Возвращает текущее изображение профиля для компонента.

Получение кампании

Возвращает сведения о кампании.

Получение пакета

Возвращает сведения о пакете.

Получение первого подарка

Возвращает первый подарок для составляющих.

Получение подарка

Возвращает сведения о подарке.

Получение последнего подарка

Возвращает последний подарок для компонента.

Получение события

Возвращает сведения о событии.

Получение составляющих

Возвращает сведения об компоненте.

Получение составляющих времени существования

Возвращает время существования, предоставляющее сводку для составляющих.

Получение составного действия

Возвращает сведения о составном действии.

Получение статуса составляющих перспектив

Возвращает текущее состояние перспективы для составляющих.

Получение участника

Возвращает сведения о конкретном участнике события.

Получение фонда

Возвращает сведения о фонде.

Получить составляющий величайший подарок

Возвращает величайший подарок для составляющих.

Создание вложения апелляции

Создает новое вложение апелляции.

Создание вложения возможностей

Создает новое вложение возможностей.

Создание вложения действия

Создает новое вложение действия.

Создание вложения кампании

Создает новое вложение кампании.

Создание вложения подарка

Создает новое вложение подарка.

Создание вложения фонда

Создает новое вложение фонда.

Создание возможной сделки

Создает новую возможность.

Создание записи о согласии на создание компонента

Создает новую запись о согласии на создание компонента.

Создание кода для создания составного запроса

Создает новый составной код запроса.

Создание компонента организации

Создает новую составную организацию.

Создание назначения сборов средств

Создает новое назначение сборов средств.

Создание настраиваемого поля возможности

Создает новое настраиваемое поле возможности.

Создание настраиваемого поля действия

Создает настраиваемое поле действия.

Создание настраиваемого поля для привлекательности

Создает новое настраиваемое поле привлекательности.

Создание настраиваемого поля кампании

Создает настраиваемое поле кампании.

Создание настраиваемого поля подарка

Создает новое настраиваемое поле подарка.

Создание настраиваемого поля фонда

Создает настраиваемое поле фонда.

Создание оплаты за участие

Создает новый платеж за участника.

Создание отдельного компонента

Создает новый отдельный компонент.

Создание отдельной связи

Создает новую отдельную связь. Если отношения связаны с другим компонентом, для этого компонента создается взаимная связь.

Создание пакета подарков

Создает новый пакет подарков.

Создание параметра участника

Создает новый параметр участника.

Создание параметра участника события

Создает новый параметр участника для события.

Создание платы за событие

Создает новую плату за событие.

Создание платы за участника

Создает новую плату для участника.

Создание подарка

Создает новый подарок.

Создание пожертвования участника

Создает новое пожертвование для участника.

Создание расположения документа

Создает новый уникальный идентификатор документа и расположение отправки для использования с физическими вложениями. Ответ будет содержать инструкции по тому, где и как отправить содержимое документа.

Создание связи организации

Создает связь организации. Если отношения связаны с другим компонентом, для этого компонента создается взаимная связь.

Создание события

Создает новое событие.

Создание составляющих онлайн-присутствия

Создает новое составное онлайн-присутствие.

Создание составного адреса

Создает новый составной адрес.

Создание составного адреса электронной почты

Создает новый составной адрес электронной почты.

Создание составного вложения

Создает новое составное вложение.

Создание составного действия

Создает новое составное действие.

Создание составного кода

Создает новый составной код.

Создание составного настраиваемого поля

Создает новое составное настраиваемое поле.

Создание составного образования

Создает новое составное образование.

Создание составного псевдонима

Создает новый составной псевдоним.

Создание составного телефона

Создает новый составной телефон.

Создание составной заметки

Создает новую составную заметку.

Создание составной оценки

Создает новый составной рейтинг.

Создание списка из набора записей

Создает список, отфильтрованный по указанному набору записей.

Создание участника

Создает нового участника для события.

Список возможностей

Возвращает список возможностей.

Список кампаний

Возвращает список кампаний.

Список настраиваемых полей действия

Выводит настраиваемые поля для действия.

Список параметров участника

Выводит список параметров участника.

Список подарков

Возвращает список подарков.

Список событий

Возвращает список событий.

Список составных кодов запроса

Перечисляет коды запроса для составляющих.

Удаление составного кода

Удаляет составной код.

Вывод списка вложений в апелляцию

Перечисляет вложения для апелляции.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор апелляции
appeal_id True string

Идентификатор системной записи апелляции.

Возвращаемое значение

Attachments

Вывод списка вложений возможностей

Перечисляет вложения для возможности.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор возможности
opportunity_id True string

Идентификатор системной записи возможности.

Возвращаемое значение

Attachments

Вывод списка вложений действий

Выводит список вложений для действия.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор действия
action_id True string

Идентификатор системной записи действия.

Возвращаемое значение

Attachments

Вывод списка вложений кампании

Выводит список вложений для кампании.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор кампании
campaign_id True string

Идентификатор системной записи кампании.

Возвращаемое значение

Attachments

Вывод списка вложений подарков

Перечисляет вложения для подарка.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор подарка
gift_id True string

Системный идентификатор записи подарка.

Возвращаемое значение

Attachments

Вывод списка вложений фонда

Перечисляет вложения для фонда.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор фонда
fund_id True string

Системный идентификатор фонда.

Возвращаемое значение

Attachments

Вывод списка настраиваемых полей

Перечисляет настраиваемые поля для составляющих.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
constituent_id True string

Системный идентификатор записи компонента.

Возвращаемое значение

Пользовательские поля

Вывод списка настраиваемых полей возможностей

Перечисляет настраиваемые поля для возможности.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор возможности
opportunity_id True string

Идентификатор системной записи возможности.

Возвращаемое значение

Пользовательские поля

Вывод списка настраиваемых полей для обращения

Перечисляет настраиваемые поля для призыва.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор апелляции
appeal_id True string

Идентификатор системной записи апелляции.

Возвращаемое значение

Пользовательские поля

Вывод списка настраиваемых полей кампании

Перечисляет настраиваемые поля для кампании.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор кампании
campaign_id True string

Идентификатор системной записи кампании.

Возвращаемое значение

Пользовательские поля

Вывод списка настраиваемых полей подарка

Перечисляет настраиваемые поля для подарка.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор подарка
gift_id True string

Системный идентификатор записи подарка.

Возвращаемое значение

Пользовательские поля

Вывод списка настраиваемых полей фонда

Перечисляет настраиваемые поля для фонда.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор фонда
fund_id True string

Системный идентификатор фонда.

Возвращаемое значение

Пользовательские поля

Вывод списка пакетов

Возвращает список пакетов.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор апелляции
appeal_id string

Представляет разделенный запятыми список идентификаторов апелляций для фильтрации результатов. Например, "506 918" возвращает только пакеты для апелляции 506 или апелляции 918.

Лимит
limit integer

Представляет количество возвращаемых записей. Значение по умолчанию — 500. Максимальное значение — 5000.

Смещение
offset integer

Представляет количество пропускаемых записей. Для использования с разбивкой на страницы.

Включить неактивное?
include_inactive boolean

Включить неактивные пакеты?

Добавлен или после
date_added date-time

Отфильтруйте результаты до пакетов, созданных по указанной дате (например, "2020-09-18T04:13:56Z").

Изменено или после
last_modified date-time

Отфильтруйте результаты до пакетов, измененных по указанной дате (например, "2020-09-18T04:13:56Z").

Возвращаемое значение

Packages

Добавление записей в список

Добавьте набор записей в существующий список.

Параметры

Имя Ключ Обязательно Тип Описание
Тип списка
list_type True string

Тип списка.

List
list_id True string

Идентификатор системной записи списка.

Идентификаторы
ids True array of string

Уникальные идентификаторы записей, добавляемых в список (максимум 100 000 значений).

Добавление подарка в пакет

Добавьте подарок в указанный пакет подарков.

Параметры

Имя Ключ Обязательно Тип Описание
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").

Возвращаемое значение

Содержит коллекцию записей об ошибках пакетного подарка и пакетных подарков, добавленных операцией.

Обновление вложения апелляции

Обновляет вложение апелляции.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор вложения
attachment_id True string

Идентификатор системной записи для обновления вложения.

Имя
name string

Имя вложения. Ограничение символов: 150.

Date
date date-time

Дата вложения (например, '2020-09-18T04:13:56Z').

URL
url string

URL-адрес для вложения. Это необходимо для вложений ссылок и неприменимо для физических вложений.

Обновление вложения возможностей

Обновляет вложение возможностей.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор вложения
attachment_id True string

Идентификатор системной записи для обновления вложения.

Имя
name string

Имя вложения. Ограничение символов: 150.

Date
date date-time

Дата вложения (например, '2020-09-18T04:13:56Z').

URL
url string

URL-адрес для вложения. Это необходимо для вложений ссылок и неприменимо для физических вложений.

Обновление вложения действия

Обновляет вложение действия.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор вложения
attachment_id True string

Идентификатор системной записи для обновления вложения.

Имя
name string

Имя вложения. Ограничение символов: 150.

Date
date date-time

Дата вложения (например, '2020-09-18T04:13:56Z').

URL
url string

URL-адрес для вложения. Это необходимо для вложений ссылок и неприменимо для физических вложений.

Обновление вложения кампании

Обновляет вложение кампании.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор вложения
attachment_id True string

Идентификатор системной записи для обновления вложения.

Имя
name string

Имя вложения. Ограничение символов: 150.

Date
date date-time

Дата вложения (например, '2020-09-18T04:13:56Z').

URL
url string

URL-адрес для вложения. Это необходимо для вложений ссылок и неприменимо для физических вложений.

Обновление вложения подарка

Обновляет вложение подарка.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор вложения
attachment_id True string

Идентификатор системной записи для обновления вложения.

Имя
name string

Имя вложения. Ограничение символов: 150.

Date
date date-time

Дата вложения (например, '2020-09-18T04:13:56Z').

URL
url string

URL-адрес для вложения. Это необходимо для вложений ссылок и неприменимо для физических вложений.

Обновление вложения фонда

Обновляет вложение фонда.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор вложения
attachment_id True string

Идентификатор системной записи для обновления вложения.

Имя
name string

Имя вложения. Ограничение символов: 150.

Date
date date-time

Дата вложения (например, '2020-09-18T04:13:56Z').

URL
url string

URL-адрес для вложения. Это необходимо для вложений ссылок и неприменимо для физических вложений.

Обновление возможности

Обновляет возможность.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор возможности
opportunity_id True string

Идентификатор системной записи возможности обновления.

Цель
purpose string

Предполагаемое использование для любых денег, поднятых в результате возможности.

Имя
name string

Имя, определяющее возможность всей программы, например в списках или на составляющих записях. Ограничение символов: 255.

Состояние
status string

Состояние, указывающее, где находится возможность в процессе запроса.

Deadline
deadline date-time

Дата цели для возможности привести к подарку (например, "2020-09-18T04:13:56Z".

Дата спросить
ask_date date-time

Дата выполнения запроса (например, "2020-09-18T04:13:56Z").

value
value double

Денежное значение.

Ожидаемая дата
expected_date date-time

Дата, когда перспектива, как ожидается, даст ответ на возможность (например, "2020-09-18T04:13:56Z".

value
value double

Денежное значение.

Дата финансирования
funded_date date-time

Дата, когда перспектива дала ответ на возможность (например, "2020-09-18T04:13:56Z".

value
value double

Денежное значение.

Идентификатор кампании
campaign_id string

Системный идентификатор кампании, связанной с возможностью. Кампания задает общие цели для сбора денег.

Идентификатор фонда
fund_id string

Системный идентификатор фонда, связанного с возможностью. Фонд назначает конкретную финансовую цель подарка и определяет финансовую учетную запись для этого подарка.

Составной идентификатор
constituent_id string

Системный идентификатор компонента, связанного с сбором средств.

value
value double

Денежное значение.

Неактивный?
inactive boolean

Неактивна ли возможность?

Обновление кода для составного запроса

Обновляет составной код запроса.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор кода запроса
constituent_solicit_code_id True string

Идентификатор системной записи кода запроса для обновления.

Код запроса
solicit_code string

Инструкции по обмену данными и /или ограничения для составляющих.

Начальная дата
start_date date

Дата начала кода запроса (например, "2005-09-18").

Дата окончания
end_date date

Дата окончания кода запроса (например, "2005-09-18").

Обновление компонента

Обновляет составную часть.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
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

Год в нечеткой дате.

Обновление компонента присутствия в Интернете

Обновляет составное онлайн-присутствие.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор присутствия в Сети
online_presence_id True string

Идентификатор системной записи для обновления присутствия в Сети.

Тип
type string

Тип присутствия в Интернете.

Link
address string

Веб-адрес для присутствия в Интернете.

Первичный?
primary boolean

Это основное онлайн-присутствие составляющих?

Неактивный?
inactive boolean

Неактивно ли это присутствие в Интернете?

Обновление настраиваемого поля возможности

Обновляет настраиваемое поле возможности.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор настраиваемого поля
custom_field_id True string

Идентификатор системной записи настраиваемого поля для обновления.

body
body True dynamic

Объект, представляющий свойства настраиваемого поля для обновления.

Обновление настраиваемого поля действия

Обновляет настраиваемое поле действия.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор настраиваемого поля
custom_field_id True string

Идентификатор системной записи настраиваемого поля для обновления.

body
body True dynamic

Объект, представляющий свойства настраиваемого поля для обновления.

Обновление настраиваемого поля для привлекательности

Обновляет настраиваемое поле для обращения.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор настраиваемого поля
custom_field_id True string

Идентификатор системной записи настраиваемого поля для обновления.

body
body True dynamic

Объект, представляющий свойства настраиваемого поля для обновления.

Обновление настраиваемого поля кампании

Обновляет настраиваемое поле кампании.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор настраиваемого поля
custom_field_id True string

Идентификатор системной записи настраиваемого поля для обновления.

body
body True dynamic

Объект, представляющий свойства настраиваемого поля для обновления.

Обновление настраиваемого поля подарка

Обновляет настраиваемое поле подарка.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор настраиваемого поля
custom_field_id True string

Идентификатор системной записи настраиваемого поля для обновления.

body
body True dynamic

Объект, представляющий свойства настраиваемого поля для обновления.

Обновление настраиваемого поля фонда

Обновляет настраиваемое поле фонда.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор настраиваемого поля
custom_field_id True string

Идентификатор системной записи настраиваемого поля для обновления.

body
body True dynamic

Объект, представляющий свойства настраиваемого поля для обновления.

Обновление параметра участника

Обновляет сведения о параметре участника.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор параметра участника
option_id True string

Идентификатор системной записи параметра участника для обновления.

Ценность
option_value True string

Ответ участника на параметр.

Обновление рисунка составного профиля

Обновляет текущую фотографию профиля для составной части.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
constituent_id True string

Системный идентификатор записи компонента, изображение профиля которого необходимо обновить.

Имя файла
file_name True string

Имя файла.

Идентификатор документа
document_id True uuid

Идентификатор документа.

Идентификатор эскиза
thumbnail_id True uuid

Идентификатор документа эскиза.

Обновление сведений о подтверждении подарков

Обновляет сведения о подтверждении для подарка.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор подтверждения
acknowledgement_id True string

Системный идентификатор подтверждения подарка для обновления. Он использует идентификатор родительского подарка в качестве значения.

Состояние
status string

Состояние подтверждения. Если для параметра состояния задано значение DoNotAcknowledge, буква и дата должны иметь значение NULL. Если для параметра состояния задано значение NeedsAcknowledgement, дата должна иметь значение NULL.

Date
date date-time

Дата, связанная с подтверждением (например, '2020-09-18T04:13:56Z').

Письмо
letter string

Письмо, связанное с подтверждением.

Обновление сведений о получении подарков

Обновляет сведения о квитанции для подарка.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор квитанции
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

Номер квитанции.

Обновление события

Обновляет сведения о событии.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор события
event_id True string

Идентификатор системной записи события для обновления.

Имя события
name string

Название мероприятия.

Description
description string

Описание события.

Категория
name True string

Имя категории.

Начальная дата
start_date date

Дата начала события (например, "2020-09-18").

Время запуска
start_time string

Время начала события (например, "07:30".

Дата окончания
end_date date

Дата окончания события (например, "2020-09-18").

Время окончания
end_time string

Время окончания события (например, "07:30".

Идентификатор подстановки
lookup_id string

Идентификатор подстановки события.

Capacity
capacity integer

Количество людей, которые могут присутствовать на мероприятии.

Цель
goal double

Денежные цели события.

Идентификатор кампании
campaign_id string

Системный идентификатор записи кампании, связанной с событием.

Идентификатор фонда
fund_id string

Системный идентификатор фонда, связанного с событием.

Неактивный?
inactive boolean

Активен ли событие?

Обновление составного адреса

Обновляет составной адрес.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор адреса
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

Год в нечеткой дате.

Обновление составного адреса электронной почты

Обновляет составной адрес электронной почты.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор адреса электронной почты
email_address_id True string

Идентификатор системной записи для обновления адреса электронной почты.

Тип электронной почты
type string

Тип адреса электронной почты.

Адрес электронной почты
address string

Адрес электронной почты.

Первичный?
primary boolean

Это основной адрес электронной почты компонента?

Не отправлять сообщения электронной почты?
do_not_email boolean

Можно ли связаться с компонентами по этому адресу электронной почты?

Неактивный?
inactive boolean

Неактивен ли адрес электронной почты?

Обновление составного вложения

Обновляет составное вложение.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор вложения
attachment_id True string

Идентификатор системной записи для обновления вложения.

Имя
name string

Имя вложения. Ограничение символов: 150.

Date
date date-time

Дата вложения (например, '2020-09-18T04:13:56Z').

URL
url string

URL-адрес для вложения. Это необходимо для вложений ссылок и неприменимо для физических вложений.

Обновление составного действия

Обновляет составное действие.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор действия
action_id True string

Идентификатор системной записи действия для обновления.

Категория
category string

Канал или намерение составного взаимодействия.

Завершённый?
completed boolean

Завершено ли действие? Если система настроена для использования пользовательских состояний действий, это значение основано на значении состояния действия.

Дата завершения
completed_date date-time

Дата завершения действия (например, "2020-09-18T04:13:56Z").

Date
date date-time

Дата действия (например, '2020-09-18T04:13:56Z').

Замечание
description string

Подробное объяснение, подробное описание сводки действий.

Направление
direction string

Направление действия.

Сбор средств
fundraisers array of string

Набор идентификаторов системных записей для сборщиков средств, связанных с действием.

Местоположение
location string

Расположение действия.

Идентификатор возможности
opportunity_id string

Идентификатор системной записи возможности, связанной с действием.

Результат
outcome string

Результат действия.

Priority
priority string

Приоритет действия.

Время запуска
start_time string

Время начала действия. Используется 24-часовое время в формате HH:mm.

Время окончания
end_time string

Время окончания действия. Используется 24-часовое время в формате HH:mm.

Состояние
status string

Состояние действия.

Сводка
summary string

Краткое описание действия, которое отображается в верхней части записи. Ограничение символов: 255.

Тип
type string

Дополнительное описание действия для дополнения категории.

Обновление составного кода

Обновляет составной код.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор составного кода
constituent_code_id True string

Идентификатор системной записи в составном коде для обновления.

day
d integer

День в нечеткой дате.

month
m integer

Месяц в нечеткой дате.

год
y integer

Год в нечеткой дате.

day
d integer

День в нечеткой дате.

month
m integer

Месяц в нечеткой дате.

год
y integer

Год в нечеткой дате.

Последовательность
sequence integer

Числовая последовательность, связанная с составным кодом.

Обновление составного настраиваемого поля

Обновляет составное настраиваемое поле.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор настраиваемого поля
custom_field_id True string

Идентификатор системной записи настраиваемого поля для обновления.

body
body True dynamic

Объект, представляющий свойства настраиваемого поля для обновления.

Обновление составного образования

Обновляет составное образование.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор образования
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.

Обновление составного псевдонима

Обновляет составной псевдоним.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор псевдонима
alias_id True string

Идентификатор системной записи псевдонима для обновления.

Псевдоним
name string

Имя, используемое в качестве псевдонима компонента. Ограничение символов: 100.

Тип
type string

Тип псевдонима.

Обновление составного телефона

Обновляет составной телефон.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор телефона
phone_id True string

Идентификатор системной записи телефона для обновления.

Тип
type string

Тип телефона.

Number
number string

Номер телефона.

Первичный?
primary boolean

Это основной телефон избирателя?

Не вызывайте?
do_not_call boolean

Можно ли связаться с компонентом по этому номеру?

Неактивный?
inactive boolean

Неактивен ли этот номер телефона?

Обновление составной заметки

Обновляет составную заметку.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор заметки
note_id True string

Идентификатор системной записи для обновления заметки.

Тип
type string

Тип заметки.

day
d integer

День в нечеткой дате.

month
m integer

Месяц в нечеткой дате.

год
y integer

Год в нечеткой дате.

Сводка
summary string

Сводка по заметкам. Ограничение символов: 50.

Замечание
text string

Текст заметки.

Обновление составной связи

Обновляет связь для составляющих. Если существует взаимная связь, она также изменяется, чтобы отразить изменения. Это не включает изменения в свойство "комментарии", которое относится к каждой записи и может быть изменено независимо от каждой записи.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор связи
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.

Обновление участника

Обновляет сведения об участнике.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор участника
participant_id True string

Идентификатор системной записи участника для обновления.

Составной идентификатор
constituent_id string

Составляющий идентификатор участника.

Идентификатор узла
host_id string

Идентификатор записи участника узла.

Состояние RSVP
rsvp_status string

Состояние взаимодействия участника с событием.

Присутствовал?
attended boolean

Присутствовал ли участник на мероприятии?

Статус приглашения
invitation_status string

Состояние приглашения участнику.

day
d integer

День в нечеткой дате.

month
m integer

Месяц в нечеткой дате.

год
y integer

Год в нечеткой дате.

day
d integer

День в нечеткой дате.

month
m integer

Месяц в нечеткой дате.

год
y integer

Год в нечеткой дате.

Уровень участия
name True string

Имя уровня участия.

Перечисление апелляций

Возвращает список апелляций.

Параметры

Имя Ключ Обязательно Тип Описание
Лимит
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").

Возвращаемое значение

Апелляция

Перечисление действий

Возвращает список действий.

Параметры

Имя Ключ Обязательно Тип Описание
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").

Возвращаемое значение

Действия

Перечисление записей о согласии компонентов

Перечисляет записи согласия для составной части.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
constituent_id True string

Системный идентификатор записи компонента.

Последнее только?
most_recent_only boolean

Включите только последние записи согласия для каждой комбинации категорий каналов в ответе?

Возвращаемое значение

Записи согласия

Перечисление назначений сборов средств

Выведите список назначений для сборщика средств.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сборов средств
fundraiser_id True string

Системный идентификатор сборов средств, для которого возвращаются назначения.

Лимит
limit integer

Представляет количество возвращаемых записей. Значение по умолчанию — 500. Максимальное значение — 5000.

Смещение
offset integer

Представляет количество пропускаемых записей. Для использования с разбивкой на страницы.

Возвращаемое значение

Assignments

Перечисление пакетов подарков

Перечисление пакетов подарков.

Параметры

Имя Ключ Обязательно Тип Описание
Номер пакета
batch_number string

Представляет фильтр для результатов, соответствующих указанному числу.

Одобренный?
approved boolean

Представляет фильтр для состояния пакета подарков.

Есть ли исключения?
has_exceptions boolean

Представляет фильтр, содержащий ли пакет подарков исключения.

Лимит
limit integer

Представляет количество возвращаемых записей. Значение по умолчанию — 500. Максимальное значение — 5000.

Смещение
offset integer

Представляет количество пропускаемых записей. Для использования с разбивкой на страницы.

Поиск текста
search_text string

Представляет фильтр для текста, включенного в описание пакета или поля номера пакета.

Кем создано:
created_by string

Представляет фильтр для пакетов подарков, созданных указанным пользователем.

Возвращаемое значение

Пакеты подарков

Перечисление параметров участника события

Выводит список параметров участника для события.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор события
event_id True string

Идентификатор события.

Возвращаемое значение

Параметры участника события

Перечисление платежей за сбор участников

Перечисляет платежи за плату для участника.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор участника
participant_id True string

Системный идентификатор записи участника.

Лимит
limit integer

Представляет количество возвращаемых записей. Значение по умолчанию — 500. Максимальное значение — 10000.

Смещение
offset integer

Представляет количество пропускаемых записей. Для использования с разбивкой на страницы. Значение по умолчанию — 0.

Возвращаемое значение

Платежи за плату

Перечисление пожертвований участников

Перечисляет пожертвования для участника.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор участника
participant_id True string

Системный идентификатор записи участника.

Лимит
limit integer

Представляет количество возвращаемых записей. Значение по умолчанию — 500. Максимальное значение — 10000.

Смещение
offset integer

Представляет количество пропускаемых записей. Для использования с разбивкой на страницы. Значение по умолчанию — 0.

Возвращаемое значение

Пожертвования

Перечисление сборов за события

Выводит список сборов за событие.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор события
event_id True string

Идентификатор системной записи события.

Возвращаемое значение

Оплата

Перечисление сборов участников

Перечисляет сборы за участника.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор участника
participant_id True string

Системный идентификатор записи участника.

Лимит
limit integer

Представляет количество возвращаемых записей. Значение по умолчанию — 500. Максимальное значение — 10000.

Смещение
offset integer

Представляет количество пропускаемых записей. Для использования с разбивкой на страницы. Значение по умолчанию — 0.

Возвращаемое значение

Оплата

Перечисление составляющих

Возвращает список составляющих.

Параметры

Имя Ключ Обязательно Тип Описание
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" в порядке убывания.

Возвращаемое значение

Составляющих

Перечисление составляющих адресов

Перечисляет адреса для составной части.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
constituent_id True string

Системный идентификатор записи компонента.

Включить неактивное?
include_inactive boolean

Включите неактивные адреса?

Возвращаемое значение

Адреса

Перечисление составляющих адресов электронной почты

Перечисляет адреса электронной почты для составляющих.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
constituent_id True string

Системный идентификатор записи компонента.

Включить неактивное?
include_inactive boolean

Включите неактивные адреса электронной почты?

Возвращаемое значение

Адреса электронной почты

Перечисление составляющих вложений

Перечисляет вложения для составного компонента.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
constituent_id True string

Системный идентификатор записи компонента.

Возвращаемое значение

Attachments

Перечисление составляющих действий

Перечисляет действия для составного элемента.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
constituent_id True string

Системный идентификатор записи компонента.

Возвращаемое значение

Действия

Перечисление составляющих образования

Список записей образования для составляющих.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
constituent_id True string

Системный идентификатор записи компонента.

Возвращаемое значение

Образования

Перечисление составляющих онлайн-присутствия

Перечисляет сведения о присутствии в Интернете для составляющих.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
constituent_id True string

Системный идентификатор записи компонента.

Включить неактивное?
include_inactive boolean

Включить неактивное присутствие в Интернете?

Возвращаемое значение

Присутствие в Сети

Перечисление составляющих примечаний

Перечисляет заметки для составного компонента.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
constituent_id True string

Системный идентификатор записи компонента.

Возвращаемое значение

Примечания.

Перечисление составляющих сбор средств

Выводит список назначений сборов средств для составляющих.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
constituent_id True string

Системный идентификатор записи компонента.

Включить неактивное?
include_inactive boolean

Включите неактивные назначения сборов средств?

Возвращаемое значение

Назначения сборов средств

Перечисление составляющих связей

Выводит список связей для составляющих.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
constituent_id True string

Системный идентификатор записи компонента.

Лимит
limit integer

Представляет количество возвращаемых записей. Значение по умолчанию — 500. Максимальное значение не существует.

Смещение
offset integer

Представляет количество пропускаемых записей. Для использования с разбивкой на страницы.

Возвращаемое значение

Отношения

Перечисление составляющих телефонов

Перечисляет телефоны для составляющих.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
constituent_id True string

Системный идентификатор записи компонента.

Включить неактивное?
include_inactive boolean

Включить неактивные телефоны?

Возвращаемое значение

Телефоны

Перечисление составных кодов

Перечисляет составные коды для составляющих.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
constituent_id True string

Системный идентификатор записи компонента.

Возвращаемое значение

Составные коды

Перечисление составных оценок

Возвращает список рейтингов для составляющих.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
constituent_id True string

Идентификатор системной записи компонента

Включить неактивное?
include_inactive boolean

Включить неактивные оценки?

Только последние?
most_recent_only boolean

Включите только последние рейтинги?

Возвращаемое значение

Рейтинги

Перечисление составных псевдонимов

Перечисляет псевдонимы для составляющих.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
constituent_id True string

Системный идентификатор записи компонента.

Возвращаемое значение

Aliases

Перечисление средств

Возвращает список средств.

Параметры

Имя Ключ Обязательно Тип Описание
Лимит
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").

Возвращаемое значение

Денежные средства

Перечисление участников события

Выводит список участников для события.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор события
event_id True string

Идентификатор системной записи события.

Состояние RSVP
rsvp_status string

Фильтрация участников на основе состояния RSVP.

Статус приглашения
invitation_status string

Фильтрация участников на основе состояния приглашения.

Уровень участия
participation_level string

Фильтрация участников на основе уровня участия.

Присутствовал?
attended_filter boolean

Фильтрация по включению или исключению участников, помеченных как участники.

Платная плата?
fees_paid_filter boolean

Фильтрация по включению или исключению участников, которые заплатили свои сборы.

Лимит
limit integer

Представляет количество возвращаемых записей. Значение по умолчанию — 500. Максимальное значение — 10000.

Смещение
offset integer

Представляет количество пропускаемых записей. Для использования с разбивкой на страницы.

Является ли составной?
is_constituent_filter boolean

Фильтрация по включению или исключению участников, являющихся участниками.

Имеет ли соответствующее сообщение электронной почты?
email_eligible_filter boolean

Фильтрация по включению или исключению участников на основе того, есть ли у них основной адрес электронной почты, который не помечен как "Не отправлять сообщения электронной почты"?

Имеет подходящий телефон?
phone_call_eligible_filter boolean

Фильтрация по включению или исключению участников на основе того, есть ли у них основной номер телефона, который не помечен как "Не звонить".

Имя
name string

Фильтруйте участников, которые соответствуют указанному имени.

Добавлен или после
date_added date-time

Отфильтруйте результаты участникам, созданным по указанной дате (например, "2020-09-18T04:13:56Z").

Изменено или после
last_modified date-time

Отфильтруйте результаты для участников, измененных по указанной дате (например, "2020-09-18T04:13:56Z").

Возвращаемое значение

Участники

Поиск составляющих

Выполняет составной поиск на основе предоставленного текста поиска. Поддерживает имя, фамилию, предпочтительное имя, прежнее имя, псевдоним, адрес электронной почты, номер телефона, адрес или идентификатор подстановки. Допустимы такие сочетания имен, как имя и фамилия или предпочтительное имя и фамилия, но в противном случае поиск поддерживает только один параметр одновременно. По умолчанию поиски включают результаты, аналогичные вашим критериям. Например, поиски "Смит" включают совпадения для "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

Представляет количество пропускаемых записей. Для использования с разбивкой на страницы.

Возвращаемое значение

Результаты поиска

Получение апелляции

Возвращает сведения об апелляции.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор апелляции
appeal_id True string

Идентификатор системной записи для получения апелляции.

Возвращаемое значение

Appeal

Получение возможности

Возвращает сведения о возможности. Примечание. Эта конечная точка возвращает свойство состояния с задержкой около 10 минут.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор возможности
opportunity_id True string

Идентификатор системной записи возможности получить.

Возвращаемое значение

Возможность

Получение изображения составляющих профилей

Возвращает текущее изображение профиля для компонента.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
constituent_id True string

Системный идентификатор записи компонента, для которого требуется получить рисунок профиля.

Возвращаемое значение

Изображение профиля

Получение кампании

Возвращает сведения о кампании.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор кампании
campaign_id True string

Системный идентификатор записи кампании для получения.

Возвращаемое значение

кампания

Получение пакета

Возвращает сведения о пакете.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор пакета
package_id True string

Идентификатор системной записи пакета, который требуется получить.

Возвращаемое значение

Package

Получение первого подарка

Возвращает первый подарок для составляющих.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
constituent_id True string

Системный идентификатор записи компонента.

Возвращаемое значение

Предоставление сводки

Получение подарка

Возвращает сведения о подарке.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор подарка
gift_id True string

Системный идентификатор записи подарка для получения.

Возвращаемое значение

Подарок

Тело
GiftApi.GiftRead

Получение последнего подарка

Возвращает последний подарок для компонента.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
constituent_id True string

Системный идентификатор записи компонента.

Возвращаемое значение

Предоставление сводки

Получение события

Возвращает сведения о событии.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор события
event_id True string

Идентификатор системной записи события, который требуется получить.

Возвращаемое значение

Event

Тело
EventApi.Event

Получение составляющих

Возвращает сведения об компоненте.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
constituent_id True string

Системный идентификатор записи компонента, который требуется получить.

Возвращаемое значение

Составляющая

Получение составляющих времени существования

Возвращает время существования, предоставляющее сводку для составляющих.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
constituent_id True string

Системный идентификатор записи компонента.

Возвращаемое значение

Время существования

Получение составного действия

Возвращает сведения о составном действии.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор действия
action_id True string

Идентификатор системной записи действия для получения.

Возвращаемое значение

Действие

Получение статуса составляющих перспектив

Возвращает текущее состояние перспективы для составляющих.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
constituent_id True string

Системный идентификатор записи компонента, для которого требуется получить состояние перспективы.

Возвращаемое значение

Состояние перспективы

Получение участника

Возвращает сведения о конкретном участнике события.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор участника
participant_id True string

Системный идентификатор записи участника.

Возвращаемое значение

Участник

Получение фонда

Возвращает сведения о фонде.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор фонда
fund_id True string

Системный идентификатор фонда для получения.

Возвращаемое значение

Фонд

Получить составляющий величайший подарок

Возвращает величайший подарок для составляющих.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
constituent_id True string

Системный идентификатор записи компонента.

Возвращаемое значение

Предоставление сводки

Создание вложения апелляции

Создает новое вложение апелляции.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор апелляции
parent_id True string

Идентификатор системной записи апелляции, связанной с вложением.

Тип
type True string

Тип вложения. Физические вложения отправляются в файлы, такие как изображения, PDF-файлы или Word документы, сохраненные локально или в сети. Они хранятся и управляются в системе. Ссылки на вложения — это ссылки на такие файлы, как изображения, записи блога или видео YouTube, которые находятся в Сети или в облачной учетной записи хранения. Они хранятся и управляются внешним образом.

Имя
name string

Имя вложения. Ограничение символов: 150.

Date
date date-time

Дата вложения (например, '2020-09-18T04:13:56Z'). Это поле по умолчанию использует текущую дату и время, если она не указана.

URL
url string

URL-адрес для вложения. Это необходимо для вложений ссылок и неприменимо для физических вложений.

Имя файла
file_name string

Имя файла. Ограничение символов: 36. Только для физических вложений.

Идентификатор файла
file_id string

Идентификатор файла. Ограничение символов: 36. Только для физических вложений.

Идентификатор эскиза
thumbnail_id string

Идентификатор эскиза. Ограничение символов: 36. Только для физических вложений.

Возвращаемое значение

Созданное вложение апелляции

Создание вложения возможностей

Создает новое вложение возможностей.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор возможности
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. Только для физических вложений.

Возвращаемое значение

Создание вложения возможностей

Создание вложения действия

Создает новое вложение действия.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор действия
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. Только для физических вложений.

Возвращаемое значение

Созданное вложение действия

Создание вложения кампании

Создает новое вложение кампании.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор кампании
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. Только для физических вложений.

Возвращаемое значение

Созданное вложение кампании

Создание вложения подарка

Создает новое вложение подарка.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор подарка
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. Только для физических вложений.

Возвращаемое значение

Созданное вложение подарка

Создание вложения фонда

Создает новое вложение фонда.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор фонда
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. Только для физических вложений.

Возвращаемое значение

Созданное вложение фонда

Создание возможной сделки

Создает новую возможность.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
constituent_id True string

Системный идентификатор записи компонента, связанного с возможностью.

Цель
purpose True string

Предполагаемое использование для любых денег, поднятых в результате возможности.

Имя
name True string

Имя, определяющее возможность всей программы, например в списках или на составляющих записях. Ограничение символов: 255.

Состояние
status string

Состояние, указывающее, где находится возможность в процессе запроса.

Deadline
deadline date-time

Дата цели для возможности привести к подарку (например, "2020-09-18T04:13:56Z".

Дата спросить
ask_date date-time

Дата выполнения запроса (например, "2020-09-18T04:13:56Z").

value
value double

Денежное значение.

Ожидаемая дата
expected_date date-time

Дата, когда перспектива, как ожидается, даст ответ на возможность (например, "2020-09-18T04:13:56Z".

value
value double

Денежное значение.

Дата финансирования
funded_date date-time

Дата, когда перспектива дала ответ на возможность (например, "2020-09-18T04:13:56Z".

value
value double

Денежное значение.

Идентификатор кампании
campaign_id string

Системный идентификатор кампании, связанной с возможностью. Кампания задает общие цели для сбора денег.

Идентификатор фонда
fund_id string

Системный идентификатор фонда, связанного с возможностью. Фонд назначает конкретную финансовую цель подарка и определяет финансовую учетную запись для этого подарка.

Составной идентификатор
constituent_id string

Системный идентификатор компонента, связанного с сбором средств.

value
value double

Денежное значение.

Неактивный?
inactive boolean

Неактивна ли возможность?

Возвращаемое значение

Созданная возможность

Создание записи о согласии на создание компонента

Создает новую запись о согласии на создание компонента.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
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

Уведомление о конфиденциальности, предоставленное избирателю.

Возвращаемое значение

Созданное согласие на создание компонента

Создание кода для создания составного запроса

Создает новый составной код запроса.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
constituent_id True string

Системный идентификатор записи компонента, связанного с кодом запроса.

Код запроса
solicit_code True string

Инструкции по обмену данными и /или ограничения для составляющих.

Начальная дата
start_date date

Дата начала кода запроса (например, "2005-09-18").

Дата окончания
end_date date

Дата окончания кода запроса (например, "2005-09-18").

Возвращаемое значение

Созданный код для создания составного запроса

Создание компонента организации

Создает новую составную организацию.

Параметры

Имя Ключ Обязательно Тип Описание
Имя
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

Соответствующие подарочные заметки для составляющих.

Возвращаемое значение

Созданная организация

Создание назначения сборов средств

Создает новое назначение сборов средств.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сборов средств
fundraiser_id True string

Системный идентификатор сборов средств.

Составной идентификатор
constituent_id True string

Идентификатор системной записи назначенного компонента.

Тип
type string

Тип сборов средств.

Начало назначения
start date-time

Дата начала назначения.

Окончание назначения
end date-time

Дата окончания назначения.

Сумма
value True double

Сумма цели для сборов средств, чтобы запрашивать от назначенного избирателя.

Идентификатор кампании
campaign_id string

Системный идентификатор кампании, к которой будут применены полученные подарки.

Идентификатор фонда
fund_id string

Системный идентификатор фонда, к которому будут применены полученные подарки.

Идентификатор апелляции
appeal_id string

Системный идентификатор обращения, к которому будут применены полученные подарки.

Возвращаемое значение

Создание назначения сборов средств

Создание настраиваемого поля возможности

Создает новое настраиваемое поле возможности.

Параметры

Имя Ключ Обязательно Тип Описание
body
body True dynamic

Объект, представляющий настраиваемое поле для создания.

Возвращаемое значение

Создание вложения возможностей

Создание настраиваемого поля действия

Создает настраиваемое поле действия.

Параметры

Имя Ключ Обязательно Тип Описание
body
body True dynamic

Объект, представляющий настраиваемое поле для создания.

Возвращаемое значение

Созданное настраиваемое поле действия

Создание настраиваемого поля для привлекательности

Создает новое настраиваемое поле привлекательности.

Параметры

Имя Ключ Обязательно Тип Описание
body
body True dynamic

Объект, представляющий настраиваемое поле для создания.

Возвращаемое значение

Созданное настраиваемое поле для обращения

Создание настраиваемого поля кампании

Создает настраиваемое поле кампании.

Параметры

Имя Ключ Обязательно Тип Описание
body
body True dynamic

Объект, представляющий настраиваемое поле для создания.

Возвращаемое значение

Созданное настраиваемое поле кампании

Создание настраиваемого поля подарка

Создает новое настраиваемое поле подарка.

Параметры

Имя Ключ Обязательно Тип Описание
body
body True dynamic

Объект, представляющий настраиваемое поле для создания.

Возвращаемое значение

Созданное настраиваемое поле подарка

Создание настраиваемого поля фонда

Создает настраиваемое поле фонда.

Параметры

Имя Ключ Обязательно Тип Описание
body
body True dynamic

Объект, представляющий настраиваемое поле для создания.

Возвращаемое значение

Созданное настраиваемое поле фонда

Создание оплаты за участие

Создает новый платеж за участника.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор участника
participant_id True string

Системный идентификатор записи участника.

Идентификатор подарка
gift_id True string

Идентификатор записи systetm для подарка, к которому связана плата участника.

Примененная сумма
applied_amount True double

Сумма платежа, применяемого к сбору участников.

Возвращаемое значение

Созданный платеж за участие

Создание отдельного компонента

Создает новый отдельный компонент.

Параметры

Имя Ключ Обязательно Тип Описание
Название
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.

Возвращаемое значение

Создано отдельное составляющие

Создание отдельной связи

Создает новую отдельную связь. Если отношения связаны с другим компонентом, для этого компонента создается взаимная связь.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
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

Дополнительные заметки о связи.

Возвращаемое значение

Созданная отдельная связь

Создание пакета подарков

Создает новый пакет подарков.

Параметры

Имя Ключ Обязательно Тип Описание
Description
batch_description string

Описание пакета.

Ожидаемое число
expected_number integer

Количество подарков, ожидаемых в пакете.

Ожидаемый итог
expected_batch_total double

Общее значение подарков в пакете.

Номер пакета
batch_number string

Уникальный идентификатор, характерный для пакета.

Возвращаемое значение

Создан пакет подарков

Создание параметра участника

Создает новый параметр участника.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор участника
participant_id True string

Идентификатор участника.

body
body True dynamic

Объект, представляющий параметр участника для создания.

Возвращаемое значение

Параметр "Созданный участник"

Создание параметра участника события

Создает новый параметр участника для события.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор события
event_id True string

Идентификатор события.

Имя
name True string

Имя параметра участника события.

Тип входных данных
input_type True string

Типы участников значений могут использовать для предоставления ответов.

Разрешить выбор нескольких вариантов?
multi_select boolean

Разрешить несколько значений для списков?

имя
name string

Имя параметра списка.

последовательность
sequence integer

Последовательность на основе 0, используемая для упорядочивания.

Возвращаемое значение

Параметр "Созданный участник события"

Создание платы за событие

Создает новую плату за событие.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор события
event_id True string

Идентификатор системной записи события.

Имя
name True string

Имя платы.

Сумма платы
cost True double

Сумма денег, связанных с сбором.

Сумма вклада
contribution_amount True double

Сумма платы, которая является пожертвованием выше расходов на событие.

Возвращаемое значение

Созданная плата за событие

Создание платы за участника

Создает новую плату для участника.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор участника
participant_id True string

Системный идентификатор записи участника.

Идентификатор события
event_id True string

Идентификатор системной записи события.

Плата
event_fee_id True string

Плата за событие.

Количество
quantity True integer

Количество приобретенных.

Сумма платы
fee_amount True double

Сумма денег, связанных с сбором.

Сумма вклада
contribution_amount True double

Сумма платы, которая является пожертвованием выше расходов на событие. Это сумма, которая обычно отображается в квитанциях.

day
d integer

День в нечеткой дате.

month
m integer

Месяц в нечеткой дате.

год
y integer

Год в нечеткой дате.

Возвращаемое значение

Созданная плата за участника

Создание подарка

Создает новый подарок.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
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").

Возвращаемое значение

Созданный подарок

Создание пожертвования участника

Создает новое пожертвование для участника.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор участника
participant_id True string

Системный идентификатор записи участника.

Идентификатор подарка
gift_id True string

Идентификатор записи systetm подарка, к которому связан пожертвование участника.

Возвращаемое значение

Созданное пожертвование участника

Создание расположения документа

Создает новый уникальный идентификатор документа и расположение отправки для использования с физическими вложениями. Ответ будет содержать инструкции по тому, где и как отправить содержимое документа.

Параметры

Имя Ключ Обязательно Тип Описание
Имя файла
file_name string

Имя файла для отправки документа.

Включить эскиз?
upload_thumbnail boolean

Включите расположение эскиза документа?

Возвращаемое значение

Определение файла

Создание связи организации

Создает связь организации. Если отношения связаны с другим компонентом, для этого компонента создается взаимная связь.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
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

Дополнительные заметки о связи.

Возвращаемое значение

Созданная связь организации

Создание события

Создает новое событие.

Параметры

Имя Ключ Обязательно Тип Описание
Имя события
name True string

Название мероприятия.

Description
description string

Описание события.

Категория
name True string

Имя категории.

Начальная дата
start_date True date

Дата начала события (например, "2020-09-18").

Время запуска
start_time string

Время начала события (например, "07:30".

Дата окончания
end_date date

Дата окончания события (например, "2020-09-18").

Время окончания
end_time string

Время окончания события (например, "07:30)".

Идентификатор подстановки
lookup_id string

Идентификатор подстановки события.

Capacity
capacity integer

Количество людей, которые могут присутствовать на мероприятии.

Цель
goal double

Денежные цели события.

Идентификатор кампании
campaign_id string

Системный идентификатор записи кампании, связанной с событием.

Идентификатор фонда
fund_id string

Системный идентификатор фонда, связанного с событием.

Неактивный?
inactive boolean

Активен ли событие?

Возвращаемое значение

Созданное событие

Создание составляющих онлайн-присутствия

Создает новое составное онлайн-присутствие.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
constituent_id True string

Системный идентификатор записи компонента, связанного с присутствием в Интернете.

Тип
type True string

Тип присутствия в Интернете.

Link
address True string

Веб-адрес для присутствия в Интернете.

Первичный?
primary boolean

Это основное онлайн-присутствие составляющих?

Неактивный?
inactive boolean

Неактивно ли это присутствие в Интернете?

Возвращаемое значение

Создание составляющих онлайн-присутствия

Создание составного адреса

Создает новый составной адрес.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
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

Год в нечеткой дате.

Возвращаемое значение

Созданный составной адрес

Создание составного адреса электронной почты

Создает новый составной адрес электронной почты.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
constituent_id True string

Системный идентификатор записи компонента, связанного с адресом электронной почты.

Тип электронной почты
type True string

Тип адреса электронной почты.

Адрес электронной почты
address True string

Адрес электронной почты.

Первичный?
primary boolean

Это основной адрес электронной почты компонента?

Не отправлять сообщения электронной почты?
do_not_email boolean

Можно ли связаться с компонентами по этому адресу электронной почты?

Неактивный?
inactive boolean

Неактивен ли адрес электронной почты?

Возвращаемое значение

Созданный составной адрес электронной почты

Создание составного вложения

Создает новое составное вложение.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
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. Только для физических вложений.

Возвращаемое значение

Созданное составное вложение

Создание составного действия

Создает новое составное действие.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
constituent_id True string

Системный идентификатор записи компонента, связанного с действием.

Категория
category True string

Канал или намерение составного взаимодействия.

Завершённый?
completed boolean

Завершено ли действие? Если система настроена для использования пользовательских состояний действий, это значение основано на значении состояния действия.

Дата завершения
completed_date date-time

Дата завершения действия (например, "2020-09-18T04:13:56Z").

Date
date True date-time

Дата действия (например, '2020-09-18T04:13:56Z').

Замечание
description string

Подробное объяснение, подробное описание сводки действий.

Направление
direction string

Направление действия.

Сбор средств
fundraisers array of string

Набор идентификаторов системных записей для сборщиков средств, связанных с действием.

Местоположение
location string

Расположение действия.

Идентификатор возможности
opportunity_id string

Идентификатор системной записи возможности, связанной с действием.

Результат
outcome string

Результат действия.

Priority
priority string

Приоритет действия.

Время запуска
start_time string

Время начала действия. Используется 24-часовое время в формате HH:mm.

Время окончания
end_time string

Время окончания действия. Используется 24-часовое время в формате HH:mm.

Состояние
status string

Состояние действия.

Сводка
summary string

Краткое описание действия, которое отображается в верхней части записи. Ограничение символов: 255.

Тип
type string

Дополнительное описание действия для дополнения категории.

Возвращаемое значение

Созданное действие

Создание составного кода

Создает новый составной код.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
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

Числовая последовательность, связанная с составным кодом.

Возвращаемое значение

Созданный составной код

Создание составного настраиваемого поля

Создает новое составное настраиваемое поле.

Параметры

Имя Ключ Обязательно Тип Описание
body
body True dynamic

Объект, представляющий настраиваемое поле для создания.

Возвращаемое значение

Созданное настраиваемое поле

Создание составного образования

Создает новое составное образование.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
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.

Возвращаемое значение

Создание составного образования

Создание составного псевдонима

Создает новый составной псевдоним.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
constituent_id True string

Системный идентификатор записи компонента, связанного с псевдонимом.

Псевдоним
name True string

Имя, используемое в качестве псевдонима компонента. Ограничение символов: 100.

Тип
type string

Тип псевдонима.

Возвращаемое значение

Созданный псевдоним компонентов

Создание составного телефона

Создает новый составной телефон.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
constituent_id True string

Системный идентификатор записи компонента, связанного с телефоном.

Тип
type True string

Тип телефона.

Number
number True string

Номер телефона.

Первичный?
primary boolean

Это основной телефон избирателя?

Не вызывайте?
do_not_call boolean

Можно ли связаться с компонентом по этому номеру?

Неактивный?
inactive boolean

Неактивен ли этот номер телефона?

Возвращаемое значение

Созданный составной телефон

Создание составной заметки

Создает новую составную заметку.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
constituent_id True string

Системный идентификатор записи компонента, связанного с примечанием.

Тип
type True string

Тип заметки.

day
d integer

День в нечеткой дате.

month
m integer

Месяц в нечеткой дате.

год
y integer

Год в нечеткой дате.

Сводка
summary string

Сводка по заметкам. Ограничение символов: 50.

Замечание
text string

Текст заметки.

Возвращаемое значение

Созданная составная заметка

Создание составной оценки

Создает новый составной рейтинг.

Параметры

Имя Ключ Обязательно Тип Описание
body
body True dynamic

Объект, представляющий создаваемый рейтинг.

Возвращаемое значение

Созданная оценка компонентов

Создание списка из набора записей

Создает список, отфильтрованный по указанному набору записей.

Параметры

Имя Ключ Обязательно Тип Описание
Имя
name True string

Имя списка. Ограничение символов: 50.

Description
description True string

Описание списка.

Тип списка
list_type True string

Определяет тип создаваемого списка.

Permissions
list_permissions True string

Определяет, могут ли другие пользователи получить доступ к списку.

Идентификаторы
ids True array of string

Уникальные идентификаторы записей, содержащихся в списке (максимум 100 000 значений).

Возвращаемое значение

Создан список

Создание участника

Создает нового участника для события.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор события
event_id True string

Идентификатор системной записи события.

Составной идентификатор
constituent_id True string

Составляющий идентификатор участника.

Идентификатор узла
host_id string

Идентификатор записи участника узла.

Состояние RSVP
rsvp_status string

Состояние взаимодействия участника с событием.

Присутствовал?
attended boolean

Присутствовал ли участник на мероприятии?

Статус приглашения
invitation_status string

Состояние приглашения участнику.

day
d integer

День в нечеткой дате.

month
m integer

Месяц в нечеткой дате.

год
y integer

Год в нечеткой дате.

day
d integer

День в нечеткой дате.

month
m integer

Месяц в нечеткой дате.

год
y integer

Год в нечеткой дате.

Уровень участия
name True string

Имя уровня участия.

Возвращаемое значение

Созданный участник

Список возможностей

Возвращает список возможностей.

Параметры

Имя Ключ Обязательно Тип Описание
List
list_id string

Определяет идентификатор списка, используемый для фильтрации набора возможностей, включенных в указанный список. Если это значение задано, другие указанные фильтры будут игнорироваться.

Составной идентификатор
constituent_id string

Представляет разделенный запятыми список составляющих идентификаторов для фильтрации результатов. Например, "280,1232" возвращает только возможности от составляющих 280 или составляющих 1232.

Лимит
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").

Возвращаемое значение

Возможности

Список кампаний

Возвращает список кампаний.

Параметры

Имя Ключ Обязательно Тип Описание
Лимит
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").

Возвращаемое значение

Кампании

Список настраиваемых полей действия

Выводит настраиваемые поля для действия.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор действия
action_id True string

Идентификатор системной записи действия.

Возвращаемое значение

Пользовательские поля

Список параметров участника

Выводит список параметров участника.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор участника
participant_id True string

Системный идентификатор записи участника.

Возвращаемое значение

Параметры участника

Список подарков

Возвращает список подарков.

Параметры

Имя Ключ Обязательно Тип Описание
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.

Добавлен или после
date_added date-time

Отфильтруйте результаты по подаркам, созданным по указанной дате (например, "2020-09-18T04:13:56Z").

Изменено или после
last_modified date-time

Отфильтруйте результаты до подарков, измененных по указанной дате (например, "2020-09-18T04:13:56Z").

Возвращаемое значение

Подарки

Список событий

Возвращает список событий.

Параметры

Имя Ключ Обязательно Тип Описание
Категория
category string

Фильтрация на основе категории событий.

Дата начала с
start_date_from date

Отфильтруйте результаты до событий с датой начала или после указанной даты (например, "2020-09-18").

Дата начала
start_date_to date

Отфильтруйте результаты до событий с датой начала или до указанной даты (например, "2020-09-18").

Включить неактивное?
include_inactive boolean

Включить неактивные события?

Лимит
limit integer

Представляет количество возвращаемых записей. Значение по умолчанию — 500. Максимальное значение — 10000.

Смещение
offset integer

Представляет количество пропускаемых записей. Для использования с разбивкой на страницы.

Идентификатор события
event_id string

Отфильтруйте события, соответствующие указанному идентификатору системной записи.

Имя
name string

Фильтруйте события, соответствующие указанному имени.

Добавлен или после
date_added date-time

Отфильтруйте результаты по событиям, созданным по указанной дате (например, "2020-09-18T04:13:56Z").

Изменено или после
last_modified date-time

Отфильтруйте результаты до событий, измененных по указанной дате (например, "2020-09-18T04:13:56Z").

Возвращаемое значение

Events

Список составных кодов запроса

Перечисляет коды запроса для составляющих.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
constituent_id True string

Системный идентификатор записи компонента.

Возвращаемое значение

Коды запроса

Удаление составного кода

Удаляет составной код.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор составного кода
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

Расположение действия.

Идентификатор возможности
opportunity_id 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.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.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.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.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.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.ProspectStatusRead

Состояние перспективы

Имя Путь Тип Описание
Состояние
status string

Текущее состояние перспективы избирателя.

Дни истекли
days_elapsed integer

Общее количество дней в текущем состоянии перспективы на основе даты начала.

Начальная дата
start date-time

Дата начала состояния перспективы.

Comments
comments string

Комментарии о состоянии перспективы.

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

Умер ли компонент?

Адрес электронной почты
email string

Адрес электронной почты избирателя.

Состояние сборов средств
fundraiser_status string

Статус сборов средств избирателя. Для отдельных лиц это вычисляемое поле указывает, является ли компонент активным, неактивным или нет. Для организаций это значение всегда будет равно None.

Неактивный?
inactive boolean

Неактивен ли компонент?

Идентификатор подстановки
lookup_id string

Определяемый пользователем идентификатор для компонента.

EventApi.AdministrativeArea

Определяет модель данных, используемую для административной области адреса (например, штат в США).

Имя Путь Тип Описание
Идентификатор
id string

Идентификатор записи административной области.

имя
name string

Имя административной области.

краткое описание
short_description string

Краткое описание административной области.

EventApi.ApiCollectionOfEventFee

Оплата

Имя Путь Тип Описание
Численность
count integer

Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений.

value
value array of EventApi.EventFee

Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции.

EventApi.ApiCollectionOfEventListEntry

Events

Имя Путь Тип Описание
Численность
count integer

Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений.

value
value array of EventApi.EventListEntry

Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции.

EventApi.ApiCollectionOfEventParticipantOption

Параметры участника события

Имя Путь Тип Описание
Численность
count integer

Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений.

value
value array of EventApi.EventParticipantOption

Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции.

EventApi.ApiCollectionOfParticipantDonation

Пожертвования

Имя Путь Тип Описание
Численность
count integer

Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений.

value
value array of EventApi.ParticipantDonation

Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции.

EventApi.ApiCollectionOfParticipantFee

Оплата

Имя Путь Тип Описание
Численность
count integer

Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений.

value
value array of EventApi.ParticipantFee

Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции.

EventApi.ApiCollectionOfParticipantFeePayment

Платежи за плату

Имя Путь Тип Описание
Численность
count integer

Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений.

value
value array of EventApi.ParticipantFeePayment

Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции.

EventApi.ApiCollectionOfParticipantListEntry

Участники

Имя Путь Тип Описание
Численность
count integer

Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений.

value
value array of EventApi.ParticipantListEntry

Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции.

EventApi.ApiCollectionOfParticipantOption

Параметры участника

Имя Путь Тип Описание
Численность
count integer

Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений.

value
value array of EventApi.ParticipantOption

Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции.

EventApi.Country

Определяет модель данных, используемую для страны адреса.

Имя Путь Тип Описание
Идентификатор
id string

Идентификатор записи страны.

отображаемое имя
display_name string

Отображаемое имя страны.

ISO-код
iso_alpha2_code string

Код ISO 3166-1 alpha-2 для страны.

EventApi.CreatedEvent

Созданное событие

Имя Путь Тип Описание
Идентификатор
id string

Идентификатор только что созданного события.

EventApi.CreatedEventFee

Созданная плата за событие

Имя Путь Тип Описание
Идентификатор
id string

Идентификатор только что созданной платы за событие.

EventApi.CreatedEventParticipantOption

Параметр "Созданный участник события"

Имя Путь Тип Описание
Идентификатор
id string

Идентификатор только что созданного параметра участника события.

EventApi.CreatedParticipant

Созданный участник

Имя Путь Тип Описание
Идентификатор
id string

Идентификатор только что созданного участника.

EventApi.CreatedParticipantDonation

Созданное пожертвование участника

Имя Путь Тип Описание
Идентификатор
id string

Идентификатор только что созданного пожертвования участника.

EventApi.CreatedParticipantFee

Созданная плата за участника

Имя Путь Тип Описание
Идентификатор
id string

Идентификатор только что созданной платы участника.

EventApi.CreatedParticipantFeePayment

Созданный платеж за участие

Имя Путь Тип Описание
Идентификатор
id string

Идентификатор только что созданного платежа за участника.

EventApi.CreatedParticipantOption

Параметр "Созданный участник"

Имя Путь Тип Описание
Идентификатор
id string

Идентификатор только что созданного параметра участника.

EventApi.Event

Event

Имя Путь Тип Описание
Идентификатор
id string

Идентификатор системной записи события. Это не то же самое, что и идентификатор события, определяемый пользователем, который хранится в lookup_id.

Имя
name string

Название мероприятия.

Description
description string

Описание события.

Начальная дата
start_date date

Дата начала события.

Время запуска
start_time string

Время начала события.

Дата окончания
end_date date

Дата окончания события.

Время окончания
end_time string

Время окончания события.

Категория
category EventApi.EventCategory

Категория событий — это настраиваемая классификация для события.

Идентификатор подстановки
lookup_id string

Идентификатор подстановки события.

Местоположение
location EventApi.Location

Определяет модель данных, используемую для расположения.

Capacity
capacity integer

Количество людей, которые могут присутствовать на мероприятии.

Цель
goal double

Денежные цели события.

Идентификатор кампании
campaign_id string

Системный идентификатор записи кампании, связанной с событием.

Идентификатор фонда
fund_id string

Системный идентификатор фонда, связанного с событием.

Неактивный?
inactive boolean

Неактивен ли событие?

Дата добавления
date_added date-time

Дата создания события.

Дата изменения
date_modified date-time

Дата последнего изменения события.

EventApi.EventCategory

Категория событий — это настраиваемая классификация для события.

Имя Путь Тип Описание
Идентификатор
id string

Системный идентификатор записи категории событий.

имя
name string

Имя категории событий.

неактивный?
inactive boolean

Неактивна ли эта категория?

EventApi.EventFee

Плата за мероприятия — это плата за участие или участие в мероприятии в организации для отдельных лиц или организаций.

Имя Путь Тип Описание
Идентификатор
id string

Системный идентификатор платы за событие.

имя
name string

Имя платы за событие.

количество
cost double

Стоимость платы.

Сумма вклада
contribution_amount double

Налог вычитаемой суммы за эту плату.

число продано
number_sold integer

Количество проданных сборов.

EventApi.EventListEntry

Event

Имя Путь Тип Описание
Идентификатор
id string

Идентификатор системной записи события.

Имя
name string

Название мероприятия.

Начальная дата
start_date date

Дата начала события.

Время запуска
start_time string

Время начала события.

Дата окончания
end_date date

Дата окончания события.

Время окончания
end_time string

Время окончания события.

Категория
category EventApi.EventCategory

Категория событий — это настраиваемая классификация для события.

Идентификатор подстановки
lookup_id string

Идентификатор подстановки события.

Capacity
capacity integer

Количество людей, которые могут присутствовать на мероприятии.

Посещать
attending_count integer

Количество участников мероприятия, которые планируют принять участие.

С сопровождением
attended_count integer

Количество участников событий.

Званый
invited_count integer

Количество приглашений на событие.

Доход
revenue double

Доход от мероприятия.

Цель
goal double

Денежные цели события.

Процент цели
percent_of_goal integer

Доход от реализации в процентах от целевой выручки.

Неактивный?
inactive boolean

Неактивен ли событие?

Дата добавления
date_added date-time

Дата создания события.

Дата изменения
date_modified date-time

Дата последнего изменения события.

EventApi.EventParticipantOption

Параметры участника события — это поля, которые собирают сведения о участниках, таких как размер футболки, предпочтения питания или запросы на сидение. Задайте параметры и их значения для события, а затем добавьте ответы для каждого участника.

Имя Путь Тип Описание
Идентификатор
id string

Идентификатор системной записи параметра участника события.

имя
name string

Имя параметра участника события.

тип входных данных
input_type string

Тип параметра участника события.

разрешить выбор нескольких вариантов?
multi_select boolean

Разрешить несколько значений для списков?

list_options
list_options array of EventApi.EventParticipantOptionListOption

Доступные параметры списка.

добавлен пользователем
added_by_user string

Идентификатор пользователя, добавляющего этот параметр.

изменено пользователем
updated_by_user string

Идентификатор пользователя, изменившего параметр.

добавлено службой
added_by_service string

Имя службы, которая добавила этот параметр.

изменено службой
updated_by_service string

Имя службы, которая изменила этот параметр.

Добавлено
date_added date-time

Дата создания параметра.

дата изменения
date_updated date-time

Дата последнего изменения параметра.

version
version integer

Номер версии параметра.

EventApi.EventParticipantOptionListOption

Параметр списка параметров участника события

Имя Путь Тип Описание
Идентификатор
id string

Идентификатор параметра списка

имя
name string

Имя параметра списка

последовательность
sequence integer

Последовательность, используемая для упорядочивания параметров списка

EventApi.Locality

Определяет модель данных, используемую для локальности адреса.

Имя Путь Тип Описание
Идентификатор
id string

Идентификатор записи локальности.

имя
name string

Имя локальности.

EventApi.Location

Определяет модель данных, используемую для расположения.

Имя Путь Тип Описание
имя
name string

Имя расположения.

линии адресов
address_lines string

Адресные строки расположения.

почтовый индекс
postal_code string

Почтовый индекс расположения.

местность
locality EventApi.Locality

Определяет модель данных, используемую для локальности адреса.

административная область
administrative_area EventApi.AdministrativeArea

Определяет модель данных, используемую для административной области адреса (например, штат в США).

вложенная административная область
sub_administrative_area EventApi.SubAdministrativeArea

Определяет модель данных, используемую для подадминиционной области адреса (например, город в США).

country
country EventApi.Country

Определяет модель данных, используемую для страны адреса.

отформатированный адрес
formatted_address string

Форматированный адрес расположения

EventApi.Membership

Сведения о членстве для участника.

Имя Путь Тип Описание
Категория членства
category EventApi.MembershipCategory

Категория членства человека.

EventApi.MembershipCategory

Категория членства человека.

Имя Путь Тип Описание
Идентификатор
id string

Идентификатор системной записи категории членства.

имя
name string

Имя категории членства.

EventApi.Participant

Участник

Имя Путь Тип Описание
Идентификатор
id string

Системный идентификатор записи участника.

Составной идентификатор
constituent_id string

Составляющий идентификатор участника.

Идентификатор события
event_id string

Системный идентификатор записи для посещаемого события.

Идентификатор узла
host_id string

Идентификатор записи участника узла.

Состояние RSVP
rsvp_status string

Состояние взаимодействия участника с событием.

Присутствовал?
attended boolean

Присутствовал ли участник на мероприятии?

Статус приглашения
invitation_status string

Состояние приглашения участнику.

day
rsvp_date.d integer

День в нечеткой дате.

month
rsvp_date.m integer

Месяц в нечеткой дате.

год
rsvp_date.y integer

Год в нечеткой дате.

day
invitation_date.d integer

День в нечеткой дате.

month
invitation_date.m integer

Месяц в нечеткой дате.

год
invitation_date.y integer

Год в нечеткой дате.

Уровень участия
participation_level EventApi.ParticipationLevel

Уровни участия — это уровень участия участников в событии.

Дата добавления
date_added date-time

Дата создания участника.

Дата изменения
date_modified date-time

Дата последнего изменения участника.

EventApi.ParticipantDonation

Определяет модель данных для пожертвования участника

Имя Путь Тип Описание
Идентификатор
id string

Системный идентификатор пожертвования участника.

Идентификатор подарка
gift_id string

Системный идентификатор записи подарка, к которому связан пожертвование участника.

EventApi.ParticipantFee

Определяет модель данных для оплаты участника

Имя Путь Тип Описание
Идентификатор
id string

Идентификатор платы участника.

Идентификатор участника
participant_id string

Идентификатор записи, с которым связана плата участника.

количество
quantity integer

Количество приобретенных.

Сумма сборов
fee_amount double

Сумма платы за участника.

Сумма вклада
tax_receiptable_amount double

Налог вычитаемой суммы за эту плату.

day
date.d integer

День в нечеткой дате.

month
date.m integer

Месяц в нечеткой дате.

год
date.y integer

Год в нечеткой дате.

Плата за событие
event_fee EventApi.EventFee

Плата за мероприятия — это плата за участие или участие в мероприятии в организации для отдельных лиц или организаций.

EventApi.ParticipantFeePayment

Определяет модель данных для оплаты платы участника

Имя Путь Тип Описание
Идентификатор
id string

Системный идентификатор оплаты оплаты за участие.

Идентификатор участника
participant_id string

Системный идентификатор записи участника, к которому связан платеж за плату участника.

Идентификатор подарка
gift_id string

Системный идентификатор подарка, к которому связан платеж за плату участника.

примененная сумма
applied_amount double

Примененная сумма оплаты за участие.

EventApi.ParticipantListEntry

Участник

Имя Путь Тип Описание
Идентификатор
id string

Системный идентификатор записи участника.

Код контактного лица
contact_id string

Идентификатор контакта, посещающего событие.

Состояние RSVP
rsvp_status string

Состояние взаимодействия участника с событием.

Присутствовал?
attended boolean

Присутствовал ли участник на мероприятии?

Статус приглашения
invitation_status string

Состояние приглашения участнику.

day
rsvp_date.d integer

День в нечеткой дате.

month
rsvp_date.m integer

Месяц в нечеткой дате.

год
rsvp_date.y integer

Год в нечеткой дате.

Уровень участия
participation_level EventApi.ParticipationLevel

Уровни участия — это уровень участия участников в событии.

Название
title string

Заголовок участника.

Имя (первое имя)
first_name string

Имя участника.

Фамилия
last_name string

Фамилия участника.

Имя
name string

Полное имя участника.

Предпочтительное имя
preferred_name string

Предпочтительное имя участника.

Суффикс
suffix string

Суффикс участника.

Идентификатор подстановки
lookup_id string

LookupId участника.

Адрес электронной почты
email string

Адрес электронной почты участника.

Не отправлять сообщения электронной почты?
do_not_email boolean

Можно ли связаться с участником по этому адресу электронной почты?

Телефон
phone string

Номер телефона участника.

Не вызывайте?
do_not_call boolean

Можно ли связаться с участником по этому номеру?

Отчество/второе имя
middle_name string

По промежуточному имени участника.

Прежнее имя
former_name string

Прежнее имя участника.

Является ли составной?
is_constituent boolean

Является ли участник составляющим?

Класс
class_of string

Выпускной класс участника.

Общая плата за регистрацию
total_registration_fees double

Сумма суммы платы участника.

Всего оплачено
total_paid double

Сумма платных подарков участника с типом сборов за регистрацию.

Сиденье
seat string

Назначение места для участника.

Тег имени
name_tag string

Тег имени участника

Дата добавления
date_added date-time

Дата создания участника.

Дата изменения
date_modified date-time

Дата последнего изменения участника.

Идентификатор контакта
host.contact_id string

Идентификатор контакта, посещающего событие.

Идентификатор участника
host.participant_id string

Идентификатор участника.

имя
host.name string

Полное имя участника.

Гости
guests array of EventApi.ParticipantListParticipantSummary

Гости участника.

Членство
memberships array of EventApi.Membership

Сведения о членстве для участника.

EventApi.ParticipantListParticipantSummary

Основные сведения о участниках.

Имя Путь Тип Описание
Идентификатор контакта
contact_id string

Идентификатор контакта, посещающего событие.

Идентификатор участника
participant_id string

Идентификатор участника.

имя
name string

Полное имя участника.

EventApi.ParticipantOption

Параметр участника, связанный с заданным участником

Имя Путь Тип Описание
Идентификатор
id string

Идентификатор системной записи параметра участника.

Идентификатор участника
participant_id string

Системный идентификатор записи участника.

Идентификатор события
event_id string

Идентификатор системной записи события.

Идентификатор параметра участника события
event_participant_option_id string

Идентификатор системной записи параметра участника события.

value
option_value string

Ответ участника на параметр.

добавлен пользователем
added_by_user string

Идентификатор пользователя, добавляющего параметр участника.

изменено пользователем
updated_by_user string

Идентификатор пользователя, изменившего параметр участника.

добавлено службой
added_by_service string

Имя службы, которая добавила этот параметр участника.

изменено службой
updated_by_service string

Имя службы, изменив этот параметр участника.

Добавлено
date_added date-time

Дата создания параметра участника.

дата изменения
date_updated date-time

Дата последнего изменения параметра участника.

EventApi.ParticipationLevel

Уровни участия — это уровень участия участников в событии.

Имя Путь Тип Описание
Идентификатор
id string

Идентификатор системной записи уровня участия.

имя
name string

Имя уровня участия.

неактивный?
is_inactive boolean

Неактивен ли уровень участия?

EventApi.SubAdministrativeArea

Определяет модель данных, используемую для подадминиционной области адреса (например, город в США).

Имя Путь Тип Описание
Идентификатор
id string

Идентификатор подадминистрирования.

имя
name string

Имя подадминистрирования.

Сбор средств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.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.ReceiptRead

Приход

Имя Путь Тип Описание
value
amount.value double

Денежное значение.

date
date date-time

Дата получения.

число/номер
number integer

Номер квитанции.

статус
status string

Состояние квитанции. Доступные значения: RECEIPTED, NEEDSRECEIPT и DONOTRECEIPT.

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

Идентификатор только что созданного списка.

OpportunityApi.ApiCollectionOfOpportunityAttachmentRead

Attachments

Имя Путь Тип Описание
Численность
count integer

Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений.

value
value array of OpportunityApi.OpportunityAttachmentRead

Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции.

OpportunityApi.ApiCollectionOfOpportunityCustomFieldRead

Пользовательские поля

Имя Путь Тип Описание
Численность
count integer

Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений.

value
value array of OpportunityApi.OpportunityCustomFieldRead

Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции.

OpportunityApi.ApiCollectionOfOpportunityRead

Возможности

Имя Путь Тип Описание
Численность
count integer

Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений.

value
value array of OpportunityApi.OpportunityRead

Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции.

OpportunityApi.CreatedOpportunity

Созданная возможность

Имя Путь Тип Описание
Идентификатор
id string

Идентификатор только что созданной возможности.

OpportunityApi.CreatedOpportunityAttachment

Создание вложения возможностей

Имя Путь Тип Описание
Идентификатор
id string

Идентификатор только что созданного вложения возможностей.

OpportunityApi.CreatedOpportunityCustomField

Создание вложения возможностей

Имя Путь Тип Описание
Идентификатор
id string

Идентификатор только что созданного вложения возможностей.

OpportunityApi.Fundraiser

Сбор средств

Имя Путь Тип Описание
Составной идентификатор
constituent_id string

Системный идентификатор компонента, связанного с сбором средств.

value
credit_amount.value double

Денежное значение.

OpportunityApi.OpportunityAttachmentRead

Вложение

Имя Путь Тип Описание
Идентификатор
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

Размер файла в байтах. Только для физических вложений.

OpportunityApi.OpportunityCustomFieldRead

Настраиваемое поле

Имя Путь Тип Описание
Идентификатор
id string

Идентификатор системной записи настраиваемого поля.

Идентификатор возможности
parent_id string

Идентификатор системной записи возможности, связанной с настраиваемым полем.

Категория
category string

Категория настраиваемого поля.

Тип
type string

Тип данных, которые представляет настраиваемое поле.

Ценность
value

Значение настраиваемого поля.

Date
date date

Дата настраиваемого поля.

Комментарий
comment string

Комментарий к пользовательскому полю. Ограничение символов: 50.

Дата добавления
date_added date-time

Дата создания настраиваемого поля.

Дата изменения
date_modified date-time

Дата последнего изменения настраиваемого поля.

OpportunityApi.OpportunityRead

Возможность

Имя Путь Тип Описание
Идентификатор
id string

Идентификатор системной записи возможности.

Составной идентификатор
constituent_id string

Системный идентификатор записи компонента, связанного с возможностью.

Цель
purpose string

Предполагаемое использование для любых денег, поднятых в результате возможности.

Имя
name string

Имя, определяющее возможность всей программы, например в списках или на составляющих записях. Ограничение символов: 255.

Состояние
status string

Состояние, указывающее, где находится возможность в процессе запроса.

Deadline
deadline date-time

Дата цели для возможности привести к подарку.

Дата спросить
ask_date date-time

Дата создания запроса.

value
ask_amount.value double

Денежное значение.

Ожидаемая дата
expected_date date-time

Дата, когда перспектива, как ожидается, даст ответ на возможность.

value
expected_amount.value double

Денежное значение.

Дата финансирования
funded_date date-time

Дата, когда перспектива дала ответ на эту возможность.

value
funded_amount.value double

Денежное значение.

Идентификатор кампании
campaign_id string

Системный идентификатор кампании, связанной с возможностью. Кампания задает общие цели для сбора денег.

Идентификатор фонда
fund_id string

Системный идентификатор фонда, связанного с возможностью. Фонд назначает конкретную финансовую цель подарка и определяет финансовую учетную запись для этого подарка.

Сбор средств
fundraisers array of OpportunityApi.Fundraiser

Набор системных идентификаторов записей для сборщиков средств, назначенных возможности.

Неактивный?
inactive boolean

Неактивна ли возможность?

linked_gifts
linked_gifts array of string

Системные идентификаторы подарков, связанных с возможностью.

Дата добавления
date_added date-time

Дата создания возможности.

Дата изменения
date_modified date-time

Дата последнего изменения возможности.