Compartilhar via


Eventos NXT do Blackbaud Raisers Edge

O Blackbaud Raiser's Edge NXT é uma solução abrangente de software de captação de recursos e gerenciamento de doadores baseada em nuvem criada especificamente para organizações sem fins lucrativos e toda a comunidade de bem social. Use o conector de Eventos para gerenciar eventos e participantes.

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

Service Class Regions
Copilot Studio Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos Standard Todas as regiões dos Aplicativos Lógicos , exceto as seguintes:
     – Regiões do Azure Governamental
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Power Apps Premium Todas as regiões do Power Apps , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Power Automate Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Suporte do Blackbaud
URL https://www.blackbaud.com/support
Email skyapi@blackbaud.com
Metadados do conector
Publicador Blackbaud, Inc.
Site 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 captação de recursos e gerenciamento de doadores baseada em nuvem criada especificamente para organizações sem fins lucrativos e toda a comunidade de bem social.

Esse conector é criado com base na API SKY da Blackbaud e fornece operações para ajudar a gerenciar eventos e entidades relacionadas encontradas no NXT de Borda do Raiser, incluindo:

  • Eventos
  • Participantes
  • Taxas e doações
  • e muito mais...

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

Pré-requisitos

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

Além disso, o administrador da sua organização também deve executar uma ação no nível do 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 instalação inicial .

Como obter credenciais?

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

Problemas e limitações conhecidos

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

Limitações

Nome Chamadas Período de renovação
Chamadas à 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 de 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 doações de participantes

Lista as doações para um participante.

Listar eventos

Retorna uma lista de eventos.

Listar opções de participantes do evento

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

Listar pagamentos de taxa de participante

Lista os pagamentos de taxa para um participante.

Listar participantes do evento

Lista os participantes de um evento.

Listar taxas de evento

Lista as taxas de um evento.

Listar taxas de participantes

Lista as taxas para um participante.

Obter um evento

Retorna informações sobre um evento.

Obter um participante

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

Opções de participante de lista

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

Atualizar um anexo de evento

Atualiza um anexo de evento.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do evento
event_id True string

A ID do registro do sistema do evento.

ID do anexo
attachment_id True string

A ID do 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 (por exemplo: '2020-09-18T04:13:56Z').

URL
url string

A URL do anexo. Isso é necessário para anexos de link e não aplicável a anexos físicos.

Etiquetas
tags array of string

As marcas associadas ao anexo.

Atualizar um evento

Atualiza os detalhes sobre um evento.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do evento
event_id True string

A ID do 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 (por exemplo: '2020-09-18').

Hora de início
start_time string

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

Data de término
end_date date

A data de término do evento (por exemplo: '2020-09-18').

Hora de término
end_time string

A hora de término do evento (ex: '07:30').

ID de pesquisa
lookup_id string

A ID de pesquisa do evento.

Capacity
capacity integer

O número de pessoas que podem participar do evento.

Goal
goal double

A meta monetária do evento.

ID da Campanha
campaign_id string

A ID de registro do sistema da campanha associada ao evento.

ID do fundo
fund_id string

A ID do registro 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

Nome Chave Obrigatório Tipo Description
ID do participante
participant_id True string

A ID do registro do sistema do participante a ser atualizado.

ID do Constituinte
constituent_id string

A ID constituinte do participante.

Host ID
host_id string

A ID do registro de participante do host.

Status do RSVP
rsvp_status string

O status do envolvimento do participante com o evento.

Participou?
attended boolean

O participante participou do evento?

Status do convite
invitation_status string

O status do convite para o participante.

dia
d integer

O dia na data difusa.

month
m integer

O mês na data difusa.

ano
y integer

O ano na data difusa.

dia
d integer

O dia na data difusa.

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

Observação resumida
summary_note string

Informações de referência rápida fixadas no registro do participante.

Atualizar uma opção de participante

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

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da opção de participante
option_id True string

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

Value
option_value True string

A resposta do participante à opção.

Criar um anexo de evento

Cria um novo anexo de evento.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do evento
event_id True string

A ID do registro do sistema do evento.

Tipo
type True string

O tipo de anexo. 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. Anexos de link são links para arquivos como imagens, postagens no 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 (por exemplo: '2020-09-18T04:13:56Z'). Esse campo usa como padrão a data e a hora atuais, se não for fornecido.

URL
url string

A URL do anexo. Isso é necessário para anexos de link e não aplicável a anexos físicos.

Nome do arquivo
file_name string

O nome do arquivo. Limite de caracteres: 36. Somente para anexos físicos.

ID de Arquivo
file_id string

O identificador do arquivo. Limite de caracteres: 36. Somente para anexos físicos.

ID da miniatura
thumbnail_id string

O identificador da miniatura. Limite de caracteres: 36. Somente para anexos físicos.

Etiquetas
tags array of string

As marcas associadas ao anexo.

Retornos

Anexo de evento criado

Criar um evento

Cria um novo evento.

Parâmetros

Nome Chave Obrigató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 (por exemplo: '2020-09-18').

Hora de início
start_time string

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

Data de término
end_date date

A data de término do evento (por exemplo: '2020-09-18').

Hora de término
end_time string

A hora de término do evento (por exemplo: '07:30)'.

ID de pesquisa
lookup_id string

A ID de pesquisa do evento.

Capacity
capacity integer

O número de pessoas que podem participar do evento.

Goal
goal double

A meta monetária do evento.

ID da Campanha
campaign_id string

A ID de registro do sistema da campanha associada ao evento.

ID do fundo
fund_id string

A ID do registro do sistema do fundo associado ao evento.

Inativo?
inactive boolean

O evento está ativo?

Retornos

Evento criado

Criar um pagamento de taxa de participante

Cria um novo pagamento de taxa para um participante.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do participante
participant_id True string

A ID do registro do sistema do participante.

ID do presente
gift_id True string

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

Valor aplicado
applied_amount True double

O valor do pagamento que se aplica às taxas dos participantes.

Retornos

Pagamento de taxa de participante criado

Criar um participante

Cria um novo participante para um evento.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do evento
event_id True string

A ID do registro do sistema do evento.

ID do Constituinte
constituent_id True string

A ID constituinte do participante.

Host ID
host_id string

A ID do registro de participante do host.

Status do RSVP
rsvp_status string

O status do envolvimento do participante com o evento.

Participou?
attended boolean

O participante participou do evento?

Status do convite
invitation_status string

O status do convite para o participante.

dia
d integer

O dia na data difusa.

month
m integer

O mês na data difusa.

ano
y integer

O ano na data difusa.

dia
d integer

O dia na data difusa.

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

Observação resumida
summary_note string

Informações de referência rápida fixadas no registro do participante.

Retornos

Participante criado

Criar uma doação de participante

Cria uma nova doação para um participante.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do participante
participant_id True string

A ID do registro do sistema do participante.

ID do presente
gift_id True string

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

Retornos

Doação de participante criada

Criar uma opção de participante

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

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do participante
participant_id True string

A ID do participante.

body
body True dynamic

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

Retornos

Opção de participante criado

Criar uma opção de participante de evento

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

Parâmetros

Nome Chave Obrigató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 ordenação.

Retornos

Opção de participante de evento criado

Criar uma taxa de evento

Cria uma nova taxa para um evento.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do evento
event_id True string

A ID do registro do sistema do evento.

Nome
name True string

O nome da taxa.

Valor da taxa
cost True double

A quantidade de dinheiro associada à taxa.

Valor da contribuição
contribution_amount True double

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

Retornos

Taxa de evento criada

Criar uma taxa de participante

Cria uma nova taxa para um participante.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do participante
participant_id True string

A ID do registro do sistema do participante.

ID do evento
event_id True string

A ID do registro do sistema do evento.

Taxa
event_fee_id True string

O valor do evento.

Quantidade
quantity True integer

A quantidade comprada.

Valor da taxa
fee_amount True double

A quantidade de dinheiro associada à taxa.

Valor da contribuição
contribution_amount True double

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

dia
d integer

O dia na data difusa.

month
m integer

O mês na data difusa.

ano
y integer

O ano na data difusa.

Retornos

Taxa de participante criada

Listar anexos de eventos

Lista os anexos de um evento.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do evento
event_id True string

A ID do registro do sistema do evento.

Retornos

Attachments

Listar doações de participantes

Lista as doações para um participante.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do participante
participant_id True string

A ID do registro do sistema do participante.

Limit
limit integer

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

Offset
offset integer

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

Retornos

Doações

Listar eventos

Retorna uma lista de eventos.

Parâmetros

Nome Chave Obrigatório Tipo Description
Categoria
category string

Filtrar com base na categoria de 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 ativada ou após a data especificada (por exemplo: '2020-09-18').

Data de início para
start_date_to date

Filtre os resultados para eventos com data de início em ou antes da data especificada (por exemplo: '2020-09-18').

Incluir inativo?
include_inactive boolean

Incluir eventos inativos?

Limit
limit integer

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

Offset
offset integer

Representa o número de registros a serem ignoradas. Para uso com paginação.

ID do evento
event_id string

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

Nome
name string

Filtro para eventos que correspondem ao nome especificado.

Adicionado em ou após
date_added date-time

Filtre os resultados para eventos criados em ou após a data especificada (por exemplo: '2020-09-18T04:13:56Z').

Modificado em ou após
last_modified date-time

Filtre os resultados para eventos modificados na data especificada (por exemplo: '2020-09-18T04:13:56Z').

Retornos

Eventos

Listar opções de participantes do evento

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

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do evento
event_id True string

A ID do evento.

Retornos

Opções do participante do evento

Listar pagamentos de taxa de participante

Lista os pagamentos de taxa para um participante.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do participante
participant_id True string

A ID do registro do sistema do participante.

Limit
limit integer

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

Offset
offset integer

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

Retornos

Pagamentos de taxas

Listar participantes do evento

Lista os participantes de um evento.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do evento
event_id True string

A ID do registro do sistema do evento.

Status do RSVP
rsvp_status string

Filtrar participantes com base no status RSVP.

Status do convite
invitation_status string

Filtrar participantes com base no status do convite.

Nível de participação
participation_level string

Filtrar participantes com base no nível de envolvimento.

Participou?
attended_filter boolean

Filtrar para incluir ou excluir participantes marcados como atendidos.

Taxas pagas?
fees_paid_filter boolean

Filtrar para incluir ou excluir participantes que pagaram suas taxas.

Limit
limit integer

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

Offset
offset integer

Representa o número de registros a serem ignoradas. Para uso com paginação.

É um constituinte?
is_constituent_filter boolean

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

Tem um email qualificado?
email_eligible_filter boolean

Filtrar para incluir ou excluir participantes com base em se eles têm um endereço de email primário que não está marcado Não enviar email?

Tem um telefone qualificado?
phone_call_eligible_filter boolean

Filtrar para incluir ou excluir participantes com base em se eles têm um número de telefone primário que não está marcado Não ligue.

Nome
name string

Filtro para participantes que correspondem ao nome especificado.

Adicionado em ou após
date_added date-time

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

Modificado em ou após
last_modified date-time

Filtre os resultados para os participantes modificados na data especificada (por exemplo: '2020-09-18T04:13:56Z').

Retornos

Participantes

Listar taxas de evento

Lista as taxas de um evento.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do evento
event_id True string

A ID do registro do sistema do evento.

Retornos

Taxas

Listar taxas de participantes

Lista as taxas para um participante.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do participante
participant_id True string

A ID do registro do sistema do participante.

Limit
limit integer

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

Offset
offset integer

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

Retornos

Taxas

Obter um evento

Retorna informações sobre um evento.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do evento
event_id True string

A ID do registro do sistema do evento a ser obtido.

Retornos

Event

Obter um participante

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

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do participante
participant_id True string

A ID do registro do sistema do participante.

Retornos

Participante

Opções de participante de lista

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

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do participante
participant_id True string

A ID do registro do sistema do participante.

Retornos

Opções de participante

Definições

EventApi.AdministrativeArea

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

Nome Caminho Tipo Description
ID
id string

A ID do registro da área administrativa.

nome
name string

O nome da área administrativa.

descrição curta
short_description string

A breve descrição da área administrativa.

EventApi.ApiCollectionOfEventFee

Taxas

Nome Caminho Tipo Description
Contagem
count integer

O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. Os parâmetros de limite e deslocamento não afetam a contagem, mas, para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados do valor.

value
value array of EventApi.EventFee

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

EventApi.ApiCollectionOfEventListEntry

Eventos

Nome Caminho Tipo Description
Contagem
count integer

O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. Os parâmetros de limite e deslocamento não afetam a contagem, mas, para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados do valor.

value
value array of EventApi.EventListEntry

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

EventApi.ApiCollectionOfEventParticipantOption

Opções do participante do evento

Nome Caminho Tipo Description
Contagem
count integer

O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. Os parâmetros de limite e deslocamento não afetam a contagem, mas, para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados do valor.

value
value array of EventApi.EventParticipantOption

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

EventApi.ApiCollectionOfParticipantDonation

Doações

Nome Caminho Tipo Description
Contagem
count integer

O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. Os parâmetros de limite e deslocamento não afetam a contagem, mas, para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados do valor.

value
value array of EventApi.ParticipantDonation

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

EventApi.ApiCollectionOfParticipantFee

Taxas

Nome Caminho Tipo Description
Contagem
count integer

O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. Os parâmetros de limite e deslocamento não afetam a contagem, mas, para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados do valor.

value
value array of EventApi.ParticipantFee

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

EventApi.ApiCollectionOfParticipantFeePayment

Pagamentos de taxas

Nome Caminho Tipo Description
Contagem
count integer

O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. Os parâmetros de limite e deslocamento não afetam a contagem, mas, para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados do valor.

value
value array of EventApi.ParticipantFeePayment

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

EventApi.ApiCollectionOfParticipantListEntry

Participantes

Nome Caminho Tipo Description
Contagem
count integer

O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. Os parâmetros de limite e deslocamento não afetam a contagem, mas, para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados do valor.

value
value array of EventApi.ParticipantListEntry

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

EventApi.ApiCollectionOfParticipantOption

Opções de participante

Nome Caminho Tipo Description
Contagem
count integer

O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. Os parâmetros de limite e deslocamento não afetam a contagem, mas, para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados do valor.

value
value array of EventApi.ParticipantOption

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

EventApi.Country

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

Nome Caminho Tipo Description
ID
id string

A ID do registro do país.

nome de exibição
display_name string

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

Código ISO
iso_alpha2_code string

O código iso 3166-1 alfa-2 para o país.

EventApi.CreatedEvent

Evento criado

Nome Caminho Tipo Description
ID
id string

A ID do evento recém-criado.

EventApi.CreatedEventAttachment

Anexo de evento criado

Nome Caminho Tipo Description
ID
id string

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

EventApi.CreatedEventFee

Taxa de evento criada

Nome Caminho Tipo Description
ID
id string

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

EventApi.CreatedEventParticipantOption

Opção de participante de evento criado

Nome Caminho Tipo Description
ID
id string

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

EventApi.CreatedParticipant

Participante criado

Nome Caminho Tipo Description
ID
id string

A ID do participante recém-criado.

EventApi.CreatedParticipantDonation

Doação de participante criada

Nome Caminho Tipo Description
ID
id string

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

EventApi.CreatedParticipantFee

Taxa de participante criada

Nome Caminho Tipo Description
ID
id string

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

EventApi.CreatedParticipantFeePayment

Pagamento de taxa de participante criado

Nome Caminho Tipo Description
ID
id string

A ID do pagamento de taxa do participante recém-criado.

EventApi.CreatedParticipantOption

Opção de participante criado

Nome Caminho Tipo Description
ID
id string

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

EventApi.Event

Event

Nome Caminho Tipo Description
ID
id string

A ID do registro do sistema do evento. Isso não é o mesmo que o identificador de evento definível 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 término
end_date date

A data de término do evento.

Hora de término
end_time string

A hora de término do evento.

Categoria
category EventApi.EventCategory

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

Capacity
capacity integer

O número de pessoas que podem participar do evento.

Goal
goal double

A meta monetária do evento.

ID da Campanha
campaign_id string

A ID de registro do sistema da campanha associada ao evento.

ID do fundo
fund_id string

A ID do registro do sistema do fundo associado ao evento.

Inativo?
inactive boolean

O evento está inativo?

Data de inclusão
date_added date-time

A data em que o evento foi criado.

Data modificada
date_modified date-time

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

EventApi.EventAttachment

Anexo

Nome Caminho Tipo Description
ID
id string

A ID do registro do sistema do anexo.

ID do evento
parent_id string

A ID do registro do sistema do evento associado ao anexo.

Tipo
type string

O tipo de anexo. 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. Anexos de link são links para arquivos como imagens, postagens no 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

A URL do anexo. Isso é necessário para anexos de link e não aplicável a anexos físicos.

Nome do arquivo
file_name string

O nome do arquivo. Limite de caracteres: 36. Somente para anexos físicos.

ID de Arquivo
file_id string

O identificador do arquivo. Limite de caracteres: 36. Somente para anexos físicos.

ID da miniatura
thumbnail_id string

O identificador da miniatura. Limite de caracteres: 36. Somente para anexos físicos.

URL de miniatura
thumbnail_url string

A URL de uma miniatura. Para anexos físicos que são somente imagens. Contém uma assinatura associada ao tempo que limita o acesso a 60 minutos.

Tipo de conteúdo
content_type string

O tipo de conteúdo. Somente para anexos físicos.

Tamanho do arquivo
file_size integer

O tamanho do arquivo em bytes. Somente para anexos físicos.

Etiquetas
tags array of string

As marcas associadas ao anexo.

EventApi.EventAttachmentCollection

Attachments

Nome Caminho Tipo Description
Contagem
count integer

O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. Os parâmetros de limite e deslocamento não afetam a contagem, mas, para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados do valor.

value
value array of EventApi.EventAttachment

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

EventApi.EventCategory

A categoria de evento é a categorização personalizada para o evento.

Nome Caminho Tipo Description
ID
id string

A ID do registro do sistema da categoria de evento.

nome
name string

O nome da categoria do evento.

inativo?
inactive boolean

Essa categoria está inativa?

EventApi.EventFee

As taxas de evento são o quanto uma organização cobra para que pessoas ou organizações participem ou participem do evento.

Nome Caminho Tipo Description
ID
id string

A ID do registro do sistema da taxa de evento.

nome
name string

O nome da taxa de evento.

quantidade
cost double

O custo da taxa.

valor da contribuição
contribution_amount double

O valor dedutível de impostos para essa taxa.

número vendido
number_sold integer

O número de taxas vendidas.

EventApi.EventListEntry

Event

Nome Caminho Tipo Description
ID
id string

A ID do 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 término
end_date date

A data de término do evento.

Hora de término
end_time string

A hora de término do evento.

Categoria
category EventApi.EventCategory

A categoria de evento é a categorização personalizada para o evento.

ID de pesquisa
lookup_id string

A ID de pesquisa do evento.

Capacity
capacity integer

O número de pessoas que podem participar do evento.

Atender
attending_count integer

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

Assistido
attended_count integer

O número de participantes do evento.

Convidado
invited_count integer

O número de convites de evento.

Receita
revenue double

A receita obtida do evento.

Goal
goal double

A meta monetária do evento.

Porcentagem da meta
percent_of_goal integer

A receita realizada como um percentual da receita da meta.

Inativo?
inactive boolean

O evento está inativo?

Data de inclusão
date_added date-time

A data em que o evento foi criado.

Data modificada
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 camiseta, preferências de refeição ou solicitações de assentos. Defina opções e seus valores para um evento e adicione respostas para cada participante.

Nome Caminho Tipo Description
ID
id string

A ID do 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 da opção de participante do evento.

permitir 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

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

adicionado pelo serviço
added_by_service string

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

modificado por 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 modificada
date_updated date-time

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

versão
version integer

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

EventApi.EventParticipantOptionListOption

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

Nome Caminho Tipo Description
ID
id string

A 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 de lista

EventApi.Locality

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

Nome Caminho Tipo Description
ID
id string

A ID de registro do registro de localidade.

nome
name string

O nome da localidade.

EventApi.Location

Define o modelo de dados usado para um local.

Nome 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 sub-administrativa
sub_administrative_area EventApi.SubAdministrativeArea

Define o modelo de dados usado para a área sub-administrativa de um endereço (por exemplo: cidade nos EUA).

country
country EventApi.Country

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

endereço formatado
formatted_address string

O endereço formatado do local

EventApi.Membership

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

Nome Caminho Tipo Description
Categoria de associação
category EventApi.MembershipCategory

A categoria de associação do indivíduo.

EventApi.MembershipCategory

A categoria de associação do indivíduo.

Nome Caminho Tipo Description
ID
id string

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

nome
name string

O nome da categoria de associação.

EventApi.Participant

Participante

Nome Caminho Tipo Description
ID
id string

A ID do registro do sistema do participante.

ID do Constituinte
constituent_id string

A ID constituinte do participante.

ID do evento
event_id string

A ID de registro do sistema do evento que está sendo assistido.

Host ID
host_id string

A ID do registro de participante do host.

Status do RSVP
rsvp_status string

O status do envolvimento do participante com o evento.

Participou?
attended boolean

O participante participou do evento?

Status do convite
invitation_status string

O status do convite para o participante.

dia
rsvp_date.d integer

O dia na data difusa.

month
rsvp_date.m integer

O mês na data difusa.

ano
rsvp_date.y integer

O ano na data difusa.

dia
invitation_date.d integer

O dia na data difusa.

month
invitation_date.m integer

O mês na data difusa.

ano
invitation_date.y integer

O ano na data difusa.

Observação resumida
summary_note string

Informações de referência rápida fixadas no registro 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 em um evento.

Data de inclusão
date_added date-time

A data em que o participante foi criado.

Data modificada
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

Nome Caminho Tipo Description
ID
id string

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

ID do presente
gift_id string

A ID do 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

Nome Caminho Tipo Description
ID
id string

A ID do valor do participante.

ID do participante
participant_id string

A ID do registro ao qual a taxa do participante está vinculada.

quantidade
quantity integer

A quantidade comprada.

valor da taxa
fee_amount double

O valor da taxa do participante.

valor da contribuição
tax_receiptable_amount double

O valor dedutível de impostos para essa taxa.

dia
date.d integer

O dia na data difusa.

month
date.m integer

O mês na data difusa.

ano
date.y integer

O ano na data difusa.

Taxa de evento
event_fee EventApi.EventFee

As taxas de evento são o quanto uma organização cobra para que pessoas ou organizações participem ou participem do evento.

EventApi.ParticipantFeePayment

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

Nome Caminho Tipo Description
ID
id string

A ID do registro do sistema do pagamento da taxa do participante.

ID do participante
participant_id string

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

ID do presente
gift_id string

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

valor aplicado
applied_amount double

O valor aplicado do pagamento da taxa do participante.

EventApi.ParticipantListEntry

Participante

Nome Caminho Tipo Description
ID
id string

A ID do registro do sistema do participante.

ID de contato
contact_id string

A ID do contato que participa do evento.

Status do RSVP
rsvp_status string

O status do envolvimento do participante com o evento.

Participou?
attended boolean

O participante participou do evento?

Status do convite
invitation_status string

O status do convite para o participante.

dia
rsvp_date.d integer

O dia na data difusa.

month
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 em um evento.

Title
title string

O título do participante.

Nome
first_name string

O nome do participante.

Sobrenome
last_name string

O sobrenome do participante.

Nome
name string

O nome completo do participante.

Nome preferencial
preferred_name string

O nome preferencial do participante.

Sufixo
suffix string

O sufixo do participante.

ID de pesquisa
lookup_id string

A LookupId do participante.

Email
email string

O endereço de email do participante.

Não enviar email?
do_not_email boolean

O participante pode ser contatado neste endereço de email?

Telefone
phone string

O número de telefone do participante.

Não ligar?
do_not_call boolean

O participante pode ser contatado com esse número?

Nome do meio
middle_name string

O nome do meio do participante.

Nome antigo
former_name string

O nome antigo do participante.

É um constituinte?
is_constituent boolean

O participante é um constituinte?

Classe de
class_of string

A turma de graduação do participante.

Taxas totais de registro
total_registration_fees double

A soma dos valores de taxa do participante.

Total pago
total_paid double

A soma dos presentes pagos do participante com um tipo de Taxas de Registro.

Doações
donations double

A soma dos presentes pagos do participante com um tipo de Doações.

Receita
revenue double

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

Assento
seat string

A atribuição de assento para o participante.

Marca de nome
name_tag string

A marca de nome do participante

Observação resumida
summary_note string

Informações de referência rápida fixadas no registro do participante.

Data de inclusão
date_added date-time

A data em que o participante foi criado.

Data modificada
date_modified date-time

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

ID de contato
host.contact_id string

A ID do contato que participa do evento.

ID do participante
host.participant_id string

A ID do participante.

nome
host.name string

O nome completo do participante.

Os hóspedes
guests array of EventApi.ParticipantListParticipantSummary

Os convidados do participante.

Associações
memberships array of EventApi.Membership

As informações de associação do participante.

EventApi.ParticipantListParticipantSummary

As informações de resumo básicas do participante.

Nome Caminho Tipo Description
ID de contato
contact_id string

A ID do contato que participa do evento.

ID do participante
participant_id string

A ID do participante.

nome
name string

O nome completo do participante.

EventApi.ParticipantOption

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

Nome Caminho Tipo Description
ID
id string

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

ID do participante
participant_id string

A ID do registro do sistema do participante.

ID do evento
event_id string

A ID do registro do sistema do evento.

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

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

value
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

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

adicionado pelo serviço
added_by_service string

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

modificado por 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 participante foi criada.

data modificada
date_updated date-time

A data em que a opção 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 em um evento.

Nome Caminho Tipo Description
ID
id string

A ID do 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 sub-administrativa de um endereço (por exemplo: cidade nos EUA).

Nome Caminho Tipo Description
ID
id string

A ID da área sub-administrativa.

nome
name string

O nome da área sub-administrativa.