Blackbaud Raisers Edge NXT Elementos
O Edge NXT da Blackbaud Raiser é uma solução abrangente de software de angariação de fundos e gestão de doadores baseada na nuvem criada especificamente para organizações sem fins lucrativos e toda a comunidade 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 | - | Não disponível |
| 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 |
| skyapi@blackbaud.com |
| Metadados do conector | |
|---|---|
| Editora | Blackbaud, Inc. |
| Sítio Web | https://www.blackbaud.com/products/blackbaud-raisers-edge-nxt |
| Política de privacidade | https://www.blackbaud.com/privacy-shield |
| Categorias | Vendas e CRM; Produtividade |
O Raiser's Edge NXT é uma solução abrangente de software de angariação de fundos e gestão de doadores baseada na nuvem criada especificamente para organizações sem fins lucrativos e toda a comunidade social do bem.
Este conector é construído sobre a API SKY da Blackbaud e fornece operações para ajudar a gerenciar constituintes e entidades relacionadas encontradas no The Raiser's Edge NXT, incluindo:
- Constituintes
- Addresses
- Telefones e e-mails
- Aliases
- Campos personalizados
- Observações
- Attachments
- Relações
- e mais...
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 Raiser's Edge NXT da organização e configurará as permissões da sua conta de utilizador no 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 a presença online de um constituinte |
Atualiza uma presença online do constituinte. |
| Atualizar um alias constituinte |
Atualiza um alias constituinte. |
| Atualizar um anexo constituinte |
Atualiza um anexo constituinte. |
| Atualizar um campo personalizado do constituinte |
Atualiza um campo personalizado do constituinte. |
| Atualizar um constituinte |
Atualiza um constituinte. |
| Atualizar um código constituinte |
Atualiza um código constituinte. |
| Atualizar um código de solicitação de constituinte |
Atualiza um código de solicitação 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 formato de nome de constituinte |
Atualiza um formato de nome de constituinte. |
| Atualizar um formato de nome primário constituinte |
Atualiza o formato do nome principal de um constituinte. |
| Atualizar um telefone constituinte |
Atualiza um telefone constituinte. |
| Atualizar uma educação constituinte |
Atualiza uma educação constituinte. |
| Atualizar uma foto de perfil do constituinte |
Atualiza a foto de perfil atual de um constituinte. |
| Atualizar uma nota constituinte |
Atualiza uma nota constituinte. |
| Atualizar uma relação constituinte |
Atualiza uma relação para um constituinte. 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. |
| Converter em constituinte |
Converte um não-constituinte em um constituinte. |
| Criar um agradecimento de homenagem |
Cria um novo reconhecimento de homenagem. |
| Criar um alias constituinte |
Cria um novo alias constituinte. |
| Criar um anexo constituinte |
Cria um novo anexo constituinte. |
| Criar um campo personalizado constituinte |
Cria um novo campo personalizado 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ódigo constituinte |
Cria um novo código constituinte. |
| 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 formato de nome de constituinte |
Cria um novo formato de nome de constituinte. |
| Criar um formato de nome primário constituinte |
Cria um formato de nome primário para um constituinte. |
| Criar um registo de consentimento de constituinte |
Cria um novo registro de consentimento constituinte. |
| Criar um telefone constituinte |
Cria um novo telefone constituinte. |
| Criar um tributo constituinte |
Cria um novo tributo constituinte. |
| Criar uma atribuição de angariação de fundos |
Cria uma nova atribuição de angariação de fundos. |
| Criar uma educação constituinte |
Cria uma nova educação constituinte. |
| Criar uma nota constituinte |
Cria uma nova nota constituinte. |
| Criar uma presença online constituinte |
Cria uma nova presença online constituinte. |
| Criar uma relação de organização |
Cria uma nova relação de organização. Se a relação for com outro constituinte, cria-se uma relação de reciprocidade para esse constituinte. |
| Criar uma relação individual |
Cria uma nova relação individual. Se a relação for com outro constituinte, cria-se uma relação de reciprocidade para esse constituinte. |
| Lista de angariadores de fundos constituintes |
Lista as atribuições de angariação de fundos para um constituinte. |
| Lista de constituintes |
Devolve uma lista de constituintes. |
| Lista de códigos constituintes |
Lista os códigos constituintes de um constituinte. |
| Lista de homenagens |
Lista os agradecimentos por uma homenagem. |
| Lista de membros constituintes |
Lista as associações de um constituinte. |
| Lista de notas constituintes |
Lista as notas para um constituinte. |
| Listar anexos constituintes |
Lista os anexos de um constituinte. |
| Listar as formações dos constituintes |
Lista os registros educacionais de um constituinte. |
| Listar atribuições de angariação de fundos |
Liste as atribuições para uma angariação de fundos. |
| Listar campos personalizados constituintes |
Lista os campos personalizados 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 presenças online constituintes |
Lista as presenças online de um constituinte. |
| Listar pseudónimos constituintes |
Lista os aliases de um constituinte. |
| Listar registros de consentimento dos constituintes |
Lista os registros de consentimento de um constituinte. |
| Listar relações constituintes |
Lista as relações de um constituinte. |
| Listar telefones constituintes |
Lista os telefones de um constituinte. |
| Listar tributos constituintes |
Lista as homenagens para um constituinte. |
| Obter resumo do formato do nome do constituinte |
Retorna o resumo do formato de nome de um constituinte. |
| Obter um constituinte |
Devolve informações sobre um constituinte. |
| Obter um constituinte por ID de pesquisa |
Retorna a ID de registro do sistema de um constituinte da ID de pesquisa especificada. |
| Obter uma foto de perfil do constituinte |
Retorna a foto de perfil atual de um constituinte. |
| Pesquisa de componentes duplicados |
Pesquisa registros de contato individuais, organizacionais e relacionados e classifica possíveis duplicatas com base nos filtros de pesquisa especificados. Os registos que correspondem a vários filtros têm uma classificação mais elevada como potenciais duplicados. |
| Procurar um constituinte |
Executa uma pesquisa constituinte com base no texto de pesquisa fornecido. Suporta nome, sobrenome, nome preferencial, nome anterior, alias, endereço de e-mail, número de telefone, endereço ou ID de pesquisa. Combinações de nomes, como nome e sobrenome ou nome e sobrenome preferidos, são válidas, mas, caso contrário, a pesquisa suporta apenas um parâmetro de cada vez. Por padrão, as pesquisas incluem resultados que soam semelhantes aos seus critérios. Por exemplo, as pesquisas por "Smith" incluem correspondências para "Smyth" e outras grafias alternativas. Esta pesquisa não suporta caracteres curinga como * ou ?. Os resultados da pesquisa estão limitados a 500 registos. |
| Procurar um constituinte (melhorado) |
Procura registos de constituintes utilizando os critérios de filtro fornecidos. |
| Receba uma homenagem constituinte |
Devolve detalhes sobre um tributo constituinte. |
| Suprimir um código constituinte |
Elimina um código constituinte. |
Atualizar a presença online de um constituinte
Atualiza uma presença online do constituinte.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de presença online
|
online_presence_id | True | string |
O ID de registo do sistema da presença online a atualizar. |
|
Tipo
|
type | string |
O tipo de presença online. |
|
|
Link
|
address | string |
O endereço Web da presença online. |
|
|
Primária?
|
primary | boolean |
Esta é a principal presença online do eleitor? |
|
|
Inativo?
|
inactive | boolean |
Esta presença online está inativa? |
Atualizar um alias constituinte
Atualiza um alias constituinte.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Alias ID
|
alias_id | True | string |
O ID de registro do sistema do alias a ser atualizado. |
|
Alias
|
name | string |
O nome a utilizar como pseudónimo do constituinte. Limite de caracteres: 100. |
|
|
Tipo
|
type | string |
O tipo de alias. |
Atualizar um anexo constituinte
Atualiza um anexo constituinte.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do anexo
|
attachment_id | True | string |
O ID de registro do sistema do anexo a ser atualizado. |
|
Nome
|
name | string |
O nome do anexo. Limite de caracteres: 150. |
|
|
Date
|
date | date-time |
A data do anexo (ex: '2020-09-18T04:13:56Z'). |
|
|
URL
|
url | string |
O URL do anexo. Isso é necessário para anexos de link e não se aplica a anexos físicos. |
|
|
Etiquetas
|
tags | array of string |
As tags associadas ao anexo. |
Atualizar um campo personalizado do constituinte
Atualiza um campo personalizado do constituinte.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do campo personalizado
|
custom_field_id | True | string |
O ID de registro do sistema do campo personalizado a ser atualizado. |
|
body
|
body | True | dynamic |
Um objeto que representa as propriedades do campo personalizado a ser atualizado. |
Atualizar um constituinte
Atualiza 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 atualizar. |
|
Title
|
title | string |
O título principal do constituinte (apenas para pessoas singulares). |
|
|
Nome próprio
|
first | string |
Nome próprio do constituinte (apenas para pessoas singulares). Limite de caracteres: 50. |
|
|
Apelido
|
last | string |
Apelido do eleitor (apenas para pessoas singulares). Limite de caracteres: 100. |
|
|
Nome da organização
|
name | string |
Para indivíduos, este é um campo computado que não é aplicável para operações de edição. Para organização, este campo é obrigatório e representa o nome da organização. Limite de caracteres: 100. |
|
|
Sufixo
|
suffix | string |
Sufixo primário do constituinte (apenas para indivíduos). |
|
|
Nome preferido
|
preferred_name | string |
O nome preferido do constituinte (apenas para pessoas singulares). Limite de caracteres: 50. |
|
|
ID de pesquisa
|
lookup_id | string |
O identificador definido pelo utilizador para o constituinte. |
|
|
Sexo
|
gender | string |
O sexo do constituinte (apenas para indivíduos). |
|
|
Nome do meio
|
middle | string |
Nome do meio do constituinte (apenas para pessoas singulares). Limite de caracteres: 50. |
|
|
Antigo nome
|
former_name | string |
O nome anterior do constituinte (apenas para pessoas singulares). Limite de caracteres: 100. |
|
|
Título 2
|
title_2 | string |
O título secundário do constituinte (apenas para pessoas singulares). |
|
|
Sufixo 2
|
suffix_2 | string |
Sufixo secundário do constituinte (apenas para indivíduos). |
|
|
Estado civil
|
marital_status | string |
O estado civil do constituinte (apenas para pessoas singulares). |
|
|
Dá anonimamente?
|
gives_anonymously | boolean |
O constituinte doa anonimamente? |
|
|
Não solicita e-mail?
|
requests_no_email | boolean |
O constituinte não solicita nenhum e-mail? |
|
|
É solicitor?
|
is_solicitor | boolean |
O constituinte é advogado? |
|
|
Não tem endereços válidos?
|
no_valid_address | boolean |
O constituinte não tem morada válida? |
|
|
Inativo?
|
inactive | boolean |
O constituinte está inativo? |
|
|
day
|
d | integer |
O dia na data difusa. |
|
|
mês
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
Local de nascimento
|
birthplace | string |
O local de nascimento do constituinte (apenas para indivíduos). |
|
|
Etnicidade
|
ethnicity | string |
A etnia do constituinte (apenas para indivíduos). |
|
|
Target
|
target | string |
O alvo do constituinte. |
|
|
Rendimentos
|
income | string |
O rendimento do constituinte (apenas para pessoas singulares). |
|
|
Tipo de recibo
|
receipt_type | string |
O tipo de recibo do constituinte. |
|
|
Religião
|
religion | string |
A religião do constituinte (apenas para indivíduos). |
|
|
Indústria
|
industry | string |
A indústria do constituinte (apenas para organizações). |
|
|
Número de empregados
|
num_employees | integer |
O número de funcionários na organização. |
|
|
Combina presentes?
|
matches_gifts | boolean |
A organização combina presentes? |
|
|
Fator de presente correspondente
|
matching_gift_factor | double |
O fator de presente correspondente (apenas para organizações). |
|
|
Min match por presente
|
value | double |
O valor mínimo correspondente por presente para o constituinte (apenas para organizações). |
|
|
Máximo de correspondência por presente
|
value | double |
O valor máximo correspondente por presente para o constituinte (apenas para organizações). |
|
|
Min match por constit
|
value | double |
O total mínimo correspondente para o constituinte (apenas para organizações). |
|
|
Correspondência máxima por constit
|
value | double |
O total máximo correspondente para o constituinte (apenas para organizações). |
|
|
Notas de presente correspondentes
|
matching_gift_notes | string |
As notas de presente correspondentes para o constituinte (apenas para organizações). |
|
|
Falecido?
|
deceased | boolean |
O constituinte faleceu (apenas para pessoas singulares)? |
|
|
day
|
d | integer |
O dia na data difusa. |
|
|
mês
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
É memorial?
|
is_memorial | boolean |
O constituinte é uma honra/memorial? |
Atualizar um código constituinte
Atualiza um código constituinte.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do código constituinte
|
constituent_code_id | True | string |
O ID de registo do sistema do código constituinte a atualizar. |
|
day
|
d | integer |
O dia na data difusa. |
|
|
mês
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
day
|
d | integer |
O dia na data difusa. |
|
|
mês
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
Sequence
|
sequence | integer |
A sequência numérica associada ao código constituinte. |
Atualizar um código de solicitação de constituinte
Atualiza 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 registro do sistema do código de solicitação a ser atualizado. |
|
Solicitar código
|
solicit_code | string |
Instruções de comunicação e/ou restrições para um componente. |
|
|
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'). |
Atualizar um endereço de constituinte
Atualiza um endereço constituinte.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do endereço
|
address_id | True | string |
O ID de registro do sistema do endereço a ser atualizado. |
|
Tipo de endereço
|
type | string |
O tipo de endereço. |
|
|
Country
|
country | string |
O país do endereço (pode ser o ID, nome ou abreviatura). |
|
|
Linhas de endereço
|
address_lines | string |
As linhas de endereço. |
|
|
City
|
city | string |
A cidade do endereço (não use em combinação com o campo Subúrbio). |
|
|
Estado
|
state | string |
O estado do endereço. |
|
|
Código postal
|
postal_code | string |
O código postal do endereço. |
|
|
Subúrbio
|
suburb | string |
O subúrbio do endereço (não use em combinação com o campo Cidade). |
|
|
Concelho
|
county | string |
O município do endereço. |
|
|
Fonte de informação
|
information_source | string |
A fonte de informação para o endereço. |
|
|
Região
|
region | string |
A região do endereço. |
|
|
CARRINHO
|
cart | string |
A rota da transportadora (CART) para o endereço. |
|
|
LOTE
|
lot | string |
A linha de viagem (LOT) para o endereço. |
|
|
CPD
|
dpc | string |
O código do ponto de entrega (DPC) para o endereço. |
|
|
Válido a partir de
|
start | date |
A data em que o constituinte começou a residir neste endereço (ex: «2005-09-18»). |
|
|
Válido para
|
end | date |
A data em que o constituinte deixou de residir neste endereço (ex: «2005-09-18»). |
|
|
Primária?
|
preferred | boolean |
É este o endereço preferido do eleitor? |
|
|
Não envia?
|
do_not_mail | boolean |
O constituinte pode ser contactado neste endereço? |
|
|
day
|
d | integer |
O dia na data difusa. |
|
|
mês
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
day
|
d | integer |
O dia na data difusa. |
|
|
mês
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
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 a ser atualizado. |
|
Tipo de e-mail
|
type | string |
O tipo de endereço de e-mail. |
|
|
Endereço de e-mail
|
address | string |
O endereço de e-mail. |
|
|
Primária?
|
primary | boolean |
Este é o endereço de e-mail principal do eleitor? |
|
|
Não envia e-mail?
|
do_not_email | boolean |
O constituinte pode ser contactado através deste endereço de correio eletrónico? |
|
|
Inativo?
|
inactive | boolean |
Este endereço de e-mail está inativo? |
Atualizar um formato de nome de constituinte
Atualiza um formato de nome de constituinte.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do formato do nome
|
name_format_id | True | string |
O ID de registro do sistema do formato de nome a ser atualizado. |
|
Tipo
|
type | string |
O tipo de formato de nome. |
|
|
Formato de nome personalizado?
|
custom_format | boolean |
É um formato personalizado? |
|
|
Formato
|
configuration_id | string |
Configuração de formato de nome (necessária, a menos que um formato personalizado seja usado). |
|
|
Nome personalizado
|
formatted_name | string |
Nome formatado (necessário quando um formato personalizado é usado). Limite de caracteres: 255. |
Atualizar um formato de nome primário constituinte
Atualiza o formato do nome principal de um constituinte.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do formato do nome
|
primary_name_format_id | True | string |
A ID de registro do sistema do formato de nome primário a ser atualizado. |
|
Formato de nome personalizado?
|
custom_format | boolean |
É um formato personalizado? |
|
|
Formato
|
configuration_id | string |
Configuração de formato de nome (necessária, a menos que um formato personalizado seja usado). |
|
|
Nome personalizado
|
formatted_name | string |
Nome formatado (necessário quando um formato personalizado é usado). Limite de caracteres: 255. |
Atualizar um telefone constituinte
Atualiza um telefone constituinte.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de telefone
|
phone_id | True | string |
O ID de registro do sistema do telefone a ser atualizado. |
|
Tipo
|
type | string |
O tipo de telefone. |
|
|
Número
|
number | string |
O número de telefone. |
|
|
Primária?
|
primary | boolean |
Este é o telefone principal do eleitor? |
|
|
Não liga?
|
do_not_call | boolean |
O constituinte pode ser contactado através deste número? |
|
|
Inativo?
|
inactive | boolean |
Este número de telefone está inativo? |
Atualizar uma educação constituinte
Atualiza uma educação constituinte.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de escolaridade
|
education_id | True | string |
O ID do registro do sistema do registro educacional a ser atualizado. |
|
Escola
|
school | string |
O nome da escola/estabelecimento. |
|
|
Tipo
|
type | string |
O tipo de educação. |
|
|
Classe de
|
class_of | string |
O ano em que o constituinte se formou. |
|
|
Situação
|
status | string |
O estatuto da educação. |
|
|
day
|
d | integer |
O dia na data difusa. |
|
|
mês
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
day
|
d | integer |
O dia na data difusa. |
|
|
mês
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
day
|
d | integer |
O dia na data difusa. |
|
|
mês
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
Licenciatura
|
degree | string |
O grau recebido. |
|
|
GPA
|
gpa | double |
A média de pontos da nota. |
|
|
Objeto de estudo
|
subject_of_study | string |
O objeto de estudo. |
|
|
Primária?
|
primary | boolean |
Esta é a associação de escolas primárias do constituinte? |
|
|
Majors
|
majors | array of string |
Os principais cursos de estudo. |
|
|
Menores
|
minors | array of string |
Os cursos menores de estudo. |
|
|
Campus
|
campus | string |
O campus. Limite de caracteres: 50. |
|
|
Organização social
|
social_organization | string |
A organização social. Limite de caracteres: 50. |
|
|
Nome conhecido
|
known_name | string |
O nome conhecido. Limite de caracteres: 50. |
|
|
Classe de grau
|
class_of_degree | string |
A classe de grau. |
|
|
Departamento
|
department | string |
O nome do departamento de educação. |
|
|
Corpo Docente
|
faculty | string |
O nome da faculdade. |
|
|
Número de registo
|
registration_number | string |
O número de registo. Limite de caracteres: 50. |
Atualizar uma foto de perfil do constituinte
Atualiza a foto de perfil atual 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 cuja foto de perfil deve ser atualizada. |
|
Nome do ficheiro
|
file_name | True | string |
O nome do arquivo. |
|
ID do documento
|
document_id | True | uuid |
O identificador do documento. |
|
ID da miniatura
|
thumbnail_id | True | uuid |
O identificador do documento em miniatura. |
Atualizar uma nota constituinte
Atualiza uma nota constituinte.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da nota
|
note_id | True | string |
O ID de registro do sistema da nota a ser atualizada. |
|
Tipo
|
type | string |
O tipo de nota. |
|
|
day
|
d | integer |
O dia na data difusa. |
|
|
mês
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
Resumo
|
summary | string |
O resumo da nota. Limite de caracteres: 50. |
|
|
Observação
|
text | string |
O texto da nota. |
Atualizar uma relação constituinte
Atualiza uma relação para um constituinte. 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 de relacionamento
|
relationship_id | True | string |
O ID de registro do sistema da relação a ser atualizada. |
|
Tipo
|
type | string |
O tipo de relação que a relação representa. |
|
|
Tipo recíproco
|
reciprocal_type | string |
Descreve a relação do constituinte com o constituinte relacionado. Por exemplo, numa relação entre um constituinte masculino e um irmão do sexo feminino, o tipo de relação recíproca seria irmão. |
|
|
day
|
d | integer |
O dia na data difusa. |
|
|
mês
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
day
|
d | integer |
O dia na data difusa. |
|
|
mês
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
É cônjuge?
|
is_spouse | boolean |
A pessoa coligada é cônjuge do constituinte (aplica-se apenas às relações entre particulares)? |
|
|
O constituinte é chefe de família?
|
is_constituent_head_of_household | boolean |
O constituinte é o chefe do agregado familiar? |
|
|
O cônjuge é chefe de família?
|
is_spouse_head_of_household | boolean |
O cônjuge é o chefe de família? |
|
|
Observações
|
comment | string |
Notas adicionais sobre a relação. |
|
|
É contacto?
|
is_organization_contact | boolean |
O constituinte representa esta organização como um contacto (aplica-se apenas às relações entre organizações e indivíduos)? |
|
|
O negócio é principal?
|
is_primary_business | boolean |
Este é o negócio principal do constituinte (aplica-se apenas às relações entre organizações e indivíduos)? |
|
|
Tipo de contacto
|
organization_contact_type | string |
Fornece contexto para interações com o indivíduo relacionado que representa a organização como um contato. Aplica-se apenas às relações entre organizações e indivíduos. |
|
|
Position
|
position | string |
A posição do indivíduo na organização. Aplica-se apenas às relações entre organizações e indivíduos. Limite de caracteres: 50. |
Converter em constituinte
Converte um não-constituinte em um constituinte.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID não constituinte
|
non_constituent_id | True | string |
A ID do registro do sistema do registro não constituinte a ser convertido. |
|
ID
|
id | string |
O ID de registo do sistema do código constituinte. |
|
|
day
|
d | integer |
O dia na data difusa. |
|
|
mês
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
day
|
d | integer |
O dia na data difusa. |
|
|
mês
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
sequência
|
sequence | integer |
A sequência do código constituinte. |
Devoluções
Constituinte convertido
Criar um agradecimento de homenagem
Cria um novo reconhecimento de homenagem.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do tributo
|
tribute_id | True | integer |
O ID de registro do sistema do tributo associado ao reconhecimento. |
|
ID de relacionamento
|
relationship_id | integer |
O ID de registro do sistema da relação (se nulo, isso representa uma autorreconhecimento). |
|
|
ID da carta
|
letter_id | integer |
A letra ID. |
Devoluções
Agradecimento de homenagem criado
Criar um alias constituinte
Cria um novo alias constituinte.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do constituinte
|
constituent_id | True | string |
O ID de registro do sistema do constituinte associado ao alias. |
|
Alias
|
name | True | string |
O nome a utilizar como pseudónimo do constituinte. Limite de caracteres: 100. |
|
Tipo
|
type | string |
O tipo de alias. |
Devoluções
Alias constituinte criado
Criar um anexo constituinte
Cria um novo anexo constituinte.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do constituinte
|
parent_id | True | string |
O ID de registo do sistema do constituinte associado ao anexo. |
|
Tipo
|
type | True | string |
O tipo de anexo. Os anexos físicos são arquivos carregados, como imagens, PDFs ou documentos do Word, que são salvos localmente ou na rede. Eles são armazenados e gerenciados no sistema. Os anexos de links são links para arquivos como imagens, postagens de blog ou vídeos do YouTube que estão online ou em uma conta de armazenamento em nuvem. Eles são armazenados e gerenciados externamente. |
|
Nome
|
name | string |
O nome do anexo. Limite de caracteres: 150. |
|
|
Date
|
date | date-time |
A data do anexo (ex: '2020-09-18T04:13:56Z'). Este campo assume como padrão a data e hora atuais se não for fornecido. |
|
|
URL
|
url | string |
O URL do anexo. Isso é necessário para anexos de link e não se aplica a anexos físicos. |
|
|
Nome do ficheiro
|
file_name | string |
O nome do arquivo. Limite de caracteres: 36. Apenas para anexos físicos. |
|
|
ID do ficheiro
|
file_id | string |
O identificador do arquivo. Limite de caracteres: 36. Apenas para anexos físicos. |
|
|
ID da miniatura
|
thumbnail_id | string |
O identificador da miniatura. Limite de caracteres: 36. Apenas para anexos físicos. |
|
|
Etiquetas
|
tags | array of string |
As tags associadas ao anexo. |
Devoluções
Anexação constituinte criada
Criar um campo personalizado constituinte
Cria um novo campo personalizado constituinte.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
Um objeto que representa o campo personalizado a ser criado. |
Devoluções
Campo personalizado constituinte criado
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 |
O nome da organização. Limite de caracteres: 100. |
|
ID de pesquisa
|
lookup_id | string |
O identificador definido pelo utilizador para o constituinte. |
|
|
tipo
|
type | True | string |
O tipo de endereço. |
|
country
|
country | string |
O país do endereço (pode ser o ID, nome ou abreviatura). |
|
|
linhas
|
address_lines | string |
As linhas de endereço. Limite de caracteres: 150. |
|
|
city
|
city | string |
A cidade do endereço (não use em combinação com o campo Subúrbio). |
|
|
state
|
state | string |
O estado do endereço. |
|
|
código postal
|
postal_code | string |
O código postal do endereço. Limite de caracteres: 12. |
|
|
subúrbio
|
suburb | string |
O subúrbio do endereço (não use em combinação com o campo Cidade). |
|
|
concelho
|
county | string |
O município do endereço. |
|
|
start
|
start | date |
A data em que o constituinte começou a residir neste endereço (ex: «2005-09-18»). |
|
|
fim
|
end | date |
A data em que o constituinte deixou de residir neste endereço (ex: «2005-09-18»). |
|
|
tipo
|
type | True | string |
O tipo de telefone. |
|
número
|
number | True | string |
O número de telefone. |
|
é primário?
|
primary | boolean |
Este é o principal número de telefone do eleitor? |
|
|
tipo
|
type | True | string |
O tipo de endereço de e-mail. |
|
address
|
address | True | string |
O endereço de e-mail. |
|
é primário?
|
primary | boolean |
Este é o endereço de e-mail principal do eleitor? |
|
|
tipo
|
type | True | string |
O tipo de presença online. |
|
address
|
address | True | string |
O endereço Web da presença online. |
|
é primário?
|
primary | boolean |
Esta é a principal presença online do eleitor? |
|
|
Dá anonimamente?
|
gives_anonymously | boolean |
O constituinte doa anonimamente? |
|
|
Não solicita e-mail?
|
requests_no_email | boolean |
O constituinte não solicita nenhum e-mail? |
|
|
É solicitor?
|
is_solicitor | boolean |
O constituinte é advogado? |
|
|
Não tem endereços válidos?
|
no_valid_address | boolean |
O constituinte não tem morada válida? |
|
|
Target
|
target | string |
O alvo do constituinte. |
|
|
Rendimentos
|
income | string |
A renda para o constituinte. |
|
|
Tipo de recibo
|
receipt_type | string |
O tipo de recibo do constituinte. |
|
|
Indústria
|
industry | string |
A indústria do constituinte. |
|
|
Número de empregados
|
num_employees | integer |
O número de funcionários na organização. |
|
|
Combina presentes?
|
matches_gifts | boolean |
A organização combina presentes? |
|
|
Fator de presente correspondente
|
matching_gift_factor | double |
O fator de presente correspondente. |
|
|
Min match por presente
|
value | double |
O valor mínimo correspondente por presente para o constituinte. |
|
|
Máximo de correspondência por presente
|
value | double |
O valor máximo correspondente por presente para o constituinte. |
|
|
Min match por constit
|
value | double |
O total mínimo correspondente para o constituinte. |
|
|
Correspondência máxima por constit
|
value | double |
O total máximo correspondente para o constituinte. |
|
|
Notas de presente correspondentes
|
matching_gift_notes | string |
As notas de presente correspondentes para o constituinte. |
|
|
É memorial?
|
is_memorial | boolean |
O constituinte é uma honra/memorial? |
Devoluções
Constituinte da organização criada
Criar um constituinte individual
Cria um novo constituinte individual.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Title
|
title | string |
O título principal do constituinte. |
|
|
Nome próprio
|
first | string |
Primeiro nome do eleitor. Limite de caracteres: 50. |
|
|
Apelido
|
last | True | string |
Apelido do eleitor. Limite de caracteres: 100. |
|
Sufixo
|
suffix | string |
Sufixo primário do constituinte. |
|
|
ID de pesquisa
|
lookup_id | string |
O identificador definido pelo utilizador para o constituinte. |
|
|
tipo
|
type | True | string |
O tipo de endereço. |
|
country
|
country | string |
O país do endereço (pode ser o ID, nome ou abreviatura). |
|
|
linhas
|
address_lines | string |
As linhas de endereço. Limite de caracteres: 150. |
|
|
city
|
city | string |
A cidade do endereço (não use em combinação com o campo Subúrbio). |
|
|
state
|
state | string |
O estado do endereço. |
|
|
código postal
|
postal_code | string |
O código postal do endereço. Limite de caracteres: 12. |
|
|
subúrbio
|
suburb | string |
O subúrbio do endereço (não use em combinação com o campo Cidade). |
|
|
concelho
|
county | string |
O município do endereço. |
|
|
start
|
start | date |
A data em que o constituinte começou a residir neste endereço (ex: «2005-09-18»). |
|
|
fim
|
end | date |
A data em que o constituinte deixou de residir neste endereço (ex: «2005-09-18»). |
|
|
tipo
|
type | True | string |
O tipo de telefone. |
|
número
|
number | True | string |
O número de telefone. |
|
é primário?
|
primary | boolean |
Este é o principal número de telefone do eleitor? |
|
|
tipo
|
type | True | string |
O tipo de endereço de e-mail. |
|
address
|
address | True | string |
O endereço de e-mail. |
|
é primário?
|
primary | boolean |
Este é o endereço de e-mail principal do eleitor? |
|
|
tipo
|
type | True | string |
O tipo de presença online. |
|
address
|
address | True | string |
O endereço Web da presença online. |
|
é primário?
|
primary | boolean |
Esta é a principal presença online do eleitor? |
|
|
Nome preferido
|
preferred_name | string |
O nome preferido do eleitor. Limite de caracteres: 50. |
|
|
Nome do meio
|
middle | string |
O nome do meio do constituinte. Limite de caracteres: 50. |
|
|
Antigo nome
|
former_name | string |
O antigo nome do constituinte. Limite de caracteres: 100. |
|
|
Título 2
|
title_2 | string |
Título secundário do constituinte. |
|
|
Sufixo 2
|
suffix_2 | string |
Sufixo secundário do constituinte. |
|
|
Sexo
|
gender | string |
O género do constituinte. |
|
|
Estado civil
|
marital_status | string |
O estado civil do constituinte. |
|
|
Dá anonimamente?
|
gives_anonymously | boolean |
O constituinte doa anonimamente? |
|
|
Não solicita e-mail?
|
requests_no_email | boolean |
O constituinte não solicita nenhum e-mail? |
|
|
É solicitor?
|
is_solicitor | boolean |
O constituinte é advogado? |
|
|
Não tem endereços válidos?
|
no_valid_address | boolean |
O constituinte não tem morada válida? |
|
|
day
|
d | integer |
O dia na data difusa. |
|
|
mês
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
Local de nascimento
|
birthplace | string |
O local de nascimento do constituinte. |
|
|
Etnicidade
|
ethnicity | string |
A etnia do constituinte. |
|
|
Target
|
target | string |
O alvo do constituinte. |
|
|
Rendimentos
|
income | string |
A renda para o constituinte. |
|
|
Tipo de recibo
|
receipt_type | string |
O tipo de recibo do constituinte. |
|
|
Religião
|
religion | string |
A religião do constituinte. |
|
|
Destinatário personalizado?
|
custom_format | boolean |
O destinatário principal é um formato personalizado? |
|
|
Formato do destinatário
|
configuration_id | string |
Configuração do destinatário principal (necessária, a menos que seja usado um formato personalizado). |
|
|
Nome personalizado do destinatário
|
formatted_name | string |
Nome formatado do destinatário principal (necessário quando um formato personalizado é usado). Limite de caracteres: 255. |
|
|
Saudação personalizada?
|
custom_format | boolean |
A saudação primária é um formato personalizado? |
|
|
Formato de saudação
|
configuration_id | string |
Configuração de saudação primária (necessária, a menos que um formato personalizado seja usado). |
|
|
Nome personalizado de saudação
|
formatted_name | string |
Nome formatado de saudação primária (necessário quando um formato personalizado é usado). Limite de caracteres: 255. |
|
|
É memorial?
|
is_memorial | boolean |
O constituinte é uma honra/memorial? |
Devoluções
Constituinte individual criado
Criar um código constituinte
Cria um novo código constituinte.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do constituinte
|
constituent_id | True | string |
O ID de registo do sistema do constituinte associado ao código do constituinte. |
|
Código constituinte
|
description | True | string |
O código constituinte. |
|
day
|
d | integer |
O dia na data difusa. |
|
|
mês
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
day
|
d | integer |
O dia na data difusa. |
|
|
mês
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
Sequence
|
sequence | integer |
A sequência numérica associada ao código constituinte. |
Devoluções
Código constituinte criado
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 associado ao código de solicitação. |
|
Solicitar código
|
solicit_code | True | string |
Instruções de comunicação e/ou restrições para um componente. |
|
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'). |
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 associado ao endereço. |
|
Tipo de endereço
|
type | True | string |
O tipo de endereço. |
|
Country
|
country | string |
O país do endereço (pode ser o ID, nome ou abreviatura). |
|
|
Linhas de endereço
|
address_lines | string |
As linhas de endereço. |
|
|
City
|
city | string |
A cidade do endereço (não use em combinação com o campo Subúrbio). |
|
|
Estado
|
state | string |
O estado do endereço. |
|
|
Código postal
|
postal_code | string |
O código postal do endereço. |
|
|
Subúrbio
|
suburb | string |
O subúrbio do endereço (não use em combinação com o campo Cidade). |
|
|
Concelho
|
county | string |
O município do endereço. |
|
|
Fonte de informação
|
information_source | string |
A fonte de informação para o endereço. |
|
|
Região
|
region | string |
A região do endereço. |
|
|
CARRINHO
|
cart | string |
A rota da transportadora (CART) para o endereço. |
|
|
LOTE
|
lot | string |
A linha de viagem (LOT) para o endereço. |
|
|
CPD
|
dpc | string |
O código do ponto de entrega (DPC) para o endereço. |
|
|
Válido a partir de
|
start | date |
A data em que o constituinte começou a residir neste endereço (ex: «2005-09-18»). |
|
|
Válido para
|
end | date |
A data em que o constituinte deixou de residir neste endereço (ex: «2005-09-18»). |
|
|
Primária?
|
preferred | boolean |
É este o endereço preferido do eleitor? |
|
|
Não envia?
|
do_not_mail | boolean |
O constituinte pode ser contactado neste endereço? |
|
|
day
|
d | integer |
O dia na data difusa. |
|
|
mês
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
day
|
d | integer |
O dia na data difusa. |
|
|
mês
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
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 registro do sistema do constituinte associado ao endereço de e-mail. |
|
Tipo de e-mail
|
type | True | string |
O tipo de endereço de e-mail. |
|
Endereço de e-mail
|
address | True | string |
O endereço de e-mail. |
|
Primária?
|
primary | boolean |
Este é o endereço de e-mail principal do eleitor? |
|
|
Não envia e-mail?
|
do_not_email | boolean |
O constituinte pode ser contactado através deste endereço de correio eletrónico? |
|
|
Inativo?
|
inactive | boolean |
Este endereço de e-mail está inativo? |
Devoluções
Endereço de e-mail constituinte criado
Criar um formato de nome de constituinte
Cria um novo formato de nome de 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
|
type | True | string |
O tipo de formato de nome. |
|
Formato de nome personalizado?
|
custom_format | boolean |
É um formato personalizado? |
|
|
Formato
|
configuration_id | string |
Configuração de formato de nome (necessária, a menos que um formato personalizado seja usado). |
|
|
Nome personalizado
|
formatted_name | string |
Nome formatado (necessário quando um formato personalizado é usado). Limite de caracteres: 255. |
Devoluções
Formato de nome criado
Criar um formato de nome primário constituinte
Cria um formato de nome primário 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. |
|
Tipo
|
primary_type | True | string |
O tipo de formato de nome primário. |
|
Formato de nome personalizado?
|
custom_format | boolean |
É um formato personalizado? |
|
|
Formato
|
configuration_id | string |
Configuração de formato de nome (necessária, a menos que um formato personalizado seja usado). |
|
|
Nome personalizado
|
formatted_name | string |
Nome formatado (necessário quando um formato personalizado é usado). Limite de caracteres: 255. |
Devoluções
Formato de nome criado
Criar um registo de consentimento de constituinte
Cria um novo registro de consentimento constituinte.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do constituinte
|
constituent_id | True | string |
O ID do registo do sistema do constituinte associado ao registo de consentimento. |
|
Channel
|
channel | True | string |
O canal ao qual a resposta de consentimento se aplica. |
|
Categoria
|
category | string |
A categoria à qual a resposta de consentimento se aplica. |
|
|
Fonte
|
source | string |
A fonte da resposta de consentimento do constituinte. |
|
|
Resposta
|
constituent_consent_response | True | string |
Como o constituinte respondeu ao consentimento para o canal/categoria especificado. |
|
Date
|
consent_date | True | date-time |
A data em que a resposta de consentimento foi recebida (ex: '2020-09-18T04:13:56Z'). |
|
Declaração de consentimento
|
consent_statement | string |
A declaração a que o constituinte respondeu ao dar o seu consentimento. |
|
|
Aviso de privacidade
|
privacy_notice | string |
A declaração de privacidade fornecida ao constituinte. |
Devoluções
Consentimento 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 registro do sistema do constituinte associado ao telefone. |
|
Tipo
|
type | True | string |
O tipo de telefone. |
|
Número
|
number | True | string |
O número de telefone. |
|
Primária?
|
primary | boolean |
Este é o telefone principal do eleitor? |
|
|
Não liga?
|
do_not_call | boolean |
O constituinte pode ser contactado através deste número? |
|
|
Inativo?
|
inactive | boolean |
Este número de telefone está inativo? |
Devoluções
Telefone constituinte criado
Criar um tributo constituinte
Cria um novo tributo constituinte.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do constituinte
|
constituent_record_id | True | integer |
O ID de registro do sistema do constituinte associado ao tributo. |
|
Tipo de tributo
|
tribute_type_id | True | integer |
O tipo de homenagem. |
|
Description
|
description | string |
A descrição da homenagem. |
|
|
day
|
d | integer |
O dia na data difusa. |
|
|
mês
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
day
|
d | integer |
O dia na data difusa. |
|
|
mês
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
ID do fundo de proteção por defeito
|
default_fund_id | integer |
O ID de registro do sistema do fundo padrão associado ao tributo. |
|
|
Observações
|
notes | string |
A homenagem aponta. |
|
|
Ativo?
|
is_active | boolean |
Essa homenagem é ativa? |
Devoluções
Tributo constituinte criado
Criar uma atribuição de angariação de fundos
Cria uma nova atribuição de angariação de fundos.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da angariação de fundos
|
fundraiser_id | True | string |
O ID de registo do sistema da angariação de fundos. |
|
ID do constituinte
|
constituent_id | True | string |
O ID de registo do sistema do componente atribuído. |
|
Tipo
|
type | string |
O tipo de angariação de fundos. |
|
|
Início da atribuição
|
start | date-time |
A data de início da atribuição (ex: '2020-09-18T04:13:56Z'). |
|
|
Fim da atribuição
|
end | date-time |
A data final da atribuição (ex: '2020-09-18T04:13:56Z'). |
|
|
Montante
|
value | True | double |
O valor da meta para a angariação de fundos solicitar ao constituinte atribuído. |
|
ID da Campanha
|
campaign_id | string |
O ID de registro do sistema da campanha à qual os presentes resultantes serão aplicados. |
|
|
ID do Fundo
|
fund_id | string |
O ID de registo do sistema do fundo ao qual os donativos resultantes serão aplicados. |
|
|
ID do recurso
|
appeal_id | string |
O sistema registra o ID do recurso ao qual os presentes resultantes serão aplicados. |
Devoluções
Criação de atribuição de angariação de fundos
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 associado à educação. |
|
Escola
|
school | True | string |
O nome da escola/estabelecimento. |
|
Tipo
|
type | string |
O tipo de educação. |
|
|
Classe de
|
class_of | string |
O ano em que o constituinte se formou. |
|
|
Situação
|
status | string |
O estatuto da educação. |
|
|
day
|
d | integer |
O dia na data difusa. |
|
|
mês
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
day
|
d | integer |
O dia na data difusa. |
|
|
mês
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
day
|
d | integer |
O dia na data difusa. |
|
|
mês
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
Licenciatura
|
degree | string |
O grau recebido. |
|
|
GPA
|
gpa | double |
A média de pontos da nota. |
|
|
Objeto de estudo
|
subject_of_study | string |
O objeto de estudo. |
|
|
Primária?
|
primary | boolean |
Esta é a associação de escolas primárias do constituinte? |
|
|
Majors
|
majors | array of string |
Os principais cursos de estudo. |
|
|
Menores
|
minors | array of string |
Os cursos menores de estudo. |
|
|
Campus
|
campus | string |
O campus. Limite de caracteres: 50. |
|
|
Organização social
|
social_organization | string |
A organização social. Limite de caracteres: 50. |
|
|
Nome conhecido
|
known_name | string |
O nome conhecido. Limite de caracteres: 50. |
|
|
Classe de grau
|
class_of_degree | string |
A classe de grau (aplicável apenas para versões do Reino Unido). |
|
|
Departamento
|
department | string |
O nome do departamento de educação (aplicável apenas para versões do Reino Unido). |
|
|
Corpo Docente
|
faculty | string |
O nome da faculdade (aplicável apenas para versões do Reino Unido). |
|
|
Número de registo
|
registration_number | string |
O número de registo (aplicável apenas às versões do Reino Unido). Limite de caracteres: 50. |
Devoluções
Criou a educação constituinte
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 associado à nota. |
|
Tipo
|
type | True | string |
O tipo de nota. |
|
day
|
d | integer |
O dia na data difusa. |
|
|
mês
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
Resumo
|
summary | string |
O resumo da nota. Limite de caracteres: 50. |
|
|
Observação
|
text | string |
O texto da nota. |
|
|
Author
|
author | string |
O autor da nota. Se não for fornecido, terá um conjunto padrão com base na conta do usuário. Limite de caracteres: 50. |
Devoluções
Nota constituinte criada
Criar uma presença online constituinte
Cria uma nova presença online constituinte.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do constituinte
|
constituent_id | True | string |
O ID de registo do sistema do constituinte associado à presença online. |
|
Tipo
|
type | True | string |
O tipo de presença online. |
|
Link
|
address | True | string |
O endereço Web da presença online. |
|
Primária?
|
primary | boolean |
Esta é a principal presença online do eleitor? |
|
|
Inativo?
|
inactive | boolean |
Esta presença online está inativa? |
Devoluções
Presença online constituinte criada
Criar uma relação de organização
Cria uma nova relação de organização. Se a relação for com outro constituinte, cria-se uma relação de reciprocidade para esse constituinte.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do constituinte
|
constituent_id | True | string |
O ID de registro do sistema do constituinte associado à relação. |
|
ID da relação
|
relation_id | True | string |
O ID de registro do sistema da organização relacionada. |
|
Tipo
|
type | string |
O tipo de relação que a relação representa. |
|
|
Tipo recíproco
|
reciprocal_type | string |
Descreve a relação do constituinte com a organização relacionada. |
|
|
day
|
d | integer |
O dia na data difusa. |
|
|
mês
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
day
|
d | integer |
O dia na data difusa. |
|
|
mês
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
É contacto?
|
is_organization_contact | boolean |
O constituinte representa esta organização como um contacto? |
|
|
Tipo de contacto
|
organization_contact_type | string |
Fornece contexto para interações com o indivíduo relacionado que representa a organização como um contato. |
|
|
Position
|
position | string |
A posição do indivíduo na organização. Limite de caracteres: 50. |
|
|
O negócio é principal?
|
is_primary_business | boolean |
Este é o principal negócio do eleitor? |
|
|
Observações
|
comment | string |
Notas adicionais sobre a relação. |
Devoluções
Relacionamento organizacional criado
Criar uma relação individual
Cria uma nova relação individual. Se a relação for com outro constituinte, cria-se uma relação de reciprocidade para esse constituinte.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do constituinte
|
constituent_id | True | string |
O ID de registro do sistema do constituinte associado à relação. |
|
ID da relação
|
relation_id | True | string |
O ID de registro do sistema do indivíduo relacionado. |
|
Tipo
|
type | string |
O tipo de relação que a relação representa. |
|
|
Tipo recíproco
|
reciprocal_type | string |
Descreve a relação do constituinte com o constituinte relacionado. Por exemplo, numa relação entre um constituinte masculino e um irmão do sexo feminino, o tipo de relação recíproca seria irmão. |
|
|
day
|
d | integer |
O dia na data difusa. |
|
|
mês
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
day
|
d | integer |
O dia na data difusa. |
|
|
mês
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
É cônjuge?
|
is_spouse | boolean |
O parente é cônjuge do constituinte? |
|
|
O constituinte é chefe de família?
|
is_constituent_head_of_household | boolean |
O constituinte é o chefe do agregado familiar? |
|
|
O cônjuge é chefe de família?
|
is_spouse_head_of_household | boolean |
O cônjuge é o chefe de família? |
|
|
Observações
|
comment | string |
Notas adicionais sobre a relação. |
Devoluções
Relacionamento individual criado
Lista de angariadores de fundos constituintes
Lista as atribuições de angariação de fundos 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. |
|
Incluir inativos?
|
include_inactive | boolean |
Incluir tarefas inativas de angariação de fundos? |
Devoluções
Trabalhos para angariação de fundos
Lista de constituintes
Devolve uma lista de constituintes.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
List
|
list_id | string |
Define um identificador de lista usado para filtrar o conjunto de componentes para aqueles incluídos na lista especificada. Se esse valor for definido, outros filtros especificados serão ignorados. |
|
|
Limite
|
limit | integer |
Representa o número de registros a serem retornados. O padrão é 500. O máximo é 5000. |
|
|
Compensação
|
offset | integer |
Representa o número de registros a serem ignorados. Para utilização com paginação. |
|
|
Código constituinte
|
constituent_code | string |
Representa um código constituinte para filtrar a lista. Por exemplo, "Membro do Conselho de Administração" devolve apenas os constituintes com um código de constituinte do Conselho de Administração. |
|
|
ID do constituinte
|
constituent_id | string |
Representa uma lista separada por vírgulas de IDs de registro do sistema constituinte para filtrar os resultados. Por exemplo, "280,1232" retorna apenas o constituinte 280 ou o constituinte 1232. |
|
|
Categoria de campo personalizado
|
custom_field_category | string |
Representa uma categoria de campo personalizada para filtrar os resultados. Por exemplo, "Aniversário" retorna apenas componentes com um campo personalizado de aniversário ativo. |
|
|
Estatuto de angariador de fundos
|
fundraiser_status | string |
Representa uma lista separada por vírgulas de status de arrecadação de fundos para filtrar os resultados. Por exemplo, "Ativo,Nenhum" retorna apenas constituintes cujo status de arrecadação de fundos é Ativo ou Nenhum. Os valores válidos para este filtro são Ativo, Inativo e Nenhum. |
|
|
Incluir falecido?
|
include_deceased | boolean |
Incluir constituintes falecidos na resposta? |
|
|
Incluir inativos?
|
include_inactive | boolean |
Incluir constituintes inativos na resposta? |
|
|
Código postal
|
postal_code | string |
Representa uma lista separada por vírgulas de códigos postais para filtrar os resultados. Por exemplo, "29466,29492" retorna apenas constituintes cujo endereço preferido tem um código postal que começa com 29466 ou 29492, como 29466, 29492 ou 29492-0727. |
|
|
Adicionado em ou após
|
date_added | date-time |
Filtre os resultados para constituintes criados na data especificada ou após essa data (ex: '2020-09-18T04:13:56Z'). |
|
|
Modificado em ou após
|
last_modified | date-time |
Filtrar os resultados para componentes modificados na data especificada ou após essa data (ex: «2020-09-18T04:13:56Z»). |
|
|
Ordenado por
|
sort | string |
Representa uma lista de campos pelos quais classificar os resultados. Os resultados estão em ordem crescente por padrão, e um sinal '-' indica ordem decrescente. Por exemplo, "date_added,-last" classifica os constituintes pelo campo "date_added" em ordem crescente e, em seguida, pelo "último" campo em ordem decrescente. |
Devoluções
Constituintes
Lista de códigos constituintes
Lista os códigos constituintes 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
Códigos constituintes
Lista de homenagens
Lista os agradecimentos por uma homenagem.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do tributo
|
tributeId | True | integer |
O ID de registro do sistema do tributo. |
Devoluções
Homenagem reconhece
Lista de membros constituintes
Lista as associações 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
Associações
Lista de notas constituintes
Lista as notas 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
Observações
Listar anexos constituintes
Lista os anexos 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
Attachments
Listar as formações dos constituintes
Lista os registros educacionais 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
Formação Académica
Listar atribuições de angariação de fundos
Liste as atribuições para uma angariação de fundos.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da angariação de fundos
|
fundraiser_id | True | string |
O ID de registo do sistema do angariador de fundos para o qual as atribuições devem ser devolvidas. |
|
Limite
|
limit | integer |
Representa o número de registros a serem retornados. O padrão é 500. O máximo é 5000. |
|
|
Compensação
|
offset | integer |
Representa o número de registros a serem ignorados. Para utilização com paginação. |
Devoluções
Assignments
Listar campos personalizados constituintes
Lista os campos personalizados 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
Campos personalizados
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. |
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 inativos?
|
include_inactive | boolean |
Incluir endereços inativos? |
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. |
|
Incluir inativos?
|
include_inactive | boolean |
Incluir endereços de e-mail inativos? |
Devoluções
Endereços de e-mail
Listar presenças online constituintes
Lista as presenças online 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 presenças online inativas? |
Devoluções
Presenças online
Listar pseudónimos constituintes
Lista os aliases 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
Aliases
Listar registros de consentimento dos constituintes
Lista os registros de consentimento 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. |
|
Apenas mais recente?
|
most_recent_only | boolean |
Incluir apenas os registros de consentimento mais recentes para cada combinação de categoria de canal na resposta? |
Devoluções
Registos de consentimento
Listar relações constituintes
Lista as relações 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. |
|
Limite
|
limit | integer |
Representa o número de registros a serem retornados. O padrão é 500. Não há um máximo. |
|
|
Compensação
|
offset | integer |
Representa o número de registros a serem ignorados. Para utilização com paginação. |
Devoluções
Relações
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. |
|
Incluir inativos?
|
include_inactive | boolean |
Incluir telefones inativos? |
Devoluções
Telefones
Listar tributos constituintes
Lista as homenagens para um constituinte.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do constituinte
|
constituentId | True | integer |
O ID de registo do sistema do constituinte. |
Devoluções
Homenagens
Obter resumo do formato do nome do constituinte
Retorna o resumo do formato de nome 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
Resumo do formato do nome
Obter um constituinte
Devolve informações sobre um constituinte.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do constituinte
|
constituent_id | True | string |
O ID de registro do sistema do constituinte a ser obtido. |
Devoluções
Constituinte
Obter um constituinte por ID de pesquisa
Retorna a ID de registro do sistema de um constituinte da ID de pesquisa especificada.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de pesquisa
|
constituent_id | True | string |
O ID de pesquisa do constituinte. |
Devoluções
Mapa de identificação do constituinte
Obter uma foto de perfil do constituinte
Retorna a foto de perfil atual 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 para o qual a foto de perfil deve ser recuperada. |
Devoluções
Imagem do perfil
Pesquisa de componentes duplicados
Pesquisa registros de contato individuais, organizacionais e relacionados e classifica possíveis duplicatas com base nos filtros de pesquisa especificados. Os registos que correspondem a vários filtros têm uma classificação mais elevada como potenciais duplicados.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Apelido/nome da organização
|
last_org_name | True | string |
Um filtro para registros que correspondem ao sobrenome especificado ou nome da organização. |
|
Nome próprio
|
first_name | string |
Um filtro para registros individuais que correspondem ao nome próprio especificado. |
|
|
Nome do meio
|
middle_name | string |
Um filtro para registros individuais que correspondem ao nome do meio especificado. |
|
|
Sufixo
|
suffix | string |
Um filtro para registros individuais que correspondem ao sufixo especificado. |
|
|
Bloco de endereços
|
address_block | string |
Um filtro para registros que correspondem ao bloco de endereço especificado. |
|
|
City
|
city | string |
Um filtro para registros que correspondem à cidade especificada. |
|
|
Estado
|
state | string |
Um filtro para registros que correspondem ao estado especificado. |
|
|
Código postal
|
post_code | string |
Um filtro para registros que correspondem ao código postal especificado. |
|
|
Email
|
array |
Um filtro para registros que correspondem aos endereços de e-mail especificados. |
||
|
Telemóvel
|
phone | array |
Um filtro para registros que correspondem aos números de telefone especificados. |
|
|
Pesquisar indivíduos?
|
search_individuals | boolean |
Procura registos individuais duplicados? |
|
|
Aliases de pesquisa?
|
search_aliases | boolean |
Pesquisar pelo alias, conforme especificado pelo parâmetro Last/org name? |
|
|
Pesquisar contatos?
|
search_contacts | boolean |
Pesquisar registros de contato de relacionamento? |
|
|
Limite
|
limit | integer |
O número de registros a serem retornados quando a paginação resultar (Padrão = 3). |
|
|
Compensação
|
offset | integer |
O número de registros a serem ignorados durante os resultados da paginação. |
Devoluções
Duplicar resultados da pesquisa
Procurar um constituinte
Executa uma pesquisa constituinte com base no texto de pesquisa fornecido. Suporta nome, sobrenome, nome preferencial, nome anterior, alias, endereço de e-mail, número de telefone, endereço ou ID de pesquisa. Combinações de nomes, como nome e sobrenome ou nome e sobrenome preferidos, são válidas, mas, caso contrário, a pesquisa suporta apenas um parâmetro de cada vez. Por padrão, as pesquisas incluem resultados que soam semelhantes aos seus critérios. Por exemplo, as pesquisas por "Smith" incluem correspondências para "Smyth" e outras grafias alternativas. Esta pesquisa não suporta caracteres curinga como * ou ?. Os resultados da pesquisa estão limitados a 500 registos.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Pesquisar texto
|
search_text | True | string |
O texto da pesquisa. Suporta nome, sobrenome, nome preferencial, nome anterior, alias, endereço de e-mail, número de telefone, endereço ou ID de pesquisa. Combinações de nomes, como nome e sobrenome ou nome e sobrenome preferidos, são válidas, mas, caso contrário, a pesquisa suporta apenas um parâmetro de cada vez. Por padrão, as pesquisas incluem resultados que soam semelhantes aos seus critérios. Por exemplo, as pesquisas por "Smith" incluem correspondências para "Smyth" e outras grafias alternativas. Esta pesquisa não suporta caracteres curinga como * ou ?. Os resultados da pesquisa estão limitados a 500 registos. |
|
Estatutos de angariação de fundos
|
fundraiser_status | string |
Representa uma lista separada por vírgulas de status de arrecadação de fundos para filtrar os resultados. Por exemplo, "Ativo,Nenhum" retorna apenas constituintes cujo status de arrecadação de fundos é Ativo ou Nenhum. Os valores válidos para este filtro são Ativo, Inativo e Nenhum. |
|
|
Incluir inativos?
|
include_inactive | boolean |
Incluir constituintes inativos na resposta? |
|
|
Campo de pesquisa
|
search_field | string |
Representa um campo para pesquisar. Atualmente, ele só suporta lookup_id. Se for fornecido com search_text, um constituinte com lookup_id que corresponda ao search_text será devolvido. |
|
|
Usa uma pesquisa rigorosa?
|
strict_search | boolean |
Excluir constituintes cujos nomes soam como o texto de pesquisa, mas são escritos de forma diferente? |
|
|
Limite
|
limit | integer |
Representa o número de registros a serem retornados. O padrão é 500. O máximo é 5000. |
|
|
Compensação
|
offset | integer |
Representa o número de registros a serem ignorados. Para utilização com paginação. |
Devoluções
Resultados da pesquisa
Procurar um constituinte (melhorado)
Procura registos de constituintes utilizando os critérios de filtro fornecidos.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome próprio
|
first_name | string |
Nome próprio do constituinte. |
|
|
Apelido
|
last_name | string |
Apelido do constituinte. |
|
|
ID de pesquisa
|
lookup_id | string |
ID de pesquisa do constituinte. |
|
|
Endereço de e-mail
|
string |
Endereço de e-mail do constituinte. |
||
|
Número de telefone
|
phone_number | string |
Número de telefone. |
|
|
Limite
|
limit | integer |
Representa o número de registros a serem retornados. O padrão é 500. O máximo é 1000. |
|
|
Linhas de endereço
|
address_lines | string |
Linhas de endereço. |
|
|
City
|
city | string |
Cidade do endereço. |
|
|
Estado
|
state | string |
Estado do endereço. |
|
|
Código postal
|
post_code | string |
Endereço código postal. |
|
|
Incluir alias?
|
include_alias | boolean |
Incluir alias ao pesquisar o sobrenome? |
|
|
Tipo de apelido
|
alias_type | string |
Tipo de alias. |
|
|
Incluir nome de solteira?
|
include_maiden_name | boolean |
Incluir o nome de solteira ao pesquisar o sobrenome? |
Devoluções
Constituintes
Receba uma homenagem constituinte
Devolve detalhes sobre um tributo constituinte.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do tributo
|
tribute_id | True | string |
O ID do tributo. |
Devoluções
Homenagem
Suprimir um código constituinte
Elimina um código constituinte.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do código constituinte
|
constituent_code_id | True | string |
O ID de registo do sistema do código constituinte a eliminar. |
Definições
CommPrefApi.ConstituentConsentRead
Representa uma entidade de consentimento para um constituinte.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O ID de registro do sistema do registro de consentimento. |
|
Channel
|
channel | string |
O canal ao qual a resposta de consentimento se aplica. |
|
Categoria
|
category | string |
A categoria à qual a resposta de consentimento se aplica. |
|
Fonte
|
source | string |
A fonte da resposta de consentimento do constituinte. |
|
Resposta
|
constituent_consent_response | string |
Como o constituinte respondeu ao consentimento para o canal/categoria especificado. |
|
Date
|
consent_date | date-time |
A data em que a resposta de consentimento foi recebida. |
|
Declaração de consentimento
|
consent_statement | string |
A declaração a que o constituinte respondeu ao dar o seu consentimento. |
|
Aviso de privacidade
|
privacy_notice | string |
A declaração de privacidade fornecida ao constituinte. |
|
Data de adição
|
date_added | date-time |
A data em que a resposta de consentimento foi adicionada. |
|
Adicionado(a) por
|
user_name | string |
O usuário que adicionou a resposta de consentimento. |
CommPrefApi.ConstituentConsentReadCollection
Registos de consentimento
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Contar
|
count | integer |
O número de registros de consentimento na lista. |
|
valor
|
value | array of CommPrefApi.ConstituentConsentRead |
O conjunto de registros de consentimento incluídos na resposta. |
CommPrefApi.ConstituentSolicitCodeRead
Solicitar código
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O ID de registo do sistema do código de solicitação constituinte. |
|
Solicitar código
|
solicit_code | string |
Instruções de comunicação e/ou restrições para um componente. |
|
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'). |
CommPrefApi.ConstituentSolicitCodeReadCollection
Solicitar códigos
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Contar
|
count | integer |
O número de códigos de solicitação constituintes na lista. |
|
valor
|
value | array of CommPrefApi.ConstituentSolicitCodeRead |
O conjunto de códigos de solicitação constituintes incluídos na resposta. |
CommPrefApi.CreatedConstituentConsent
Consentimento constituinte criado
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID do registro de consentimento recém-criado. |
CommPrefApi.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. |
ConstituentApi.AddressRead
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. |
|
Country
|
country | string |
O país do endereço (pode ser o ID, nome ou abreviatura). |
|
Linhas de endereço
|
address_lines | string |
As linhas de endereço. |
|
City
|
city | string |
A cidade do endereço (não use em combinação com o campo Subúrbio). |
|
Estado
|
state | string |
O estado do endereço. |
|
Código postal
|
postal_code | string |
O código postal do endereço. |
|
Subúrbio
|
suburb | string |
O subúrbio do endereço (não use em combinação com o campo Cidade). |
|
Concelho
|
county | string |
O município do endereço. |
|
Endereço formatado
|
formatted_address | string |
O endereço formatado no formato configurado do país. |
|
Fonte de informação
|
information_source | string |
A fonte de informação para o endereço. |
|
Região
|
region | string |
A região do endereço. |
|
CARRINHO
|
cart | string |
A rota da transportadora (CART) para o endereço. |
|
LOTE
|
lot | string |
A linha de viagem (LOT) para o endereço. |
|
CPD
|
dpc | string |
O código do ponto de entrega (DPC) para o endereço. |
|
Válido a partir de
|
start | date-time |
A data em que o constituinte passou a residir neste endereço. |
|
Válido para
|
end | date-time |
A data em que o constituinte deixou de residir neste endereço. |
|
Primária?
|
preferred | boolean |
É este o endereço preferido do eleitor? |
|
Inativo?
|
inactive | boolean |
O endereço está inativo (ou seja, a data atual é anterior a qualquer data de término)? |
|
Não envia?
|
do_not_mail | boolean |
O constituinte pode ser contactado neste endereço? |
|
day
|
seasonal_start.d | integer |
O dia na data difusa. |
|
mês
|
seasonal_start.m | integer |
O mês na data difusa. |
|
ano
|
seasonal_start.y | integer |
O ano na data difusa. |
|
day
|
seasonal_end.d | integer |
O dia na data difusa. |
|
mês
|
seasonal_end.m | integer |
O mês na data difusa. |
|
ano
|
seasonal_end.y | integer |
O ano na data difusa. |
|
Data de adição
|
date_added | date-time |
A data em que o endereço foi criado. |
|
Data de modificação
|
date_modified | date-time |
A data em que o endereço foi modificado pela última vez. |
ConstituentApi.AliasRead
Alias
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O ID de registro do sistema do alias. |
|
Alias
|
name | string |
O nome a utilizar como pseudónimo do constituinte. |
|
Tipo
|
type | string |
O tipo de alias. |
ConstituentApi.ApiCollectionOfAddressRead
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 ConstituentApi.AddressRead |
O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção. |
ConstituentApi.ApiCollectionOfAliasRead
Aliases
| 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 ConstituentApi.AliasRead |
O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção. |
ConstituentApi.ApiCollectionOfConstituentAttachmentRead
Attachments
| 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 ConstituentApi.ConstituentAttachmentRead |
O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção. |
ConstituentApi.ApiCollectionOfConstituentCodeRead
Códigos constituintes
| 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 ConstituentApi.ConstituentCodeRead |
O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção. |
ConstituentApi.ApiCollectionOfConstituentCustomFieldRead
Campos personalizados
| 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 ConstituentApi.ConstituentCustomFieldRead |
O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção. |
ConstituentApi.ApiCollectionOfConstituentRead
Constituintes
| 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 ConstituentApi.ConstituentRead |
O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção. |
ConstituentApi.ApiCollectionOfEducationRead
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 ConstituentApi.EducationRead |
O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção. |
ConstituentApi.ApiCollectionOfEmailAddressRead
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 ConstituentApi.EmailAddressRead |
O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção. |
ConstituentApi.ApiCollectionOfFundraiserAssignmentRead
Trabalhos para angariação de fundos
| 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 ConstituentApi.FundraiserAssignmentRead |
O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção. |
ConstituentApi.ApiCollectionOfMembershipRead
Associações
| 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 ConstituentApi.MembershipRead |
O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção. |
ConstituentApi.ApiCollectionOfNoteRead
Observações
| 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 ConstituentApi.NoteRead |
O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção. |
ConstituentApi.ApiCollectionOfOnlinePresenceRead
Presenças online
| 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 ConstituentApi.OnlinePresenceRead |
O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção. |
ConstituentApi.ApiCollectionOfPhoneRead
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 ConstituentApi.PhoneRead |
O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção. |
ConstituentApi.ApiCollectionOfRelationshipRead
Relações
| 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 ConstituentApi.RelationshipRead |
O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção. |
ConstituentApi.ApiCollectionOfSearchResultRead
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. 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 ConstituentApi.SearchResultRead |
O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção. |
ConstituentApi.ConstituentAttachmentRead
Attachment
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O ID de registro do sistema do anexo. |
|
ID do constituinte
|
parent_id | string |
O ID de registo do sistema do constituinte associado ao anexo. |
|
Tipo
|
type | string |
O tipo de anexo. Os anexos físicos são arquivos carregados, como imagens, PDFs ou documentos do Word, que são salvos localmente ou na rede. Eles são armazenados e gerenciados no sistema. Os anexos de links são links para arquivos como imagens, postagens de blog ou vídeos do YouTube que estão online ou em uma conta de armazenamento em nuvem. Eles são armazenados e gerenciados externamente. |
|
Nome
|
name | string |
O nome do anexo. Limite de caracteres: 150. |
|
Date
|
date | date-time |
A data do anexo. |
|
URL
|
url | string |
O URL do anexo. Isso é necessário para anexos de link e não se aplica a anexos físicos. |
|
Nome do ficheiro
|
file_name | string |
O nome do arquivo. Limite de caracteres: 36. Apenas para anexos físicos. |
|
ID do ficheiro
|
file_id | string |
O identificador do arquivo. Limite de caracteres: 36. Apenas para anexos físicos. |
|
ID da miniatura
|
thumbnail_id | string |
O identificador da miniatura. Limite de caracteres: 36. Apenas para anexos físicos. |
|
URL da miniatura
|
thumbnail_url | string |
O URL de uma miniatura. Para anexos físicos que são apenas imagens. Contém uma assinatura com limite de tempo que limita o acesso a 60 minutos. |
|
Tipo de conteúdo
|
content_type | string |
O tipo de conteúdo. Apenas para anexos físicos. |
|
Tamanho do ficheiro
|
file_size | integer |
O tamanho do arquivo em bytes. Apenas para anexos físicos. |
|
Etiquetas
|
tags | array of string |
As tags associadas ao anexo. |
ConstituentApi.ConstituentCodeRead
Código constituinte
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O ID de registo do sistema do código constituinte. |
|
ID do constituinte
|
constituent_id | string |
O ID de registo do sistema do constituinte associado ao código do constituinte. |
|
Código constituinte
|
description | string |
O código constituinte. |
|
day
|
start.d | integer |
O dia na data difusa. |
|
mês
|
start.m | integer |
O mês na data difusa. |
|
ano
|
start.y | integer |
O ano na data difusa. |
|
day
|
end.d | integer |
O dia na data difusa. |
|
mês
|
end.m | integer |
O mês na data difusa. |
|
ano
|
end.y | integer |
O ano na data difusa. |
|
Inativo?
|
inactive | boolean |
O código constituinte está inativo? |
|
Sequence
|
sequence | integer |
A sequência numérica associada ao código constituinte. |
|
Data de adição
|
date_added | date-time |
A data em que o código constituinte foi criado. |
|
Data de modificação
|
date_modified | date-time |
A data em que o código constituinte foi modificado pela última vez. |
ConstituentApi.ConstituentCustomFieldRead
Campo personalizado
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID de registro do sistema do campo personalizado. |
|
ID do constituinte
|
parent_id | string |
O ID de registro do sistema do componente associado ao campo personalizado. |
|
Categoria
|
category | string |
A categoria de campo personalizado. |
|
Tipo
|
type | string |
O tipo de dados que o campo personalizado representa. |
|
Valor
|
value |
O valor do campo personalizado. |
|
|
Valor do texto
|
text_value | string |
O valor de texto do campo personalizado. |
|
Valor do número
|
number_value | integer |
O valor numérico do campo personalizado. |
|
Valor da data
|
date_value | date |
O valor de data do campo personalizado. |
|
Valor da moeda
|
currency_value | double |
O valor da moeda do campo personalizado. |
|
Valor booleano
|
boolean_value | boolean |
O valor booleano do campo personalizado. |
|
Valor de entrada da tabela
|
codetableentry_value | string |
O valor de entrada de tabela do campo personalizado. |
|
Valor da ID do constituinte
|
constituentid_value | string |
O valor de ID do constituinte do campo personalizado. |
|
day
|
fuzzydate_value.d | integer |
O dia na data difusa. |
|
mês
|
fuzzydate_value.m | integer |
O mês na data difusa. |
|
ano
|
fuzzydate_value.y | integer |
O ano na data difusa. |
|
Date
|
date | date |
A data no campo personalizado. |
|
Comment
|
comment | string |
O comentário no campo personalizado. Limite de caracteres: 50. |
|
Data de adição
|
date_added | date-time |
A data em que o campo personalizado foi criado. |
|
Data de modificação
|
date_modified | date-time |
A data em que o campo personalizado foi modificado pela última vez. |
ConstituentApi.ConstituentRead
Constituinte
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O ID de registo do sistema para o constituinte. Isso não é o mesmo que o identificador de constituinte definido pelo usuário, que é armazenado no lookup_id. |
|
Tipo
|
type | string |
O tipo de constituinte. |
|
Title
|
title | string |
O título principal do constituinte (apenas para pessoas singulares). |
|
Nome próprio
|
first | string |
Nome próprio do constituinte (apenas para pessoas singulares). |
|
Apelido
|
last | string |
Apelido do eleitor (apenas para pessoas singulares). |
|
Nome
|
name | string |
Para indivíduos, este campo é o nome completo do constituinte com base nas configurações de nome de exibição da organização de destino. Para as organizações, este é o nome da organização. |
|
Nome preferido
|
preferred_name | string |
O nome preferido do constituinte (apenas para pessoas singulares). |
|
Sufixo
|
suffix | string |
Sufixo primário do constituinte (apenas para indivíduos). |
|
ID de pesquisa
|
lookup_id | string |
O identificador definido pelo utilizador para o constituinte. |
|
ID
|
email.id | string |
O ID de registro do sistema do endereço de e-mail. |
|
tipo
|
email.type | string |
O tipo de endereço de e-mail. |
|
address
|
email.address | string |
O endereço de e-mail. |
|
não enviar e-mail?
|
email.do_not_email | boolean |
O constituinte pode ser contactado através deste endereço de correio eletrónico? |
|
inativo?
|
email.inactive | boolean |
Este endereço de e-mail está inativo? |
|
data adicionada
|
email.date_added | date-time |
A data em que o endereço de e-mail foi criado. |
|
Data de modificação
|
email.date_modified | date-time |
A data em que o endereço de e-mail foi modificado pela última vez. |
|
ID
|
phone.id | string |
O ID de registro do sistema do telefone. |
|
tipo
|
phone.type | string |
O tipo de telefone. |
|
número
|
phone.number | string |
O número de telefone. |
|
não liga?
|
phone.do_not_call | boolean |
O constituinte pode ser contactado através deste número? |
|
inativo?
|
phone.inactive | boolean |
Este número de telefone está inativo? |
|
data adicionada
|
phone.date_added | date-time |
A data em que o telefone foi criado. |
|
Data de modificação
|
phone.date_modified | date-time |
A data em que o telefone foi modificado pela última vez. |
|
ID
|
online_presence.id | string |
O ID de registo do sistema da presença online. |
|
tipo
|
online_presence.type | string |
O tipo de presença online. |
|
ligação
|
online_presence.address | string |
O endereço Web da presença online. |
|
inativo?
|
online_presence.inactive | boolean |
Esta presença online está inativa? |
|
data adicionada
|
online_presence.date_added | date-time |
A data em que a presença online foi criada. |
|
Data de modificação
|
online_presence.date_modified | date-time |
A data em que a presença online foi modificada pela última vez. |
|
ID
|
address.id | string |
O ID de registro do sistema do endereço. |
|
tipo
|
address.type | string |
O tipo de endereço. |
|
country
|
address.country | string |
O país do endereço (pode ser o ID, nome ou abreviatura). |
|
linhas
|
address.address_lines | string |
As linhas de endereço. |
|
city
|
address.city | string |
A cidade do endereço (não use em combinação com o campo Subúrbio). |
|
state
|
address.state | string |
O estado do endereço. |
|
código postal
|
address.postal_code | string |
O código postal do endereço. |
|
subúrbio
|
address.suburb | string |
O subúrbio do endereço (não use em combinação com o campo Cidade). |
|
concelho
|
address.county | string |
O município do endereço. |
|
formatado
|
address.formatted_address | string |
O endereço formatado no formato configurado do país. |
|
válido a partir de
|
address.start | date-time |
A data em que o constituinte passou a residir neste endereço. |
|
válido para
|
address.end | date-time |
A data em que o constituinte deixou de residir neste endereço. |
|
inativo?
|
address.inactive | boolean |
O endereço está inativo (ou seja, a data atual é anterior a qualquer data de término)? |
|
não envia?
|
address.do_not_mail | boolean |
O constituinte pode ser contactado neste endereço? |
|
day
|
address.seasonal_start.d | integer |
O dia na data difusa. |
|
mês
|
address.seasonal_start.m | integer |
O mês na data difusa. |
|
ano
|
address.seasonal_start.y | integer |
O ano na data difusa. |
|
day
|
address.seasonal_end.d | integer |
O dia na data difusa. |
|
mês
|
address.seasonal_end.m | integer |
O mês na data difusa. |
|
ano
|
address.seasonal_end.y | integer |
O ano na data difusa. |
|
data adicionada
|
address.date_added | date-time |
A data em que o endereço foi criado. |
|
Data de modificação
|
address.date_modified | date-time |
A data em que o endereço foi modificado pela última vez. |
|
Sexo
|
gender | string |
O sexo do constituinte (apenas para indivíduos). |
|
Nome do meio
|
middle | string |
Nome do meio do constituinte (apenas para pessoas singulares). |
|
Antigo nome
|
former_name | string |
O nome anterior do constituinte (apenas para pessoas singulares). |
|
Título 2
|
title_2 | string |
O título secundário do constituinte (apenas para pessoas singulares). |
|
Sufixo 2
|
suffix_2 | string |
Sufixo secundário do constituinte (apenas para indivíduos). |
|
Estado conjugal
|
marital_status | string |
O estado civil do constituinte (apenas para pessoas singulares). |
|
Dá anonimamente?
|
gives_anonymously | boolean |
O constituinte doa anonimamente? |
|
Não solicita e-mail?
|
requests_no_email | boolean |
O constituinte não solicita nenhum e-mail? |
|
É solicitor?
|
is_solicitor | boolean |
O constituinte é advogado? |
|
Não tem endereços válidos?
|
no_valid_address | boolean |
O constituinte não tem morada válida? |
|
Inativo?
|
inactive | boolean |
O constituinte está inativo? |
|
day
|
birthdate.d | integer |
O dia na data difusa. |
|
mês
|
birthdate.m | integer |
O mês na data difusa. |
|
ano
|
birthdate.y | integer |
O ano na data difusa. |
|
Local de nascimento
|
birthplace | string |
O local de nascimento do constituinte (apenas para indivíduos). |
|
Etnicidade
|
ethnicity | string |
A etnia do constituinte (apenas para indivíduos). |
|
Target
|
target | string |
O alvo do constituinte. |
|
Rendimentos
|
income | string |
O rendimento do constituinte (apenas para pessoas singulares). |
|
Tipo de recibo
|
receipt_type | string |
O tipo de recibo do constituinte. |
|
Religião
|
religion | string |
A religião do constituinte (apenas para indivíduos). |
|
Indústria
|
industry | string |
A indústria do constituinte (apenas para organizações). |
|
Número de empregados
|
num_employees | integer |
O número de funcionários na organização. |
|
Combina presentes?
|
matches_gifts | boolean |
A organização combina presentes? |
|
Fator de presente correspondente
|
matching_gift_factor | double |
O fator de presente correspondente (apenas para organizações). |
|
valor
|
matching_gift_per_gift_min.value | double |
O valor do montante. |
|
valor
|
matching_gift_per_gift_max.value | double |
O valor do montante. |
|
valor
|
matching_gift_total_min.value | double |
O valor do montante. |
|
valor
|
matching_gift_total_max.value | double |
O valor do montante. |
|
Notas de presente correspondentes
|
matching_gift_notes | string |
As notas de presente correspondentes para o constituinte (apenas para organizações). |
|
Idade
|
age | integer |
A idade do constituinte, calculada com base na propriedade da data de nascimento (apenas para indivíduos). |
|
Falecido?
|
deceased | boolean |
O constituinte faleceu (apenas para pessoas singulares)? |
|
day
|
deceased_date.d | integer |
O dia na data difusa. |
|
mês
|
deceased_date.m | integer |
O mês na data difusa. |
|
ano
|
deceased_date.y | integer |
O ano na data difusa. |
|
Estatuto de angariador de fundos
|
fundraiser_status | string |
Indica se o constituinte é um angariador de fundos (apenas para pessoas singulares). |
|
É memorial?
|
is_memorial | boolean |
O constituinte é uma honra/memorial? |
|
ID
|
spouse.id | string |
O ID de registo do sistema do cônjuge. |
|
Nome próprio
|
spouse.first | string |
Nome próprio do cônjuge. |
|
Apelido
|
spouse.last | string |
Apelido do cônjuge. |
|
é chefe de família?
|
spouse.is_head_of_household | boolean |
O cônjuge é o chefe de família? |
|
Data de adição
|
date_added | date-time |
A data em que o constituinte foi criado. |
|
Data de modificação
|
date_modified | date-time |
A data em que o constituinte foi modificado pela última vez. |
ConstituentApi.ConvertedConstituent
Constituinte convertido
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID do constituinte convertido. |
ConstituentApi.CreatedConstituentAddress
Endereço constituinte criado
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O ID do endereço do constituinte recém-criado. |
ConstituentApi.CreatedConstituentAlias
Alias constituinte criado
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID do alias constituinte recém-criado. |
ConstituentApi.CreatedConstituentAttachment
Anexação constituinte criada
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID do anexo constituinte recém-criado. |
ConstituentApi.CreatedConstituentCode
Código constituinte criado
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID do código constituinte recém-criado. |
ConstituentApi.CreatedConstituentCustomField
Campo personalizado constituinte criado
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID do campo personalizado constituinte recém-criado. |
ConstituentApi.CreatedConstituentEducation
Criou a educação constituinte
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O ID da educação constituinte recém-criada. |
ConstituentApi.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. |
ConstituentApi.CreatedConstituentNote
Nota constituinte criada
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O ID da nota constituinte recém-criada. |
ConstituentApi.CreatedConstituentOnlinePresence
Presença online constituinte criada
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O ID da presença online do constituinte recém-criado. |
ConstituentApi.CreatedConstituentPhone
Telefone constituinte criado
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O ID do telefone constituinte recém-criado. |
ConstituentApi.CreatedIndividualConstituent
Constituinte individual criado
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O ID do constituinte individual recém-criado. |
ConstituentApi.CreatedIndividualRelationship
Relacionamento individual criado
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID da relação individual recém-criada. |
ConstituentApi.CreatedNameFormat
Formato de nome criado
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID do formato de nome recém-criado. |
ConstituentApi.CreatedOrganizationConstituent
Constituinte da organização criada
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID do constituinte da organização recém-criado. |
ConstituentApi.CreatedOrganizationRelationship
Relacionamento organizacional criado
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID da relação de organização recém-criada. |
ConstituentApi.DuplicateSearchResult
Duplicar o resultado da pesquisa
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O ID de registo do sistema para o 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 de exibição
|
display_name | string |
O nome de exibição do constituinte. |
|
Address
|
formatted_address | string |
O endereço principal formatado para o constituinte. |
|
Falecido?
|
deceased | boolean |
O constituinte faleceu? |
|
É um constituinte?
|
is_constituent | boolean |
O registo é um constituinte? |
|
ID de pesquisa
|
constituent_id | string |
O identificador definido pelo utilizador para o constituinte. |
|
Data de adição
|
date_added | date-time |
A data em que o constituinte foi adicionado. |
|
Classificação
|
rank | string |
A classificação da pesquisa indica em que o constituinte foi correspondido. |
ConstituentApi.DuplicateSearchResultCollection
Duplicar 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. 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 ConstituentApi.DuplicateSearchResult |
O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção. |
ConstituentApi.EducationRead
Education
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O ID de registro do sistema da educação. |
|
ID do constituinte
|
constituent_id | string |
O ID de registo do sistema do constituinte associado à educação. |
|
Escola
|
school | string |
O nome da escola/estabelecimento. |
|
Tipo
|
type | string |
O tipo de educação. |
|
Classe de
|
class_of | string |
O ano em que o constituinte se formou. |
|
Situação
|
status | string |
O estatuto da educação. |
|
day
|
date_entered.d | integer |
O dia na data difusa. |
|
mês
|
date_entered.m | integer |
O mês na data difusa. |
|
ano
|
date_entered.y | integer |
O ano na data difusa. |
|
day
|
date_left.d | integer |
O dia na data difusa. |
|
mês
|
date_left.m | integer |
O mês na data difusa. |
|
ano
|
date_left.y | integer |
O ano na data difusa. |
|
day
|
date_graduated.d | integer |
O dia na data difusa. |
|
mês
|
date_graduated.m | integer |
O mês na data difusa. |
|
ano
|
date_graduated.y | integer |
O ano na data difusa. |
|
Licenciatura
|
degree | string |
O grau recebido. |
|
GPA
|
gpa | double |
A média de pontos da nota. |
|
Majors
|
majors | array of string |
Os principais cursos de estudo. |
|
Menores
|
minors | array of string |
Os cursos menores de estudo. |
|
O ensino primário?
|
primary | boolean |
Esta é a associação de escolas primárias do constituinte? |
|
Campus
|
campus | string |
O campus. |
|
Organização social
|
social_organization | string |
A organização social. |
|
Nome conhecido
|
known_name | string |
O nome conhecido. |
|
Classe de grau
|
class_of_degree | string |
A classe de grau. |
|
Departamento
|
department | string |
O nome do departamento de educação. |
|
Corpo Docente
|
faculty | string |
O nome da faculdade. |
|
Número de registo
|
registration_number | string |
O número de registo. |
|
Objeto de estudo
|
subject_of_study | string |
O objeto de estudo. |
|
Data de adição
|
date_added | date-time |
A data em que a educação foi criada. |
|
Data de modificação
|
date_modified | date-time |
A data em que a educação foi modificada pela última vez. |
ConstituentApi.EmailAddressRead
Endereço de e-mail
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O ID de registro do sistema do endereço de e-mail. |
|
ID do constituinte
|
constituent_id | string |
O ID de registro do sistema do constituinte associado ao endereço de e-mail. |
|
Tipo de e-mail
|
type | string |
O tipo de endereço de e-mail. |
|
Endereço de e-mail
|
address | string |
O endereço de e-mail. |
|
Primária?
|
primary | boolean |
Este é o endereço de e-mail principal do eleitor? |
|
Não envia e-mail?
|
do_not_email | boolean |
O constituinte pode ser contactado através deste endereço de correio eletrónico? |
|
Inativo?
|
inactive | boolean |
Este endereço de e-mail está inativo? |
|
Data de adição
|
date_added | date-time |
A data em que o endereço de e-mail foi criado. |
|
Data de modificação
|
date_modified | date-time |
A data em que o endereço de e-mail foi modificado pela última vez. |
ConstituentApi.FundraiserAssignmentLer
Atribuição de angariação de fundos
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O ID de registo do sistema da atribuição de angariação de fundos. |
|
ID do constituinte
|
constituent_id | string |
O ID de registo do sistema do constituinte atribuído à angariação de fundos. |
|
ID da angariação de fundos
|
fundraiser_id | string |
O ID de registo do sistema da angariação de fundos. |
|
Tipo
|
type | string |
O tipo de angariação de fundos. |
|
valor
|
amount.value | double |
O valor monetário. |
|
ID da Campanha
|
campaign_id | string |
O ID de registro do sistema da campanha para aplicar os presentes resultantes. |
|
ID do Fundo
|
fund_id | string |
O ID de registo do sistema do fundo a que todos os donativos resultantes devem ser aplicados. Se um fundo restrito for selecionado, apenas as campanhas e recursos associados a esse fundo poderão ser selecionados. |
|
ID do recurso
|
appeal_id | string |
O ID de registo do sistema do recurso que o angariador de fundos deve utilizar para solicitar presentes. |
|
Data de início
|
start | date-time |
Data de início da atribuição da angariação de fundos. |
|
Data de fim
|
end | date-time |
Data de término da atribuição da angariação de fundos. |
ConstituentApi.MembershipMemberRead
Membro
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O ID de registro do sistema do membro. |
|
ID do constituinte
|
constituent_id | string |
O ID de registro do sistema do constituinte associado ao membro. |
|
É membro principal?
|
primary | boolean |
Este é o membro principal? |
ConstituentApi.MembershipRead
Membership
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O ID de registro do sistema da associação. |
|
ID do constituinte
|
constituent_id | string |
O ID de registro do sistema do constituinte associado à associação. |
|
Programa
|
program | string |
O programa de filiação. |
|
Categoria
|
category | string |
A categoria de membros. |
|
Subcategoria
|
subcategory | string |
A subcategoria de membros. |
|
Em pé
|
standing | string |
O estatuto de membro. |
|
Expira
|
expires | date-time |
A data em que a adesão expira. |
|
Cadastrou-se
|
joined | date-time |
A data em que a associação se torna ativa. |
|
valor
|
dues.value | double |
O valor monetário. |
|
Members
|
members | array of ConstituentApi.MembershipMemberRead |
O conjunto de membros que pertencem ao membro. |
|
Data de adição
|
date_added | date-time |
A data em que a associação foi criada. |
|
Data de modificação
|
date_modified | date-time |
A data em que a associação foi modificada pela última vez. |
ConstituentApi.NameFormatRead
Os formatos de nomes definem como abordar os constituintes nas comunicações. A forma como você se refere aos indivíduos define o tom de suas comunicações com eles e o quão bem eles recebem suas interações.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O ID de registro do sistema do formato de nome. |
|
tipo
|
type | string |
O tipo de formato de nome. |
|
formato personalizado?
|
custom_format | boolean |
Este é um formato personalizado? |
|
ID de configuração
|
configuration_id | string |
O ID de configuração do formato de nome (para formatos não personalizados). |
|
Nome formatado
|
formatted_name | string |
O nome formatado (para formatos personalizados). |
ConstituentApi.NameFormatSummaryRead
Resumo do formato do nome
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
primary_addressee.id | string |
O ID de registro do sistema do formato de nome. |
|
tipo
|
primary_addressee.primary_type | string |
O tipo de formato de nome. |
|
formato personalizado?
|
primary_addressee.custom_format | boolean |
Este é um formato personalizado? |
|
ID de configuração
|
primary_addressee.configuration_id | string |
O ID de configuração do formato de nome (para formatos não personalizados). |
|
Nome formatado
|
primary_addressee.formatted_name | string |
O nome formatado (para formatos personalizados). |
|
ID
|
primary_salutation.id | string |
O ID de registro do sistema do formato de nome. |
|
tipo
|
primary_salutation.primary_type | string |
O tipo de formato de nome. |
|
formato personalizado?
|
primary_salutation.custom_format | boolean |
Este é um formato personalizado? |
|
ID de configuração
|
primary_salutation.configuration_id | string |
O ID de configuração do formato de nome (para formatos não personalizados). |
|
Nome formatado
|
primary_salutation.formatted_name | string |
O nome formatado (para formatos personalizados). |
|
Formatos de nomes adicionais
|
additional_name_formats | array of ConstituentApi.NameFormatRead |
Os formatos de nome adicionais do constituinte. |
ConstituentApi.NoteRead
Observação
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O ID de registro do sistema da nota. |
|
ID do constituinte
|
constituent_id | string |
O ID de registo do sistema do constituinte associado à nota. |
|
Tipo
|
type | string |
O tipo de nota. |
|
day
|
date.d | integer |
O dia na data difusa. |
|
mês
|
date.m | integer |
O mês na data difusa. |
|
ano
|
date.y | integer |
O ano na data difusa. |
|
Resumo
|
summary | string |
O resumo da nota. |
|
Observação
|
text | string |
O texto da nota. |
|
Data de adição
|
date_added | date-time |
A data em que a nota foi criada. |
|
Data de modificação
|
date_modified | date-time |
A data em que a nota foi modificada pela última vez. |
ConstituentApi.OnlinePresenceRead
Presença online
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O ID de registo do sistema da presença online. |
|
ID do constituinte
|
constituent_id | string |
O ID de registo do sistema do constituinte associado à presença online. |
|
Tipo
|
type | string |
O tipo de presença online. |
|
Link
|
address | string |
O endereço Web da presença online. |
|
Primária?
|
primary | boolean |
Esta é a principal presença online do eleitor? |
|
Inativo?
|
inactive | boolean |
Esta presença online está inativa? |
|
Data de adição
|
date_added | date-time |
A data em que a presença online foi criada. |
|
Data de modificação
|
date_modified | date-time |
A data em que a presença online foi modificada pela última vez. |
ConstituentApi.PhoneRead
Telemóvel
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O ID de registro do sistema do telefone. |
|
ID do constituinte
|
constituent_id | string |
O ID de registro do sistema do constituinte associado ao telefone. |
|
Tipo
|
type | string |
O tipo de telefone. |
|
Número
|
number | string |
O número de telefone. |
|
Primária?
|
primary | boolean |
Este é o telefone principal do eleitor? |
|
Não liga?
|
do_not_call | boolean |
O constituinte pode ser contactado através deste número? |
|
Inativo?
|
inactive | boolean |
Este número de telefone está inativo? |
|
Data de adição
|
date_added | date-time |
A data em que o telefone foi criado. |
|
Data de modificação
|
date_modified | date-time |
A data em que o telefone foi modificado pela última vez. |
ConstituentApi.ProfilePictureRead
Imagem do perfil
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do constituinte
|
constituent_id | string |
O ID de registo do sistema do constituinte associado à foto de perfil. |
|
URL
|
url | string |
O URL da foto de perfil. O URL contém uma assinatura com limite de tempo que limita o acesso a 60 minutos. |
|
URL da miniatura
|
thumbnail_url | string |
O URL de uma miniatura da foto do perfil. Contém uma assinatura com limite de tempo que limita o acesso a 60 minutos. |
ConstituentApi.RelationshipRead
Relacionamento
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O ID de registro do sistema da relação. |
|
ID do constituinte
|
constituent_id | string |
O ID de registro do sistema do constituinte associado à relação. |
|
ID da relação
|
relation_id | string |
O ID de registro do sistema do indivíduo ou organização relacionado. |
|
ID de relacionamento recíproco
|
reciprocal_relationship_id | string |
O identificador para o registro de relacionamento recíproco. Esse valor é somente leitura e é gerado automaticamente quando a relação é criada. As alterações feitas nesse registro também serão refletidas na recíproca, com exceção da propriedade comments. |
|
Nome
|
name | string |
O nome do constituinte relacionado. Se o constituinte relacionado for um indivíduo, este será o nome completo do constituinte com base nas configurações de nome de exibição da organização de destino. |
|
Tipo
|
type | string |
O tipo de relação que a relação representa. |
|
Tipo recíproco
|
reciprocal_type | string |
Descreve a relação do constituinte com o constituinte relacionado. Por exemplo, numa relação entre um constituinte masculino e um irmão do sexo feminino, o tipo de relação recíproca seria irmão. |
|
day
|
start.d | integer |
O dia na data difusa. |
|
mês
|
start.m | integer |
O mês na data difusa. |
|
ano
|
start.y | integer |
O ano na data difusa. |
|
day
|
end.d | integer |
O dia na data difusa. |
|
mês
|
end.m | integer |
O mês na data difusa. |
|
ano
|
end.y | integer |
O ano na data difusa. |
|
É cônjuge?
|
is_spouse | boolean |
A pessoa coligada é cônjuge do constituinte (aplica-se apenas às relações entre particulares)? |
|
O constituinte é chefe de família?
|
is_constituent_head_of_household | boolean |
O constituinte é o chefe do agregado familiar? |
|
O cônjuge é chefe de família?
|
is_spouse_head_of_household | boolean |
O cônjuge é o chefe de família? |
|
Observações
|
comment | string |
O comentário sobre a relação. |
|
É contacto?
|
is_organization_contact | boolean |
O constituinte representa esta organização como um contacto (aplica-se apenas às relações entre organizações e indivíduos)? |
|
O negócio é principal?
|
is_primary_business | boolean |
Este é o negócio principal do constituinte (aplica-se apenas às relações entre organizações e indivíduos)? |
|
Tipo de contacto
|
organization_contact_type | string |
Fornece contexto para interações com o indivíduo relacionado que representa a organização como um contato. Aplica-se apenas às relações entre organizações e indivíduos. |
|
Position
|
position | string |
A posição do indivíduo na organização. Aplica-se apenas às relações entre organizações e indivíduos. |
|
Data de adição
|
date_added | date-time |
A data em que a relação foi criada. |
|
Data de modificação
|
date_modified | date-time |
A data em que a relação foi modificada pela última vez. |
ConstituentApi.SearchResultRead
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. |
|
Address
|
address | string |
Endereço preferencial do eleitor. |
|
Falecido?
|
deceased | boolean |
O constituinte faleceu? |
|
Email
|
string |
Endereço de correio eletrónico do constituinte. |
|
|
Estatuto de angariador de fundos
|
fundraiser_status | string |
O estatuto de angariador de fundos do eleitor. Para indivíduos, este campo calculado indica se o constituinte é Ativo, Inativo ou Nenhum. Para as organizações, este valor será sempre Nenhum. |
|
Inativo?
|
inactive | boolean |
O constituinte está inativo? |
|
ID de pesquisa
|
lookup_id | string |
O identificador definido pelo utilizador para o constituinte. |
Angariação de FundosApi.ApiCollectionOfFundraiserAssignmentRead
Assignments
| 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 FundraisingApi.FundraiserAssignmentRead |
O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção. |
Angariação de fundosApi.CriadoAngariação de fundosAtribuição
Criação de atribuição de angariação de fundos
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O ID da atribuição de angariação de fundos recém-criada. |
Angariação de FundosApi.Angariação de FundosAtribuiçãoLer
Assignment
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O ID de registo do sistema da atribuição de angariação de fundos. |
|
ID do constituinte
|
constituent_id | string |
O ID de registo do sistema do componente atribuído. |
|
Tipo
|
type | string |
O tipo de angariação de fundos. |
|
Início da atribuição
|
start | date-time |
A data de início da atribuição. |
|
Fim da atribuição
|
end | date-time |
A data final da atribuição. |
|
valor
|
amount.value | double |
O valor monetário. |
|
ID da Campanha
|
campaign_id | string |
O ID de registro do sistema da campanha à qual os presentes resultantes serão aplicados. |
|
ID do Fundo
|
fund_id | string |
O ID de registo do sistema do fundo ao qual os donativos resultantes serão aplicados. |
|
ID do recurso
|
appeal_id | string |
O sistema registra o ID do recurso ao qual os presentes resultantes serão aplicados. |
NXTDataIntegrationApi.ConstituentIdMap
Mapa de identificação do constituinte
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
system_record_id | integer |
O ID de registo do sistema constituinte. |
NXTDataIntegrationApi.ConstituentSearchResult
Resultado da pesquisa
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
record_id | integer |
O ID de registo do sistema do constituinte. |
|
ID de pesquisa
|
constituent_id | string |
A ID do constituinte. |
|
Indicador-chave
|
key_indicator | string |
O indicador-chave para o registo. |
|
Nome próprio
|
first_name | string |
O primeiro nome (apenas indivíduos). |
|
Apelido
|
last_name | string |
O apelido (apenas indivíduos). |
|
Nome do meio
|
middle_name | string |
O nome do meio (apenas indivíduos). |
|
Nome preferido
|
preferred_name | string |
O nome preferido (apenas indivíduos). |
|
Antigo nome
|
maiden_name | string |
O nome anterior (apenas indivíduos). |
|
Título 1
|
title1 | string |
O título 1 (apenas indivíduos). |
|
Sufixo 1
|
suffix1 | string |
O sufixo 1 (apenas indivíduos). |
|
Sexo
|
gender | string |
O sexo constituinte (apenas indivíduos). |
|
day
|
birth_date.d | integer |
O dia na data difusa. |
|
mês
|
birth_date.m | integer |
O mês na data difusa. |
|
ano
|
birth_date.y | integer |
O ano na data difusa. |
|
Nome próprio do cônjuge
|
spouse_first_name | string |
Nome próprio do cônjuge (apenas pessoas singulares). |
|
Apelido do cônjuge
|
spouse_last_name | string |
Apelido do cônjuge (apenas pessoas singulares). |
|
Nome da organização
|
org_name | string |
O nome da organização (somente organizações). |
|
Bloco de endereços
|
address_block | string |
O bloco de endereço. |
|
Cidade e estado
|
address_city_state | string |
O endereço cidade e estado. |
|
Código postal
|
address_post_code | string |
O código postal do endereço. |
|
Endereço de e-mail principal
|
primary_email | string |
O e-mail principal. |
|
Número de telefone principal
|
primary_phone | string |
O telefone principal. |
|
Alias correspondente
|
matched_alias | string |
O nome do alias correspondente (apenas indivíduos). |
|
E-mail correspondente
|
matched_email | string |
O endereço de e-mail correspondente. |
|
Telefone correspondente
|
matched_phone | string |
O número de telefone correspondente. |
|
É um constituinte?
|
is_constituent | boolean |
O registo é um constituinte? |
|
Faleceu?
|
is_deceased | boolean |
O registo é falecido? |
|
Está inativo?
|
is_inactive | boolean |
O registo está inativo? |
NXTDataIntegrationApi.ConstituentSearchResultCollection
Constituintes
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
results
|
results | array of NXTDataIntegrationApi.ConstituentSearchResult |
O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção. |
NXTDataIntegrationApi.CreatedConstituentTribute
Tributo constituinte criado
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O ID do tributo constituinte recém-criado. |
NXTDataIntegrationApi.CreatedTributeAcknowledgee
Agradecimento de homenagem criado
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O ID do tributo recém-criado reconhece. |
NXTDataIntegrationApi.Tribute
Homenagem
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
O ID de registro do sistema do tributo. |
|
ID do constituinte
|
constituent_record_id | integer |
O ID de registro do sistema do constituinte associado ao tributo. |
|
Tipo de tributo
|
tribute_type_name | string |
O tipo de homenagem. |
|
ID do tipo de tributo
|
tribute_type_id | integer |
O ID do tipo tributo. |
|
Description
|
description | string |
A descrição da homenagem. |
|
day
|
start_date.d | integer |
O dia na data difusa. |
|
mês
|
start_date.m | integer |
O mês na data difusa. |
|
ano
|
start_date.y | integer |
O ano na data difusa. |
|
day
|
end_date.d | integer |
O dia na data difusa. |
|
mês
|
end_date.m | integer |
O mês na data difusa. |
|
ano
|
end_date.y | integer |
O ano na data difusa. |
|
ID do fundo de proteção por defeito
|
default_fund_id | integer |
O ID de registro do sistema do fundo padrão associado ao tributo. |
|
Observações
|
notes | string |
A homenagem aponta. |
|
Ativo?
|
is_active | boolean |
Essa homenagem é ativa? |
|
Sequence
|
sequence | integer |
A sequência da homenagem. |
|
Data de adição
|
date_added | date-time |
A data em que a homenagem foi criada. |
|
Data de modificação
|
date_modified | date-time |
A data em que a homenagem foi modificada pela última vez. |
NXTDataIntegrationApi.TributeAcknowledgee
Reconhecimento de homenagem
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
O sistema registra o ID do reconhecimento do tributo. |
|
ID do tributo
|
tribute_id | integer |
O ID de registro do sistema do tributo associado ao reconhecimento. |
|
ID de relacionamento
|
relationships_id | integer |
O ID de registro do sistema da relação (se nulo, isso representa uma autorreconhecimento). |
|
ID da carta
|
letter | integer |
A letra ID. |
|
Sequence
|
sequence | integer |
A homenagem reconhece a sequência. |
NXTDataIntegrationApi.TributeAcknowledgeeCollection
Homenagem reconhece
| 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 NXTDataIntegrationApi.TributeAcknowledgee |
O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção. |
NXTDataIntegrationApi.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 NXTDataIntegrationApi.Tribute |
O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção. |