Partilhar via


Constituinte de Blackbaud Altru (Pré-visualização)

Altru é uma solução abrangente de software de emissão de tíquetes de nível empresarial construída especificamente para organizações sem fins lucrativos e toda a comunidade do bem social. Use o conector Constituintes para gerenciar detalhes biográficos, informações de contato e relacionamentos do constituinte.

Este conector está disponível nos seguintes produtos e regiões:

Serviço Class Regiões
Estúdio Copiloto Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas Standard Todas as regiões do Logic Apps , exceto as seguintes:
     - Regiões do Azure Government
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Aplicações Power Premium Todas as regiões do Power Apps , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Automatize o poder Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Suporte Blackbaud
URL https://www.blackbaud.com/support
Email skyapi@blackbaud.com
Metadados do conector
Editora Blackbaud, Inc.
Sítio Web https://www.blackbaud.com/products/blackbaud-altru
Política de privacidade https://www.blackbaud.com/privacy-shield
Categorias Vendas e CRM; Produtividade

Blackbaud Altru é a solução completa construída para suportar bilhetes multicanal eficazes, associações, doações e vendas na web.

Este conector é construído sobre a API SKY da Blackbaud e fornece operações para ajudar a gerenciar constituintes e entidades relacionadas encontradas no Blackbaud Altru.

Para mais informações, consulte a documentação.

Pré-requisitos

Para usar esse conector, você deve ter uma conta Blackbaud ID com acesso a um ou mais ambientes Blackbaud.

Além disso, o administrador da sua organização também deve executar uma ação de nível de administrador dentro do sistema para permitir que esse conector acesse seu ambiente Blackbaud. Mais informações sobre esses pré-requisitos podem ser encontradas na documentação de configuração inicial .

Como obter credenciais?

O administrador da sua organização enviará um convite para o ambiente Blackbaud Altru da organização e configurará as permissões da sua conta de usuário dentro do ambiente. Não são necessárias credenciais adicionais para usar esse conector.

Problemas conhecidos e limitações

O conector funcionará no contexto da sua conta de usuário e, portanto, estará sujeito às suas permissões de usuário dentro do ambiente.

Limites de Limitação

Name Chamadas Período de Renovação
Chamadas de API por conexão 100 60 segundos

Ações

Atualizar um constituinte da organização

Atualiza um componente da organização.

Atualizar um constituinte individual

Atualiza um constituinte individual. Se existe uma relação recíproca, ela também é modificada para refletir as mudanças. Isso não inclui alterações na propriedade "comments", que é específica para cada registro e pode ser modificada independentemente em cada registro.

Atualizar um círculo eleitoral de angariação de fundos

Atualiza um círculo eleitoral de angariação de fundos sobre um constituinte.

Atualizar um código de solicitação de constituinte

Atualiza uma nota constituinte.

Atualizar um endereço de constituinte

Atualiza um endereço constituinte.

Atualizar um endereço de e-mail constituinte

Atualiza um endereço de e-mail constituinte.

Atualizar um histórico de emprego do constituinte

Atualiza um histórico de emprego constituinte.

Atualizar um ID de pesquisa alternativo constituinte

Atualiza uma ID de pesquisa alternativa do constituinte.

Atualizar um recurso constituinte

Atualiza um recurso constituinte.

Atualizar um telefone constituinte

Atualiza um telefone constituinte.

Atualizar uma educação constituinte

Atualiza uma educação constituinte.

Atualizar uma interação constituinte

Atualiza uma interação constituinte.

Atualizar uma nota constituinte

Atualiza uma nota constituinte.

Criar um constituinte da organização

Cria um novo componente da organização.

Criar um constituinte individual

Cria um novo constituinte individual.

Criar um círculo eleitoral de angariação de fundos

Cria uma nova circunscrição de angariação de fundos para um eleitorado.

Criar um código de solicitação constituinte

Cria um novo código de solicitação constituinte.

Criar um endereço de constituinte

Cria um novo endereço constituinte.

Criar um endereço de e-mail constituinte

Cria um novo endereço de e-mail constituinte.

Criar um histórico de emprego constituinte

Cria uma nova história de emprego constituinte.

Criar um ID de pesquisa alternativo constituinte

Cria um novo ID de pesquisa alternativo constituinte.

Criar um recurso constituinte

Cria um novo apelo constituinte.

Criar um telefone constituinte

Cria um novo telefone constituinte.

Criar uma educação constituinte

Cria uma nova educação constituinte.

Criar uma interação constituinte

Cria uma nova interação constituinte.

Criar uma nota constituinte

Cria uma nova nota constituinte.

Criar uma resposta de recurso constituinte

Cria uma nova resposta de apelo constituinte.

Eliminar um círculo eleitoral de angariação de fundos

Elimina um círculo eleitoral de angariação de fundos de um constituinte.

Eliminar um endereço constituinte

Exclui um endereço constituinte.

Excluir um atributo constituinte

Exclui um atributo constituinte.

Excluir um endereço de e-mail constituinte

Exclui um endereço de e-mail constituinte.

Excluir um histórico de emprego constituinte

Exclui um histórico de emprego constituinte.

Excluir um ID de pesquisa alternativo constituinte

Exclui um ID de pesquisa alternativo constituinte.

Excluir um telefone constituinte

Exclui um telefone constituinte.

Excluir uma educação constituinte

Exclui um registro educacional constituinte.

Excluir uma interação constituinte

Exclui uma interação constituinte.

Fundir dois constituintes

Mesclar dois registros constituintes.

Listar as formações dos constituintes

Lista as formações para um constituinte.

Listar atributos constituintes

Lista os atributos de um constituinte.

Listar códigos de solicitação de constituintes

Lista os códigos de solicitação para um constituinte.

Listar endereços de constituintes

Lista os endereços de um constituinte.

Listar endereços de e-mail constituintes

Lista os endereços de e-mail de um constituinte.

Listar histórico de emprego do constituinte

Lista o histórico de emprego de um constituinte.

Listar IDs de pesquisa alternativos constituintes

Lista as IDs de pesquisa alternativas para um constituinte.

Listar recursos constituintes

Enumera os recursos enviados a um constituinte.

Listar telefones constituintes

Lista os telefones de um constituinte.

Listar tributos constituintes

Lista as homenagens para um constituinte.

Obter informações de contato principal do constituinte

Retorna as informações de contato principais de um constituinte.

Obter um constituinte da organização

Retorna informações sobre um componente da organização.

Obter um constituinte individual

Devolve informações sobre um constituinte individual.

Obter um perfil de resumo do constituinte

Retorna as informações de perfil de resumo de um constituinte.

Obter uma foto de perfil do constituinte

Retorna a foto do perfil de um constituinte.

Obter uma interação constituinte

Devolve detalhes sobre a interação constituinte especificada.

Procurar um constituinte

Procura registos de constituintes utilizando os critérios de filtro fornecidos.

Suprimir um componente

Elimina um constituinte.

Suprimir um código de solicitação constituinte

Exclui um código de solicitação constituinte.

Suprimir um recurso constituinte

Elimina um recurso constituinte.

Suprimir uma nota constitutiva

Elimina uma nota constituinte.

Atualizar um constituinte da organização

Atualiza um componente da organização.

Parâmetros

Name Chave Necessário Tipo Description
ID do constituinte
constituent_id True string

O ID de registro do sistema do componente da organização a ser atualizado.

Nome
organization_name string

Nome do constituinte da organização. Limite de caracteres: 100.

Indústria
industry string

O código da indústria.

Não. Número de empregados
num_employees integer

O número de empregados.

Não. de organizações subsidiárias
num_subsidiaries integer

O número de organizações subsidiárias.

Organização dos pais
parent_corp_id string

O ID de registro do sistema da empresa-mãe.

Endereço Web
web_address string

O sítio Web. Limite de caracteres: 100

A organização é primária?
is_primary boolean

Esta é uma organização primária?

Imagem do perfil
picture string

A foto de perfil do constituinte.

Miniatura do perfil
picture_thumbnail string

Miniatura da foto de perfil do constituinte.

Atualizar um constituinte individual

Atualiza um constituinte individual. Se existe uma relação recíproca, ela também é modificada para refletir as mudanças. Isso não inclui alterações na propriedade "comments", que é específica para cada registro e pode ser modificada independentemente em cada registro.

Parâmetros

Name Chave Necessário Tipo Description
ID do constituinte
constituent_id True string

O ID de registro do sistema do indivíduo a ser atualizado.

Apelido
last_name string

Apelido do eleitor. Limite de caracteres: 100.

Title
title string

O título principal do constituinte.

Nome próprio
first_name string

Primeiro nome do eleitor. Limite de caracteres: 50.

Sufixo
suffix string

Sufixo primário do constituinte.

Nome do meio
middle_name string

O nome do meio do constituinte. Limite de caracteres: 50.

Título 2
title_2 string

Título secundário do constituinte.

Sufixo 2
suffix_2 string

Sufixo secundário do constituinte

Apelido
nickname string

O apelido do eleitor. Limite de caracteres: 50.

Nome da donzela
maiden_name string

Nome de solteira do eleitor. Limite de caracteres: 100.

Estado civil
marital_status string

O estado civil.

ano
year integer

O ano na data difusa.

mês
month integer

O mês na data difusa.

day
day integer

O dia na data difusa.

Sexo
gender_code string

O género do constituinte.

Sítio Web
web_address string

Sítio Web do eleitor.

Dá anonimamente?
gives_anonymously boolean

O constituinte doa anonimamente?

Falecido?
deceased boolean

O constituinte faleceu?

Imagem do perfil
picture string

A foto de perfil do constituinte.

Miniatura do perfil
picture_thumbnail string

Miniatura da foto de perfil do constituinte.

Atualizar um círculo eleitoral de angariação de fundos

Atualiza um círculo eleitoral de angariação de fundos sobre um constituinte.

Parâmetros

Name Chave Necessário Tipo Description
ID do círculo eleitoral
fundraiser_constituency_id True string

O ID de registo do sistema da circunscrição de angariação de fundos a atualizar.

Data de
date_from date

Data de início do círculo eleitoral (ex: «2005-09-18»).

Data para
date_to date

Data de termo para o círculo eleitoral (ex: «2005-09-18»).

Atualizar um código de solicitação de constituinte

Atualiza uma nota constituinte.

Parâmetros

Name Chave Necessário Tipo Description
ID do código de solicitação
constituent_solicit_code_id True string

O ID de registo do sistema do código de solicitação do constituinte para atualização.

Solicitar código
solicit_code string

O código de solicitação.

Data de início
start_date date

A data de início do código de solicitação (ex: '2005-09-18').

Data de fim
end_date date

A data final do código de solicitação (ex: '2005-09-18').

Comments
comments string

Os comentários do código de solicitação. Limite de caracteres: 100.

Atualizar um endereço de constituinte

Atualiza um endereço constituinte.

Parâmetros

Name Chave Necessário Tipo Description
ID do endereço do constituinte
constituent_address_id True string

O ID de registo do sistema do endereço do constituinte a atualizar.

Country
country string

O país de endereço.

Tipo
address_type string

O tipo de endereço.

Address
address_block string

O bloco de endereço. Limite de caracteres: 150.

City
city string

A cidade do endereço. Limite de caracteres: 50.

Estado
state string

O estado do endereço.

Código postal
postcode string

O código potal do endereço. Limite de caracteres: 12.

Primária?
primary boolean

É este o endereço principal do eleitor?

Não envia?
do_not_mail boolean

Não contacta o constituinte neste endereço?

Não envie o motivo do e-mail
do_not_mail_reason string

O motivo de não contactar o constituinte neste endereço.

É confidencial?
confidential boolean

Este endereço é confidencial?

mês
month integer

O mês.

day
day integer

O dia.

mês
month integer

O mês.

day
day integer

O dia.

Data histórica de início
historical_start_date date

A data histórica de início (ex: '2005-09-18').

Data histórica de fim
historical_end_date date

A data histórica do fim (ex: '2005-09-18').

Concelho
county string

O município de endereço.

Região
region string

A região de endereço.

CPD
dpc string

O código do ponto de entrega de endereço. Limite de caracteres: 8.

CARRINHO
cart string

A rota da transportadora de endereço. Limite de caracteres: 10.

LOTE
lot string

O lote de endereço. Limite de caracteres: 5.

Distrito do Congresso
congressional_district string

O endereço congressional distrital.

Distrito da casa do Estado
state_house_district string

O distrito da casa do estado endereço.

Distrito do Senado do Estado
state_senate_district string

O distrito do senado estadual endereço.

Delegacia local
local_precinct string

O endereço delegacia local.

Fonte de informação
info_source string

A fonte de informação para o endereço.

Comentários da fonte de informação
info_source_comments string

Os comentários da fonte de informação. Limite de caracteres: 256.

Omitir da validação?
omit_from_validation boolean

Omitir este endereço da validação?

Atualizar contatos?
update_contacts boolean

Atualizar contatos que usam esse endereço?

Copiar para casa?
update_matching_household_addresses boolean

Copiar informações de endereço para os membros da família?

Atualizar um endereço de e-mail constituinte

Atualiza um endereço de e-mail constituinte.

Parâmetros

Name Chave Necessário Tipo Description
ID do endereço de e-mail
email_address_id True string

O ID de registro do sistema do endereço de e-mail do constituinte a ser atualizado.

Tipo
email_address_type string

O tipo de endereço de e-mail.

Endereço de e-mail
email_address string

O endereço de e-mail. Limite de caracteres: 100.

Data de início
start_date date

A data de início do endereço de e-mail (ex: '2005-09-18').

Data de fim
end_date date

A data de fim do endereço de e-mail (ex: '2005-09-18').

Primária?
primary boolean

Este é o endereço de e-mail principal do eleitor?

Não envia e-mail?
do_not_email boolean

Não contacta o constituinte neste endereço de e-mail?

Fonte de informação
info_source string

A fonte de informação para o endereço de e-mail.

Comentários da fonte de informação
info_source_comments string

Os comentários da fonte de informação. Limite de caracteres: 256.

Copiar para o cônjuge?
update_matching_spouse_email_address boolean

Copiar informações de endereço de e-mail para o cônjuge (aplicável apenas para constituintes individuais)?

Copiar para casa?
update_matching_household_email_address boolean

Copiar informações de endereço de e-mail para membros do agregado familiar (aplicável apenas a constituintes individuais)?

Atualizar um histórico de emprego do constituinte

Atualiza um histórico de emprego constituinte.

Parâmetros

Name Chave Necessário Tipo Description
ID do histórico de emprego
relationship_job_info_id True string

O ID de registro do sistema do histórico de emprego do constituinte a ser excluído.

Cargo
job_title string

O título do cargo. Limite de caracteres: 100.

Nível de carreira
career_level string

O nível de carreira.

Categoria
job_category string

A categoria do trabalho.

Data de início
start_date date

A data de início do emprego (ex: '2005-09-18').

Data de fim
end_date date

Data de fim do contrato de trabalho (ex: «2005-09-18»).

Departamento
job_department string

O departamento de emprego. Limite de caracteres: 100.

Divisão
job_division string

A divisão de trabalhos. Limite de caracteres: 100.

Nível de carreira
job_schedule string

O nível de carreira.

Responsabilidades
job_responsibility string

As responsabilidades do trabalho. Limite de caracteres: 250.

É privado?
private_record boolean

O histórico de emprego é privado?

Atualizar um ID de pesquisa alternativo constituinte

Atualiza uma ID de pesquisa alternativa do constituinte.

Parâmetros

Name Chave Necessário Tipo Description
ID de pesquisa alternativo
alternate_lookup_id True string

O ID de registro do sistema do ID de pesquisa alternativo do constituinte a ser atualizado.

Tipo
alternate_lookup_id_type string

O tipo de ID de pesquisa alternativa.

ID de pesquisa alternativo
alternate_lookup_id string

O ID de pesquisa alternativo. Limite de caracteres: 100.

Atualizar um recurso constituinte

Atualiza um recurso constituinte.

Parâmetros

Name Chave Necessário Tipo Description
Recurso constituinte ID
constituent_appeal_id True string

O ID de registro do sistema do recurso constituinte para atualização.

ID do recurso
appeal_id string

O ID de registro do sistema do recurso.

Envio por correspondência
mkt_segmentation string

A correspondência associada ao recurso.

Data de envio
date_sent date

A data de envio (ex: '2005-09-18').

Package
mkt_package_id string

O ID de registro do sistema do pacote.

Código fonte
source_code string

O código-fonte. Limite de caracteres: 50.

Comments
comments string

Observações do recurso constituinte. Limite de caracteres: 255.

Atualizar um telefone constituinte

Atualiza um telefone constituinte.

Parâmetros

Name Chave Necessário Tipo Description
ID de telefone do constituinte
constituent_phone_id True string

O ID de registro do sistema do telefone constituinte a ser atualizado.

Tipo
phone_type string

O tipo de telefone.

Número
number string

O número de telefone. Limite de caracteres: 100.

Country
country string

O país do telefone.

hora
hour integer

A hora.

minuto
minute integer

O minuto.

hora
hour integer

A hora.

minuto
minute integer

O minuto.

Data de início
start_date date

A data de início do telefone (ex: '2005-09-18').

Data de fim
end_date date

A data de fim do telefone (ex: '2005-09-18').

Primária?
primary boolean

Este é o telefone principal do eleitor?

Não liga?
do_not_call boolean

Não contacta o constituinte através deste número?

Não chame a razão
do_not_call_reason string

O motivo de não entrar em contato com o constituinte neste número.

Não escreve?
donottext boolean

Não contacta o constituinte através de mensagem de texto para este número?

É confidencial?
confidential boolean

Este número de telefone é confidencial?

mês
month integer

O mês.

day
day integer

O dia.

mês
month integer

O mês.

day
day integer

O dia.

Fonte de informação
info_source string

A fonte de informação para o número de telefone.

Comentários da fonte de informação
info_source_comments string

Os comentários da fonte de informação. Limite de caracteres: 256.

Copiar para o cônjuge?
update_matching_spouse_phone boolean

Copiar dados telefónicos para o cônjuge (aplicável apenas a constituintes individuais)?

Copiar para casa?
update_matching_household_phone boolean

Copiar informações telefónicas para os membros do agregado familiar (aplicável apenas a constituintes individuais)?

Atualizar uma educação constituinte

Atualiza uma educação constituinte.

Parâmetros

Name Chave Necessário Tipo Description
ID de história educacional
educational_history_id True string

O ID de registro do sistema da educação constituinte a ser atualizada.

Instituição de ensino
educational_institution_id string

A instituição de ensino.

Situação
educational_history_status string

O estatuto da educação.

Primária?
primary_record boolean

É esta a educação primária do constituinte?

Programa
educational_program string

O programa educacional.

Licenciatura
educational_degree string

O grau de instrução.

Distinção atribuída
educational_award string

A honraria concedida.

Fonte
educational_source string

A fonte de informação.

ano
year integer

O ano na data difusa.

mês
month integer

O mês na data difusa.

day
day integer

O dia na data difusa.

Comments
comment string

A educação comenta. Limite de caracteres: 500.

ano
year integer

O ano na data difusa.

mês
month integer

O mês na data difusa.

day
day integer

O dia na data difusa.

Classe de
class_year integer

A classe de.

Classe preferida de
preferred_class_year integer

A classe preferida de.

Afiliado?
affiliated boolean

A instituição de ensino é afiliada à organização?

ano
year integer

O ano na data difusa.

mês
month integer

O mês na data difusa.

day
day integer

O dia na data difusa.

ano
year integer

O ano na data difusa.

mês
month integer

O mês na data difusa.

day
day integer

O dia na data difusa.

Reason
educational_history_reason string

O motivo do histórico educacional (aplicável apenas para o status de educação "Desconhecido").

Nível
educational_history_level string

O nível de histórico educacional (aplicável apenas para o status de educação "Atualmente frequentando").

Atualizar uma interação constituinte

Atualiza uma interação constituinte.

Parâmetros

Name Chave Necessário Tipo Description
ID de interação
constituent_interaction_id True string

O ID de registro do sistema da interação constituinte a ser excluída.

Resumo
objective string

O resumo da interação. Limite de caracteres: 100.

Situação
status string

O status de interação.

Categoria
interaction_category string

A categoria de interação.

Subcategoria
interaction_subcategory string

A subcategoria interação.

Data prevista
expected_date date

A data de interação prevista (ex: '2005-09-18').

hora
hour integer

A hora.

minuto
minute integer

O minuto.

hora
hour integer

A hora.

minuto
minute integer

O minuto.

Data real
actual_date date

A data real da interação (ex: '2005-09-18').

hora
hour integer

A hora.

minuto
minute integer

O minuto.

hora
hour integer

A hora.

minuto
minute integer

O minuto.

Fuso horário
time_zone_entry string

O fuso horário de interação.

Evento de dia inteiro?
all_day_event boolean

A interação é um evento de dia inteiro?

ID do Proprietário
fundraiser_id string

O ID de registo do sistema do angariador de fundos que detém a interação.

Método de contacto
interaction_type string

O método de contato de interação.

ID do Evento
event_id string

A ID de registro do sistema do evento de interação.

Comments
comment string

A interação comenta.

ID
id string

O ID de registro do sistema do participante da interação.

identificação do constituinte
constituent_id True string

O ID de registo do sistema do componente participante.

Atualizar uma nota constituinte

Atualiza uma nota constituinte.

Parâmetros

Name Chave Necessário Tipo Description
ID da nota constituinte
constituent_note_id True string

O ID de registo do sistema da nota constituinte a atualizar.

Tipo
note_type string

O tipo de nota.

Date
date_entered date

A data da nota (ex: «2005-09-18»).

Title
title string

O título da nota. Limite de caracteres: 50.

ID do autor
author_id string

O ID de registro do sistema do autor da nota.

Observação
text_note string

O texto simples da nota.

HTML
html_note string

O texto html da nota.

Criar um constituinte da organização

Cria um novo componente da organização.

Parâmetros

Name Chave Necessário Tipo Description
Nome
name True string

Nome do constituinte da organização. Limite de caracteres: 100.

Indústria
industry string

O código da indústria.

Não. Número de empregados
num_employees integer

O número de empregados.

Não. de organizações subsidiárias
num_subsidiaries integer

O número de organizações subsidiárias.

Organização dos pais
parent_corp_id string

O ID de registro do sistema da empresa-mãe.

Tipo de endereço
address_type string

O tipo de endereço.

Country
address_country string

O país de endereço.

Address
address_block string

O bloco de endereço. Limite de caracteres: 150.

City
address_city string

A cidade do endereço. Limite de caracteres: 50.

Estado
address_state string

O estado do endereço.

Código postal
address_postcode string

O código postal do endereço. Limite de caracteres: 12.

Não envia correio?
address_do_not_mail boolean

Não envia correio para este endereço?

Não envie o motivo do e-mail
address_do_not_mail_reason string

A razão para não enviar e-mail para este endereço.

CPD
dpc string

O endereço DPC. Limite de caracteres: 8.

CARRINHO
cart string

O endereço CART. Limite de caracteres: 10.

LOTE
lot string

O endereço LOT. Limite de caracteres: 5.

Concelho
county string

O código do condado do endereço.

Distrito do Congresso
congressional_district string

O código distrital do Congresso.

Tipo de telefone
phone_type string

O tipo de telefone.

Número de telefone
phone_number string

O número de telefone. Limite de caracteres: 100.

Tipo de e-mail
email_address_type string

O tipo de e-mail.

Endereço de e-mail
email_address string

O endereço de e-mail. Limite de caracteres: 100.

Endereço Web
web_address string

O sítio Web. Limite de caracteres: 100

A organização é primária?
is_primary boolean

Esta é uma organização primária?

Fonte de informação
info_source string

A fonte de informação.

Imagem do perfil
picture string

A foto de perfil do constituinte.

Miniatura do perfil
picture_thumbnail string

Miniatura da foto de perfil do constituinte.

Devoluções

Constituinte da organização criada

Criar um constituinte individual

Cria um novo constituinte individual.

Parâmetros

Name Chave Necessário Tipo Description
Apelido
last_name True string

Apelido do eleitor. Limite de caracteres: 100.

Title
title string

O título principal do constituinte.

Nome próprio
first_name string

Primeiro nome do eleitor. Limite de caracteres: 50.

Sufixo
suffix string

Sufixo primário do constituinte.

Tipo de endereço
address_type string

O tipo de endereço principal.

Country
address_country string

O país de endereço principal.

Address
address_block string

Endereço principal do eleitor. Limite de caracteres: 150.

City
address_city string

A cidade principal addres. Limite de caracteres: 50.

Estado
address_state string

O estado do endereço.

Código postal
address_post_code string

O código postal do endereço principal. Limite de caracteres: 12.

Não envia correio?
address_do_not_mail boolean

Não envia correio para este endereço?

Não envie o motivo do e-mail
address_do_not_mail_reason string

A razão para não enviar e-mail para este endereço.

CPD
address_dpc string

O endereço DPC. Limite de caracteres: 8.

CARRINHO
address_cart string

O endereço CART. Limite de caracteres: 10.

LOTE
address_lot string

O endereço LOT. Limite de caracteres: 5.

Concelho
address_county string

O código do condado do endereço.

Distrito do Congresso
address_congressional_district string

O código distrital do Congresso.

Tipo de telefone
phone_type string

O tipo de telefone.

Número de telefone
phone_number string

O número de telefone. Limite de caracteres: 100.

Tipo de e-mail
email_address_type string

O tipo de e-mail.

Endereço de e-mail
email_address string

O endereço de e-mail. Limite de caracteres: 100.

Nome do meio
middle_name string

O nome do meio do constituinte. Limite de caracteres: 50.

Título 2
title_2 string

Título secundário do constituinte.

Sufixo 2
suffix_2 string

Sufixo secundário do constituinte

Apelido
nickname string

O apelido do eleitor. Limite de caracteres: 50.

Nome da donzela
maiden_name string

Nome de solteira do eleitor. Limite de caracteres: 100.

Estado civil
marital_status string

O estado civil.

ano
year integer

O ano na data difusa.

mês
month integer

O mês na data difusa.

day
day integer

O dia na data difusa.

Sexo
gender_code string

O género do constituinte.

Devoluções

Constituinte individual criado

Criar um círculo eleitoral de angariação de fundos

Cria uma nova circunscrição de angariação de fundos para um eleitorado.

Parâmetros

Name Chave Necessário Tipo Description
ID do constituinte
constituent_id True string

O ID de registo do sistema do constituinte.

Data de
date_from date

Data de início do círculo eleitoral (ex: «2005-09-18»).

Data para
date_to date

Data de termo para o círculo eleitoral (ex: «2005-09-18»).

Devoluções

Criação de um círculo eleitoral de angariação de fundos

Criar um código de solicitação constituinte

Cria um novo código de solicitação constituinte.

Parâmetros

Name Chave Necessário Tipo Description
ID do constituinte
constituent_id True string

O ID de registo do sistema do constituinte.

Solicitar código
solicit_code True string

O código de solicitação.

Data de início
start_date date

A data de início do código de solicitação (ex: '2005-09-18').

Data de fim
end_date date

A data final do código de solicitação (ex: '2005-09-18').

Comments
comments string

Os comentários do código de solicitação. Limite de caracteres: 100.

Devoluções

Código de solicitação constituinte criado

Criar um endereço de constituinte

Cria um novo endereço constituinte.

Parâmetros

Name Chave Necessário Tipo Description
ID do constituinte
constituent_id True string

O ID de registo do sistema do constituinte.

Country
country True string

O país de endereço.

Tipo
address_type string

O tipo de endereço.

Address
address_block string

O bloco de endereço. Limite de caracteres: 150.

City
city string

A cidade do endereço. Limite de caracteres: 50.

Estado
state string

O estado do endereço.

Código postal
postcode string

O código potal do endereço. Limite de caracteres: 12.

Primária?
primary boolean

É este o endereço principal do eleitor?

Não envia?
do_not_mail boolean

Não contacta o constituinte neste endereço?

Não envie o motivo do e-mail
do_not_mail_reason string

O motivo de não contactar o constituinte neste endereço.

É confidencial?
confidential boolean

Este endereço é confidencial?

mês
month integer

O mês.

day
day integer

O dia.

mês
month integer

O mês.

day
day integer

O dia.

Data histórica de início
historical_start_date date

A data histórica de início (ex: '2005-09-18').

Concelho
county string

O município de endereço.

Região
region string

A região de endereço.

CPD
dpc string

O código do ponto de entrega de endereço. Limite de caracteres: 8.

CARRINHO
cart string

A rota da transportadora de endereço. Limite de caracteres: 10.

LOTE
lot string

O lote de endereço. Limite de caracteres: 5.

Distrito do Congresso
congressional_district string

O endereço congressional distrital.

Distrito da casa do Estado
state_house_district string

O distrito da casa do estado endereço.

Distrito do Senado do Estado
state_senate_district string

O distrito do senado estadual endereço.

Delegacia local
local_precinct string

O endereço delegacia local.

Origem
origin string

A origem do endereço.

Fonte de informação
info_source string

A fonte de informação para o endereço.

Comentários da fonte de informação
info_source_comments string

Os comentários da fonte de informação. Limite de caracteres: 256.

Mudou-se recentemente?
recent_move boolean

Mudou/mudou recentemente deste endereço?

Endereço antigo
old_address string

O endereço antigo.

Omitir da validação?
omit_from_validation boolean

Omitir este endereço da validação?

Copiar para o cônjuge?
update_matching_spouse_addresses boolean

Copiar informações de endereço para o cônjuge (aplicável apenas a constituintes individuais)?

Copiar para casa?
update_matching_household_addresses boolean

Copiar informações de endereço para membros do agregado familiar (aplicável apenas a constituintes individuais)?

Devoluções

Endereço constituinte criado

Criar um endereço de e-mail constituinte

Cria um novo endereço de e-mail constituinte.

Parâmetros

Name Chave Necessário Tipo Description
ID do constituinte
constituent_id True string

O ID de registo do sistema do constituinte.

Tipo
email_address_type string

O tipo de endereço de e-mail.

Endereço de e-mail
email_address True string

O endereço de e-mail. Limite de caracteres: 100.

Data de início
start_date date

A data de início do endereço de e-mail (ex: '2005-09-18').

Primária?
primary boolean

Este é o endereço de e-mail principal do eleitor?

Não envia e-mail?
do_not_email boolean

Não contacta o constituinte neste endereço de e-mail?

Origem
origin string

A origem do endereço de e-mail.

Fonte de informação
info_source string

A fonte de informação para o endereço de e-mail.

Comentários da fonte de informação
info_source_comments string

Os comentários da fonte de informação. Limite de caracteres: 256.

Copiar para o cônjuge?
update_matching_spouse_email_address boolean

Copiar informações de endereço de e-mail para o cônjuge (aplicável apenas para constituintes individuais)?

Copiar para casa?
update_matching_household_email_address boolean

Copiar informações de endereço de e-mail para membros do agregado familiar (aplicável apenas a constituintes individuais)?

Devoluções

Endereço de e-mail constituinte criado

Criar um histórico de emprego constituinte

Cria uma nova história de emprego constituinte.

Parâmetros

Name Chave Necessário Tipo Description
ID do constituinte
context_id True string

O ID de registo do sistema do constituinte.

Relacionamento
relationship True string

A relação constituinte.

Cargo
job_title string

O título do cargo. Limite de caracteres: 100.

Nível de carreira
career_level string

O nível de carreira.

Categoria
job_category string

A categoria do trabalho.

Data de início
start_date date

A data de início do emprego (ex: '2005-09-18').

Data de fim
end_date date

Data de fim do contrato de trabalho (ex: «2005-09-18»).

Departamento
job_department string

O departamento de emprego. Limite de caracteres: 100.

Divisão
job_division string

A divisão de trabalhos. Limite de caracteres: 100.

Nível de carreira
job_schedule string

O nível de carreira.

Responsabilidades
job_responsibility string

As responsabilidades do trabalho. Limite de caracteres: 250.

É privado?
private_record boolean

O histórico de emprego é privado?

Devoluções

Histórico de emprego constituinte criado

Criar um ID de pesquisa alternativo constituinte

Cria um novo ID de pesquisa alternativo constituinte.

Parâmetros

Name Chave Necessário Tipo Description
ID do constituinte
constituent_id True string

O ID de registo do sistema do constituinte.

Tipo
alternate_lookup_id_type True string

O tipo de ID de pesquisa alternativa.

ID de pesquisa alternativo
alternate_lookup_id True string

O ID de pesquisa alternativo. Limite de caracteres: 100.

Devoluções

ID de pesquisa alternativa do constituinte criado

Criar um recurso constituinte

Cria um novo apelo constituinte.

Parâmetros

Name Chave Necessário Tipo Description
ID do constituinte
constituent_id True string

O ID de registo do sistema do constituinte.

ID do recurso
appeal_id True string

O ID de registro do sistema do recurso.

Envio por correspondência
mkt_segmentation string

A correspondência associada ao recurso.

Data de envio
date_sent date

A data de envio (ex: '2005-09-18').

Package
mkt_package_id string

O ID de registro do sistema do pacote.

Código fonte
source_code string

O código-fonte. Limite de caracteres: 50.

Comments
comments string

Observações do recurso constituinte. Limite de caracteres: 255.

Devoluções

Recurso constituinte criado

Criar um telefone constituinte

Cria um novo telefone constituinte.

Parâmetros

Name Chave Necessário Tipo Description
ID do constituinte
constituent_id True string

O ID de registo do sistema do constituinte.

Tipo
phone_type string

O tipo de telefone.

Número
number True string

O número de telefone. Limite de caracteres: 100.

Country
country string

O país do telefone.

hora
hour integer

A hora.

minuto
minute integer

O minuto.

hora
hour integer

A hora.

minuto
minute integer

O minuto.

Data de início
start_date date

A data de início do telefone (ex: '2005-09-18').

Primária?
primary boolean

Este é o telefone principal do eleitor?

Não liga?
do_not_call boolean

Não contacta o constituinte através deste número?

Não chame a razão
do_not_call_reason string

O motivo de não entrar em contato com o constituinte neste número.

Não escreve?
donottext boolean

Não contacta o constituinte através de mensagem de texto para este número?

É confidencial?
confidential boolean

Este número de telefone é confidencial?

mês
month integer

O mês.

day
day integer

O dia.

mês
month integer

O mês.

day
day integer

O dia.

Origem
origin string

A origem do telefone.

Fonte de informação
info_source string

A fonte de informação para o número de telefone.

Comentários da fonte de informação
info_source_comments string

Os comentários da fonte de informação. Limite de caracteres: 256.

Copiar para o cônjuge?
update_matching_spouse_phone boolean

Copiar dados telefónicos para o cônjuge (aplicável apenas a constituintes individuais)?

Copiar para casa?
update_matching_household_phone boolean

Copiar informações telefónicas para os membros do agregado familiar (aplicável apenas a constituintes individuais)?

Devoluções

Telefone constituinte criado

Criar uma educação constituinte

Cria uma nova educação constituinte.

Parâmetros

Name Chave Necessário Tipo Description
ID do constituinte
constituent_id True string

O ID de registo do sistema do constituinte.

Instituição de ensino
educational_institution_id True string

A instituição de ensino.

Situação
educational_history_status True string

O estatuto da educação.

Primária?
primary_record boolean

É esta a educação primária do constituinte?

Programa
educational_program string

O programa educacional.

Licenciatura
educational_degree string

O grau de instrução.

Distinção atribuída
educational_award string

A honraria concedida.

Fonte
educational_source string

A fonte de informação.

ano
year integer

O ano na data difusa.

mês
month integer

O mês na data difusa.

day
day integer

O dia na data difusa.

Comments
comment string

A educação comenta. Limite de caracteres: 500.

ano
year integer

O ano na data difusa.

mês
month integer

O mês na data difusa.

day
day integer

O dia na data difusa.

Classe de
class_year integer

A classe de.

Classe preferida de
preferred_class_year integer

A classe preferida de.

Afiliado?
affiliated boolean

A instituição de ensino é afiliada à organização?

ano
year integer

O ano na data difusa.

mês
month integer

O mês na data difusa.

day
day integer

O dia na data difusa.

ano
year integer

O ano na data difusa.

mês
month integer

O mês na data difusa.

day
day integer

O dia na data difusa.

Reason
educational_history_reason string

O motivo do histórico educacional (aplicável apenas para o status de educação "Desconhecido").

Nível
educational_history_level string

O nível de histórico educacional (aplicável apenas para o status de educação "Atualmente cursando").

Devoluções

Criou a educação constituinte

Criar uma interação constituinte

Cria uma nova interação constituinte.

Parâmetros

Name Chave Necessário Tipo Description
ID do constituinte
constituent_id True string

O ID de registo do sistema do constituinte.

Resumo
objective True string

O resumo da interação. Limite de caracteres: 100.

Situação
status True string

O status de interação.

Categoria
interaction_category string

A categoria de interação.

Subcategoria
interaction_subcategory string

A subcategoria interação.

Data prevista
expected_date True date

A data de interação prevista (ex: '2005-09-18').

hora
hour integer

A hora.

minuto
minute integer

O minuto.

hora
hour integer

A hora.

minuto
minute integer

O minuto.

Data real
actual_date date

A data real da interação (ex: '2005-09-18').

hora
hour integer

A hora.

minuto
minute integer

O minuto.

hora
hour integer

A hora.

minuto
minute integer

O minuto.

Fuso horário
time_zone_entry string

O fuso horário de interação.

Evento de dia inteiro?
is_all_day_event boolean

A interação é um evento de dia inteiro?

ID do Proprietário
fundraiser_id string

O ID de registo do sistema do angariador de fundos que detém a interação.

Método de contacto
interaction_type True string

O método de contato de interação.

ID do Evento
event_id string

A ID de registro do sistema do evento de interação.

Comments
comment string

A interação comenta.

ID do constit
constituent_id True string

O ID de registo do sistema do componente participante.

Devoluções

Interação constituinte criada

Criar uma nota constituinte

Cria uma nova nota constituinte.

Parâmetros

Name Chave Necessário Tipo Description
ID do constituinte
constituent_id True string

O ID de registo do sistema do constituinte.

Tipo
note_type True string

O tipo de nota.

Date
date_entered True date

A data da nota (ex: «2005-09-18»).

Title
title string

O título da nota. Limite de caracteres: 50.

ID do autor
author_id string

O ID de registro do sistema do autor da nota.

Observação
text_note string

O texto simples da nota.

HTML
html_note string

O texto html da nota.

Devoluções

Nota constituinte criada

Criar uma resposta de recurso constituinte

Cria uma nova resposta de apelo constituinte.

Parâmetros

Name Chave Necessário Tipo Description
Recurso constituinte ID
constituent_appeal_id True string

O ID de registro do sistema do recurso constituinte.

Categoria
response_category True string

A categoria de resposta.

Resposta
response True string

A resposta.

Date
date date

A data de resposta (ex: '2005-09-18').

Devoluções

Resposta de recurso constituinte criada

Eliminar um círculo eleitoral de angariação de fundos

Elimina um círculo eleitoral de angariação de fundos de um constituinte.

Parâmetros

Name Chave Necessário Tipo Description
ID do círculo eleitoral
fundraiser_constituency_id True string

O ID de registo do sistema do círculo eleitoral da angariação de fundos a eliminar.

Eliminar um endereço constituinte

Exclui um endereço constituinte.

Parâmetros

Name Chave Necessário Tipo Description
ID do endereço do constituinte
constituent_address_id True string

O ID de registo do sistema do endereço constituinte a eliminar.

Excluir um atributo constituinte

Exclui um atributo constituinte.

Parâmetros

Name Chave Necessário Tipo Description
ID do atributo constituinte
constituent_attribute_id True string

O ID de registro do sistema do atributo constituinte a ser excluído.

Excluir um endereço de e-mail constituinte

Exclui um endereço de e-mail constituinte.

Parâmetros

Name Chave Necessário Tipo Description
ID do endereço de e-mail
email_address_id True string

O ID de registro do sistema do endereço de e-mail do constituinte a ser excluído.

Excluir um histórico de emprego constituinte

Exclui um histórico de emprego constituinte.

Parâmetros

Name Chave Necessário Tipo Description
ID do histórico de emprego
relationship_job_info_id True string

O ID de registro do sistema do histórico de emprego do constituinte a ser excluído.

Excluir um ID de pesquisa alternativo constituinte

Exclui um ID de pesquisa alternativo constituinte.

Parâmetros

Name Chave Necessário Tipo Description
ID de pesquisa alternativo
alternate_lookup_id True string

O ID de registo do sistema do ID de pesquisa alternativo do constituinte a eliminar.

Excluir um telefone constituinte

Exclui um telefone constituinte.

Parâmetros

Name Chave Necessário Tipo Description
ID de telefone do constituinte
constituent_phone_id True string

O ID de registro do sistema do telefone constituinte a ser excluído.

Excluir uma educação constituinte

Exclui um registro educacional constituinte.

Parâmetros

Name Chave Necessário Tipo Description
ID de história educacional
educational_history_id True string

A ID do registro do sistema do registro educacional a ser excluído.

Excluir uma interação constituinte

Exclui uma interação constituinte.

Parâmetros

Name Chave Necessário Tipo Description
ID de interação
constituent_interaction_id True string

O ID de registro do sistema da interação constituinte a ser excluída.

Fundir dois constituintes

Mesclar dois registros constituintes.

Parâmetros

Name Chave Necessário Tipo Description
ID do constituinte de origem
source_id True string

O ID de registo do sistema do constituinte de origem cujos dados serão fundidos no componente de destino.

ID do constituinte alvo
target_id True string

O ID de registro do sistema do componente de destino que representará a exibição consolidada dos dados após a conclusão da mesclagem.

Configuração
config True string

A configuração de mesclagem.

Excluir fonte?
delete_source True boolean

Excluir o componente de origem após a conclusão da mesclagem?

Ação de exclusão
delete_source_constituent True string

O componente de origem de exclusão. Os valores disponíveis são excluir constituinte de origem, marcar constituinte de origem inativo

Motivo inativo
constituent_inactivity_reason_code string

A razão inativa.

Detalhes da inatividade
constituent_inactivity_details string

Os detalhes inativos. Limite de caracteres: 300.

Devoluções

Constituinte resultante da fusão

Listar as formações dos constituintes

Lista as formações para um constituinte.

Parâmetros

Name Chave Necessário Tipo Description
ID do constituinte
constituent_id True string

O ID de registo do sistema do constituinte.

Devoluções

Formação Académica

Listar atributos constituintes

Lista os atributos de um constituinte.

Parâmetros

Name Chave Necessário Tipo Description
ID do constituinte
constituent_id True string

O ID de registo do sistema do constituinte.

Devoluções

Attributes

Listar códigos de solicitação de constituintes

Lista os códigos de solicitação para um constituinte.

Parâmetros

Name Chave Necessário Tipo Description
ID do constituinte
constituent_id True string

O ID de registo do sistema do constituinte.

Mostrar expirado?
show_expired boolean

Mostrar códigos de solicitação expirados?

Intervalo de datas
date_range string

Filtre os resultados para o intervalo de datas especificado.

Devoluções

Solicitar códigos

Listar endereços de constituintes

Lista os endereços de um constituinte.

Parâmetros

Name Chave Necessário Tipo Description
ID do constituinte
constituent_id True string

O ID de registo do sistema do constituinte.

Incluir o primeiro?
include_former boolean

Incluir endereços antigos?

Devoluções

Addresses

Listar endereços de e-mail constituintes

Lista os endereços de e-mail de um constituinte.

Parâmetros

Name Chave Necessário Tipo Description
ID do constituinte
constituent_id True string

O ID de registo do sistema do constituinte.

Devoluções

Endereços de e-mail

Listar histórico de emprego do constituinte

Lista o histórico de emprego de um constituinte.

Parâmetros

Name Chave Necessário Tipo Description
ID do constituinte
constituent_id True string

O ID de registo do sistema do constituinte.

Incluir inativos?
include_inactive boolean

Incluir registos inativos?

Devoluções

Histórico de emprego

Listar IDs de pesquisa alternativos constituintes

Lista as IDs de pesquisa alternativas para um constituinte.

Parâmetros

Name Chave Necessário Tipo Description
ID do constituinte
constituent_id True string

O ID de registo do sistema do constituinte.

Devoluções

IDs de pesquisa alternativos

Listar recursos constituintes

Enumera os recursos enviados a um constituinte.

Parâmetros

Name Chave Necessário Tipo Description
ID do constituinte
constituent_id True string

O ID de registo do sistema do constituinte.

Devoluções

Recursos

Listar telefones constituintes

Lista os telefones de um constituinte.

Parâmetros

Name Chave Necessário Tipo Description
ID do constituinte
constituent_id True string

O ID de registo do sistema do constituinte.

Devoluções

Telefones

Listar tributos constituintes

Lista as homenagens para um constituinte.

Parâmetros

Name Chave Necessário Tipo Description
ID do constituinte
constituent_id True string

O ID de registo do sistema do constituinte.

Devoluções

Homenagens

Obter informações de contato principal do constituinte

Retorna as informações de contato principais de um constituinte.

Parâmetros

Name Chave Necessário Tipo Description
ID do constituinte
constituent_id True string

O ID de registo do sistema do constituinte.

Devoluções

Informações de contato principal do constituinte

Obter um constituinte da organização

Retorna informações sobre um componente da organização.

Parâmetros

Name Chave Necessário Tipo Description
ID do constituinte
constituent_id True string

O ID de registro do sistema do constituinte da organização a ser obtido.

Devoluções

Constituinte da organização

Obter um constituinte individual

Devolve informações sobre um constituinte individual.

Parâmetros

Name Chave Necessário Tipo Description
ID do constituinte
constituent_id True string

O ID de registro do sistema do constituinte individual a ser obtido.

Devoluções

Constituinte individual

Obter um perfil de resumo do constituinte

Retorna as informações de perfil de resumo de um constituinte.

Parâmetros

Name Chave Necessário Tipo Description
ID do constituinte
constituent_id True string

O ID de registo do sistema do constituinte.

Devoluções

Perfil sumário dos constituintes

Obter uma foto de perfil do constituinte

Retorna a foto do perfil de um constituinte.

Parâmetros

Name Chave Necessário Tipo Description
ID do constituinte
constituent_id True string

O ID de registo do sistema do constituinte.

Devoluções

Informações de contato principal do constituinte

Obter uma interação constituinte

Devolve detalhes sobre a interação constituinte especificada.

Parâmetros

Name Chave Necessário Tipo Description
ID de interação
constituent_interaction_id True string

O ID de registro do sistema da interação constituinte a ser obtida.

Devoluções

Interação

Procurar um constituinte

Procura registos de constituintes utilizando os critérios de filtro fornecidos.

Parâmetros

Name Chave Necessário Tipo Description
Nome da chave
key_name string

O nome da chave constituinte (sobrenome para indivíduos, nome da organização para organizações).

Nome próprio
first_name string

O primeiro nome do constituinte.

ID de pesquisa
lookup_id string

O ID de pesquisa do constituinte.

Endereço de e-mail
email_address string

O endereço de e-mail do constituinte.

Número de telefone
phone_number string

O número de telefone do constituinte.

Country
country string

Um filtro para o país de endereço do constituinte.

Address
address_block string

Um filtro para o bloco de endereços constituinte.

City
city string

Um filtro para a cidade de endereço do constituinte.

Estado
state string

Um filtro para o estado do endereço do constituinte.

Código postal
post_code string

Um filtro para o código postal do endereço constituinte.

Classe de
classof integer

Um filtro para o ano de classe primária do constituinte.

Corresponde exatamente?
exact_match_only boolean

Corresponde exatamente a todos os critérios?

Nome do meio
middle_name string

O nome do meio constituinte.

Círculo eleitoral
constituency string

Um filtro para o círculo eleitoral do constituinte.

Código fonte
sourcecode string

Um filtro para o código-fonte do recurso constituinte.

Incluir indivíduos?
include_individuals boolean

Incluir constituintes individuais?

Incluir organizações?
include_organizations boolean

Incluir constituintes da organização?

Incluir grupos?
include_groups boolean

Incluir grupos ao pesquisar?

Excluir agregados familiares?
exclude_households boolean

Excluir agregados familiares ao pesquisar?

Verificar apelido?
check_nickname boolean

Verificar apelido ao pesquisar?

Verificar aliases?
check_aliases boolean

Verificar aliases ao pesquisar?

Verificar IDs de pesquisa alt?
check_alternate_lookup_ids boolean

Verificar IDs de pesquisa alternativos ao pesquisar?

Só primária?
only_primary_address boolean

Pesquise apenas endereços primários?

Incluir falecido?
include_deceased boolean

Incluir eleitores falecidos?

Incluir inativos?
include_inactive boolean

Incluir constituintes inativos?

Usa a pesquisa difusa?
fuzzy_search_on_name boolean

Usa pesquisa difusa no nome?

Limite
limit integer

Representa o número de registros a serem retornados.

Devoluções

Resultados da pesquisa

Suprimir um componente

Elimina um constituinte.

Parâmetros

Name Chave Necessário Tipo Description
ID do constituinte
constituent_id True string

O ID de registo do sistema do constituinte a eliminar.

Suprimir um código de solicitação constituinte

Exclui um código de solicitação constituinte.

Parâmetros

Name Chave Necessário Tipo Description
ID do código de solicitação
constituent_solicit_code_id True string

O ID de registo do sistema do constituinte solicita o código a eliminar.

Suprimir um recurso constituinte

Elimina um recurso constituinte.

Parâmetros

Name Chave Necessário Tipo Description
Recurso constituinte ID
constituent_appeal_id True string

O ID de registro do sistema do recurso constituinte para excluir.

Suprimir uma nota constitutiva

Elimina uma nota constituinte.

Parâmetros

Name Chave Necessário Tipo Description
ID da nota constituinte
constituent_note_id True string

O ID de registo do sistema da nota constituinte a eliminar.

Definições

Conmg.Endereço

Address

Name Caminho Tipo Description
ID
id string

O ID de registro do sistema do endereço.

Tipo
type string

O tipo de endereço.

Address
contact_info string

O endereço.

É primário?
primary string

É este o endereço principal do eleitor?

É confidencial?
confidential boolean

O endereço é confidencial?

É o primeiro?
former boolean

O endereço é um endereço anterior?

Não contacta?
do_not_contact string

Não contacta o constituinte neste endereço?

Data de início
start_date date-time

A data de início do endereço.

Data de fim
end_date date

A data de término do endereço.

Geocodificado?
geocoded boolean

O endereço foi geocodificado?

Geocódigo pendente?
pending_geocode boolean

O endereço está pendente de geocodificação?

Geocódigo inválido?
invalid_geocode boolean

A geocodificação de endereços é inválida?

ID de contexto do mapa
map_context_id string

O ID de contexto do mapa de endereços

Conmg.AddressCollection

Addresses

Name Caminho Tipo Description
Contar
count integer

O número de itens disponíveis para recuperação na coleção após a aplicação de quaisquer parâmetros de solicitação. Os parâmetros limit e offset não afetam a contagem, mas para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados de valor.

valor
value array of Conmg.Address

O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

Conmg.AlternateLookupID

ID de pesquisa alternativo

Name Caminho Tipo Description
ID
id string

O ID de registro do sistema do ID de pesquisa alternativo.

Tipo
type string

O tipo de ID de pesquisa alternativa.

ID de pesquisa alternativo
alternate_lookup_id string

O ID de pesquisa alternativo.

Conmg.AlternateLookupIDCollection

IDs de pesquisa alternativos

Name Caminho Tipo Description
Contar
count integer

O número de itens disponíveis para recuperação na coleção após a aplicação de quaisquer parâmetros de solicitação. Os parâmetros limit e offset não afetam a contagem, mas para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados de valor.

valor
value array of Conmg.AlternateLookupID

O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

Conmg.Atributo

Attribute

Name Caminho Tipo Description
ID
id string

O ID de registro do sistema do atributo.

Categoria
category string

A categoria de atributo.

ID da categoria
attribute_category_id string

O ID de registro do sistema da categoria de atributo.

Grupo
attribute_group string

O grupo de atributos.

Valor
value string

O valor do atributo.

Data de início
start_date date-time

A data de início do atributo.

Data de fim
end_date date-time

A data de término do atributo.

Comment
comment string

O comentário do atributo.

Conmg.AttributeCollection

Attributes

Name Caminho Tipo Description
Contar
count integer

O número de itens disponíveis para recuperação na coleção após a aplicação de quaisquer parâmetros de solicitação. Os parâmetros limit e offset não afetam a contagem, mas para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados de valor.

valor
value array of Conmg.Attribute

O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

Conmg.ConstituentAppeal

Appeal

Name Caminho Tipo Description
ID
id string

O ID de registro do sistema do recurso constituinte.

ID do recurso
appeal_id string

O ID de registro do sistema do recurso.

Nome do recurso
appeal string

O nome do recurso.

Descrição do recurso
description string

A descrição do recurso.

ID para correspondência
mkt_segmentation_id string

O ID de registro do sistema da correspondência.

Nome para correspondência
mailing string

O nome para correspondência.

Código do tipo de família Mailing
mailing_family_type_code integer

O código do tipo de família de correspondência.

Data de envio
date_sent date-time

A data enviada.

Nome do pacote
package string

O nome do pacote.

Código fonte
source_code string

O código-fonte.

ID do Segmento
mkt_segmentation_segment_id string

O ID de registro do sistema do segmento de endereçamento.

Segmento
segment string

O segmento de mailing.

Número do localizador
finder_number integer

O número do localizador.

Segmento de teste
test_segment string

O segmento de teste.

Carta
letter string

A carta de apelação constituinte.

Comments
comments string

Observações do recurso constituinte.

Tem respostas?
has_responses boolean

Este apelo teve respostas?

Envio de recurso?
appeal_mailing boolean

Trata-se de um envio de apelação?

Período de tempo
time_frame_text string

O prazo de recurso constituinte.

Classificação de grupo de período de tempo
time_frame_group_sort string

A ordem de classificação do grupo de períodos.

Conmg.ConstituentAppealCollection

Recursos

Name Caminho Tipo Description
Contar
count integer

O número de itens disponíveis para recuperação na coleção após a aplicação de quaisquer parâmetros de solicitação. Os parâmetros limit e offset não afetam a contagem, mas para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados de valor.

valor
value array of Conmg.ConstituentAppeal

O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

Conmg.ConstituentInteractionParticipant

Um objeto que representa um participante da interação constituinte.

Name Caminho Tipo Description
ID
id string

O ID de registro do sistema do participante da interação.

identificação do constituinte
constituent_id string

O ID de registo do sistema do componente participante.

Conmg.ConstituentInteraction

Interação

Name Caminho Tipo Description
ID do constituinte
constituent_id string

O ID de registo do sistema do constituinte.

Nome do constituinte
constituent_name string

O nome do constituinte.

Resumo
objective string

O resumo da interação.

Situação
status string

O status de interação.

Categoria
interaction_category string

A categoria de interação.

Subcategoria
interaction_subcategory string

A subcategoria interação.

Data prevista
expected_date date-time

A data de interação esperada.

hora
expected_start_time.hour integer

A hora.

minuto
expected_start_time.minute integer

O minuto.

hora
expected_end_time.hour integer

A hora.

minuto
expected_end_time.minute integer

O minuto.

Data real
actual_date date-time

A data real da interação.

hora
actual_start_time.hour integer

A hora.

minuto
actual_start_time.minute integer

O minuto.

hora
actual_end_time.hour integer

A hora.

minuto
actual_end_time.minute integer

O minuto.

Fuso horário
time_zone_entry string

O fuso horário de interação.

Evento de dia inteiro?
all_day_event boolean

A interação é um evento de dia inteiro?

ID do Proprietário
fundraiser_id string

O ID de registo do sistema do angariador de fundos que detém a interação.

Método de contacto
interaction_type string

O método de contato de interação.

ID do Evento
event_id string

A ID de registro do sistema do evento de interação.

Comments
comment string

A interação comenta.

Participants
participants array of Conmg.ConstituentInteractionParticipant

Os participantes da interação.

Conmg.ConstituentPrimaryContactInfo

Informações de contato principal do constituinte

Name Caminho Tipo Description
Tipo de endereço
address_type_label string

O tipo de endereço principal.

ID do tipo de endereço
address_type_id string

O ID de registro do sistema do tipo de endereço principal.

ID do país do endereço principal
country_id string

O ID de registro do sistema do país de endereço principal.

Endereço principal
address string

O endereço principal.

Cidade do endereço principal
city string

A cidade de endereço principal.

ID do estado do endereço principal
state_id string

O ID de registro do sistema do estado do endereço primário.

Código postal do endereço principal
post_code string

O código postal do endereço principal.

O endereço é confidencial?
confidential boolean

O endereço é confidencial?

Não envia?
do_not_mail boolean

Não contacta o constituinte neste endereço?

Não envie por e-mail o ID do motivo
do_not_mail_reason_code_id string

O sistema regista o ID do motivo para não contactar o constituinte neste endereço.

Tipo de telefone principal
phone_type_label string

O tipo de telefone principal.

ID do tipo de telefone principal
phone_type_id string

O ID de registro do sistema do tipo de telefone principal.

Número de telefone principal
phone string

O número de telefone principal.

O telefone é confidencial?
phone_is_confidential boolean

O número de telefone é confidencial?

Não liga?
do_not_call boolean

Não contacta o constituinte através deste número?

Não ligue para o ID do motivo
do_not_call_reason_code_id string

O sistema regista o ID do motivo pelo qual não contactou o constituinte neste número.

Tipo de endereço de e-mail principal
email_type_label string

O tipo de endereço de e-mail principal.

ID do tipo de endereço de e-mail principal
email_type_id string

O ID de registro do sistema do tipo de endereço de e-mail principal.

Endereço de e-mail principal
email string

O endereço de e-mail principal.

Não envia e-mail?
do_not_email boolean

Não contacta o constituinte neste endereço de e-mail?

Sítio Web
web_address string

Sítio Web do eleitor.

Conmg.ConstituentProfilePicture

Informações de contato principal do constituinte

Name Caminho Tipo Description
Imagem
picture string

A foto de perfil contituente.

Title
title string

O título principal do constituinte.

Nome próprio
first_name string

Primeiro nome do eleitor.

Nome da chave
key_name string

O nome-chave do constituinte.

Sufixo
suffix string

Sufixo primário do constituinte.

Nome do meio
middle_name string

O nome do meio do constituinte.

Apelido
nick_name string

O apelido do eleitor.

Nome da donzela
maiden_name string

Nome de solteira do eleitor.

Dá anonimamente?
gives_anonymously boolean

O constituinte doa anonimamente?

Conmg.ConstituentSearchResult

Resultado da pesquisa

Name Caminho Tipo Description
ID
id string

O ID de registo do sistema do constituinte.

Nome
name string

O nome do constituinte. Para indivíduos, esse campo calculado indica o nome completo do constituinte com base nas configurações de nome de exibição da organização de destino.

Nome do meio
middle_name string

O nome do meio do constituinte.

ID do código de sufixo
suffixcodeid string

O ID de registo do sistema do sufixo do constituinte.

ID de pesquisa
lookup_id string

O identificador definido pelo utilizador para o constituinte.

Nome da ordenação
sort_constituent_name string

O nome da classificação constituinte.

ID do país
country_id string

O ID de registo do sistema do país de endereço principal do constituinte.

Address
address string

Endereço preferencial do eleitor.

City
city string

A cidade de endereço preferida do eleitor.

Estado
state string

O endereço preferencial do eleitor, indica.

Código postal
post_code string

Código postal do endereço preferencial do eleitor.

Telemóvel
phone string

O telefone do eleitor.

Endereço de e-mail
email_address string

Endereço de correio eletrónico do constituinte.

Classe de
classof integer

O ano letivo primário do constituinte.

Dá anonimamente?
gives_anonymously boolean

O constituinte doa anonimamente?

É organização?
organization boolean

O constituinte é uma organização?

É grupo?
group boolean

O constituinte é um grupo?

O agregado familiar é o agregado familiar?
household boolean

O constituinte é um agregado familiar?

Gestor de prospeção
prospectmanager string

O gestor de prospeção do constituinte

Conmg.ConstituentSearchResultCollection

Resultados da pesquisa

Name Caminho Tipo Description
Contar
count integer

O número de itens disponíveis para recuperação na coleção após a aplicação de quaisquer parâmetros de solicitação.

valor
value array of Conmg.ConstituentSearchResult

O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

Conmg.ConstituentSummaryProfile

Perfil sumário dos constituintes

Name Caminho Tipo Description
Nome
name string

O nome do constituinte.

ID de pesquisa
lookup_id string

O ID de pesquisa do constituinte.

É um perfil de constituinte?
constituent_profile boolean

É um perfil de constituinte?

É organização?
organization boolean

O constituinte é uma organização?

Organização-mãe
top_parent string

A organização-mãe.

ID da organização pai
top_parent_id string

O ID de registro do sistema da organização pai.

É grupo?
group boolean

O constituinte é um grupo?

O grupo é dissolvido?
dissolved boolean

O grupo é dissolvido?

tipo de grupo
group_type string

O tipo de grupo.

Número de membros do grupo
group_member_count integer

O número de membros do grupo.

É membro da comissão?
committee_member boolean

É membro de um comité?

O agregado familiar é o agregado familiar?
household boolean

O constituinte é um agregado familiar?

Identificação do agregado familiar
household_id string

O ID de registo do sistema do agregado familiar.

Texto doméstico
household_text string

O texto doméstico.

Está inativo?
inactive boolean

O constituinte está inativo?

Motivo da inatividade
constituent_inactivity_reason string

A razão da inatividade cosntituente.

Faleceu?
deceased boolean

O constituinte faleceu?

ano
deceaseddate.year integer

O ano na data difusa.

mês
deceaseddate.month integer

O mês na data difusa.

day
deceaseddate.day integer

O dia na data difusa.

O cônjuge faleceu?
spouse_deceased boolean

O cônjuge faleceu?

Dá anonimamente?
gives_anonymously boolean

O constituinte doa anonimamente?

Declarações arquivadas?
declarations_on_file boolean

O constituinte tem declarações arquivadas?

Atualização do WealthPoint pendente?
wealthpoint_update_pending boolean

Uma atualização do WealthPoint está pendente?

Imagem do perfil
picture string

A foto de perfil do constituinte.

Negócio principal
primary_business string

O negócio principal do constituinte.

ID comercial principal
primary_business_id string

A ID de registro do sistema da empresa principal.

Ensino primário
primary_education string

A educação primária do constituinte.

ID do ensino primário
primary_education_id string

O ID de registo do sistema do ensino primário.

Atributos educacionais definidos?
education_attribute_defined boolean

O constituinte tem atributos educacionais definidos?

Constituinte relacionado
related_constituent string

O constituinte relacionado.

ID do constituinte relacionado
related_constituent_id string

O ID de registo do sistema do componente relacionado.

Solicitar contagem de códigos
solicit_code_count integer

O número de códigos solicitados.

ID do endereço principal
address_id string

O ID de registro do sistema do endereço principal.

Endereço principal
address string

O endereço principal.

O endereço é confidencial?
address_is_confidential boolean

O endereço é confidencial?

Não envia?
do_not_mail boolean

Não contacta o constituinte neste endereço?

ID de telefone principal
phone_number_id string

O ID de registro do sistema do telefone principal.

Tipo de telefone principal
phone_type string

O tipo de telefone principal.

Número de telefone principal
phone_number string

O número de telefone principal.

O telefone é confidencial?
phone_is_confidential boolean

O número de telefone é confidencial?

Não liga?
do_not_phone boolean

Não contacta o constituinte através deste número?

ID do endereço de e-mail principal
email_address_id string

O ID de registro do sistema do endereço de e-mail principal.

Endereço de e-mail principal
email_address string

O endereço de e-mail principal.

Não envia e-mail?
do_not_email boolean

Não contacta o constituinte neste endereço de e-mail?

Sítio Web
web_address string

Sítio Web do eleitor.

Texto do estado do registante
registrant_status_text string

O texto do estatuto do registante.

Texto de status do fornecedor
vendor_status_text string

O texto de status do fornecedor.

Texto do status do ex-aluno
alumnus_status_text string

O texto do status do ex-aluno.

ID de inscrição do Alumnus
alumnus_enrollment_id string

O ID de inscrição do ex-aluno.

ID de inscrição atual
current_enrollment_id string

O ID de inscrição atual.

ID de inscrição atual 2
current_enrollment_id_2 string

O ID de inscrição atual 2.

ID de inscrição atual 3
current_enrollment_id_3 string

O ID de inscrição atual 3.

ID de matrícula do aluno
student_enrollment_id string

O ID de matrícula do aluno.

Escola atual
current_school string

A escola atual.

Escola atual 2
current_school_2 string

A atual escola 2.

Escola atual 3
current_school_3 string

A escola atual 3.

Fase do ciclo de vida
lifecycle_stage string

A fase do ciclo de vida do dador.

Estágio do ciclo de vida a partir de
lifecycle_stage_as_of date-time

A fase do ciclo de vida do dador as-of data.

Fase planeada do doador
planned_giver_stage string

O estágio de doador planejado.

Fase planeada do doador a partir de
planned_giver_stage_as_of date-time

O estágio de doador planejado as-of data.

Estado doador
donor_state string

O Estado doador.

Código do Estado do dador
donor_state_code integer

O código do estado do doador.

Código do tipo de patrocinador
sponsor_type_code integer

O código de tipo do patrocinador.

Data da última receita
last_revenue_date date-time

A data da última receita.

Texto do círculo eleitoral dos antigos alunos
alumnus_constituency_text string

O texto do círculo eleitoral dos antigos alunos.

Defender o texto do círculo eleitoral
advocate_constituency_text string

O texto do círculo eleitoral do advogado.

Texto do círculo eleitoral bancário
bank_constituency_text string

O texto da circunscrição bancária.

Texto do círculo eleitoral dos membros do conselho de administração
board_member_constituency_text string

O texto da circunscrição dos membros do conselho de administração.

Texto do círculo eleitoral das comissões
committee_constituency_text string

O texto da circunscrição da comissão.

Texto do círculo eleitoral dos membros do Comité
committee_member_constituency_text string

O texto da circunscrição dos membros da comissão.

Texto do círculo eleitoral dos membros da Comunidade
community_member_constituency_text string

O texto do círculo eleitoral dos membros da comunidade.

Texto do círculo eleitoral dos doadores
donor_constituency_text string

O texto do eleitorado doador.

Texto do círculo docente
faculty_constituency_text string

O texto da circunscrição docente.

Texto do círculo eleitoral da angariação de fundos
fundraiser_constituency_text string

O texto do círculo eleitoral de angariação de fundos.

Texto do círculo eleitoral do grupo de angariação de fundos
fundraising_group_constituency_text string

O texto do círculo eleitoral do grupo de angariação de fundos.

Texto do círculo eleitoral do concedente
grantor_constituency_text string

O texto do círculo eleitoral concedente.

Texto do eleitorado do doador leal
loyal_donor_constituency_text string

O texto do eleitorado doador leal.

Texto do círculo eleitoral dos principais doadores
major_donor_constituency_text string

O texto do círculo eleitoral dos principais doadores.

Texto do círculo eleitoral do MatchFinder
matchfinder_constituency_text string

O texto do círculo eleitoral do MatchFinder.

ID do registo online do MatchFinder
matchfinder_online_record_id integer

O ID de registro online do MatchFinder.

Texto do círculo eleitoral dos membros
member_constituency_text string

O texto da circunscrição dos membros.

Texto do círculo eleitoral do NFG
nfg_constituency_text string

O texto do círculo eleitoral do NFG.

Texto do círculo eleitoral do Padroeiro
patron_constituency_text string

O texto do eleitorado patrono.

Texto do círculo eleitoral do doador planeado
plannedgiverconstituencytext string

O texto da circunscrição do doador planeado.

Texto do círculo eleitoral prospetivo
prospect_constituency_text string

O texto do círculo eleitoral em perspetiva.

Texto do círculo eleitoral de reconhecimento
recognition_constituency_text string

O texto da circunscrição de reconhecimento.

Texto do círculo eleitoral da relação
relation_constituency_text string

O texto da circunscrição relacional.

Texto do círculo eleitoral do patrocinador
sponsor_constituency_text string

O texto do círculo eleitoral do patrocinador.

Texto do círculo eleitoral do pessoal
staff_constituency_text string

O texto do círculo eleitoral do pessoal.

Texto do círculo eleitoral estudantil
student_constituency_text string

O texto do círculo eleitoral estudantil.

Texto do círculo eleitoral da relação estudantil
student_relation_constituency_text string

O texto da circunscrição da relação estudantil.

Texto do círculo eleitoral definido pelo utilizador
user_defined_constituency_text string

O texto do constituinte definido pelo usuário.

Texto do eleitorado voluntário
volunteer_constituency_text string

O texto do eleitorado voluntário.

Ordem de exibição dos círculos eleitorais
constituencies_display_order array of Conmg.ConstituencyDisplayOrder

A ordem de exibição para os círculos eleitorais.

Círculos eleitorais definidos pelo utilizador
user_defined_constituencies array of Conmg.UserDefinedConstituency

O conjunto de círculos eleitorais definidos pelo utilizador.

Círculos eleitorais de relações estudantis
student_relation_constituencies array of Conmg.StudentRelationConstituency

O conjunto de círculos eleitorais de relações estudantis.

Contas nas redes sociais
social_media_accounts array of Conmg.ConstituentSocialMediaAccount

O conjunto de contas de mídia social para o constituinte.

Conmg.ConstituencyDisplayOrder

Ordem de exibição do círculo eleitoral

Name Caminho Tipo Description
ID
id string

O ID do eleitorado.

descrição
description string

A descrição do círculo eleitoral.

sequência
sequence integer

A sequência eleitoral.

é sistema?
system boolean

O sistema constituinte é definido?

Conmg.UserDefinedConstituency

Círculo eleitoral definido pelo utilizador

Name Caminho Tipo Description
descrição
description string

A descrição do círculo eleitoral.

sequência
sequence string

A sequência eleitoral.

Conmg.StudentRelationConstituency

Círculo eleitoral de relações estudantis

Name Caminho Tipo Description
descrição
description string

A descrição do círculo eleitoral.

sequência
sequence string

A sequência eleitoral.

Conmg.ConstituentSocialMediaAccount

Conta constituinte nas redes sociais

Name Caminho Tipo Description
ID
id string

O ID de registro do sistema da conta de mídia social.

ID do serviço
social_media_service_id string

O ID de registro do sistema do serviço de mídia social.

Nome do serviço
social_media_service_name string

O serviço de mídia social.

icon
social_media_service_icon string

O ícone do serviço de mídia social.

ID do tipo de conta
social_media_account_type_code_id string

O ID de registro do sistema do tipo de conta do serviço de mídia social.

tipo de conta
social_media_account_type string

O tipo de conta do serviço de rede social.

ID de utilizador
user_id string

O ID de utilizador da conta de rede social.

URL
url string

O url da rede social.

ID do código-fonte info
info_source_code_id string

O ID de registro do sistema do código-fonte de informações da conta de mídia social.

fonte de informação
info_source string

A fonte de informações da conta de mídia social.

não contacta?
do_not_contact boolean

Não contacta o constituinte nesta conta?

sequência
sequence integer

A sequência da conta nas redes sociais.

Conmg.CreatedConstituentAddress

Endereço constituinte criado

Name Caminho Tipo Description
ID
id string

O ID do endereço do constituinte recém-criado.

Conmg.CreatedConstituentAlternateLookupID

ID de pesquisa alternativa do constituinte criado

Name Caminho Tipo Description
ID
id string

A ID da ID de pesquisa alternativa do constituinte recém-criada.

Conmg.CreatedConstituentAppeal

Recurso constituinte criado

Name Caminho Tipo Description
ID
id string

A identificação do recurso constituinte recém-criado.

Conmg.CreatedConstituentAppealResponse

Resposta de recurso constituinte criada

Name Caminho Tipo Description
ID
id string

O ID da resposta de recurso constituinte recém-criada.

Conmg.CreatedConstituentEducation

Criou a educação constituinte

Name Caminho Tipo Description
ID
id string

O ID da educação constituinte recém-criada.

Conmg.CreatedConstituentEmailAddress

Endereço de e-mail constituinte criado

Name Caminho Tipo Description
ID
id string

O ID do endereço de e-mail do constituinte recém-criado.

Conmg.CreatedConstituentEmploymentHistory

Histórico de emprego constituinte criado

Name Caminho Tipo Description
ID
id string

O ID do histórico de emprego do constituinte recém-criado.

Conmg.CreatedConstituentInteraction

Interação constituinte criada

Name Caminho Tipo Description
ID
id string

A ID da interação constituinte recém-criada.

Conmg.CreatedConstituentNote

Nota constituinte criada

Name Caminho Tipo Description
ID
id string

O ID da nota constituinte recém-criada.

Conmg.CreatedConstituentPhone

Telefone constituinte criado

Name Caminho Tipo Description
ID
id string

O ID do telefone constituinte recém-criado.

Conmg.CreatedConstituentSolicitCode

Código de solicitação constituinte criado

Name Caminho Tipo Description
ID
id string

O ID do código de solicitação do constituinte recém-criado.

Conmg.CriadoAngariação de fundosConstituency

Criação de um círculo eleitoral de angariação de fundos

Name Caminho Tipo Description
ID
id string

O ID do círculo eleitoral recém-criado para angariação de fundos.

Conmg.CreatedIndividualConstituent

Constituinte individual criado

Name Caminho Tipo Description
ID
id string

O ID do constituinte individual recém-criado.

Conmg.CreatedOrganizationConstituent

Constituinte da organização criada

Name Caminho Tipo Description
ID
id string

A ID do constituinte da organização recém-criado.

Conmg.Educação

Education

Name Caminho Tipo Description
ID
id string

O ID de registro do sistema da educação constituinte.

Instituição de ensino
name string

A instituição de ensino.

Situação
education_history_status string

O estatuto da educação.

Primária?
primary_record boolean

É esta a educação primária do constituinte?

Programa
program string

O programa educacional.

Licenciatura
degree string

O grau de instrução.

Classe de
class_of integer

A classe de.

Afiliado?
affiliated boolean

A instituição de ensino é afiliada à organização?

ano
start_date.year integer

O ano na data difusa.

mês
start_date.month integer

O mês na data difusa.

day
start_date.day integer

O dia na data difusa.

ano
end_date.year integer

O ano na data difusa.

mês
end_date.month integer

O mês na data difusa.

day
end_date.day integer

O dia na data difusa.

Conmg.EducationCollection

Formação Académica

Name Caminho Tipo Description
Contar
count integer

O número de itens disponíveis para recuperação na coleção após a aplicação de quaisquer parâmetros de solicitação. Os parâmetros limit e offset não afetam a contagem, mas para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados de valor.

valor
value array of Conmg.Education

O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

Conmg.EmailAddress

Endereço de e-mail

Name Caminho Tipo Description
ID
id string

O ID de registro do sistema do endereço de e-mail.

Tipo de e-mail
type string

O tipo de endereço de e-mail.

Endereço de e-mail
email_address string

O endereço de e-mail.

Primária?
primary boolean

Este é o endereço de e-mail principal do eleitor?

Data de início
start_date date-time

A data de início do endereço de e-mail.

Data de fim
end_date date

A data de término do endereço de e-mail.

Fonte de informação
info_source string

A fonte de informação.

Comentários da fonte de informação
info_source_comments string

Os comentários da fonte de informação.

Conmg.EmailAddressCollection

Endereços de e-mail

Name Caminho Tipo Description
Contar
count integer

O número de itens disponíveis para recuperação na coleção após a aplicação de quaisquer parâmetros de solicitação. Os parâmetros limit e offset não afetam a contagem, mas para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados de valor.

valor
value array of Conmg.EmailAddress

O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

Conmg.EmpregoHistória

Histórico de emprego

Name Caminho Tipo Description
ID
id string

O ID de registro do sistema do histórico de emprego do constituinte.

Relacionamento
name string

A relação constituinte.

Cargo
job_title string

O título do cargo.

Nível de carreira
career_level string

O nível de carreira.

Categoria
job_category string

A categoria do trabalho.

Data de início
start_date date-time

A data de início do emprego.

Data de fim
end_date date-time

A data de fim do emprego.

Departamento
job_department string

O departamento de emprego.

Divisão
job_division string

A divisão de trabalhos.

Nível de carreira
job_schedule string

O nível de carreira.

Responsabilidades
job_responsibility string

As responsabilidades do trabalho.

É privado?
private_record boolean

O histórico de emprego é privado?

Conmg.EmploymentHistoryCollection

Histórico de emprego

Name Caminho Tipo Description
Contar
count integer

O número de itens disponíveis para recuperação na coleção após a aplicação de quaisquer parâmetros de solicitação. Os parâmetros limit e offset não afetam a contagem, mas para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados de valor.

valor
value array of Conmg.EmploymentHistory

O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

Conmg.IndividualConstituinte

Constituinte individual

Name Caminho Tipo Description
Title
title string

O título principal do constituinte.

Nome próprio
first_name string

Primeiro nome do eleitor.

Apelido
last_name string

Apelido do eleitor.

Sufixo
suffix string

Sufixo primário do constituinte.

Nome do meio
middle_name string

O nome do meio do constituinte.

Apelido
nickname string

O apelido do eleitor.

Nome da donzela
maiden_name string

Nome de solteira do eleitor.

Estado civil
marital_status string

O estado civil.

ano
birth_date.year integer

O ano na data difusa.

mês
birth_date.month integer

O mês na data difusa.

day
birth_date.day integer

O dia na data difusa.

Idade
age integer

A idade do constituinte.

Sexo
gender_code string

O género do constituinte.

Sítio Web
web_address string

Sítio Web do eleitor.

Título 2
title_2 string

Título secundário do constituinte.

Sufixo 2
suffix_2 string

Sufixo secundário do constituinte

Dá anonimamente?
gives_anonymously boolean

O constituinte doa anonimamente?

Falecido?
deceased boolean

O constituinte faleceu?

Imagem do perfil
picture string

A foto de perfil do constituinte.

Miniatura da imagem de perfil
picture_thumbnail string

Miniatura da foto de perfil do constituinte.

Conmg.MergedConstituent

Constituinte resultante da fusão

Name Caminho Tipo Description
ID
id string

O ID do constituinte fundido.

Conmg.OrganizaçãoConstituinte

Constituinte da organização

Name Caminho Tipo Description
Nome
organization_name string

O nome da organização.

Indústria
industry string

A indústria.

Sociedade-mãe
parent_corp_id string

O ID de registro do sistema da empresa-mãe.

Número de empregados
num_employees integer

O número de empregados.

Número de filiais
num_subsidiaries integer

O número de organizações subsidiárias.

Sítio Web
web_address string

O site da organização.

É uma organização primária?
is_primary boolean

O constituinte é uma organização primária?

Imagem do perfil
picture string

A foto de perfil da organização.

Miniatura da imagem de perfil
picture_thumbnail string

Miniatura da foto de perfil da organização.

ID do endereço principal
primary_address_id string

O ID de registro do sistema do endereço principal.

Tipo de endereço principal
address_type string

O tipo de endereço principal.

País do endereço principal
address_country string

O país de endereço principal.

Bloco de endereço principal
address_block string

O bloco de endereço principal.

Cidade do endereço principal
address_city string

A cidade de endereço principal.

Estado do endereço principal
address_state string

O estado do endereço principal.

Código postal do endereço principal
address_postcode string

O código postal do endereço principal.

Não envia?
address_do_not_mail boolean

Não contacta o constituinte neste endereço?

Não envie o motivo do e-mail
address_do_not_mail_reason string

O motivo de não contactar o constituinte neste endereço.

ID de telefone principal
primary_phone_id string

O ID de registro do sistema do número de telefone principal.

Tipo de telefone principal
phone_type string

O tipo de telefone principal.

Número de telefone principal
phone_number string

O número de telefone principal.

ID do endereço de e-mail principal
primary_email_address_id string

O ID de registro do sistema do endereço de e-mail principal.

Tipo de endereço de e-mail principal
email_address_type string

O tipo de endereço de e-mail principal.

Endereço de e-mail principal
email_address string

O endereço de e-mail principal.

Conmg.Telefone

Telemóvel

Name Caminho Tipo Description
ID
id string

O ID de registro do sistema do telefone.

Tipo
type string

O tipo de telefone.

Country
country string

O país do telefone.

Número
phone_number string

O número de telefone.

Primária?
primary boolean

Este é o telefone principal do eleitor?

Não liga?
donotcall boolean

Não contacta o constituinte através deste número?

Fonte de informação
info_source string

A fonte de informação.

Comentários da fonte de informação
info_source_comments string

Os comentários da fonte de informação.

Data de início
start_date date-time

A data de início da chamada telefónica.

Data de fim
end_date date-time

A data de término da chamada telefônica.

hora
start_time.hour integer

A hora.

minuto
start_time.minute integer

O minuto.

hora
end_time.hour integer

A hora.

minuto
end_time.minute integer

O minuto.

Conmg.PhoneCollection

Telefones

Name Caminho Tipo Description
Contar
count integer

O número de itens disponíveis para recuperação na coleção após a aplicação de quaisquer parâmetros de solicitação. Os parâmetros limit e offset não afetam a contagem, mas para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados de valor.

valor
value array of Conmg.Phone

O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

Conmg.SolicitCode

Solicitar código

Name Caminho Tipo Description
ID
id string

O ID de registro do sistema do código de solicitação.

Solicitar código
description string

O código de solicitação.

Data de início
start_date date-time

A data de início do código de solicitação.

Data de fim
end_date date-time

A data de término do código de solicitação.

Comments
comments string

Os comentários do código de solicitação.

Caducou?
expired boolean

O código de solicitação expirou?

Conmg.SolicitCodeCollection

Solicitar códigos

Name Caminho Tipo Description
Contar
count integer

O número de itens disponíveis para recuperação na coleção após a aplicação de quaisquer parâmetros de solicitação. Os parâmetros limit e offset não afetam a contagem, mas para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados de valor.

valor
value array of Conmg.SolicitCode

O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

Conmg.Tributo

Homenagem

Name Caminho Tipo Description
ID
id string

O ID de registro do sistema do tributo.

Tipo de tributo
tribute_type string

O tipo de homenagem.

Texto de homenagem
tribute_text string

O texto da homenagem.

É tributo?
tributee boolean

O constituinte é o tributo?

É reconhecimento?
acknowledgee boolean

O constituinte é um reconhecimento?

Ativo?
active boolean

A homenagem é ativa?

Data de criação
date_created date-time

A data em que a homenagem foi criada.

Conmg.TributeCollection

Homenagens

Name Caminho Tipo Description
Contar
count integer

O número de itens disponíveis para recuperação na coleção após a aplicação de quaisquer parâmetros de solicitação. Os parâmetros limit e offset não afetam a contagem, mas para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados de valor.

valor
value array of Conmg.Tribute

O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.