Partager via


Événements NXT de Blackbaud Raisers Edge

Blackbaud Raiser’s Edge NXT est une solution logicielle complète de collecte de fonds et de gestion des donateurs basée sur le cloud conçue spécifiquement pour les organisations à but non lucratif et l’ensemble de la bonne communauté sociale. Utilisez le connecteur Événements pour gérer les événements et les participants.

Ce connecteur est disponible dans les produits et régions suivants :

Service classe Régions
Copilot Studio Premium Toutes les régions Power Automate , à l’exception des éléments suivants :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Applications logiques Norme Toutes les régions Logic Apps , à l’exception des suivantes :
     - Régions Azure Government
     - Régions Azure Chine
     - Us Department of Defense (DoD)
Power Apps Premium Toutes les régions Power Apps , à l’exception des suivantes :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Power Automate Premium Toutes les régions Power Automate , à l’exception des éléments suivants :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Contact
Nom Prise en charge de Blackbaud
URL https://www.blackbaud.com/support
Messagerie électronique skyapi@blackbaud.com
Métadonnées du connecteur
Éditeur Blackbaud, Inc.
Site internet https://www.blackbaud.com/products/blackbaud-raisers-edge-nxt
Politique de confidentialité https://www.blackbaud.com/privacy-shield
Catégories Ventes et CRM ; Productivité

Raiser’s Edge NXT est une solution complète de collecte de fonds et de gestion des donateurs basée sur le cloud conçue spécifiquement pour les organisations à but non lucratif et l’ensemble de la bonne communauté sociale.

Ce connecteur repose sur l’API SKY de Blackbaud et fournit des opérations pour gérer les événements et les entités associées trouvées dans le NXT edge de The Raiser, notamment :

  • Événements
  • Participants
  • Frais et dons
  • et bien plus encore...

Pour plus d’informations, consultez la documentation.

Prerequisites

Pour utiliser ce connecteur, vous devez disposer d’un compte Blackbaud ID avec accès à un ou plusieurs environnements Blackbaud.

En outre, l’administrateur de votre organisation doit également effectuer une action au niveau de l’administrateur au sein du système pour permettre à ce connecteur d’accéder à votre environnement Blackbaud. Vous trouverez plus d’informations sur ces prérequis dans la documentation de configuration initiale .

Comment obtenir des informations d’identification ?

L’administrateur de votre organisation vous enverra une invitation à l’environnement Edge NXT de l’organisation de l’organisation et configurera les autorisations de votre compte d’utilisateur dans l’environnement. Aucune information d’identification supplémentaire n’est requise pour utiliser ce connecteur.

Problèmes connus et limitations

Le connecteur fonctionne dans le contexte de votre compte d’utilisateur et sera donc soumis à vos autorisations utilisateur dans l’environnement.

Limitations

Nom Appels Période de renouvellement
Appels d’API par connexion 100 60 secondes

Actions

Créer des frais de participant

Crée un frais pour un participant.

Créer des frais d’événement

Crée un frais pour un événement.

Créer un don de participant

Crée un don pour un participant.

Créer un paiement des frais de participant

Crée un paiement de frais pour un participant.

Créer un participant

Crée un participant pour un événement.

Créer un événement

Crée un événement.

Créer une option de participant

Crée une option de participant pour un participant.

Créer une option de participant à un événement

Crée une option de participant pour un événement.

Créer une pièce jointe d’événement

Crée une pièce jointe d’événement.

Mettre à jour un participant

Met à jour les détails d’un participant.

Mettre à jour un événement

Met à jour les détails d’un événement.

Mettre à jour une option de participant

Met à jour les détails d’une option de participant.

Mettre à jour une pièce jointe d’événement

Met à jour une pièce jointe d’événement.

Obtenir un participant

Retourne des informations sur un participant à un événement spécifique.

Obtenir un événement

Retourne des informations sur un événement.

Répertorier des événements

Retourne une liste d’événements.

Répertorier les dons des participants

Répertorie les dons d’un participant.

Répertorier les frais des participants

Répertorie les frais d’un participant.

Répertorier les frais d’événement

Répertorie les frais d’un événement.

Répertorier les options des participants

Répertorie les options de participant pour un participant.

Répertorier les options des participants aux événements

Répertorie les options de participant pour un événement.

Répertorier les paiements des frais de participant

Répertorie les paiements de frais pour un participant.

Répertorier les participants à l’événement

Répertorie les participants pour un événement.

Répertorier les pièces jointes d’événements

Répertorie les pièces jointes d’un événement.

Créer des frais de participant

Crée un frais pour un participant.

Paramètres

Nom Clé Obligatoire Type Description
Identifiant du participant
participant_id True string

ID d’enregistrement système du participant.

ID de l’événement
event_id True string

ID d’enregistrement système de l’événement.

Frais
event_fee_id True string

Frais d’événement.

Quantité
quantity True integer

Quantité achetée.

Montant des frais
fee_amount True double

Montant de l’argent associé aux frais.

Montant de la contribution
contribution_amount True double

Montant des frais d’un don au-dessus des coûts de l’événement. Il s’agit du montant qui apparaît généralement sur les reçus.

jour
d integer

Jour de la date floue.

month
m integer

Mois à la date approximative.

année
y integer

L’année dans la date approximative.

Retours

Frais de participant créés

Créer des frais d’événement

Crée un frais pour un événement.

Paramètres

Nom Clé Obligatoire Type Description
ID de l’événement
event_id True string

ID d’enregistrement système de l’événement.

Nom
name True string

Nom des frais.

Montant des frais
cost True double

Montant de l’argent associé aux frais.

Montant de la contribution
contribution_amount True double

Montant des frais d’un don au-dessus des coûts de l’événement.

Retours

Frais d’événement créés

Créer un don de participant

Crée un don pour un participant.

Paramètres

Nom Clé Obligatoire Type Description
Identifiant du participant
participant_id True string

ID d’enregistrement système du participant.

ID cadeau
gift_id True string

ID d’enregistrement systetm du cadeau auquel le don du participant est lié.

Retours

Don de participant créé

Créer un paiement des frais de participant

Crée un paiement de frais pour un participant.

Paramètres

Nom Clé Obligatoire Type Description
Identifiant du participant
participant_id True string

ID d’enregistrement système du participant.

ID cadeau
gift_id True string

ID d’enregistrement systetm du cadeau auquel les frais de participant sont liés.

Quantité appliquée
applied_amount True double

Montant du paiement qui s’applique aux frais des participants.

Retours

Paiement des frais de participant créés

Créer un participant

Crée un participant pour un événement.

Paramètres

Nom Clé Obligatoire Type Description
ID de l’événement
event_id True string

ID d’enregistrement système de l’événement.

ID constituant
constituent_id True string

ID constituant du participant.

ID d’hôte
host_id string

ID de l’enregistrement du participant de l’hôte.

État du RSVP
rsvp_status string

État de l’engagement du participant avec l’événement.

Assisté?
attended boolean

Le participant a-t-il participé à l’événement ?

Statut de l’invitation
invitation_status string

État de l’invitation au participant.

jour
d integer

Jour de la date floue.

month
m integer

Mois à la date approximative.

année
y integer

L’année dans la date approximative.

jour
d integer

Jour de la date floue.

month
m integer

Mois à la date approximative.

année
y integer

L’année dans la date approximative.

Niveau de participation
name True string

Nom du niveau de participation.

Note récapitulative
summary_note string

Informations de référence rapides épinglées à l’enregistrement du participant.

Retours

Participant créé

Créer un événement

Crée un événement.

Paramètres

Nom Clé Obligatoire Type Description
Nom de l’événement
name True string

Nom de l’événement.

Descriptif
description string

Description de l’événement.

Catégorie
name True string

Nom de la catégorie.

Date de début
start_date True date

Date de début de l’événement (par exemple : « 2020-09-18 »).

Heure de début
start_time string

Heure de début de l’événement (par exemple : '07:30').

Date de fin
end_date date

Date de fin de l’événement (par exemple : « 2020-09-18 »).

Heure de fin
end_time string

Heure de fin de l’événement (par exemple : '07:30)'.

ID de recherche
lookup_id string

ID de recherche de l’événement.

Capacity
capacity integer

Nombre de personnes qui peuvent assister à l’événement.

Objectif
goal double

Objectif monétaire de l’événement.

ID de campagne
campaign_id string

ID d’enregistrement système de la campagne associée à l’événement.

ID du fonds
fund_id string

ID d’enregistrement système du fonds associé à l’événement.

Inactif?
inactive boolean

L’événement est-il actif ?

Retours

Événement créé

Créer une option de participant

Crée une option de participant pour un participant.

Paramètres

Nom Clé Obligatoire Type Description
Identifiant du participant
participant_id True string

ID du participant.

body
body True dynamic

Objet qui représente l’option participant à créer.

Retours

Option de participant créé

Créer une option de participant à un événement

Crée une option de participant pour un événement.

Paramètres

Nom Clé Obligatoire Type Description
ID de l’événement
event_id True string

ID de l'événement.

Nom
name True string

Nom de l’option participant à l’événement.

Type d’entrée
input_type True string

Les types de valeurs que les participants peuvent utiliser pour fournir des réponses.

Autoriser la sélection multiple ?
multi_select boolean

Autoriser plusieurs valeurs pour les listes ?

nom
name string

Nom de l’option de liste.

Séquence
sequence integer

Séquence basée sur 0 utilisée pour l’ordre.

Retours

Option de participant à l’événement créé

Créer une pièce jointe d’événement

Crée une pièce jointe d’événement.

Paramètres

Nom Clé Obligatoire Type Description
ID de l’événement
event_id True string

ID d’enregistrement système de l’événement.

Type
type True string

Type de pièce jointe. Les pièces jointes physiques sont des fichiers chargés tels que des images, des fichiers PDF ou des documents Word enregistrés localement ou sur le réseau. Ils sont stockés et gérés dans le système. Les pièces jointes de liens sont des liens vers des fichiers tels que des images, des billets de blog ou des vidéos YouTube en ligne ou dans un compte de stockage cloud. Ils sont stockés et gérés en externe.

Nom
name string

Nom de fichier de la pièce jointe Limite de caractères : 150.

Date
date date-time

Date de la pièce jointe (par exemple : '2020-09-18T04:13:56Z'). Ce champ est défini par défaut sur la date et l’heure actuelles s’il n’est pas fourni.

URL
url string

URL de la pièce jointe. Cela est requis pour les pièces jointes de lien et non applicables aux pièces jointes physiques.

Nom de fichier
file_name string

Le nom du fichier. Limite de caractères : 36. Pour les pièces jointes physiques uniquement.

ID de fichier
file_id string

L’identificateur du fichier. Limite de caractères : 36. Pour les pièces jointes physiques uniquement.

ID de miniature
thumbnail_id string

Identificateur de la miniature. Limite de caractères : 36. Pour les pièces jointes physiques uniquement.

Étiquettes
tags array of string

Balises associées à la pièce jointe.

Retours

Pièce jointe d’événement créée

Mettre à jour un participant

Met à jour les détails d’un participant.

Paramètres

Nom Clé Obligatoire Type Description
Identifiant du participant
participant_id True string

ID d’enregistrement système du participant à mettre à jour.

ID constituant
constituent_id string

ID constituant du participant.

ID d’hôte
host_id string

ID de l’enregistrement du participant de l’hôte.

État du RSVP
rsvp_status string

État de l’engagement du participant avec l’événement.

Assisté?
attended boolean

Le participant a-t-il participé à l’événement ?

Statut de l’invitation
invitation_status string

État de l’invitation au participant.

jour
d integer

Jour de la date floue.

month
m integer

Mois à la date approximative.

année
y integer

L’année dans la date approximative.

jour
d integer

Jour de la date floue.

month
m integer

Mois à la date approximative.

année
y integer

L’année dans la date approximative.

Niveau de participation
name True string

Nom du niveau de participation.

Note récapitulative
summary_note string

Informations de référence rapides épinglées à l’enregistrement du participant.

Mettre à jour un événement

Met à jour les détails d’un événement.

Paramètres

Nom Clé Obligatoire Type Description
ID de l’événement
event_id True string

ID d’enregistrement système de l’événement à mettre à jour.

Nom de l’événement
name string

Nom de l’événement.

Descriptif
description string

Description de l’événement.

Catégorie
name True string

Nom de la catégorie.

Date de début
start_date date

Date de début de l’événement (par exemple : « 2020-09-18 »).

Heure de début
start_time string

Heure de début de l’événement (par exemple : '07:30').

Date de fin
end_date date

Date de fin de l’événement (par exemple : « 2020-09-18 »).

Heure de fin
end_time string

Heure de fin de l’événement (par exemple : '07:30').

ID de recherche
lookup_id string

ID de recherche de l’événement.

Capacity
capacity integer

Nombre de personnes qui peuvent assister à l’événement.

Objectif
goal double

Objectif monétaire de l’événement.

ID de campagne
campaign_id string

ID d’enregistrement système de la campagne associée à l’événement.

ID du fonds
fund_id string

ID d’enregistrement système du fonds associé à l’événement.

Inactif?
inactive boolean

L’événement est-il actif ?

Mettre à jour une option de participant

Met à jour les détails d’une option de participant.

Paramètres

Nom Clé Obligatoire Type Description
ID d’option participant
option_id True string

ID d’enregistrement système de l’option participant à mettre à jour.

Valeur
option_value True string

Réponse du participant à l’option.

Mettre à jour une pièce jointe d’événement

Met à jour une pièce jointe d’événement.

Paramètres

Nom Clé Obligatoire Type Description
ID de l’événement
event_id True string

ID d’enregistrement système de l’événement.

ID de pièce jointe
attachment_id True string

ID d’enregistrement système de la pièce jointe à mettre à jour.

Nom
name string

Nom de fichier de la pièce jointe Limite de caractères : 150.

Date
date date-time

Date de la pièce jointe (par exemple : '2020-09-18T04:13:56Z').

URL
url string

URL de la pièce jointe. Cela est requis pour les pièces jointes de lien et non applicables aux pièces jointes physiques.

Étiquettes
tags array of string

Balises associées à la pièce jointe.

Obtenir un participant

Retourne des informations sur un participant à un événement spécifique.

Paramètres

Nom Clé Obligatoire Type Description
Identifiant du participant
participant_id True string

ID d’enregistrement système du participant.

Retours

Participant

Obtenir un événement

Retourne des informations sur un événement.

Paramètres

Nom Clé Obligatoire Type Description
ID de l’événement
event_id True string

ID d’enregistrement système de l’événement à obtenir.

Retours

Événement

Répertorier des événements

Retourne une liste d’événements.

Paramètres

Nom Clé Obligatoire Type Description
Catégorie
category string

Filtre en fonction de la catégorie d’événement.

ID de recherche
lookup_id string

Filtre pour les résultats qui correspondent à l’identificateur personnalisé de l’enregistrement d’événement.

Date de début à partir de
start_date_from date

Filtrez les résultats sur les événements avec la date de début ou après la date spécifiée (par exemple : « 2020-09-18 »).

Date de début à
start_date_to date

Filtrez les résultats sur les événements avec la date de début ou avant la date spécifiée (par exemple : « 2020-09-18 »).

Inclure inactif ?
include_inactive boolean

Inclure des événements inactifs ?

Limit
limit integer

Représente le nombre d’enregistrements à retourner. La valeur par défaut est 500. La valeur maximale est de 1 0000.

Décalage
offset integer

Représente le nombre d’enregistrements à ignorer. Pour une utilisation avec la pagination.

ID de l’événement
event_id string

Filtrez les événements qui correspondent à l’ID d’enregistrement système spécifié.

Nom
name string

Filtrez les événements qui correspondent au nom spécifié.

Ajouté ou après
date_added date-time

Filtrez les résultats sur les événements créés ou après la date spécifiée (par exemple : « 2020-09-18T04:13:56Z »).

Modifié sur ou après
last_modified date-time

Filtrez les résultats sur les événements modifiés ou après la date spécifiée (par exemple : « 2020-09-18T04:13:56Z »).

Retours

Événements

Répertorier les dons des participants

Répertorie les dons d’un participant.

Paramètres

Nom Clé Obligatoire Type Description
Identifiant du participant
participant_id True string

ID d’enregistrement système du participant.

Limit
limit integer

Représente le nombre d’enregistrements à retourner. La valeur par défaut est 500. La valeur maximale est de 1 0000.

Décalage
offset integer

Représente le nombre d’enregistrements à ignorer. Pour une utilisation avec la pagination. La valeur par défaut est 0.

Retours

Dons

Répertorier les frais des participants

Répertorie les frais d’un participant.

Paramètres

Nom Clé Obligatoire Type Description
Identifiant du participant
participant_id True string

ID d’enregistrement système du participant.

Limit
limit integer

Représente le nombre d’enregistrements à retourner. La valeur par défaut est 500. La valeur maximale est de 1 0000.

Décalage
offset integer

Représente le nombre d’enregistrements à ignorer. Pour une utilisation avec la pagination. La valeur par défaut est 0.

Retours

Frais

Répertorier les frais d’événement

Répertorie les frais d’un événement.

Paramètres

Nom Clé Obligatoire Type Description
ID de l’événement
event_id True string

ID d’enregistrement système de l’événement.

Retours

Frais

Répertorier les options des participants

Répertorie les options de participant pour un participant.

Paramètres

Nom Clé Obligatoire Type Description
Identifiant du participant
participant_id True string

ID d’enregistrement système du participant.

Retours

Options de participant

Répertorier les options des participants aux événements

Répertorie les options de participant pour un événement.

Paramètres

Nom Clé Obligatoire Type Description
ID de l’événement
event_id True string

ID de l'événement.

Retours

Options des participants aux événements

Répertorier les paiements des frais de participant

Répertorie les paiements de frais pour un participant.

Paramètres

Nom Clé Obligatoire Type Description
Identifiant du participant
participant_id True string

ID d’enregistrement système du participant.

Limit
limit integer

Représente le nombre d’enregistrements à retourner. La valeur par défaut est 500. La valeur maximale est de 1 0000.

Décalage
offset integer

Représente le nombre d’enregistrements à ignorer. Pour une utilisation avec la pagination. La valeur par défaut est 0.

Retours

Paiements des frais

Répertorier les participants à l’événement

Répertorie les participants pour un événement.

Paramètres

Nom Clé Obligatoire Type Description
ID de l’événement
event_id True string

ID d’enregistrement système de l’événement.

État du RSVP
rsvp_status string

Filtrez les participants en fonction de l’état RSVP.

Statut de l’invitation
invitation_status string

Filtrez les participants en fonction de l’état de l’invitation.

Niveau de participation
participation_level string

Filtrer les participants en fonction du niveau d’implication.

Assisté?
attended_filter boolean

Filtrez pour inclure ou exclure les participants marqués comme participants.

Frais payés ?
fees_paid_filter boolean

Filtrez pour inclure ou exclure les participants qui ont payé leurs frais.

Limit
limit integer

Représente le nombre d’enregistrements à retourner. La valeur par défaut est 500. La valeur maximale est de 1 0000.

Décalage
offset integer

Représente le nombre d’enregistrements à ignorer. Pour une utilisation avec la pagination.

Est-ce qu’un constituant ?
is_constituent_filter boolean

Filtre pour inclure ou exclure les participants qui sont des constituants.

Un e-mail éligible est-il éligible ?
email_eligible_filter boolean

Filtrez pour inclure ou exclure les participants en fonction d’une adresse e-mail principale qui n’est pas marquée Ne pas envoyer un e-mail ?

A-t-il un téléphone éligible ?
phone_call_eligible_filter boolean

Filtrez pour inclure ou exclure les participants selon qu’ils ont un numéro de téléphone principal qui n’est pas marqué Ne pas appeler.

Nom
name string

Filtrez les participants qui correspondent au nom spécifié.

Ajouté ou après
date_added date-time

Filtrez les résultats sur les participants créés ou après la date spécifiée (par exemple : « 2020-09-18T04:13:56Z »).

Modifié sur ou après
last_modified date-time

Filtrez les résultats sur les participants modifiés ou après la date spécifiée (par exemple : « 2020-09-18T04:13:56Z »).

Retours

Participants

Répertorier les pièces jointes d’événements

Répertorie les pièces jointes d’un événement.

Paramètres

Nom Clé Obligatoire Type Description
ID de l’événement
event_id True string

ID d’enregistrement système de l’événement.

Retours

Attachments

Définitions

EventApi.AdministrativeArea

Définit le modèle de données utilisé pour la zone administrative d’une adresse (par exemple, l’état aux États-Unis).

Nom Chemin d’accès Type Description
ID
id string

ID d’enregistrement de la zone administrative.

nom
name string

Nom de la zone administrative.

brève description
short_description string

Brève description de la zone administrative.

EventApi.ApiCollectionOfEventFee

Frais

Nom Chemin d’accès Type Description
Nombre
count integer

Nombre d’éléments disponibles pour la récupération dans la collection après l’application de paramètres de requête. Les paramètres de limite et de décalage n’affectent pas le nombre, mais pour faciliter la pagination, ils peuvent affecter le nombre d’éléments dans le jeu de résultats de valeur.

value
value array of EventApi.EventFee

Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection.

EventApi.ApiCollectionOfEventListEntry

Événements

Nom Chemin d’accès Type Description
Nombre
count integer

Nombre d’éléments disponibles pour la récupération dans la collection après l’application de paramètres de requête. Les paramètres de limite et de décalage n’affectent pas le nombre, mais pour faciliter la pagination, ils peuvent affecter le nombre d’éléments dans le jeu de résultats de valeur.

value
value array of EventApi.EventListEntry

Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection.

EventApi.ApiCollectionOfEventParticipantOption

Options des participants aux événements

Nom Chemin d’accès Type Description
Nombre
count integer

Nombre d’éléments disponibles pour la récupération dans la collection après l’application de paramètres de requête. Les paramètres de limite et de décalage n’affectent pas le nombre, mais pour faciliter la pagination, ils peuvent affecter le nombre d’éléments dans le jeu de résultats de valeur.

value
value array of EventApi.EventParticipantOption

Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection.

EventApi.ApiCollectionOfParticipantDonation

Dons

Nom Chemin d’accès Type Description
Nombre
count integer

Nombre d’éléments disponibles pour la récupération dans la collection après l’application de paramètres de requête. Les paramètres de limite et de décalage n’affectent pas le nombre, mais pour faciliter la pagination, ils peuvent affecter le nombre d’éléments dans le jeu de résultats de valeur.

value
value array of EventApi.ParticipantDonation

Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection.

EventApi.ApiCollectionOfParticipantFee

Frais

Nom Chemin d’accès Type Description
Nombre
count integer

Nombre d’éléments disponibles pour la récupération dans la collection après l’application de paramètres de requête. Les paramètres de limite et de décalage n’affectent pas le nombre, mais pour faciliter la pagination, ils peuvent affecter le nombre d’éléments dans le jeu de résultats de valeur.

value
value array of EventApi.ParticipantFee

Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection.

EventApi.ApiCollectionOfParticipantFeePayment

Paiements des frais

Nom Chemin d’accès Type Description
Nombre
count integer

Nombre d’éléments disponibles pour la récupération dans la collection après l’application de paramètres de requête. Les paramètres de limite et de décalage n’affectent pas le nombre, mais pour faciliter la pagination, ils peuvent affecter le nombre d’éléments dans le jeu de résultats de valeur.

value
value array of EventApi.ParticipantFeePayment

Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection.

EventApi.ApiCollectionOfParticipantListEntry

Participants

Nom Chemin d’accès Type Description
Nombre
count integer

Nombre d’éléments disponibles pour la récupération dans la collection après l’application de paramètres de requête. Les paramètres de limite et de décalage n’affectent pas le nombre, mais pour faciliter la pagination, ils peuvent affecter le nombre d’éléments dans le jeu de résultats de valeur.

value
value array of EventApi.ParticipantListEntry

Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection.

EventApi.ApiCollectionOfParticipantOption

Options de participant

Nom Chemin d’accès Type Description
Nombre
count integer

Nombre d’éléments disponibles pour la récupération dans la collection après l’application de paramètres de requête. Les paramètres de limite et de décalage n’affectent pas le nombre, mais pour faciliter la pagination, ils peuvent affecter le nombre d’éléments dans le jeu de résultats de valeur.

value
value array of EventApi.ParticipantOption

Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection.

EventApi.Country

Définit le modèle de données utilisé pour le pays d’une adresse.

Nom Chemin d’accès Type Description
ID
id string

ID de l’enregistrement du pays.

le nom d’affichage
display_name string

Nom complet du pays.

Code ISO
iso_alpha2_code string

Code ISO 3166-1 alpha-2 pour le pays.

EventApi.CreatedEvent

Événement créé

Nom Chemin d’accès Type Description
ID
id string

ID de l’événement nouvellement créé.

EventApi.CreatedEventAttachment

Pièce jointe d’événement créée

Nom Chemin d’accès Type Description
ID
id string

ID de la pièce jointe d’événement nouvellement créée.

EventApi.CreatedEventFee

Frais d’événement créés

Nom Chemin d’accès Type Description
ID
id string

ID des frais d’événement nouvellement créés.

EventApi.CreatedEventParticipantOption

Option de participant à l’événement créé

Nom Chemin d’accès Type Description
ID
id string

ID de l’option participant à l’événement nouvellement créé.

EventApi.CreatedParticipant

Participant créé

Nom Chemin d’accès Type Description
ID
id string

ID du participant nouvellement créé.

EventApi.CreatedParticipantDonation

Don de participant créé

Nom Chemin d’accès Type Description
ID
id string

ID du don de participant nouvellement créé.

EventApi.CreatedParticipantFee

Frais de participant créés

Nom Chemin d’accès Type Description
ID
id string

ID des frais de participant nouvellement créés.

EventApi.CreatedParticipantFeePayment

Paiement des frais de participant créés

Nom Chemin d’accès Type Description
ID
id string

ID du paiement des frais de participant nouvellement créé.

EventApi.CreatedParticipantOption

Option de participant créé

Nom Chemin d’accès Type Description
ID
id string

ID de l’option participant nouvellement créée.

EventApi.Event

Événement

Nom Chemin d’accès Type Description
ID
id string

ID d’enregistrement système de l’événement. Il ne s’agit pas de l’identificateur d’événement défini par l’utilisateur, qui est stocké dans le lookup_id.

Nom
name string

Nom de l’événement.

Descriptif
description string

Description de l’événement.

Date de début
start_date date

Date de début de l’événement.

Heure de début
start_time string

Heure de début de l’événement.

Date de fin
end_date date

Date de fin de l’événement.

Heure de fin
end_time string

Heure de fin de l’événement.

Catégorie
category EventApi.EventCategory

La catégorie d’événement est la catégorisation personnalisée de l’événement.

ID de recherche
lookup_id string

ID de recherche de l’événement.

Emplacement
location EventApi.Location

Définit le modèle de données utilisé pour un emplacement.

Capacity
capacity integer

Nombre de personnes qui peuvent assister à l’événement.

Objectif
goal double

Objectif monétaire de l’événement.

ID de campagne
campaign_id string

ID d’enregistrement système de la campagne associée à l’événement.

ID du fonds
fund_id string

ID d’enregistrement système du fonds associé à l’événement.

Inactif?
inactive boolean

L’événement est-il inactif ?

Date d’ajout
date_added date-time

Date de création de l’événement.

Date de modification
date_modified date-time

Date de la dernière modification de l’événement.

EventApi.EventAttachment

Attachment

Nom Chemin d’accès Type Description
ID
id string

ID d’enregistrement système de la pièce jointe.

ID de l’événement
parent_id string

ID d’enregistrement système de l’événement associé à la pièce jointe.

Type
type string

Type de pièce jointe. Les pièces jointes physiques sont des fichiers chargés tels que des images, des fichiers PDF ou des documents Word enregistrés localement ou sur le réseau. Ils sont stockés et gérés dans le système. Les pièces jointes de liens sont des liens vers des fichiers tels que des images, des billets de blog ou des vidéos YouTube en ligne ou dans un compte de stockage cloud. Ils sont stockés et gérés en externe.

Nom
name string

Nom de fichier de la pièce jointe Limite de caractères : 150.

Date
date date-time

Date de la pièce jointe.

URL
url string

URL de la pièce jointe. Cela est requis pour les pièces jointes de lien et non applicables aux pièces jointes physiques.

Nom de fichier
file_name string

Le nom du fichier. Limite de caractères : 36. Pour les pièces jointes physiques uniquement.

ID de fichier
file_id string

L’identificateur du fichier. Limite de caractères : 36. Pour les pièces jointes physiques uniquement.

ID de miniature
thumbnail_id string

Identificateur de la miniature. Limite de caractères : 36. Pour les pièces jointes physiques uniquement.

URL de miniature
thumbnail_url string

URL d’une miniature. Pour les pièces jointes physiques qui sont uniquement des images. Contient une signature limitée dans le temps qui limite l’accès à 60 minutes.

Type de contenu
content_type string

Type de contenu. Pour les pièces jointes physiques uniquement.

Taille du fichier
file_size integer

Taille du fichier en octets. Pour les pièces jointes physiques uniquement.

Étiquettes
tags array of string

Balises associées à la pièce jointe.

EventApi.EventAttachmentCollection

Attachments

Nom Chemin d’accès Type Description
Nombre
count integer

Nombre d’éléments disponibles pour la récupération dans la collection après l’application de paramètres de requête. Les paramètres de limite et de décalage n’affectent pas le nombre, mais pour faciliter la pagination, ils peuvent affecter le nombre d’éléments dans le jeu de résultats de valeur.

value
value array of EventApi.EventAttachment

Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection.

EventApi.EventCategory

La catégorie d’événement est la catégorisation personnalisée de l’événement.

Nom Chemin d’accès Type Description
ID
id string

ID d’enregistrement système de la catégorie d’événement.

nom
name string

Nom de la catégorie d’événement.

inactif?
inactive boolean

Cette catégorie est-elle inactive ?

EventApi.EventFee

Les frais d’événement sont le montant des frais d’une organisation pour les individus ou les organisations à participer ou assister à l’événement.

Nom Chemin d’accès Type Description
ID
id string

ID d’enregistrement système des frais d’événement.

nom
name string

Nom des frais d’événement.

montant
cost double

Le coût des frais.

montant de contribution
contribution_amount double

Montant de franchise fiscale pour ces frais.

nombre vendu
number_sold integer

Nombre de frais vendus.

EventApi.EventListEntry

Événement

Nom Chemin d’accès Type Description
ID
id string

ID d’enregistrement système de l’événement.

Nom
name string

Nom de l’événement.

Date de début
start_date date

Date de début de l’événement.

Heure de début
start_time string

Heure de début de l’événement.

Date de fin
end_date date

Date de fin de l’événement.

Heure de fin
end_time string

Heure de fin de l’événement.

Catégorie
category EventApi.EventCategory

La catégorie d’événement est la catégorisation personnalisée de l’événement.

ID de recherche
lookup_id string

ID de recherche de l’événement.

Capacity
capacity integer

Nombre de personnes qui peuvent assister à l’événement.

Concomitant
attending_count integer

Nombre de participants à l’événement qui prévoient de participer.

Présencé
attended_count integer

Nombre de participants à l’événement.

Invité
invited_count integer

Nombre d’invités d’événement.

Revenu
revenue double

Le chiffre d’affaires réalisé de l’événement.

Objectif
goal double

Objectif monétaire de l’événement.

Pourcentage d’objectif
percent_of_goal integer

Chiffre d’affaires réalisé en pourcentage du chiffre d’affaires de l’objectif.

Inactif?
inactive boolean

L’événement est-il inactif ?

Date d’ajout
date_added date-time

Date de création de l’événement.

Date de modification
date_modified date-time

Date de la dernière modification de l’événement.

EventApi.EventParticipantOption

Les options des participants aux événements sont des champs qui collectent des détails sur les participants, tels que les tailles de t-shirt, les préférences de repas ou les demandes de sièges. Définissez les options et leurs valeurs pour un événement, puis ajoutez des réponses pour chaque participant.

Nom Chemin d’accès Type Description
ID
id string

ID d’enregistrement système de l’option participant à l’événement.

nom
name string

Nom de l’option participant à l’événement.

type d’entrée
input_type string

Type de l’option participant à l’événement.

autoriser la sélection multiple ?
multi_select boolean

Autoriser plusieurs valeurs pour les listes ?

list_options
list_options array of EventApi.EventParticipantOptionListOption

Options de liste disponibles.

ajouté par l’utilisateur
added_by_user string

ID de l’utilisateur qui a ajouté l’option.

modifié par l’utilisateur
updated_by_user string

ID de l’utilisateur qui a modifié l’option.

ajouté par service
added_by_service string

Nom du service qui a ajouté cette option.

modifié par le service
updated_by_service string

Nom du service qui a modifié cette option.

date ajoutée
date_added date-time

Date de création de l’option.

date de modification
date_updated date-time

Date de la dernière modification de l’option.

version
version integer

Numéro de version de l’option.

EventApi.EventParticipantOptionListOption

Option de liste d’options d’un participant à un événement

Nom Chemin d’accès Type Description
ID
id string

ID de l’option de liste

nom
name string

Nom de l’option de liste

Séquence
sequence integer

Séquence utilisée pour classer les options de liste

EventApi.Locality

Définit le modèle de données utilisé pour la localité d’une adresse.

Nom Chemin d’accès Type Description
ID
id string

ID d’enregistrement de l’enregistrement de localité.

nom
name string

Nom de la localité.

EventApi.Location

Définit le modèle de données utilisé pour un emplacement.

Nom Chemin d’accès Type Description
nom
name string

Nom de l’emplacement.

lignes d’adresse
address_lines string

Lignes d’adresse de l’emplacement.

code postal
postal_code string

Code postal de l’emplacement.

localité
locality EventApi.Locality

Définit le modèle de données utilisé pour la localité d’une adresse.

zone administrative
administrative_area EventApi.AdministrativeArea

Définit le modèle de données utilisé pour la zone administrative d’une adresse (par exemple, l’état aux États-Unis).

sous-administration
sub_administrative_area EventApi.SubAdministrativeArea

Définit le modèle de données utilisé pour la zone sous-administrative d’une adresse (par exemple, ville aux États-Unis).

country
country EventApi.Country

Définit le modèle de données utilisé pour le pays d’une adresse.

Adresse mise en forme
formatted_address string

Adresse mise en forme de l’emplacement

EventApi.Membership

Informations d’adhésion pour le participant.

Nom Chemin d’accès Type Description
Catégorie d’appartenance
category EventApi.MembershipCategory

Catégorie d’appartenance de l’individu.

EventApi.MembershipCategory

Catégorie d’appartenance de l’individu.

Nom Chemin d’accès Type Description
ID
id string

ID d’enregistrement système de la catégorie d’appartenance.

nom
name string

Nom de la catégorie d’appartenance.

EventApi.Participant

Participant

Nom Chemin d’accès Type Description
ID
id string

ID d’enregistrement système du participant.

ID constituant
constituent_id string

ID constituant du participant.

ID de l’événement
event_id string

ID d’enregistrement système de l’événement en cours d’participation.

ID d’hôte
host_id string

ID de l’enregistrement du participant de l’hôte.

État du RSVP
rsvp_status string

État de l’engagement du participant avec l’événement.

Assisté?
attended boolean

Le participant a-t-il participé à l’événement ?

Statut de l’invitation
invitation_status string

État de l’invitation au participant.

jour
rsvp_date.d integer

Jour de la date floue.

month
rsvp_date.m integer

Mois à la date approximative.

année
rsvp_date.y integer

L’année dans la date approximative.

jour
invitation_date.d integer

Jour de la date floue.

month
invitation_date.m integer

Mois à la date approximative.

année
invitation_date.y integer

L’année dans la date approximative.

Note récapitulative
summary_note string

Informations de référence rapides épinglées à l’enregistrement du participant.

Niveau de participation
participation_level EventApi.ParticipationLevel

Les niveaux de participation sont le niveau de participation des participants à un événement.

Date d’ajout
date_added date-time

Date de création du participant.

Date de modification
date_modified date-time

Date de la dernière modification du participant.

EventApi.ParticipantDonation

Définit un modèle de données pour un don de participant

Nom Chemin d’accès Type Description
ID
id string

ID d’enregistrement système du don du participant.

ID cadeau
gift_id string

ID d’enregistrement système du don auquel le don du participant est lié.

EventApi.ParticipantFee

Définit un modèle de données pour les frais d’un participant

Nom Chemin d’accès Type Description
ID
id string

ID des frais du participant.

ID de participant
participant_id string

ID de l’enregistrement auquel les frais de participant sont liés.

quantité
quantity integer

Quantité achetée.

montant des frais
fee_amount double

Montant des frais de participant.

montant de contribution
tax_receiptable_amount double

Montant de franchise fiscale pour ces frais.

jour
date.d integer

Jour de la date floue.

month
date.m integer

Mois à la date approximative.

année
date.y integer

L’année dans la date approximative.

Frais d’événement
event_fee EventApi.EventFee

Les frais d’événement sont le montant des frais d’une organisation pour les individus ou les organisations à participer ou assister à l’événement.

EventApi.ParticipantFeePayment

Définit un modèle de données pour un paiement des frais de participant

Nom Chemin d’accès Type Description
ID
id string

ID d’enregistrement système du paiement des frais de participant.

ID de participant
participant_id string

ID d’enregistrement système du participant auquel le paiement des frais de participant est lié.

ID cadeau
gift_id string

ID d’enregistrement système du cadeau auquel le paiement des frais de participant est lié.

quantité appliquée
applied_amount double

Montant appliqué du paiement des frais de participant.

EventApi.ParticipantListEntry

Participant

Nom Chemin d’accès Type Description
ID
id string

ID d’enregistrement système du participant.

Identifiant de contact
contact_id string

ID du contact qui participe à l’événement.

État du RSVP
rsvp_status string

État de l’engagement du participant avec l’événement.

Assisté?
attended boolean

Le participant a-t-il participé à l’événement ?

Statut de l’invitation
invitation_status string

État de l’invitation au participant.

jour
rsvp_date.d integer

Jour de la date floue.

month
rsvp_date.m integer

Mois à la date approximative.

année
rsvp_date.y integer

L’année dans la date approximative.

Niveau de participation
participation_level EventApi.ParticipationLevel

Les niveaux de participation sont le niveau de participation des participants à un événement.

Titre
title string

Titre du participant.

Prénom
first_name string

Prénom du participant.

Nom
last_name string

Nom du participant.

Nom
name string

Nom complet du participant.

Nom préféré
preferred_name string

Nom préféré du participant.

Suffixe
suffix string

Suffixe du participant.

ID de recherche
lookup_id string

LookupId du participant.

Messagerie électronique
email string

Adresse e-mail du participant.

N’envoyez pas d’e-mail ?
do_not_email boolean

Le participant peut-il être contacté à cette adresse e-mail ?

Téléphone
phone string

Numéro de téléphone du participant.

N’appelez pas ?
do_not_call boolean

Le participant peut-il être contacté à ce numéro ?

Deuxième prénom
middle_name string

Le prénom du participant.

Ancien nom
former_name string

L’ancien nom du participant.

Est-ce qu’un constituant ?
is_constituent boolean

Le participant est-il un constituant ?

Classe de
class_of string

Classe de diplôme du participant.

Total des frais d’inscription
total_registration_fees double

Somme des montants des frais du participant.

Total payé
total_paid double

Somme des cadeaux payés par le participant avec un type de frais d’inscription.

Dons
donations double

Somme des dons payés par le participant avec un type de dons.

Revenu
revenue double

Somme des cadeaux payés par le participant dans tous les types.

Seat
seat string

Affectation de siège pour le participant.

Balise name
name_tag string

Balise de nom du participant

Note récapitulative
summary_note string

Informations de référence rapides épinglées à l’enregistrement du participant.

Date d’ajout
date_added date-time

Date de création du participant.

Date de modification
date_modified date-time

Date de la dernière modification du participant.

ID de contact
host.contact_id string

ID du contact qui participe à l’événement.

ID de participant
host.participant_id string

ID du participant.

nom
host.name string

Nom complet du participant.

Invités
guests array of EventApi.ParticipantListParticipantSummary

Les invités du participant.

Adhésions
memberships array of EventApi.Membership

Informations d’appartenance pour le participant.

EventApi.ParticipantListParticipantSummary

Informations récapitulatives de base du participant.

Nom Chemin d’accès Type Description
ID de contact
contact_id string

ID du contact qui participe à l’événement.

ID de participant
participant_id string

ID du participant.

nom
name string

Nom complet du participant.

EventApi.ParticipantOption

Option de participant associée à un participant donné

Nom Chemin d’accès Type Description
ID
id string

ID d’enregistrement système de l’option participant.

ID de participant
participant_id string

ID d’enregistrement système du participant.

ID d’événement
event_id string

ID d’enregistrement système de l’événement.

ID d’option participant à l’événement
event_participant_option_id string

ID d’enregistrement système de l’option participant à l’événement.

value
option_value string

Réponse du participant à l’option.

ajouté par l’utilisateur
added_by_user string

ID de l’utilisateur qui a ajouté l’option participant.

modifié par l’utilisateur
updated_by_user string

ID de l’utilisateur qui a modifié l’option participant.

ajouté par service
added_by_service string

Nom du service qui a ajouté cette option de participant.

modifié par le service
updated_by_service string

Nom du service qui a modifié cette option de participant.

date ajoutée
date_added date-time

Date de création de l’option participant.

date de modification
date_updated date-time

Date de dernière modification de l’option participant.

EventApi.ParticipationLevel

Les niveaux de participation sont le niveau de participation des participants à un événement.

Nom Chemin d’accès Type Description
ID
id string

ID d’enregistrement système du niveau de participation.

nom
name string

Nom du niveau de participation.

inactif?
is_inactive boolean

Le niveau de participation est-il inactif ?

EventApi.SubAdministrativeArea

Définit le modèle de données utilisé pour la zone sous-administrative d’une adresse (par exemple, ville aux États-Unis).

Nom Chemin d’accès Type Description
ID
id string

ID de la zone de sous-administration.

nom
name string

Nom de la zone sous-administrative.