Partilhar via


Eventos Blackbaud Raisers Edge NXT

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 Eventos para gerenciar eventos e participantes.

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

Serviço Class Regiões
Estúdio Copiloto Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas Standard Todas as regiões do Logic Apps , exceto as seguintes:
     - Regiões do Azure Government
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Aplicações Power Premium Todas as regiões do Power Apps , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Automatize o poder Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Suporte Blackbaud
URL https://www.blackbaud.com/support
Email skyapi@blackbaud.com
Metadados do conector
Editora Blackbaud, Inc.
Sítio Web https://www.blackbaud.com/products/blackbaud-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 do Blackbaud e fornece operações para ajudar a gerenciar eventos e entidades relacionadas encontradas no The Raiser's Edge NXT, incluindo:

  • Events
  • Participants
  • Taxas e donativos
  • 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 um anexo de evento

Atualiza um anexo de evento.

Atualizar um evento

Atualiza os detalhes sobre um evento.

Atualizar um participante

Atualiza os detalhes sobre um participante.

Atualizar uma opção de participante

Atualiza os detalhes sobre uma opção de participante.

Criar um anexo de evento

Cria um novo anexo de evento.

Criar um evento

Cria um novo evento.

Criar um pagamento de taxa de participante

Cria um novo pagamento de taxa para um participante.

Criar um participante

Cria um novo participante para um evento.

Criar uma doação de participante

Cria uma nova doação para um participante.

Criar uma opção de participante

Cria uma nova opção de participante para um participante.

Criar uma opção de participante do evento

Cria uma nova opção de participante para um evento.

Criar uma taxa de evento

Cria uma nova taxa para um evento.

Criar uma taxa de participante

Cria uma nova taxa para um participante.

Listar anexos de eventos

Lista os anexos de um evento.

Listar as taxas de participação

Lista as taxas para um participante.

Listar doações de participantes

Lista as doações para um participante.

Listar eventos

Retorna uma lista de eventos.

Listar opções de participantes

Lista as opções de participante para um participante.

Listar opções de participantes do evento

Lista as opções de participantes para um evento.

Listar pagamentos de taxas de participante

Lista os pagamentos de taxas para um participante.

Listar participantes do evento

Lista os participantes de um evento.

Listar taxas de eventos

Lista as taxas para um evento.

Obter um participante

Retorna informações sobre um participante específico do evento.

Receba um evento

Retorna informações sobre um evento.

Atualizar um anexo de evento

Atualiza um anexo de evento.

Parâmetros

Name Chave Necessário Tipo Description
ID do Evento
event_id True string

A ID de registro do sistema do evento.

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 evento

Atualiza os detalhes sobre um evento.

Parâmetros

Name Chave Necessário Tipo Description
ID do Evento
event_id True string

A ID de registro do sistema do evento a ser atualizado.

Nome do evento
name string

O nome do evento.

Description
description string

A descrição do evento.

Categoria
name True string

O nome da categoria.

Data de início
start_date date

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

Hora de início
start_time string

A hora de início do evento (ex: '07:30').

Data de fim
end_date date

A data final do evento (ex: '2020-09-18').

Hora de fim
end_time string

A hora de fim do evento (ex: '07:30').

ID de pesquisa
lookup_id string

A ID de pesquisa do evento.

Capacidade
capacity integer

O número de pessoas que podem assistir ao evento.

Objetivo
goal double

O objetivo monetário do evento.

ID da Campanha
campaign_id string

O ID de registo do sistema da campanha associada ao evento.

ID do Fundo
fund_id string

O ID de registo do sistema do fundo associado ao evento.

Inativo?
inactive boolean

O evento está ativo?

Atualizar um participante

Atualiza os detalhes sobre um participante.

Parâmetros

Name Chave Necessário Tipo Description
ID do Participante
participant_id True string

O ID de registro do sistema do participante a ser atualizado.

ID do constituinte
constituent_id string

O ID de constituinte do participante.

ID do anfitrião
host_id string

O ID do registo de participante do anfitrião.

Estado de RSVP
rsvp_status string

O status do envolvimento do participante com o evento.

Participou?
attended boolean

O participante compareceu ao evento?

Estado do convite
invitation_status string

O estado do convite ao participante.

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.

Nível de participação
name True string

O nome do nível de participação.

Nota de síntese
summary_note string

Informações de referência rápida fixadas ao registo do participante.

Atualizar uma opção de participante

Atualiza os detalhes sobre uma opção de participante.

Parâmetros

Name Chave Necessário Tipo Description
ID da opção do participante
option_id True string

O ID de registro do sistema da opção de participante a ser atualizada.

Valor
option_value True string

A resposta do participante à opção.

Criar um anexo de evento

Cria um novo anexo de evento.

Parâmetros

Name Chave Necessário Tipo Description
ID do Evento
event_id True string

A ID de registro do sistema do evento.

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

Anexo de evento criado

Criar um evento

Cria um novo evento.

Parâmetros

Name Chave Necessário Tipo Description
Nome do evento
name True string

O nome do evento.

Description
description string

A descrição do evento.

Categoria
name True string

O nome da categoria.

Data de início
start_date True date

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

Hora de início
start_time string

A hora de início do evento (ex: '07:30').

Data de fim
end_date date

A data final do evento (ex: '2020-09-18').

Hora de fim
end_time string

A hora de fim do evento (ex: '07:30)'.

ID de pesquisa
lookup_id string

A ID de pesquisa do evento.

Capacidade
capacity integer

O número de pessoas que podem assistir ao evento.

Objetivo
goal double

O objetivo monetário do evento.

ID da Campanha
campaign_id string

O ID de registo do sistema da campanha associada ao evento.

ID do Fundo
fund_id string

O ID de registo do sistema do fundo associado ao evento.

Inativo?
inactive boolean

O evento está ativo?

Devoluções

Evento criado

Criar um pagamento de taxa de participante

Cria um novo pagamento de taxa para um participante.

Parâmetros

Name Chave Necessário Tipo Description
ID do Participante
participant_id True string

O ID de registo do sistema do participante.

ID de presente
gift_id True string

O ID de registro systetm do presente ao qual a taxa de participante está vinculada.

Montante aplicado
applied_amount True double

O valor do pagamento que se aplica às taxas de participação.

Devoluções

Pagamento da taxa de participante criada

Criar um participante

Cria um novo participante para um evento.

Parâmetros

Name Chave Necessário Tipo Description
ID do Evento
event_id True string

A ID de registro do sistema do evento.

ID do constituinte
constituent_id True string

O ID de constituinte do participante.

ID do anfitrião
host_id string

O ID do registo de participante do anfitrião.

Estado de RSVP
rsvp_status string

O status do envolvimento do participante com o evento.

Participou?
attended boolean

O participante compareceu ao evento?

Estado do convite
invitation_status string

O estado do convite ao participante.

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.

Nível de participação
name True string

O nome do nível de participação.

Nota de síntese
summary_note string

Informações de referência rápida fixadas ao registo do participante.

Devoluções

Participante criado

Criar uma doação de participante

Cria uma nova doação para um participante.

Parâmetros

Name Chave Necessário Tipo Description
ID do Participante
participant_id True string

O ID de registo do sistema do participante.

ID de presente
gift_id True string

O ID de registro systetm do presente ao qual a doação do participante está vinculada.

Devoluções

Criação de doação de participantes

Criar uma opção de participante

Cria uma nova opção de participante para um participante.

Parâmetros

Name Chave Necessário Tipo Description
ID do Participante
participant_id True string

O ID do participante.

body
body True dynamic

Um objeto que representa a opção de participante a ser criada.

Devoluções

Opção de participante criada

Criar uma opção de participante do evento

Cria uma nova opção de participante para um evento.

Parâmetros

Name Chave Necessário Tipo Description
ID do Evento
event_id True string

A ID do evento.

Nome
name True string

O nome da opção de participante do evento.

Tipo de entrada
input_type True string

Os tipos de valores que os participantes podem usar para fornecer respostas.

Permitir seleção múltipla?
multi_select boolean

Permitir mais de um valor para listas?

nome
name string

O nome da opção de lista.

sequência
sequence integer

A sequência baseada em 0 usada para ordenar.

Devoluções

Opção de participante do evento criado

Criar uma taxa de evento

Cria uma nova taxa para um evento.

Parâmetros

Name Chave Necessário Tipo Description
ID do Evento
event_id True string

A ID de registro do sistema do evento.

Nome
name True string

O nome da taxa.

Montante da taxa
cost True double

O montante de dinheiro associado à taxa.

Montante da contribuição
contribution_amount True double

O valor da taxa que é uma doação acima dos custos do evento.

Devoluções

Taxa de evento criada

Criar uma taxa de participante

Cria uma nova taxa para um participante.

Parâmetros

Name Chave Necessário Tipo Description
ID do Participante
participant_id True string

O ID de registo do sistema do participante.

ID do Evento
event_id True string

A ID de registro do sistema do evento.

Taxa
event_fee_id True string

A taxa do evento.

Quantidade
quantity True integer

A quantidade comprada.

Montante da taxa
fee_amount True double

O montante de dinheiro associado à taxa.

Montante da contribuição
contribution_amount True double

O valor da taxa que é uma doação acima dos custos do evento. Este é o valor que normalmente aparece nos recibos.

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

Taxa de participante criada

Listar anexos de eventos

Lista os anexos de um evento.

Parâmetros

Name Chave Necessário Tipo Description
ID do Evento
event_id True string

A ID de registro do sistema do evento.

Devoluções

Attachments

Listar as taxas de participação

Lista as taxas para um participante.

Parâmetros

Name Chave Necessário Tipo Description
ID do Participante
participant_id True string

O ID de registo do sistema do participante.

Limite
limit integer

Representa o número de registros a serem retornados. O padrão é 500. O máximo é 10000.

Compensação
offset integer

Representa o número de registros a serem ignorados. Para utilização com paginação. O padrão é 0.

Devoluções

Taxas

Listar doações de participantes

Lista as doações para um participante.

Parâmetros

Name Chave Necessário Tipo Description
ID do Participante
participant_id True string

O ID de registo do sistema do participante.

Limite
limit integer

Representa o número de registros a serem retornados. O padrão é 500. O máximo é 10000.

Compensação
offset integer

Representa o número de registros a serem ignorados. Para utilização com paginação. O padrão é 0.

Devoluções

Doações

Listar eventos

Retorna uma lista de eventos.

Parâmetros

Name Chave Necessário Tipo Description
Categoria
category string

Filtrar com base na categoria do evento.

ID de pesquisa
lookup_id string

Um filtro para resultados que correspondem ao identificador personalizado para o registro de evento.

Data de início a partir de
start_date_from date

Filtre os resultados para eventos com data de início na data especificada ou após essa data (ex: '2020-09-18').

Data de início para
start_date_to date

Filtre os resultados para eventos com data de início na data especificada ou antes dela (ex: '2020-09-18').

Incluir inativos?
include_inactive boolean

Incluir eventos inativos?

Limite
limit integer

Representa o número de registros a serem retornados. O padrão é 500. O máximo é 10000.

Compensação
offset integer

Representa o número de registros a serem ignorados. Para utilização com paginação.

ID do Evento
event_id string

Filtre os eventos que correspondem à ID de registro do sistema especificada.

Nome
name string

Filtre eventos que correspondam ao nome especificado.

Adicionado em ou após
date_added date-time

Filtre os resultados para eventos criados na data especificada ou após ela (ex: '2020-09-18T04:13:56Z').

Modificado em ou após
last_modified date-time

Filtre os resultados para eventos modificados na ou após a data especificada (ex: '2020-09-18T04:13:56Z').

Devoluções

Events

Listar opções de participantes

Lista as opções de participante para um participante.

Parâmetros

Name Chave Necessário Tipo Description
ID do Participante
participant_id True string

O ID de registo do sistema do participante.

Devoluções

Opções dos participantes

Listar opções de participantes do evento

Lista as opções de participantes para um evento.

Parâmetros

Name Chave Necessário Tipo Description
ID do Evento
event_id True string

A ID do evento.

Devoluções

Opções dos participantes no evento

Listar pagamentos de taxas de participante

Lista os pagamentos de taxas para um participante.

Parâmetros

Name Chave Necessário Tipo Description
ID do Participante
participant_id True string

O ID de registo do sistema do participante.

Limite
limit integer

Representa o número de registros a serem retornados. O padrão é 500. O máximo é 10000.

Compensação
offset integer

Representa o número de registros a serem ignorados. Para utilização com paginação. O padrão é 0.

Devoluções

Pagamento de taxas

Listar participantes do evento

Lista os participantes de um evento.

Parâmetros

Name Chave Necessário Tipo Description
ID do Evento
event_id True string

A ID de registro do sistema do evento.

Estado de RSVP
rsvp_status string

Filtre os participantes com base no status de RSVP.

Estado do convite
invitation_status string

Filtre os participantes com base no status do convite.

Nível de participação
participation_level string

Filtre os participantes com base no nível de envolvimento.

Participou?
attended_filter boolean

Filtro para incluir ou excluir participantes marcados como participantes.

Taxas pagas?
fees_paid_filter boolean

Filtrar para incluir ou excluir participantes que pagaram suas taxas.

Limite
limit integer

Representa o número de registros a serem retornados. O padrão é 500. O máximo é 10000.

Compensação
offset integer

Representa o número de registros a serem ignorados. Para utilização com paginação.

É um constituinte?
is_constituent_filter boolean

Filtro para incluir ou excluir participantes que são constituintes.

Tem um e-mail elegível?
email_eligible_filter boolean

Filtrar para incluir ou excluir participantes com base no fato de eles terem um endereço de e-mail principal que não está marcado como Não enviar e-mail?

Tem um telefone elegível?
phone_call_eligible_filter boolean

Filtre para incluir ou excluir participantes com base no fato de eles terem um número de telefone principal que não esteja marcado como Não ligar.

Nome
name string

Filtro para participantes que correspondem ao nome especificado.

Adicionado em ou após
date_added date-time

Filtre os resultados para participantes criados na ou após a data especificada (ex: '2020-09-18T04:13:56Z').

Modificado em ou após
last_modified date-time

Filtre os resultados para participantes modificados na ou após a data especificada (ex: '2020-09-18T04:13:56Z').

Devoluções

Participants

Listar taxas de eventos

Lista as taxas para um evento.

Parâmetros

Name Chave Necessário Tipo Description
ID do Evento
event_id True string

A ID de registro do sistema do evento.

Devoluções

Taxas

Obter um participante

Retorna informações sobre um participante específico do evento.

Parâmetros

Name Chave Necessário Tipo Description
ID do Participante
participant_id True string

O ID de registo do sistema do participante.

Devoluções

Participante

Receba um evento

Retorna informações sobre um evento.

Parâmetros

Name Chave Necessário Tipo Description
ID do Evento
event_id True string

O ID de registro do sistema do evento a ser obtido.

Devoluções

Event

Definições

EventApi.AdministrativeArea

Define o modelo de dados usado para a área administrativa de um endereço (por exemplo, estado nos EUA).

Name Caminho Tipo Description
ID
id string

O ID de registro da área administrativa.

nome
name string

O nome da área administrativa.

breve descrição
short_description string

A breve descrição da área administrativa.

EventApi.ApiCollectionOfEventFee

Taxas

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 EventApi.EventFee

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

EventApi.ApiCollectionOfEventListEntry

Events

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 EventApi.EventListEntry

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

EventApi.ApiCollectionOfEventParticipantOption

Opções dos participantes no evento

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 EventApi.EventParticipantOption

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

EventApi.ApiCollectionOfParticipantDonation

Doaçõ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 EventApi.ParticipantDonation

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

EventApi.ApiCollectionOfParticipantFee

Taxas

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 EventApi.ParticipantFee

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

EventApi.ApiCollectionOfParticipantFeePayment

Pagamento de taxas

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 EventApi.ParticipantFeePayment

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

EventApi.ApiCollectionOfParticipantListEntry

Participants

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 EventApi.ParticipantListEntry

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

EventApi.ApiCollectionOfParticipantOption

Opções dos participantes

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 EventApi.ParticipantOption

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

EventApi.Country

Define o modelo de dados usado para o país de um endereço.

Name Caminho Tipo Description
ID
id string

O ID do registo do país.

nome a apresentar
display_name string

O nome de exibição do país.

Código ISO
iso_alpha2_code string

O código ISO 3166-1 alpha-2 para o país.

EventApi.CreatedEvent

Evento criado

Name Caminho Tipo Description
ID
id string

A ID do evento recém-criado.

EventApi.CreatedEventAttachment

Anexo de evento criado

Name Caminho Tipo Description
ID
id string

A ID do anexo de evento recém-criado.

EventApi.CreatedEventFee

Taxa de evento criada

Name Caminho Tipo Description
ID
id string

A ID da taxa de evento recém-criada.

EventApi.CreatedEventParticipantOption

Opção de participante do evento criado

Name Caminho Tipo Description
ID
id string

A ID da opção de participante do evento recém-criada.

EventApi.CreatedParticipant

Participante criado

Name Caminho Tipo Description
ID
id string

O ID do participante recém-criado.

EventApi.CreatedParticipantDonation

Criação de doação de participantes

Name Caminho Tipo Description
ID
id string

O ID da doação de participante recém-criada.

EventApi.CreatedParticipantFee

Taxa de participante criada

Name Caminho Tipo Description
ID
id string

O ID da taxa de participante recém-criada.

EventApi.CreatedParticipantFeePayment

Pagamento da taxa de participante criada

Name Caminho Tipo Description
ID
id string

O ID do pagamento da taxa de participante recém-criada.

EventApi.CreatedParticipantOption

Opção de participante criada

Name Caminho Tipo Description
ID
id string

A ID da opção de participante recém-criada.

EventApi.Event

Event

Name Caminho Tipo Description
ID
id string

A ID de registro do sistema do evento. Isso não é o mesmo que o identificador de evento definido pelo usuário, que é armazenado no lookup_id.

Nome
name string

O nome do evento.

Description
description string

A descrição do evento.

Data de início
start_date date

A data de início do evento.

Hora de início
start_time string

A hora de início do evento.

Data de fim
end_date date

A data final do evento.

Hora de fim
end_time string

A hora de término do evento.

Categoria
category EventApi.EventCategory

Categoria de evento é a categorização personalizada para o evento.

ID de pesquisa
lookup_id string

A ID de pesquisa do evento.

Localização
location EventApi.Location

Define o modelo de dados usado para um local.

Capacidade
capacity integer

O número de pessoas que podem assistir ao evento.

Objetivo
goal double

O objetivo monetário do evento.

ID da Campanha
campaign_id string

O ID de registo do sistema da campanha associada ao evento.

ID do Fundo
fund_id string

O ID de registo do sistema do fundo associado ao evento.

Inativo?
inactive boolean

O evento está inativo?

Data de adição
date_added date-time

A data em que o evento foi criado.

Data de modificação
date_modified date-time

A data em que o evento foi modificado pela última vez.

EventApi.EventAttachment

Attachment

Name Caminho Tipo Description
ID
id string

O ID de registro do sistema do anexo.

ID do Evento
parent_id string

A ID de registro do sistema do evento 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.

EventApi.EventAttachmentCollection

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 EventApi.EventAttachment

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

EventApi.EventCategory

Categoria de evento é a categorização personalizada para o evento.

Name Caminho Tipo Description
ID
id string

O ID de registro do sistema da categoria de evento.

nome
name string

O nome da categoria do evento.

inativo?
inactive boolean

Esta categoria está inativa?

EventApi.EventFee

As taxas do evento são o valor que uma organização cobra para que indivíduos ou organizações participem ou participem do evento.

Name Caminho Tipo Description
ID
id string

O ID de registro do sistema da taxa do evento.

nome
name string

O nome da taxa do evento.

Montante
cost double

O custo da taxa.

Montante da contribuição
contribution_amount double

O valor dedutível do imposto para esta taxa.

número vendido
number_sold integer

O número de taxas vendidas.

EventApi.EventListEntry

Event

Name Caminho Tipo Description
ID
id string

A ID de registro do sistema do evento.

Nome
name string

O nome do evento.

Data de início
start_date date

A data de início do evento.

Hora de início
start_time string

A hora de início do evento.

Data de fim
end_date date

A data final do evento.

Hora de fim
end_time string

A hora de término do evento.

Categoria
category EventApi.EventCategory

Categoria de evento é a categorização personalizada para o evento.

ID de pesquisa
lookup_id string

A ID de pesquisa do evento.

Capacidade
capacity integer

O número de pessoas que podem assistir ao evento.

Participação
attending_count integer

O número de participantes do evento que planejam participar.

Presenças
attended_count integer

O número de participantes do evento.

Convidados
invited_count integer

O número de convidados para o evento.

Receitas
revenue double

A receita realizada do evento.

Objetivo
goal double

O objetivo monetário do evento.

Percentagem do objetivo
percent_of_goal integer

A receita realizada como uma porcentagem da receita da meta.

Inativo?
inactive boolean

O evento está inativo?

Data de adição
date_added date-time

A data em que o evento foi criado.

Data de modificação
date_modified date-time

A data em que o evento foi modificado pela última vez.

EventApi.EventParticipantOption

As opções dos participantes do evento são campos que coletam detalhes sobre os participantes, como tamanhos de camisetas, preferências de refeição ou solicitações de assentos. Defina opções e seus valores para um evento e, em seguida, adicione respostas para cada participante.

Name Caminho Tipo Description
ID
id string

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

nome
name string

O nome da opção de participante do evento.

tipo de entrada
input_type string

O tipo de opção de participante do evento.

permitir a seleção múltipla?
multi_select boolean

Permitir mais de um valor para listas?

list_options
list_options array of EventApi.EventParticipantOptionListOption

As opções de lista disponíveis.

adicionado pelo usuário
added_by_user string

A ID do usuário que adicionou a opção.

modificado pelo usuário
updated_by_user string

O ID do usuário que modificou a opção.

adicionado por serviço
added_by_service string

O nome do serviço que adicionou essa opção.

modificado pelo serviço
updated_by_service string

O nome do serviço que modificou essa opção.

data adicionada
date_added date-time

A data em que a opção foi criada.

Data de modificação
date_updated date-time

A data em que a opção foi modificada pela última vez.

versão
version integer

O número da versão da opção.

EventApi.EventParticipantOptionListOption

Uma opção de lista de opções de participante do evento

Name Caminho Tipo Description
ID
id string

O ID da opção de lista

nome
name string

O nome da opção de lista

sequência
sequence integer

A sequência usada para ordenar as opções da lista

EventApi.Locality

Define o modelo de dados usado para a localidade de um endereço.

Name Caminho Tipo Description
ID
id string

A ID do registro do registro de localidade.

nome
name string

O nome da localidade.

EventApi.Location

Define o modelo de dados usado para um local.

Name Caminho Tipo Description
nome
name string

O nome do local.

linhas de endereço
address_lines string

As linhas de endereço do local.

código postal
postal_code string

O código postal do local.

Localidade
locality EventApi.Locality

Define o modelo de dados usado para a localidade de um endereço.

área administrativa
administrative_area EventApi.AdministrativeArea

Define o modelo de dados usado para a área administrativa de um endereço (por exemplo, estado nos EUA).

área subadministrativa
sub_administrative_area EventApi.SubAdministrativeArea

Define o modelo de dados usado para a área subadministrativa de um endereço (por exemplo, cidade nos EUA).

country
country EventApi.Country

Define o modelo de dados usado para o país de um endereço.

Endereço formatado
formatted_address string

O endereço formatado do local

EventApi.Membership

Informações de filiação para o participante.

Name Caminho Tipo Description
Categoria de membro
category EventApi.MembershipCategory

A categoria de membro do indivíduo.

EventApi.MembershipCategory

A categoria de membro do indivíduo.

Name Caminho Tipo Description
ID
id string

O ID de registro do sistema da categoria de associação.

nome
name string

O nome da categoria de associação.

EventApi.Participante

Participante

Name Caminho Tipo Description
ID
id string

O ID de registo do sistema do participante.

ID do constituinte
constituent_id string

O ID de constituinte do participante.

ID do Evento
event_id string

O ID de registro do sistema do evento que está sendo participado.

ID do anfitrião
host_id string

O ID do registo de participante do anfitrião.

Estado de RSVP
rsvp_status string

O status do envolvimento do participante com o evento.

Participou?
attended boolean

O participante compareceu ao evento?

Estado do convite
invitation_status string

O estado do convite ao participante.

day
rsvp_date.d integer

O dia na data difusa.

mês
rsvp_date.m integer

O mês na data difusa.

ano
rsvp_date.y integer

O ano na data difusa.

day
invitation_date.d integer

O dia na data difusa.

mês
invitation_date.m integer

O mês na data difusa.

ano
invitation_date.y integer

O ano na data difusa.

Nota de síntese
summary_note string

Informações de referência rápida fixadas ao registo do participante.

Nível de participação
participation_level EventApi.ParticipationLevel

Os níveis de participação são o nível de envolvimento que os participantes têm num evento.

Data de adição
date_added date-time

A data em que o participante foi criado.

Data de modificação
date_modified date-time

A data em que o participante foi modificado pela última vez.

EventApi.ParticipantDonation

Define um modelo de dados para uma doação de participante

Name Caminho Tipo Description
ID
id string

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

ID do presente
gift_id string

O ID de registro do sistema do presente ao qual a doação do participante está vinculada.

EventApi.ParticipantFee

Define um modelo de dados para uma taxa de participante

Name Caminho Tipo Description
ID
id string

O ID da taxa de participante.

ID do participante
participant_id string

O ID do registo ao qual a taxa de participante está associada.

quantidade
quantity integer

A quantidade comprada.

Montante da taxa
fee_amount double

O valor da taxa de participação.

Montante da contribuição
tax_receiptable_amount double

O valor dedutível do imposto para esta taxa.

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.

Taxa do evento
event_fee EventApi.EventFee

As taxas do evento são o valor que uma organização cobra para que indivíduos ou organizações participem ou participem do evento.

EventApi.ParticipantFeePayment

Define um modelo de dados para o pagamento de uma taxa de participante

Name Caminho Tipo Description
ID
id string

O ID de registo do sistema do pagamento da taxa de participante.

ID do participante
participant_id string

O ID de registo do sistema do participante ao qual o pagamento da taxa de participante está ligado.

ID do presente
gift_id string

O ID de registro do sistema do presente ao qual o pagamento da taxa de participante está vinculado.

Montante aplicado
applied_amount double

O valor aplicado do pagamento da taxa de participante.

EventApi.ParticipantListEntry

Participante

Name Caminho Tipo Description
ID
id string

O ID de registo do sistema do participante.

ID de contato
contact_id string

O ID do contacto que participa no evento.

Estado de RSVP
rsvp_status string

O status do envolvimento do participante com o evento.

Participou?
attended boolean

O participante compareceu ao evento?

Estado do convite
invitation_status string

O estado do convite ao participante.

day
rsvp_date.d integer

O dia na data difusa.

mês
rsvp_date.m integer

O mês na data difusa.

ano
rsvp_date.y integer

O ano na data difusa.

Nível de participação
participation_level EventApi.ParticipationLevel

Os níveis de participação são o nível de envolvimento que os participantes têm num evento.

Title
title string

Título do participante.

Nome próprio
first_name string

Nome próprio do participante.

Apelido
last_name string

Apelido do participante.

Nome
name string

Nome completo do participante.

Nome preferido
preferred_name string

Nome preferido do participante.

Sufixo
suffix string

Sufixo do participante.

ID de pesquisa
lookup_id string

O LookupId do participante.

Email
email string

O endereço de e-mail do participante.

Não envia e-mail?
do_not_email boolean

O participante pode ser contactado através deste endereço de e-mail?

Telemóvel
phone string

O número de telefone do participante.

Não liga?
do_not_call boolean

O participante pode ser contactado através deste número?

Nome do meio
middle_name string

Nome do meio do participante.

Antigo nome
former_name string

O nome anterior do participante.

É um constituinte?
is_constituent boolean

O participante é um constituinte?

Classe de
class_of string

A turma de formandos do participante.

Total das taxas de inscrição
total_registration_fees double

A soma dos valores dos honorários do participante.

Total pago
total_paid double

A soma dos presentes pagos pelo participante com um tipo de Taxas de Inscrição.

Doações
donations double

A soma dos presentes pagos pelo participante com um tipo de doações.

Receitas
revenue double

A soma dos presentes pagos pelo participante em todos os tipos.

Assento
seat string

A atribuição do lugar ao participante.

Tag de nome
name_tag string

A tag de nome do participante

Nota de síntese
summary_note string

Informações de referência rápida fixadas ao registo do participante.

Data de adição
date_added date-time

A data em que o participante foi criado.

Data de modificação
date_modified date-time

A data em que o participante foi modificado pela última vez.

ID de contacto
host.contact_id string

O ID do contacto que participa no evento.

ID do participante
host.participant_id string

O ID do participante.

nome
host.name string

Nome completo do participante.

hóspedes
guests array of EventApi.ParticipantListParticipantSummary

Os convidados do participante.

Associações
memberships array of EventApi.Membership

As informações de filiação para o participante.

EventApi.ParticipantListParticipantSummary

Informações resumidas básicas do participante.

Name Caminho Tipo Description
ID de contacto
contact_id string

O ID do contacto que participa no evento.

ID do participante
participant_id string

O ID do participante.

nome
name string

Nome completo do participante.

EventApi.ParticipantOption

A opção de participante associada a um determinado participante

Name Caminho Tipo Description
ID
id string

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

ID do participante
participant_id string

O ID de registo do sistema do participante.

ID do evento
event_id string

A ID de registro do sistema do evento.

ID da opção do participante do evento
event_participant_option_id string

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

valor
option_value string

A resposta do participante à opção.

adicionado pelo usuário
added_by_user string

A ID do usuário que adicionou a opção de participante.

modificado pelo usuário
updated_by_user string

O ID do usuário que modificou a opção de participante.

adicionado por serviço
added_by_service string

O nome do serviço que adicionou essa opção de participante.

modificado pelo serviço
updated_by_service string

O nome do serviço que modificou essa opção de participante.

data adicionada
date_added date-time

A data em que a opção de participante foi criada.

Data de modificação
date_updated date-time

A data em que a opção do participante foi modificada pela última vez.

EventApi.ParticipationLevel

Os níveis de participação são o nível de envolvimento que os participantes têm num evento.

Name Caminho Tipo Description
ID
id string

O ID de registro do sistema do nível de participação.

nome
name string

O nome do nível de participação.

inativo?
is_inactive boolean

O nível de participação está inativo?

EventApi.SubAdministrativeArea

Define o modelo de dados usado para a área subadministrativa de um endereço (por exemplo, cidade nos EUA).

Name Caminho Tipo Description
ID
id string

O ID da área subadministrativa.

nome
name string

O nome da área subadministrativa.