Blackbaud Raisers Edge NXT Составляющие

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

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

Услуга	Class	Регионы
Copilot Studio	Премия	Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD)
Логические приложения	Стандарт	Все регионы Logic Apps , кроме следующих: — Регионы Azure для государственных организаций — Регионы Azure Для Китая - Министерство обороны США (DoD)
Power Apps	-	Недоступно
Power Automate	Премия	Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD)

Контакт
Имя	Поддержка Blackbaud
URL	https://www.blackbaud.com/support
Адрес электронной почты	skyapi@blackbaud.com

Метаданные соединителя
Publisher	Blackbaud, Inc.
Веб-сайт	https://www.blackbaud.com/products/blackbaud-raisers-edge-nxt
Политика конфиденциальности	https://www.blackbaud.com/privacy-shield
Категории	Продажи и CRM; Продуктивность

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

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

Составляющих
Адреса
Телефоны и сообщения электронной почты
Aliases
Пользовательские поля
Примечания.
Attachments
Отношения
и другие...

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

Предпосылки

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

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

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

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

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

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

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

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

Действия

Вывод списка настраиваемых полей	Перечисляет настраиваемые поля для составляющих.
Обновление кода для составного запроса	Обновляет составной код запроса.
Обновление компонента	Обновляет составную часть.
Обновление компонента присутствия в Интернете	Обновляет составное онлайн-присутствие.
Обновление основного формата имени	Обновляет основной формат имени для составного элемента.
Обновление рисунка составного профиля	Обновляет текущую фотографию профиля для составной части.
Обновление составного адреса	Обновляет составной адрес.
Обновление составного адреса электронной почты	Обновляет составной адрес электронной почты.
Обновление составного вложения	Обновляет составное вложение.
Обновление составного кода	Обновляет составной код.
Обновление составного настраиваемого поля	Обновляет составное настраиваемое поле.
Обновление составного образования	Обновляет составное образование.
Обновление составного псевдонима	Обновляет составной псевдоним.
Обновление составного телефона	Обновляет составной телефон.
Обновление составной заметки	Обновляет составную заметку.
Обновление составной связи	Обновляет связь для составляющих. Если существует взаимная связь, она также изменяется, чтобы отразить изменения. Это не включает изменения в свойство "комментарии", которое относится к каждой записи и может быть изменено независимо от каждой записи.
Обновление формата составного имени	Обновляет формат составного имени.
Перечисление записей о согласии компонентов	Перечисляет записи согласия для составной части.
Перечисление назначений сборов средств	Выведите список назначений для сборщика средств.
Перечисление подтверждений дани	Перечисляет признания за дань.
Перечисление составляющих	Возвращает список составляющих.
Перечисление составляющих адресов	Перечисляет адреса для составной части.
Перечисление составляющих адресов электронной почты	Перечисляет адреса электронной почты для составляющих.
Перечисление составляющих вложений	Перечисляет вложения для составного компонента.
Перечисление составляющих дань	Перечисляет дань для избирателя.
Перечисление составляющих образования	Список записей образования для составляющих.
Перечисление составляющих онлайн-присутствия	Перечисляет сведения о присутствии в Интернете для составляющих.
Перечисление составляющих примечаний	Перечисляет заметки для составного компонента.
Перечисление составляющих сбор средств	Выводит список назначений сборов средств для составляющих.
Перечисление составляющих связей	Выводит список связей для составляющих.
Перечисление составляющих телефонов	Перечисляет телефоны для составляющих.
Перечисление составных кодов	Перечисляет составные коды для составляющих.
Перечисление составных псевдонимов	Перечисляет псевдонимы для составляющих.
Перечисление составных членов	Перечисляет членства для составной части.
Поиск повторяющихся компонентов	Выполняет поиск отдельных, организационных и связанных записей контактов и ранжирует потенциальные дубликаты на основе указанных фильтров поиска. Записи, соответствующие нескольким фильтрам, ранжируются выше в качестве потенциальных дубликатов.
Поиск составляющих	Выполняет составной поиск на основе предоставленного текста поиска. Поддерживает имя, фамилию, предпочтительное имя, прежнее имя, псевдоним, адрес электронной почты, номер телефона, адрес или идентификатор подстановки. Допустимы такие сочетания имен, как имя и фамилия или предпочтительное имя и фамилия, но в противном случае поиск поддерживает только один параметр одновременно. По умолчанию поиски включают результаты, аналогичные вашим критериям. Например, поиски "Смит" включают совпадения для "Smyth" и других альтернативных орфографических выражений. Этот поиск не поддерживает подстановочные знаки, такие как * или ?. Результаты поиска ограничены 500 записями.
Поиск составляющих (расширенных)	Выполняет поиск составляющих записей с помощью заданных критериев фильтра.
Получение изображения составляющих профилей	Возвращает текущее изображение профиля для компонента.
Получение компонента по идентификатору подстановки	Возвращает системный идентификатор системной записи компонента из указанного идентификатора подстановки.
Получение сводки по формату составных имен	Возвращает сводку по формату имени для составной части.
Получение составляющих	Возвращает сведения об компоненте.
Получение составляющих дань	Возвращает сведения о составляющих дань.
Преобразование в составляющие	Преобразует неисключаемый компонент в состав.
Создание записи о согласии на создание компонента	Создает новую запись о согласии на создание компонента.
Создание кода для создания составного запроса	Создает новый составной код запроса.
Создание компонента организации	Создает новую составную организацию.
Создание назначения сборов средств	Создает новое назначение сборов средств.
Создание основного формата имени	Создает основной формат имени для составной части.
Создание отдельного компонента	Создает новый отдельный компонент.
Создание отдельной связи	Создает новую отдельную связь. Если отношения связаны с другим компонентом, для этого компонента создается взаимная связь.
Создание подтверждения дани	Создает новое признание дани.
Создание связи организации	Создает связь организации. Если отношения связаны с другим компонентом, для этого компонента создается взаимная связь.
Создание составляющих дани	Создает новую составную дань.
Создание составляющих онлайн-присутствия	Создает новое составное онлайн-присутствие.
Создание составного адреса	Создает новый составной адрес.
Создание составного адреса электронной почты	Создает новый составной адрес электронной почты.
Создание составного вложения	Создает новое составное вложение.
Создание составного кода	Создает новый составной код.
Создание составного настраиваемого поля	Создает новое составное настраиваемое поле.
Создание составного образования	Создает новое составное образование.
Создание составного псевдонима	Создает новый составной псевдоним.
Создание составного телефона	Создает новый составной телефон.
Создание составной заметки	Создает новую составную заметку.
Создание формата составного имени	Создает новый формат составного имени.
Список составных кодов запроса	Перечисляет коды запроса для составляющих.
Удаление составного кода	Удаляет составной код.

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

Идентификатор операции:: ListConstituentCustomFields

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

Параметры

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

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

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

Тело: ConstituentApi.ApiCollectionOfConstituentCustomFieldRead

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

Идентификатор операции:: EditConstituentSolicitCode

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор кода запроса	constituent_solicit_code_id	True	string	Идентификатор системной записи кода запроса для обновления.
Код запроса	solicit_code		string	Инструкции по обмену данными и /или ограничения для составляющих.
Начальная дата	start_date		date	Дата начала кода запроса (например, "2005-09-18").
Дата окончания	end_date		date	Дата окончания кода запроса (например, "2005-09-18").

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

Идентификатор операции:: EditConstituent

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Составной идентификатор	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	Дает ли избиратель анонимно?
Запросы электронной почты не выполняются?	requests_no_email		boolean	Нет ли в составном запросе электронной почты?
Является ли адвокат?	is_solicitor		boolean	Является ли составитель адвокатом?
Допустимые адреса отсутствуют?	no_valid_address		boolean	У компонента нет допустимых адресов?
Неактивный?	inactive		boolean	Неактивен ли компонент?
day	d		integer	День в нечеткой дате.
month	m		integer	Месяц в нечеткой дате.
год	y		integer	Год в нечеткой дате.
Родина	birthplace		string	Место рождения компонента (только для отдельных лиц).
Этнос	ethnicity		string	Этническое происхождение составляющих (только для отдельных лиц).
Цель	target		string	Цель составляющих.
доход	income		string	Доход для составляющих (только для физических лиц).
Тип чека	receipt_type		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	Год в нечеткой дате.
Является ли мемориал?	is_memorial		boolean	Является ли составная часть честью или мемориалом?

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

Идентификатор операции:: EditConstituentOnlinePresence

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор присутствия в Сети	online_presence_id	True	string	Идентификатор системной записи для обновления присутствия в Сети.
Тип	type		string	Тип присутствия в Интернете.
Link	address		string	Веб-адрес для присутствия в Интернете.
Первичный?	primary		boolean	Это основное онлайн-присутствие составляющих?
Неактивный?	inactive		boolean	Неактивно ли это присутствие в Интернете?

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

Идентификатор операции:: EditConstituentPrimaryNameFormat

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор формата имени	primary_name_format_id	True	string	Идентификатор системной записи основного формата имени для обновления.
Формат пользовательского имени?	custom_format		boolean	Является ли настраиваемый формат?
Формат	configuration_id		string	Конфигурация формата имени (требуется, если не используется пользовательский формат).
Пользовательское имя	formatted_name		string	Отформатированное имя (обязательно, если используется пользовательский формат). Ограничение символов: 255.

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

Идентификатор операции:: EditConstituentProfilePicture

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Составной идентификатор	constituent_id	True	string	Системный идентификатор записи компонента, изображение профиля которого необходимо обновить.
Имя файла	file_name	True	string	Имя файла.
Идентификатор документа	document_id	True	uuid	Идентификатор документа.
Идентификатор эскиза	thumbnail_id	True	uuid	Идентификатор документа эскиза.

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

Идентификатор операции:: EditConstituentAddress

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

Параметры

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

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

Идентификатор операции:: EditConstituentEmailAddress

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор адреса электронной почты	email_address_id	True	string	Идентификатор системной записи для обновления адреса электронной почты.
Тип электронной почты	type		string	Тип адреса электронной почты.
Адрес электронной почты	address		string	Адрес электронной почты.
Первичный?	primary		boolean	Это основной адрес электронной почты компонента?
Не отправлять сообщения электронной почты?	do_not_email		boolean	Можно ли связаться с компонентами по этому адресу электронной почты?
Неактивный?	inactive		boolean	Неактивен ли адрес электронной почты?

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

Идентификатор операции:: EditConstituentAttachment

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор вложения	attachment_id	True	string	Идентификатор системной записи для обновления вложения.
Имя	name		string	Имя вложения. Ограничение символов: 150.
Date	date		date-time	Дата вложения (например, '2020-09-18T04:13:56Z').
URL	url		string	URL-адрес для вложения. Это необходимо для вложений ссылок и неприменимо для физических вложений.
Метки	tags		array of string	Теги, связанные с вложением.

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

Идентификатор операции:: EditConstituentCode

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор составного кода	constituent_code_id	True	string	Идентификатор системной записи в составном коде для обновления.
day	d		integer	День в нечеткой дате.
month	m		integer	Месяц в нечеткой дате.
год	y		integer	Год в нечеткой дате.
day	d		integer	День в нечеткой дате.
month	m		integer	Месяц в нечеткой дате.
год	y		integer	Год в нечеткой дате.
Последовательность	sequence		integer	Числовая последовательность, связанная с составным кодом.

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

Идентификатор операции:: EditConstituentCustomField

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

Параметры

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

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

Идентификатор операции:: EditConstituentEducation

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

Параметры

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

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

Идентификатор операции:: EditConstituentAlias

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор псевдонима	alias_id	True	string	Идентификатор системной записи псевдонима для обновления.
Псевдоним	name		string	Имя, используемое в качестве псевдонима компонента. Ограничение символов: 100.
Тип	type		string	Тип псевдонима.

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

Идентификатор операции:: EditConstituentPhone

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор телефона	phone_id	True	string	Идентификатор системной записи телефона для обновления.
Тип	type		string	Тип телефона.
Number	number		string	Номер телефона.
Первичный?	primary		boolean	Это основной телефон избирателя?
Не вызывайте?	do_not_call		boolean	Можно ли связаться с компонентом по этому номеру?
Неактивный?	inactive		boolean	Неактивен ли этот номер телефона?

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

Идентификатор операции:: EditConstituentNote

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор заметки	note_id	True	string	Идентификатор системной записи для обновления заметки.
Тип	type		string	Тип заметки.
day	d		integer	День в нечеткой дате.
month	m		integer	Месяц в нечеткой дате.
год	y		integer	Год в нечеткой дате.
Сводка	summary		string	Сводка по заметкам. Ограничение символов: 50.
Замечание	text		string	Текст заметки.

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

Идентификатор операции:: EditConstituentRelationship

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

Параметры

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

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

Идентификатор операции:: EditConstituentNameFormat

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор формата имени	name_format_id	True	string	Идентификатор системной записи формата имени для обновления.
Тип	type		string	Тип формата имени.
Формат пользовательского имени?	custom_format		boolean	Является ли настраиваемый формат?
Формат	configuration_id		string	Конфигурация формата имени (требуется, если не используется пользовательский формат).
Пользовательское имя	formatted_name		string	Отформатированное имя (обязательно, если используется пользовательский формат). Ограничение символов: 255.

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

Идентификатор операции:: ListConstituentConsents

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Составной идентификатор	constituent_id	True	string	Системный идентификатор записи компонента.
Последнее только?	most_recent_only		boolean	Включите только последние записи согласия для каждой комбинации категорий каналов в ответе?

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

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

Тело: CommPrefApi.ConstituentConsentReadCollection

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

Идентификатор операции:: ListFundraiserAssignments

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор сборов средств	fundraiser_id	True	string	Системный идентификатор сборов средств, для которого возвращаются назначения.
Лимит	limit		integer	Представляет количество возвращаемых записей. Значение по умолчанию — 500. Максимальное значение — 5000.
Смещение	offset		integer	Представляет количество пропускаемых записей. Для использования с разбивкой на страницы.

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

Assignments

Тело: FundraisingApi.ApiCollectionOfFundraiserAssignmentRead

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

Идентификатор операции:: ListTributeAcknowledgees

Перечисляет признания за дань.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор дани	tributeId	True	integer	Системный идентификатор записи дани.

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

Дань признает

Тело: NXTDataIntegrationApi.TributeAcknowledgeeCollection

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

Идентификатор операции:: ListConstituents

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

Параметры

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

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

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

Тело: ConstituentApi.ApiCollectionOfConstituentRead

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

Идентификатор операции:: ListConstituentAddresses

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

Параметры

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

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

Адреса

Тело: ConstituentApi.ApiCollectionOfAddressRead

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

Идентификатор операции:: ListConstituentEmailAddresses

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

Параметры

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

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

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

Тело: ConstituentApi.ApiCollectionOfEmailAddressRead

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

Идентификатор операции:: ListConstituentAttachments

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

Параметры

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

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

Attachments

Тело: ConstituentApi.ApiCollectionOfConstituentAttachmentRead

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

Идентификатор операции:: ListConstituentTributes

Перечисляет дань для избирателя.

Параметры

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

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

Дани

Тело: NXTDataIntegrationApi.TributeCollection

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

Идентификатор операции:: ListConstituentEducations

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

Параметры

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

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

Образования

Тело: ConstituentApi.ApiCollectionOfEducationRead

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

Идентификатор операции:: ListConstituentOnlinePresences

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

Параметры

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

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

Присутствие в Сети

Тело: ConstituentApi.ApiCollectionOfOnlinePresenceRead

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

Идентификатор операции:: ListConstituentNotes

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

Параметры

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

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

Примечания.

Тело: ConstituentApi.ApiCollectionOfNoteRead

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

Идентификатор операции:: ListConstituentFundraiserAssignments

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

Параметры

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

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

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

Тело: ConstituentApi.ApiCollectionOfFundraiserAssignmentRead

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

Идентификатор операции:: ListConstituentRelationships

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Составной идентификатор	constituent_id	True	string	Системный идентификатор записи компонента.
Лимит	limit		integer	Представляет количество возвращаемых записей. Значение по умолчанию — 500. Максимальное значение не существует.
Смещение	offset		integer	Представляет количество пропускаемых записей. Для использования с разбивкой на страницы.

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

Отношения

Тело: ConstituentApi.ApiCollectionOfRelationshipRead

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

Идентификатор операции:: ListConstituentPhones

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

Параметры

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

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

Телефоны

Тело: ConstituentApi.ApiCollectionOfPhoneRead

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

Идентификатор операции:: ListConstituentCodes

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

Параметры

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

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

Составные коды

Тело: ConstituentApi.ApiCollectionOfConstituentCodeRead

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

Идентификатор операции:: ListConstituentAliases

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

Параметры

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

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

Aliases

Тело: ConstituentApi.ApiCollectionOfAliasRead

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

Идентификатор операции:: ListConstituentMemberships

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

Параметры

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

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

Членство

Тело: ConstituentApi.ApiCollectionOfMembershipRead

Поиск повторяющихся компонентов

Идентификатор операции:: GetDuplicateSearchResults

Выполняет поиск отдельных, организационных и связанных записей контактов и ранжирует потенциальные дубликаты на основе указанных фильтров поиска. Записи, соответствующие нескольким фильтрам, ранжируются выше в качестве потенциальных дубликатов.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя последней или организации	last_org_name	True	string	Фильтр для записей, соответствующих указанному фамилии или имени организации.
Имя (первое имя)	first_name		string	Фильтр для отдельных записей, соответствующих указанному имени.
Отчество/второе имя	middle_name		string	Фильтр для отдельных записей, соответствующих указанному промежуточному имени.
Суффикс	suffix		string	Фильтр для отдельных записей, соответствующих указанному суффиксу.
Блок адресов	address_block		string	Фильтр записей, соответствующих указанному блоку адресов.
Город	city		string	Фильтр для записей, соответствующих указанному городу.
Государство	state		string	Фильтр для записей, соответствующих указанному состоянию.
Почтовый индекс	post_code		string	Фильтр для записей, соответствующих указанному почтовому индексу.
Адрес электронной почты	email		array	Фильтр записей, соответствующих указанным адресам электронной почты.
Телефон	phone		array	Фильтр для записей, соответствующих указанным номерам телефонов.
Поиск отдельных лиц?	search_individuals		boolean	Выполните поиск повторяющихся отдельных записей?
Псевдонимы поиска?	search_aliases		boolean	Выполните поиск по псевдониму, как указано параметром last/org name?
Поиск контактов?	search_contacts		boolean	Записи контактов поиска?
Лимит	limit		integer	Количество записей, возвращаемых при выполнении разбиения по страницам (по умолчанию = 3).
Смещение	offset		integer	Количество записей, пропускаемых при разбиении по страницам.

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

Повторяющиеся результаты поиска

Тело: ConstituentApi.DuplicateSearchResultCollection

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

Идентификатор операции:: SearchConstituent

Выполняет составной поиск на основе предоставленного текста поиска. Поддерживает имя, фамилию, предпочтительное имя, прежнее имя, псевдоним, адрес электронной почты, номер телефона, адрес или идентификатор подстановки. Допустимы такие сочетания имен, как имя и фамилия или предпочтительное имя и фамилия, но в противном случае поиск поддерживает только один параметр одновременно. По умолчанию поиски включают результаты, аналогичные вашим критериям. Например, поиски "Смит" включают совпадения для "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	Представляет количество пропускаемых записей. Для использования с разбивкой на страницы.

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

Результаты поиска

Тело: ConstituentApi.ApiCollectionOfSearchResultRead

Поиск составляющих (расширенных)

Идентификатор операции:: SearchConstituentEnhanced

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

Параметры

Имя	Ключ	Тип	Описание
Имя (первое имя)	first_name	string	Составляющие имя.
Фамилия	last_name	string	Составляющие фамилию.
Идентификатор подстановки	lookup_id	string	Идентификатор составной подстановки.
Адрес электронной почты	email	string	Составляющий адрес электронной почты.
Номер телефона	phone_number	string	Номер телефона.
Лимит	limit	integer	Представляет количество возвращаемых записей. Значение по умолчанию — 500. Максимальное значение — 1000.
Линии адресов	address_lines	string	Адресные строки.
Город	city	string	Адрес города.
Государство	state	string	Состояние адреса.
Почтовый индекс	post_code	string	Почтовый индекс адреса.
Включить псевдоним?	include_alias	boolean	Включите псевдоним при поиске по фамилии?
Тип псевдонима	alias_type	string	Тип псевдонима.
Включить девичье имя?	include_maiden_name	boolean	Включите имя девицы при поиске по фамилии?

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

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

Тело: NXTDataIntegrationApi.ConstituentSearchResultCollection

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

Идентификатор операции:: GetConstituentProfilePicture

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

Параметры

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

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

Изображение профиля

Тело: ConstituentApi.ProfilePictureRead

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

Идентификатор операции:: GetConstituentIdFromLookupId

Возвращает системный идентификатор системной записи компонента из указанного идентификатора подстановки.

Параметры

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

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

Карта составляющих идентификаторов

Тело: NXTDataIntegrationApi.ConstituentIdMap

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

Идентификатор операции:: GetConstituentNameFormatSummary

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

Параметры

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

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

Сводка по формату имени

Тело: ConstituentApi.NameFormatSummaryRead

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

Идентификатор операции:: GetConstituent

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

Параметры

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

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

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

Тело: ConstituentApi.ConstituentRead

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

Идентификатор операции:: GetConstituentTribute

Возвращает сведения о составляющих дань.

Параметры

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

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

Дань

Тело: NXTDataIntegrationApi.Tribute

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

Идентификатор операции:: ConvertToConstituent

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Неисключающий идентификатор	non_constituent_id	True	string	Идентификатор системной записи преобразуемой нефиксной записи.
Идентификатор	id		string	Системный идентификатор записи в составном коде.
day	d		integer	День в нечеткой дате.
month	m		integer	Месяц в нечеткой дате.
год	y		integer	Год в нечеткой дате.
day	d		integer	День в нечеткой дате.
month	m		integer	Месяц в нечеткой дате.
год	y		integer	Год в нечеткой дате.
последовательность	sequence		integer	Последовательность составного кода.

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

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

Тело: ConstituentApi.ConvertedConstituent

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

Идентификатор операции:: CreateConstituentConsent

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

Параметры

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

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

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

Тело: CommPrefApi.CreatedConstituentConsent

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

Идентификатор операции:: CreateConstituentSolicitCode

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Составной идентификатор	constituent_id	True	string	Системный идентификатор записи компонента, связанного с кодом запроса.
Код запроса	solicit_code	True	string	Инструкции по обмену данными и /или ограничения для составляющих.
Начальная дата	start_date		date	Дата начала кода запроса (например, "2005-09-18").
Дата окончания	end_date		date	Дата окончания кода запроса (например, "2005-09-18").

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

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

Тело: CommPrefApi.CreatedConstituentSolicitCode

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

Идентификатор операции:: CreateOrganizationConstituent

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя	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	Дает ли избиратель анонимно?
Запросы электронной почты не выполняются?	requests_no_email		boolean	Нет ли в составном запросе электронной почты?
Является ли адвокат?	is_solicitor		boolean	Является ли составитель адвокатом?
Допустимые адреса отсутствуют?	no_valid_address		boolean	У компонента нет допустимых адресов?
Цель	target		string	Цель составляющих.
доход	income		string	Доход для составляющих.
Тип чека	receipt_type		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	Соответствующие подарочные заметки для составляющих.
Является ли мемориал?	is_memorial		boolean	Является ли составная часть честью или мемориалом?

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

Созданная организация

Тело: ConstituentApi.CreatedOrganizationConstituent

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

Идентификатор операции:: CreateFundraiserAssignment

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор сборов средств	fundraiser_id	True	string	Системный идентификатор сборов средств.
Составной идентификатор	constituent_id	True	string	Идентификатор системной записи назначенного компонента.
Тип	type		string	Тип сборов средств.
Начало назначения	start		date-time	Дата начала назначения (например, "2020-09-18T04:13:56Z").
Окончание назначения	end		date-time	Дата окончания назначения (например, '2020-09-18T04:13:56Z').
Сумма	value	True	double	Сумма цели для сборов средств, чтобы запрашивать от назначенного избирателя.
Идентификатор кампании	campaign_id		string	Системный идентификатор кампании, к которой будут применены полученные подарки.
Идентификатор фонда	fund_id		string	Системный идентификатор фонда, к которому будут применены полученные подарки.
Идентификатор апелляции	appeal_id		string	Системный идентификатор обращения, к которому будут применены полученные подарки.

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

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

Тело: FundraisingApi.CreatedFundraiserAssignment

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

Идентификатор операции:: CreateConstituentPrimaryNameFormat

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Составной идентификатор	constituent_id	True	string	Системный идентификатор записи компонента.
Тип	primary_type	True	string	Тип формата основного имени.
Формат пользовательского имени?	custom_format		boolean	Является ли настраиваемый формат?
Формат	configuration_id		string	Конфигурация формата имени (требуется, если не используется пользовательский формат).
Пользовательское имя	formatted_name		string	Отформатированное имя (обязательно, если используется пользовательский формат). Ограничение символов: 255.

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

Формат созданного имени

Тело: ConstituentApi.CreatedNameFormat

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

Идентификатор операции:: CreateIndividualConstituent

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Название	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	Дает ли избиратель анонимно?
Запросы электронной почты не выполняются?	requests_no_email		boolean	Нет ли в составном запросе электронной почты?
Является ли адвокат?	is_solicitor		boolean	Является ли составитель адвокатом?
Допустимые адреса отсутствуют?	no_valid_address		boolean	У компонента нет допустимых адресов?
day	d		integer	День в нечеткой дате.
month	m		integer	Месяц в нечеткой дате.
год	y		integer	Год в нечеткой дате.
Родина	birthplace		string	Место рождения составляющих.
Этнос	ethnicity		string	Этническое происхождение составляющих.
Цель	target		string	Цель составляющих.
доход	income		string	Доход для составляющих.
Тип чека	receipt_type		string	Тип квитанции компонента.
Религиозная деятельность	religion		string	Религия составляющих.
Пользовательский адрес?	custom_format		boolean	Основной адрес настраиваемого формата?
Формат адреса	configuration_id		string	Конфигурация основного адреса (требуется, если не используется пользовательский формат).
Адрес пользовательского имени	formatted_name		string	Основное имя отформатированного адреса (необходимо, если используется пользовательский формат). Ограничение символов: 255.
Настраиваемое приветствие?	custom_format		boolean	Является ли основное приветствие настраиваемым форматом?
Формат салютации	configuration_id		string	Первичная конфигурация приветствия (требуется, если не используется пользовательский формат).
Пользовательское имя приветствия	formatted_name		string	Основное форматируемое имя салютации (необходимо, если используется пользовательский формат). Ограничение символов: 255.
Является ли мемориал?	is_memorial		boolean	Является ли составная часть честью или мемориалом?

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

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

Тело: ConstituentApi.CreatedIndividualConstituent

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

Идентификатор операции:: CreateIndividualRelationship

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

Параметры

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

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

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

Тело: ConstituentApi.CreatedIndividualRelationship

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

Идентификатор операции:: CreateTributeAcknowledgee

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор дани	tribute_id	True	integer	Системный идентификатор дани, связанной с подтверждением.
Идентификатор связи	relationship_id		integer	Идентификатор системной записи связи (если значение NULL, это представляет самоподобие).
Идентификатор буквы	letter_id		integer	Идентификатор буквы.

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

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

Тело: NXTDataIntegrationApi.CreatedTributeAcknowledgee

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

Идентификатор операции:: CreateOrganizationRelationship

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

Параметры

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

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

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

Тело: ConstituentApi.CreatedOrganizationRelationship

Создание составляющих дани

Идентификатор операции:: CreateConstituentTribute

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Составной идентификатор	constituent_record_id	True	integer	Системный идентификатор записи компонента, связанного с данью.
Тип дани	tribute_type_id	True	integer	Тип дани.
Description	description		string	Описание дани.
day	d		integer	День в нечеткой дате.
month	m		integer	Месяц в нечеткой дате.
год	y		integer	Год в нечеткой дате.
day	d		integer	День в нечеткой дате.
month	m		integer	Месяц в нечеткой дате.
год	y		integer	Год в нечеткой дате.
Идентификатор фонда по умолчанию	default_fund_id		integer	Системный идентификатор фонда по умолчанию, связанного с данью.
Примечания.	notes		string	Примечания дани.
Активный?	is_active		boolean	Это дань активна?

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

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

Тело: NXTDataIntegrationApi.CreatedConstituentTribute

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

Идентификатор операции:: CreateConstituentOnlinePresence

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Составной идентификатор	constituent_id	True	string	Системный идентификатор записи компонента, связанного с присутствием в Интернете.
Тип	type	True	string	Тип присутствия в Интернете.
Link	address	True	string	Веб-адрес для присутствия в Интернете.
Первичный?	primary		boolean	Это основное онлайн-присутствие составляющих?
Неактивный?	inactive		boolean	Неактивно ли это присутствие в Интернете?

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

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

Тело: ConstituentApi.CreatedConstituentOnlinePresence

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

Идентификатор операции:: CreateConstituentAddress

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

Параметры

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

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

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

Тело: ConstituentApi.CreatedConstituentAddress

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

Идентификатор операции:: CreateConstituentEmailAddress

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Составной идентификатор	constituent_id	True	string	Системный идентификатор записи компонента, связанного с адресом электронной почты.
Тип электронной почты	type	True	string	Тип адреса электронной почты.
Адрес электронной почты	address	True	string	Адрес электронной почты.
Первичный?	primary		boolean	Это основной адрес электронной почты компонента?
Не отправлять сообщения электронной почты?	do_not_email		boolean	Можно ли связаться с компонентами по этому адресу электронной почты?
Неактивный?	inactive		boolean	Неактивен ли адрес электронной почты?

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

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

Тело: ConstituentApi.CreatedConstituentEmailAddress

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

Идентификатор операции:: CreateConstituentAttachment

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Составной идентификатор	parent_id	True	string	Системный идентификатор записи компонента, связанного с вложением.
Тип	type	True	string	Тип вложения. Физические вложения отправляются в файлы, такие как изображения, PDF-файлы или документы Word, сохраненные локально или в сети. Они хранятся и управляются в системе. Ссылки на вложения — это ссылки на такие файлы, как изображения, записи блога или видео YouTube, которые находятся в Сети или в облачной учетной записи хранения. Они хранятся и управляются внешним образом.
Имя	name		string	Имя вложения. Ограничение символов: 150.
Date	date		date-time	Дата вложения (например, '2020-09-18T04:13:56Z'). Это поле по умолчанию использует текущую дату и время, если она не указана.
URL	url		string	URL-адрес для вложения. Это необходимо для вложений ссылок и неприменимо для физических вложений.
Имя файла	file_name		string	Имя файла. Ограничение символов: 36. Только для физических вложений.
Идентификатор файла	file_id		string	Идентификатор файла. Ограничение символов: 36. Только для физических вложений.
Идентификатор эскиза	thumbnail_id		string	Идентификатор эскиза. Ограничение символов: 36. Только для физических вложений.
Метки	tags		array of string	Теги, связанные с вложением.

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

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

Тело: ConstituentApi.CreatedConstituentAttachment

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

Идентификатор операции:: CreateConstituentCode

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

Параметры

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

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

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

Тело: ConstituentApi.CreatedConstituentCode

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

Идентификатор операции:: CreateConstituentCustomField

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
body	body	True	dynamic	Объект, представляющий настраиваемое поле для создания.

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

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

Тело: ConstituentApi.CreatedConstituentCustomField

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

Идентификатор операции:: CreateConstituentEducation

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

Параметры

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

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

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

Тело: ConstituentApi.CreatedConstituentEducation

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

Идентификатор операции:: CreateConstituentAlias

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Составной идентификатор	constituent_id	True	string	Системный идентификатор записи компонента, связанного с псевдонимом.
Псевдоним	name	True	string	Имя, используемое в качестве псевдонима компонента. Ограничение символов: 100.
Тип	type		string	Тип псевдонима.

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

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

Тело: ConstituentApi.CreatedConstituentAlias

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

Идентификатор операции:: CreateConstituentPhone

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Составной идентификатор	constituent_id	True	string	Системный идентификатор записи компонента, связанного с телефоном.
Тип	type	True	string	Тип телефона.
Number	number	True	string	Номер телефона.
Первичный?	primary		boolean	Это основной телефон избирателя?
Не вызывайте?	do_not_call		boolean	Можно ли связаться с компонентом по этому номеру?
Неактивный?	inactive		boolean	Неактивен ли этот номер телефона?

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

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

Тело: ConstituentApi.CreatedConstituentPhone

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

Идентификатор операции:: CreateConstituentNote

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Составной идентификатор	constituent_id	True	string	Системный идентификатор записи компонента, связанного с примечанием.
Тип	type	True	string	Тип заметки.
day	d		integer	День в нечеткой дате.
month	m		integer	Месяц в нечеткой дате.
год	y		integer	Год в нечеткой дате.
Сводка	summary		string	Сводка по заметкам. Ограничение символов: 50.
Замечание	text		string	Текст заметки.
Author	author		string	Автор заметок. Если он не указан, у вас будет набор по умолчанию на основе учетной записи пользователя. Ограничение символов: 50.

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

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

Тело: ConstituentApi.CreatedConstituentNote

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

Идентификатор операции:: CreateConstituentNameFormat

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Составной идентификатор	constituent_id	True	string	Системный идентификатор записи компонента.
Тип	type	True	string	Тип формата имени.
Формат пользовательского имени?	custom_format		boolean	Является ли настраиваемый формат?
Формат	configuration_id		string	Конфигурация формата имени (требуется, если не используется пользовательский формат).
Пользовательское имя	formatted_name		string	Отформатированное имя (обязательно, если используется пользовательский формат). Ограничение символов: 255.

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

Формат созданного имени

Тело: ConstituentApi.CreatedNameFormat

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

Идентификатор операции:: ListConstituentSolicitCodes

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

Параметры

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

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

Коды запроса

Тело: CommPrefApi.ConstituentSolicitCodeReadCollection

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

Идентификатор операции:: DeleteConstituentCode

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

Параметры

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

Членство

Имя	Путь	Тип	Описание
Численность	count	integer	Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений.
value	value	array of ConstituentApi.MembershipRead	Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции.

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.ApiCollectionOfRelationshipRead

Отношения

Имя	Путь	Тип	Описание
Численность	count	integer	Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений.
value	value	array of ConstituentApi.RelationshipRead	Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции.

ConstituentApi.ApiCollectionOfSearchResultRead

Результаты поиска

Имя	Путь	Тип	Описание
Численность	count	integer	Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений.
value	value	array of ConstituentApi.SearchResultRead	Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции.

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	Размер файла в байтах. Только для физических вложений.
Метки	tags	array of string	Теги, связанные с вложением.

ConstituentApi.ConstituentCodeRead

Составной код

Имя	Путь	Тип	Описание
Идентификатор	id	string	Системный идентификатор записи в составном коде.
Составной идентификатор	constituent_id	string	Системный идентификатор записи компонента, связанного с составным кодом.
Составной код	description	string	Составной код.
day	start.d	integer	День в нечеткой дате.
month	start.m	integer	Месяц в нечеткой дате.
год	start.y	integer	Год в нечеткой дате.
day	end.d	integer	День в нечеткой дате.
month	end.m	integer	Месяц в нечеткой дате.
год	end.y	integer	Год в нечеткой дате.
Неактивный?	inactive	boolean	Неактивен ли составной код?
Последовательность	sequence	integer	Числовая последовательность, связанная с составным кодом.
Дата добавления	date_added	date-time	Дата создания составного кода.
Дата изменения	date_modified	date-time	Дата последнего изменения составного кода.

ConstituentApi.ConstituentCustomFieldRead

Настраиваемое поле

Имя	Путь	Тип	Описание
Идентификатор	id	string	Идентификатор системной записи настраиваемого поля.
Составной идентификатор	parent_id	string	Идентификатор системной записи компонента, связанного с настраиваемым полем.
Категория	category	string	Категория настраиваемого поля.
Тип	type	string	Тип данных, которые представляет настраиваемое поле.
Ценность	value		Значение настраиваемого поля.
Текстовое значение	text_value	string	Текстовое значение настраиваемого поля.
Числовое значение	number_value	integer	Числовое значение настраиваемого поля.
Значение даты	date_value	date	Значение даты настраиваемого поля.
Значение валюты	currency_value	double	Значение валюты настраиваемого поля.
Логическое значение	boolean_value	boolean	Логическое значение настраиваемого поля.
Значение записи таблицы	codetableentry_value	string	Значение записи таблицы настраиваемого поля.
Значение составного идентификатора	constituentid_value	string	Значение составного идентификатора настраиваемого поля.
day	fuzzydate_value.d	integer	День в нечеткой дате.
month	fuzzydate_value.m	integer	Месяц в нечеткой дате.
год	fuzzydate_value.y	integer	Год в нечеткой дате.
Date	date	date	Дата настраиваемого поля.
Комментарий	comment	string	Комментарий к пользовательскому полю. Ограничение символов: 50.
Дата добавления	date_added	date-time	Дата создания настраиваемого поля.
Дата изменения	date_modified	date-time	Дата последнего изменения настраиваемого поля.

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	Дает ли избиратель анонимно?
Запросы электронной почты не выполняются?	requests_no_email	boolean	Нет ли в составном запросе электронной почты?
Является ли адвокат?	is_solicitor	boolean	Является ли составитель адвокатом?
Допустимые адреса отсутствуют?	no_valid_address	boolean	У компонента нет допустимых адресов?
Неактивный?	inactive	boolean	Неактивен ли компонент?
day	birthdate.d	integer	День в нечеткой дате.
month	birthdate.m	integer	Месяц в нечеткой дате.
год	birthdate.y	integer	Год в нечеткой дате.
Родина	birthplace	string	Место рождения компонента (только для отдельных лиц).
Этнос	ethnicity	string	Этническое происхождение составляющих (только для отдельных лиц).
Цель	target	string	Цель составляющих.
доход	income	string	Доход для составляющих (только для физических лиц).
Тип чека	receipt_type	string	Тип квитанции компонента.
Религиозная деятельность	religion	string	Религия составляющих (только для отдельных лиц).
Промышленность	industry	string	Отрасль составляющих (только для организаций).
Количество сотрудников	num_employees	integer	Количество сотрудников в организации.
Соответствует подаркам?	matches_gifts	boolean	Соответствует ли организация подаркам?
Соответствующий фактор подарка	matching_gift_factor	double	Соответствующий фактор подарка (только для организаций).
value	matching_gift_per_gift_min.value	double	Значение суммы.
value	matching_gift_per_gift_max.value	double	Значение суммы.
value	matching_gift_total_min.value	double	Значение суммы.
value	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	Указывает, является ли компонент сбором средств (только для отдельных лиц).
Является ли мемориал?	is_memorial	boolean	Является ли составная часть честью или мемориалом?
Идентификатор	spouse.id	string	Системный идентификатор записи супруга.
имя	spouse.first	string	Имя супруга.
фамилия	spouse.last	string	Фамилия супруга.
является главой семьи?	spouse.is_head_of_household	boolean	Является ли супруг главой семьи?
Дата добавления	date_added	date-time	Дата создания компонента.
Дата изменения	date_modified	date-time	Дата последнего изменения компонента.

ConstituentApi.ConvertedConstituent

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

Имя	Путь	Тип	Описание
Идентификатор	id	string	Идентификатор преобразованного компонента.

ConstituentApi.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.CreatedIndividualConstituent

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

Имя	Путь	Тип	Описание
Идентификатор	id	string	Идентификатор только что созданного отдельного компонента.

ConstituentApi.CreatedIndividualRelationship

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

Имя	Путь	Тип	Описание
Идентификатор	id	string	Идентификатор только что созданной отдельной связи.

ConstituentApi.CreatedNameFormat

Формат созданного имени

Имя	Путь	Тип	Описание
Идентификатор	id	string	Идентификатор только что созданного формата имени.

ConstituentApi.CreatedOrganizationConstituent

Созданная организация

Имя	Путь	Тип	Описание
Идентификатор	id	string	Идентификатор только что созданной организации.

ConstituentApi.CreatedOrganizationRelationship

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

Имя	Путь	Тип	Описание
Идентификатор	id	string	Идентификатор только что созданной связи организации.

ConstituentApi.DuplicateSearchResult

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

Имя	Путь	Тип	Описание
Идентификатор	id	string	Идентификатор системной записи для составляющих.
Имя	name	string	Имя составляющих. Для отдельных лиц это вычисляемое поле указывает полное имя компонента на основе параметров отображаемого имени целевой организации.
Показать имя	display_name	string	Отображаемое имя компонента.
Address	formatted_address	string	Отформатированный первичный адрес для составляющих.
Покойный?	deceased	boolean	Умер ли компонент?
Является ли составной?	is_constituent	boolean	Является ли запись составной?
Идентификатор подстановки	constituent_id	string	Определяемый пользователем идентификатор для компонента.
Дата добавления	date_added	date-time	Дата добавления компонента.
Ранг	rank	string	Ранг поиска, указывающий, на что был сопоставлен составной элемент.

ConstituentApi.DuplicateSearchResultCollection

Повторяющиеся результаты поиска

Имя	Путь	Тип	Описание
Численность	count	integer	Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений.
value	value	array of ConstituentApi.DuplicateSearchResult	Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции.

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.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.MembershipMemberRead

Член

Имя	Путь	Тип	Описание
Идентификатор	id	string	Идентификатор системной записи члена.
Составной идентификатор	constituent_id	string	Системный идентификатор записи компонента, связанного с элементом.
Является ли основной член?	primary	boolean	Это основной член?

ConstituentApi.MembershipRead

Membership

Имя	Путь	Тип	Описание
Идентификатор	id	string	Идентификатор системной записи членства.
Составной идентификатор	constituent_id	string	Системный идентификатор записи компонента, связанного с членством.
Программа	program	string	Программа членства.
Категория	category	string	Категория членства.
Подкатегория	subcategory	string	Подкатегория членства.
Стоячий	standing	string	Состояние членства.
Действительно до	expires	date-time	Дата истечения срока действия членства.
Присоединился к	joined	date-time	Дата, когда членство становится активным.
value	dues.value	double	Денежное значение.
Members	members	array of ConstituentApi.MembershipMemberRead	Набор членов, принадлежащих к членству.
Дата добавления	date_added	date-time	Дата создания членства.
Дата изменения	date_modified	date-time	Дата последнего изменения членства.

ConstituentApi.NameFormatRead

Форматы имен определяют, как устранять составляющие в обмене данными. Как вы ссылаетесь на людей задает тон ваших коммуникаций с ними и насколько хорошо они получают ваши взаимодействия.

Имя	Путь	Тип	Описание
Идентификатор	id	string	Идентификатор системной записи формата имени.
type	type	string	Тип формата имени.
настраиваемый формат?	custom_format	boolean	Это настраиваемый формат?
Идентификатор конфигурации	configuration_id	string	Идентификатор конфигурации формата имени (для не настраиваемых форматов).
отформатированный имя	formatted_name	string	Отформатированное имя (для пользовательских форматов).

ConstituentApi.NameFormatSummaryRead

Сводка по формату имени

Имя	Путь	Тип	Описание
Идентификатор	primary_addressee.id	string	Идентификатор системной записи формата имени.
type	primary_addressee.primary_type	string	Тип формата имени.
настраиваемый формат?	primary_addressee.custom_format	boolean	Это настраиваемый формат?
Идентификатор конфигурации	primary_addressee.configuration_id	string	Идентификатор конфигурации формата имени (для не настраиваемых форматов).
отформатированный имя	primary_addressee.formatted_name	string	Отформатированное имя (для пользовательских форматов).
Идентификатор	primary_salutation.id	string	Идентификатор системной записи формата имени.
type	primary_salutation.primary_type	string	Тип формата имени.
настраиваемый формат?	primary_salutation.custom_format	boolean	Это настраиваемый формат?
Идентификатор конфигурации	primary_salutation.configuration_id	string	Идентификатор конфигурации формата имени (для не настраиваемых форматов).
отформатированный имя	primary_salutation.formatted_name	string	Отформатированное имя (для пользовательских форматов).
Дополнительные форматы имен	additional_name_formats	array of ConstituentApi.NameFormatRead	Дополнительные форматы имен составляющих.

ConstituentApi.NoteRead

Замечание

Имя	Путь	Тип	Описание
Идентификатор	id	string	Идентификатор системной записи заметки.
Составной идентификатор	constituent_id	string	Системный идентификатор записи компонента, связанного с примечанием.
Тип	type	string	Тип заметки.
day	date.d	integer	День в нечеткой дате.
month	date.m	integer	Месяц в нечеткой дате.
год	date.y	integer	Год в нечеткой дате.
Сводка	summary	string	Сводка по заметкам.
Замечание	text	string	Текст заметки.
Дата добавления	date_added	date-time	Дата создания заметки.
Дата изменения	date_modified	date-time	Дата последнего изменения заметки.

ConstituentApi.OnlinePresenceRead

Присутствие в Интернете

Имя	Путь	Тип	Описание
Идентификатор	id	string	Идентификатор системной записи присутствия в Интернете.
Составной идентификатор	constituent_id	string	Системный идентификатор записи компонента, связанного с присутствием в Интернете.
Тип	type	string	Тип присутствия в Интернете.
Link	address	string	Веб-адрес для присутствия в Интернете.
Первичный?	primary	boolean	Это основное онлайн-присутствие составляющих?
Неактивный?	inactive	boolean	Неактивно ли это присутствие в Интернете?
Дата добавления	date_added	date-time	Дата создания присутствия в Интернете.
Дата изменения	date_modified	date-time	Дата последнего изменения присутствия в Интернете.

ConstituentApi.PhoneRead

Телефон

Имя	Путь	Тип	Описание
Идентификатор	id	string	Идентификатор системной записи телефона.
Составной идентификатор	constituent_id	string	Системный идентификатор записи компонента, связанного с телефоном.
Тип	type	string	Тип телефона.
Number	number	string	Номер телефона.
Первичный?	primary	boolean	Это основной телефон избирателя?
Не вызывайте?	do_not_call	boolean	Можно ли связаться с компонентом по этому номеру?
Неактивный?	inactive	boolean	Неактивен ли этот номер телефона?
Дата добавления	date_added	date-time	Дата создания телефона.
Дата изменения	date_modified	date-time	Дата последнего изменения телефона.

ConstituentApi.ProfilePictureRead

Изображение профиля

Имя	Путь	Тип	Описание
Составной идентификатор	constituent_id	string	Идентификатор системной записи компонента, связанного с изображением профиля.
URL	url	string	URL-адрес рисунка профиля. URL-адрес содержит сигнатуру с привязкой к времени, которая ограничивает доступ к 60 минутам.
URL-адрес эскиза	thumbnail_url	string	URL-адрес эскиза рисунка профиля. Содержит сигнатуру с привязкой к времени, которая ограничивает доступ к 60 минутам.

ConstituentApi.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	Определяемый пользователем идентификатор для компонента.

Сбор средствApi.ApiCollectionOfFundraiserAssignmentRead

Assignments

Имя	Путь	Тип	Описание
Численность	count	integer	Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений.
value	value	array of FundraisingApi.FundraiserAssignmentRead	Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции.

FundraisingApi.CreatedFundraiserAssignment

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

Имя	Путь	Тип	Описание
Идентификатор	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	Системный идентификатор обращения, к которому будут применены полученные подарки.

NXTDataIntegrationApi.ConstituentIdMap

Карта составляющих идентификаторов

Имя	Путь	Тип	Описание
Идентификатор	system_record_id	integer	Идентификатор составной системы записи.

NXTDataIntegrationApi.ConstituentSearchResult

Результат поиска

Имя	Путь	Тип	Описание
Идентификатор	record_id	integer	Системный идентификатор записи компонента.
Идентификатор подстановки	constituent_id	string	Составной идентификатор.
Ключевой индикатор	key_indicator	string	Ключевой индикатор записи.
Имя (первое имя)	first_name	string	Первое имя (только для отдельных лиц).
Фамилия	last_name	string	Фамилия (только для отдельных лиц).
Отчество/второе имя	middle_name	string	Среднее имя (только для отдельных лиц).
Предпочтительное имя	preferred_name	string	Предпочтительное имя (только для отдельных лиц).
Прежнее имя	maiden_name	string	Прежнее имя (только лица).
Заголовок 1	title1	string	Название 1 (только для отдельных лиц).
Суффикс 1	suffix1	string	Суффикс 1 (только для отдельных лиц).
Gender	gender	string	Составляющий пол (только для отдельных лиц).
day	birth_date.d	integer	День в нечеткой дате.
month	birth_date.m	integer	Месяц в нечеткой дате.
год	birth_date.y	integer	Год в нечеткой дате.
Имя супруга	spouse_first_name	string	Имя супруга (только лица).
Фамилия супруга	spouse_last_name	string	Фамилия супруга (только лица).
Название организации	org_name	string	Имя организации (только организации).
Блок адресов	address_block	string	Блок адресов.
Город и штат	address_city_state	string	Адресный город и штат.
Почтовый индекс	address_post_code	string	Адресный почтовый код.
Основной адрес электронной почты	primary_email	string	Основной адрес электронной почты.
Основной номер телефона	primary_phone	string	Основной телефон.
Соответствующий псевдоним	matched_alias	string	Имя соответствующего псевдонима (только для отдельных лиц).
Соответствующее сообщение электронной почты	matched_email	string	Соответствующий адрес электронной почты.
Соответствующий телефон	matched_phone	string	Соответствующий номер телефона.
Является ли составной?	is_constituent	boolean	Является ли запись составной?
Умер?	is_deceased	boolean	Является ли запись умершей?
Неактивен?	is_inactive	boolean	Неактивна ли запись?

NXTDataIntegrationApi.ConstituentSearchResultCollection

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

Имя	Путь	Тип	Описание
results	results	array of NXTDataIntegrationApi.ConstituentSearchResult	Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции.

NXTDataIntegrationApi.CreatedConstituentTribute

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

Имя	Путь	Тип	Описание
Идентификатор	id	string	Идентификатор только что созданной конституционной дани.

NXTDataIntegrationApi.CreatedTributeAcknowledgee

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

Имя	Путь	Тип	Описание
Идентификатор	id	string	Идентификатор только что созданного дани признать.

NXTDataIntegrationApi.Tribute

Дань

Имя	Путь	Тип	Описание
Идентификатор	id	integer	Системный идентификатор записи дани.
Составной идентификатор	constituent_record_id	integer	Системный идентификатор записи компонента, связанного с данью.
Тип дани	tribute_type_name	string	Тип дани.
Идентификатор типа дани	tribute_type_id	integer	Идентификатор типа дани.
Description	description	string	Описание дани.
day	start_date.d	integer	День в нечеткой дате.
month	start_date.m	integer	Месяц в нечеткой дате.
год	start_date.y	integer	Год в нечеткой дате.
day	end_date.d	integer	День в нечеткой дате.
month	end_date.m	integer	Месяц в нечеткой дате.
год	end_date.y	integer	Год в нечеткой дате.
Идентификатор фонда по умолчанию	default_fund_id	integer	Системный идентификатор фонда по умолчанию, связанного с данью.
Примечания.	notes	string	Примечания дани.
Активный?	is_active	boolean	Это дань активна?
Последовательность	sequence	integer	Последовательность дани.
Дата добавления	date_added	date-time	Дата создания дани.
Дата изменения	date_modified	date-time	Дата последнего изменения дани.

NXTDataIntegrationApi.TributeAcknowledgee

Дань признает

Имя	Путь	Тип	Описание
Идентификатор	id	integer	Системный идентификатор подтверждения дани.
Идентификатор дани	tribute_id	integer	Системный идентификатор дани, связанной с подтверждением.
Идентификатор связи	relationships_id	integer	Идентификатор системной записи связи (если значение NULL, это представляет самоподобие).
Идентификатор буквы	letter	integer	Идентификатор буквы.
Последовательность	sequence	integer	Дань признает последовательность.

NXTDataIntegrationApi.TributeAcknowledgeeCollection

Дань признает

Имя	Путь	Тип	Описание
Численность	count	integer	Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений.
value	value	array of NXTDataIntegrationApi.TributeAcknowledgee	Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции.

NXTDataIntegrationApi.TributeCollection

Дани

Имя	Путь	Тип	Описание
Численность	count	integer	Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений.
value	value	array of NXTDataIntegrationApi.Tribute	Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции.