Blackbaud Raisers Edge NXT (préversion)
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.
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 est basé sur l’API SKY de Blackbaud et fournit des opérations pour aider à gérer les entités trouvées dans le NXT edge de The Raiser, notamment :
- Constituants
- Cadeaux
- Actions
- Remarques
- Champs personnalisés
- Campagnes
- Fonds
- Appels
- 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 au NXT edge de Raiser. 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 | 500 | 60 secondes |
Actions
| Actions de liste |
Retourne une liste d’actions. |
| Ajouter des enregistrements à une liste |
Ajoutez un ensemble d’enregistrements à une liste existante. |
| Ajouter un cadeau au lot |
Ajoutez un cadeau au lot de cadeaux spécifié. |
| 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 alias constituant |
Crée un alias constituant. |
| Créer un cadeau |
Crée un cadeau. |
| Créer un champ personnalisé cadeau |
Crée un champ personnalisé cadeau. |
| Créer un champ personnalisé constituant |
Crée un champ personnalisé constituant. |
| Créer un champ personnalisé de campagne |
Crée un champ personnalisé de campagne. |
| Créer un champ personnalisé de fonds |
Crée un champ personnalisé de fonds. |
| Créer un champ personnalisé d’action |
Crée un champ personnalisé d’action. |
| Créer un champ personnalisé d’appel |
Crée un champ personnalisé d’appel. |
| Créer un champ personnalisé d’opportunité |
Crée un champ personnalisé d’opportunité. |
| Créer un code constituant |
Crée un code constituant. |
| Créer un code de sollicitation constituant |
Crée un code de sollicitation constituant. |
| Créer un constituant individuel |
Crée un constituant individuel. |
| Créer un don de participant |
Crée un don pour un participant. |
| Créer un emplacement de document |
Crée un identificateur de document unique et un emplacement de chargement pour une utilisation avec des pièces jointes physiques. La réponse inclut des instructions sur l’emplacement et la façon de charger le contenu du document. |
| Créer un enregistrement de consentement constituant |
Crée un enregistrement de consentement constituant. |
| Créer un lot cadeau |
Crée un lot cadeau. |
| 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 téléphone constituant |
Crée un téléphone constituant. |
| Créer un événement |
Crée un événement. |
| Créer une action constituante |
Crée une action constituante. |
| Créer une adresse constituante |
Crée une adresse constituante. |
| Créer une adresse e-mail constituante |
Crée une adresse e-mail constituante. |
| Créer une affectation de collecte de fonds |
Crée une affectation de collecte de fonds. |
| Créer une liste à partir d’un ensemble d’enregistrements |
Crée une liste filtrée sur le jeu d’enregistrements spécifié. |
| Créer une note constituante |
Crée une note constituante. |
| Créer une opportunité |
Crée une nouvelle opportunité. |
| 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 organisation constituante |
Crée une organisation constituante. |
| Créer une pièce jointe cadeau |
Crée une pièce jointe cadeau. |
| Créer une pièce jointe constituante |
Crée une pièce jointe constituante. |
| Créer une pièce jointe de campagne |
Crée une pièce jointe de campagne. |
| Créer une pièce jointe de fonds |
Crée une pièce jointe de fonds. |
| Créer une pièce jointe d’action |
Crée une pièce jointe d’action. |
| Créer une pièce jointe d’appel |
Crée une pièce jointe d’appel. |
| Créer une pièce jointe d’opportunité |
Crée une pièce jointe d’opportunité. |
| Créer une présence en ligne constituante |
Crée une présence en ligne constituante. |
| Créer une relation d’organisation |
Crée une relation d’organisation. Si la relation est avec une autre constituante, une relation réciproque est créée pour cette constituante. |
| Créer une relation individuelle |
Crée une relation individuelle. Si la relation est avec une autre constituante, une relation réciproque est créée pour cette constituante. |
| Créer une éducation constituante |
Crée une éducation constituante. |
| Créer une évaluation constituante |
Crée une évaluation constituante. |
| Liste des constituants |
Retourne une liste de constituants. |
| Lister les appels |
Retourne une liste d’appels. |
| Lister les notes constituantes |
Répertorie les notes d’un constituant. |
| Lister les pièces jointes d’action |
Répertorie les pièces jointes d’une action. |
| Lister les pièces jointes d’appel |
Répertorie les pièces jointes pour un appel. |
| Lister les téléphones constituants |
Répertorie les téléphones d’un constituant. |
| Mettre à jour les détails de l’accusé de réception du cadeau |
Met à jour les détails de l’accusé de réception d’un cadeau. |
| Mettre à jour les détails des reçus de cadeau |
Met à jour les détails du reçu pour un cadeau. |
| Mettre à jour un alias constituant |
Met à jour un alias constituant. |
| Mettre à jour un champ personnalisé cadeau |
Met à jour un champ personnalisé cadeau. |
| Mettre à jour un champ personnalisé constituant |
Met à jour un champ personnalisé constituant. |
| Mettre à jour un champ personnalisé de campagne |
Met à jour un champ personnalisé de campagne. |
| Mettre à jour un champ personnalisé de fonds |
Met à jour un champ personnalisé de fonds. |
| Mettre à jour un champ personnalisé d’action |
Met à jour un champ personnalisé d’action. |
| Mettre à jour un champ personnalisé d’appel |
Met à jour un champ personnalisé d’appel. |
| Mettre à jour un champ personnalisé d’opportunité |
Met à jour un champ personnalisé d’opportunité. |
| Mettre à jour un code constituant |
Met à jour un code constituant. |
| Mettre à jour un code de sollicitation constituant |
Met à jour un code de sollicitation constituant. |
| Mettre à jour un constituant |
Met à jour un constituant. |
| Mettre à jour un participant |
Met à jour les détails d’un participant. |
| Mettre à jour un téléphone constituant |
Met à jour un téléphone constituant. |
| Mettre à jour un événement |
Met à jour les détails d’un événement. |
| Mettre à jour une action constituante |
Met à jour une action constituante. |
| Mettre à jour une adresse constituante |
Met à jour une adresse constituante. |
| Mettre à jour une adresse e-mail constituante |
Met à jour une adresse e-mail constituante. |
| Mettre à jour une image de profil constituante |
Met à jour l’image de profil actuelle pour un constituant. |
| Mettre à jour une note constituante |
Met à jour une note constituante. |
| Mettre à jour une opportunité |
Met à jour une opportunité. |
| Mettre à jour une option de participant |
Met à jour les détails d’une option de participant. |
| Mettre à jour une pièce jointe cadeau |
Met à jour une pièce jointe cadeau. |
| Mettre à jour une pièce jointe constituante |
Met à jour une pièce jointe constituante. |
| Mettre à jour une pièce jointe de campagne |
Met à jour une pièce jointe de campagne. |
| Mettre à jour une pièce jointe de fonds |
Met à jour une pièce jointe de fonds. |
| Mettre à jour une pièce jointe d’action |
Met à jour une pièce jointe d’action. |
| Mettre à jour une pièce jointe d’appel |
Met à jour une pièce jointe d’appel. |
| Mettre à jour une pièce jointe d’opportunité |
Met à jour une pièce jointe d’opportunité. |
| Mettre à jour une présence en ligne constituante |
Met à jour une présence en ligne constituante. |
| Mettre à jour une relation constituante |
Met à jour une relation pour un constituant. Si une relation réciproque existe, elle est également modifiée pour refléter les modifications. Cela n’inclut pas les modifications apportées à la propriété « comments », qui est spécifique à chaque enregistrement et peut être modifiée indépendamment sur chaque enregistrement. |
| Mettre à jour une éducation constituante |
Met à jour une éducation constituante. |
| Obtenir le dernier cadeau constituant |
Retourne le dernier cadeau pour un constituant. |
| Obtenir le plus grand cadeau constituant |
Retourne le plus grand cadeau pour un constituant. |
| Obtenir l’état des prospects constituants |
Retourne l’état actuel des prospects pour un constituant. |
| Obtenir un appel |
Retourne des informations sur un appel. |
| Obtenir un cadeau |
Retourne des informations sur un cadeau. |
| Obtenir un constituant |
Retourne des informations sur un constituant. |
| Obtenir un don de durée de vie constituante |
Retourne le résumé de la durée de vie d’un constituant. |
| Obtenir un fonds |
Retourne des informations sur un fonds. |
| Obtenir un package |
Retourne des informations sur un package. |
| Obtenir un participant |
Retourne des informations sur un participant à un événement spécifique. |
| Obtenir un premier cadeau constituant |
Retourne le premier cadeau pour un constituant. |
| Obtenir un événement |
Retourne des informations sur un événement. |
| Obtenir une action constituante |
Retourne des informations sur une action constituante. |
| Obtenir une campagne |
Retourne des informations sur une campagne. |
| Obtenir une image de profil constituante |
Retourne l’image de profil actuelle d’un constituant. |
| Obtenir une opportunité |
Retourne des informations sur une opportunité. Remarque : ce point de terminaison retourne la propriété d’état avec une latence d’environ 10 minutes. |
| Rechercher un constituant |
Effectue une recherche constituante basée sur le texte de recherche fourni. Prend en charge le prénom, le nom, le nom préféré, l’ancien nom, l’alias, l’adresse e-mail, le numéro de téléphone, l’adresse ou l’ID de recherche. Les combinaisons de noms, telles que le prénom et le nom ou le nom préféré, sont valides, mais la recherche ne prend en charge qu’un seul paramètre à la fois. Par défaut, les recherches incluent les résultats qui ressemblent à vos critères. Par exemple, les recherches de « Smith » incluent des correspondances pour « Smyth » et d’autres orthographes alternatives. Cette recherche ne prend pas en charge les caractères génériques tels que * ou ?. Les résultats de la recherche sont limités à 500 enregistrements. |
| Répertorier des événements |
Retourne une liste d’événements. |
| Répertorier les actions constituantes |
Répertorie les actions d’un constituant. |
| Répertorier les adresses constituantes |
Répertorie les adresses d’un constituant. |
| Répertorier les adresses e-mail constituantes |
Répertorie les adresses e-mail d’un constituant. |
| Répertorier les affectations de collecte de fonds |
Répertoriez les affectations d’une collecte de fonds. |
| Répertorier les alias constituants |
Répertorie les alias d’un constituant. |
| Répertorier les cadeaux |
Retourne une liste de cadeaux. |
| Répertorier les campagnes |
Retourne une liste de campagnes. |
| Répertorier les champs personnalisés constituants |
Répertorie les champs personnalisés d’un constituant. |
| Répertorier les champs personnalisés de campagne |
Répertorie les champs personnalisés d’une campagne. |
| Répertorier les champs personnalisés du cadeau |
Répertorie les champs personnalisés d’un cadeau. |
| Répertorier les champs personnalisés du fonds |
Répertorie les champs personnalisés d’un fonds. |
| Répertorier les champs personnalisés d’action |
Répertorie les champs personnalisés d’une action. |
| Répertorier les champs personnalisés d’appel |
Répertorie les champs personnalisés pour un appel. |
| Répertorier les champs personnalisés d’opportunité |
Répertorie les champs personnalisés pour une opportunité. |
| Répertorier les codes constituants |
Répertorie les codes constituants d’un constituant. |
| Répertorier les codes de sollicitation des constituants |
Répertorie les codes de sollicitation d’un constituant. |
| Répertorier les collectes de fonds constituantes |
Répertorie les affectations de collecte de fonds pour une constituante. |
| Répertorier les dons des participants |
Répertorie les dons d’un participant. |
| Répertorier les enregistrements de consentement constituants |
Répertorie les enregistrements de consentement d’un constituant. |
| Répertorier les fonds |
Retourne une liste de fonds. |
| 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 lots de cadeaux |
Répertoriez les lots de cadeaux. |
| Répertorier les opportunités |
Retourne une liste d’opportunités. |
| 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 packages |
Retourne une liste de packages. |
| 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 constituantes |
Répertorie les pièces jointes d’un constituant. |
| Répertorier les pièces jointes de cadeau |
Répertorie les pièces jointes pour un cadeau. |
| Répertorier les pièces jointes de campagne |
Répertorie les pièces jointes d’une campagne. |
| Répertorier les pièces jointes de fonds |
Répertorie les pièces jointes d’un fonds. |
| Répertorier les pièces jointes d’opportunité |
Répertorie les pièces jointes pour une opportunité. |
| Répertorier les présences en ligne constituantes |
Répertorie les présences en ligne d’un constituant. |
| Répertorier les relations constituantes |
Répertorie les relations d’un constituant. |
| Répertorier les éducations constituantes |
Répertorie les dossiers d’éducation d’un constituant. |
| Répertorier les évaluations des constituants |
Retourne la liste des évaluations d’un constituant. |
| Supprimer un code constituant |
Supprime un code constituant. |
Actions de liste
Retourne une liste d’actions.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Liste
|
list_id | string |
Définit un identificateur de liste utilisé pour filtrer l’ensemble d’actions sur ceux inclus dans la liste spécifiée. Si cette valeur est définie, d’autres filtres spécifiés sont ignorés. |
|
|
État calculé
|
computed_status | string |
Représente un filtre pour les résultats en fonction de l’état de l’action calculée. Les valeurs disponibles sont Open, Completed ou PastDue. |
|
|
Statut
|
status_code | string |
Représente un code d’état d’action pour filtrer les résultats (applicable uniquement lorsque le système est configuré pour utiliser des codes d’état d’action). Par exemple, « En attente » retourne des actions avec l’état « En attente ». |
|
|
Limit
|
limit | integer |
Représente le nombre d’enregistrements à retourner. La valeur par défaut est 500. La valeur maximale est de 5 000. |
|
|
Décalage
|
offset | integer |
Représente le nombre d’enregistrements à ignorer. Pour une utilisation avec la pagination. |
|
|
Ajouté ou après
|
date_added | date-time |
Filtrez les résultats sur les actions créées 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 actions modifiées ou après la date spécifiée (par exemple : « 2020-09-18T04:13:56Z »). |
Retours
Actions
Ajouter des enregistrements à une liste
Ajoutez un ensemble d’enregistrements à une liste existante.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Type de liste
|
list_type | True | string |
Type de liste. |
|
Liste
|
list_id | True | string |
ID d’enregistrement système de la liste. |
|
ID(s)
|
ids | True | array of string |
Identificateurs uniques pour les enregistrements à ajouter à la liste (valeur maximale de 100 000 valeurs). |
Ajouter un cadeau au lot
Ajoutez un cadeau au lot de cadeaux spécifié.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Batch
|
batch_id | True | string |
Lot auquel le cadeau sera ajouté. |
|
ID constituant
|
constituent_id | True | string |
ID d’enregistrement système de la constituante associée au cadeau. |
|
Montant
|
value | True | double |
Montant monétaire du cadeau. |
|
Date
|
date | True | date |
Date de cadeau (par exemple : '2020-09-18'). |
|
Type
|
type | True | string |
Le type de cadeau. |
|
ID de campagne
|
campaign_id | string |
ID d’enregistrement système de la campagne associée au fractionnement du cadeau. |
|
|
ID de fonds
|
fund_id | True | string |
ID d’enregistrement système du fonds associé au fractionnement du cadeau. |
|
ID d’appel
|
appeal_id | string |
ID d’enregistrement système de l’appel associé au fractionnement du cadeau. |
|
|
ID de package
|
package_id | string |
ID d’enregistrement système du package associé au fractionnement cadeau. |
|
|
montant
|
value | True | double |
Montant monétaire du fractionnement du cadeau. |
|
Mode de paiement
|
payment_method | True | string |
Mode de paiement. |
|
Vérifier le numéro
|
check_number | string |
Numéro de vérification (applicable uniquement lorsque le mode de paiement est « PersonalCheck »). |
|
|
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. |
|
|
Reference
|
reference | string |
Référence de paiement (applicable uniquement lorsque le mode de paiement est « Autre »). |
|
|
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. |
|
|
Est-ce anonyme ?
|
is_anonymous | boolean |
Le cadeau est-il anonyme ? Si aucune valeur n’est fournie, l’anonymat par défaut du donneur sera utilisé. |
|
|
Sous-type
|
subtype | string |
Sous-type du cadeau. |
|
|
Commentaire
|
reference | string |
Remarques pour suivre des détails spéciaux sur un cadeau, comme la motivation derrière elle ou une description détaillée d’un cadeau en nature. |
|
|
ID de recherche
|
lookup_id | string |
Identificateur défini par l’utilisateur pour le cadeau. |
|
|
Utilisez des crédits de collecte de fonds ?
|
default_fundraiser_credits | boolean |
Utilisez les crédits de collecte de fonds par défaut ? |
|
|
Utilisez des crédits souples ?
|
default_soft_credits | boolean |
Utilisez les crédits soft par défaut ? |
|
|
Circonscription
|
constituency | string |
La circonscription du cadeau. |
|
|
Publier l’état
|
post_status | string |
L’état post du cadeau. |
|
|
Date de publication
|
post_date | date |
Date à laquelle le cadeau a été publié (par exemple : '2020-09-18'). |
|
|
État du reçu
|
status | True | string |
État de réception du cadeau. |
|
Montant du reçu
|
value | True | double |
Montant monétaire du reçu pour le cadeau. |
|
Date de réception
|
date | date |
Date à laquelle le cadeau a été reçu (par exemple : « 2020-09-18 »). |
Retours
Contient une collection d’enregistrements d’erreurs de cadeau par lots et les cadeaux par lots ajoutés par l’opération
- Results
- GiftApi.BatchGiftAddResults
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
- Corps
- EventApi.CreatedEventFee
Créer un alias constituant
Crée un alias constituant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID constituant
|
constituent_id | True | string |
ID d’enregistrement système de la constituante associée à l’alias. |
|
Alias
|
name | True | string |
Nom à utiliser comme alias de la constituante. Limite de caractères : 100. |
|
Type
|
type | string |
Type d’alias. |
Retours
Alias constituant créé
Créer un cadeau
Crée un cadeau.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID constituant
|
constituent_id | True | string |
ID d’enregistrement système de la constituante associée au cadeau. |
|
Montant
|
value | True | double |
Montant monétaire du cadeau. |
|
Date
|
date | True | date |
Date de cadeau (par exemple : '2020-09-18'). |
|
Type
|
type | True | string |
Le type de cadeau. |
|
ID de campagne
|
campaign_id | string |
ID d’enregistrement système de la campagne associée au fractionnement du cadeau. |
|
|
ID de fonds
|
fund_id | True | string |
ID d’enregistrement système du fonds associé au fractionnement du cadeau. |
|
ID d’appel
|
appeal_id | string |
ID d’enregistrement système de l’appel associé au fractionnement du cadeau. |
|
|
ID de package
|
package_id | string |
ID d’enregistrement système du package associé au fractionnement cadeau. |
|
|
montant
|
value | True | double |
Montant monétaire du fractionnement du cadeau. |
|
Mode de paiement
|
payment_method | True | string |
Mode de paiement. |
|
Vérifier le numéro
|
check_number | string |
Numéro de vérification (applicable uniquement lorsque le mode de paiement est « PersonalCheck »). |
|
|
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. |
|
|
Reference
|
reference | string |
Référence de paiement (applicable uniquement lorsque le mode de paiement est « Autre »). |
|
|
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. |
|
|
Est-ce anonyme ?
|
is_anonymous | boolean |
Le cadeau est-il anonyme ? Si aucune valeur n’est fournie, l’anonymat par défaut du donneur sera utilisé. |
|
|
Sous-type
|
subtype | string |
Sous-type du cadeau. |
|
|
Commentaire
|
reference | string |
Remarques pour suivre des détails spéciaux sur un cadeau, comme la motivation derrière elle ou une description détaillée d’un cadeau en nature. |
|
|
ID de recherche
|
lookup_id | string |
Identificateur défini par l’utilisateur pour le cadeau. |
|
|
Utilisez des crédits de collecte de fonds ?
|
default_fundraiser_credits | boolean |
Utilisez les crédits de collecte de fonds par défaut ? |
|
|
Utilisez des crédits souples ?
|
default_soft_credits | boolean |
Utilisez les crédits soft par défaut ? |
|
|
Circonscription
|
constituency | string |
La circonscription du cadeau. |
|
|
Préfixe de lot
|
batch_prefix | string |
Préfixe à utiliser pour les cadeaux par lots. Cela doit inclure au moins une lettre et est obligatoire lorsque le « numéro batch » a une valeur. |
|
|
Numéro de lot
|
batch_number | string |
Numéro de lot. Limite de caractères : 50 (y compris le préfixe de lot). |
|
|
Publier l’état
|
post_status | string |
L’état post du cadeau. |
|
|
Date de publication
|
post_date | date |
Date à laquelle le cadeau a été publié (par exemple : '2020-09-18'). |
|
|
État du reçu
|
status | True | string |
État de réception du cadeau. |
|
Montant du reçu
|
value | True | double |
Montant monétaire du reçu pour le cadeau. |
|
Date de réception
|
date | date |
Date à laquelle le cadeau a été reçu (par exemple : « 2020-09-18 »). |
Retours
Cadeau créé
- Corps
- GiftApi.CreatedGift
Créer un champ personnalisé cadeau
Crée un champ personnalisé cadeau.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
Objet qui représente le champ personnalisé à créer. |
Retours
Champ personnalisé cadeau créé
Créer un champ personnalisé constituant
Crée un champ personnalisé constituant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
Objet qui représente le champ personnalisé à créer. |
Retours
Champ personnalisé constituant créé
Créer un champ personnalisé de campagne
Crée un champ personnalisé de campagne.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
Objet qui représente le champ personnalisé à créer. |
Retours
Champ personnalisé de campagne créé
Créer un champ personnalisé de fonds
Crée un champ personnalisé de fonds.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
Objet qui représente le champ personnalisé à créer. |
Retours
Champ personnalisé de fonds créé
Créer un champ personnalisé d’action
Crée un champ personnalisé d’action.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
Objet qui représente le champ personnalisé à créer. |
Retours
Champ personnalisé d’action créé
Créer un champ personnalisé d’appel
Crée un champ personnalisé d’appel.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
Objet qui représente le champ personnalisé à créer. |
Retours
Champ personnalisé d’appel créé
Créer un champ personnalisé d’opportunité
Crée un champ personnalisé d’opportunité.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
Objet qui représente le champ personnalisé à créer. |
Retours
Pièce jointe d’opportunité créée
Créer un code constituant
Crée un code constituant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID constituant
|
constituent_id | True | string |
ID d’enregistrement système de la constituante associée au code constituant. |
|
Code constituant
|
description | True | string |
Code constituant. |
|
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. |
|
|
Sequence
|
sequence | integer |
Séquence numérique associée au code constituant. |
Retours
Code constituant créé
Créer un code de sollicitation constituant
Crée un code de sollicitation constituant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID constituant
|
constituent_id | True | string |
ID d’enregistrement système de la constituante associée au code de sollicitation. |
|
Solliciter du code
|
solicit_code | True | string |
Instructions de communication et/ou restrictions pour un constituant. |
|
Date de début
|
start_date | date |
Date de début du code de sollicitation (par exemple : « 2005-09-18 »). |
|
|
Date de fin
|
end_date | date |
Date de fin du code de sollicitation (par exemple : « 2005-09-18 »). |
Retours
Code de sollicitation constituant créé
Créer un constituant individuel
Crée un constituant individuel.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Titre
|
title | string |
Titre principal de la constituante. |
|
|
Prénom
|
first | string |
Prénom de la constituante. Limite de caractères : 50. |
|
|
Nom
|
last | True | string |
Nom de la constituante. Limite de caractères : 100. |
|
Suffixe
|
suffix | string |
Suffixe principal de la constituante. |
|
|
ID de recherche
|
lookup_id | string |
Identificateur défini par l’utilisateur pour la constituante. |
|
|
type
|
type | True | string |
Type d’adresse. |
|
country
|
country | string |
Pays de l’adresse (il peut s’agir de l’ID, du nom ou de l’abréviation). |
|
|
Lignes
|
address_lines | string |
Lignes d’adresse. Limite de caractères : 150. |
|
|
city
|
city | string |
Ville de l’adresse (ne pas utiliser en combinaison avec le champ banlieue). |
|
|
état
|
state | string |
État de l’adresse. |
|
|
code postal
|
postal_code | string |
Code postal de l’adresse. Limite de caractères : 12. |
|
|
banlieue
|
suburb | string |
Banlieue de l’adresse (ne pas utiliser en combinaison avec le champ Ville). |
|
|
comté
|
county | string |
Le comté de l’adresse. |
|
|
start
|
start | date |
Date à laquelle la constituante a commencé à résider à cette adresse (par exemple : '2005-09-18'). |
|
|
end
|
end | date |
Date à laquelle la constituante a cessé de résider à cette adresse (par exemple : '2005-09-18'). |
|
|
type
|
type | True | string |
Type de téléphone. |
|
nombre
|
number | True | string |
Numéro de téléphone. |
|
est primaire ?
|
primary | boolean |
Est-ce le numéro de téléphone principal de la constituante ? |
|
|
type
|
type | True | string |
Type d’adresse e-mail. |
|
address
|
address | True | string |
Adresse e-mail. |
|
est primaire ?
|
primary | boolean |
S’agit-il de l’adresse e-mail principale de la constituante ? |
|
|
type
|
type | True | string |
Type de présence en ligne. |
|
address
|
address | True | string |
Adresse web de la présence en ligne. |
|
est primaire ?
|
primary | boolean |
S’agit-il de la présence en ligne principale de la constituante ? |
|
|
Nom préféré
|
preferred_name | string |
Nom préféré de la constituante. Limite de caractères : 50. |
|
|
Deuxième prénom
|
middle | string |
Le prénom de la constituante. Limite de caractères : 50. |
|
|
Ancien nom
|
former_name | string |
L’ancien nom de la constituante. Limite de caractères : 100. |
|
|
Titre 2
|
title_2 | string |
Titre secondaire de la constituante. |
|
|
Suffixe 2
|
suffix_2 | string |
Suffixe secondaire de la constituante. |
|
|
Gender
|
gender | string |
Le sexe de la constituante. |
|
|
Situation de famille
|
marital_status | string |
L’état conjugal de la constituante. |
|
|
Donne anonymement ?
|
gives_anonymously | boolean |
La constituante donne-t-elle anonymement ? |
|
|
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. |
|
|
Lieu de naissance
|
birthplace | string |
Le lieu de naissance de la constituante. |
|
|
Ethnicité
|
ethnicity | string |
L’ethnicité de la constituante. |
|
|
Revenu
|
income | string |
Revenu de la constituante. |
|
|
Religion
|
religion | string |
La religion de la constituante. |
|
|
Destinataire personnalisé ?
|
custom_format | boolean |
Le destinataire principal est-il un format personnalisé ? |
|
|
Format du destinataire
|
configuration_id | string |
Configuration du destinataire principal (obligatoire, sauf si un format personnalisé est utilisé). |
|
|
Nom personnalisé du destinataire
|
formatted_name | string |
Nom mis en forme du destinataire principal (obligatoire lorsqu’un format personnalisé est utilisé). Limite de caractères : 255. |
|
|
Salutation personnalisée ?
|
custom_format | boolean |
La salutation principale est-elle un format personnalisé ? |
|
|
Format salutation
|
configuration_id | string |
Configuration de salutation principale (obligatoire, sauf si un format personnalisé est utilisé). |
|
|
Nom personnalisé salutation
|
formatted_name | string |
Nom mis en forme de salutation primaire (obligatoire lorsqu’un format personnalisé est utilisé). Limite de caractères : 255. |
Retours
Création d’une constituante individuelle
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 emplacement de document
Crée un identificateur de document unique et un emplacement de chargement pour une utilisation avec des pièces jointes physiques. La réponse inclut des instructions sur l’emplacement et la façon de charger le contenu du document.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nom de fichier
|
file_name | string |
Nom de fichier du document à charger. |
|
|
Inclure une miniature ?
|
upload_thumbnail | boolean |
Inclure un emplacement de document miniature ? |
Retours
Définition de fichier
Créer un enregistrement de consentement constituant
Crée un enregistrement de consentement constituant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID constituant
|
constituent_id | True | string |
ID d’enregistrement système du constituant associé à l’enregistrement de consentement. |
|
Canal
|
channel | True | string |
Canal auquel la réponse de consentement s’applique. |
|
Catégorie
|
category | string |
Catégorie à laquelle la réponse de consentement s’applique. |
|
|
Origine
|
source | string |
Source de la réponse de consentement de la constituante. |
|
|
Réponse
|
constituent_consent_response | True | string |
Comment l’constituant a répondu au consentement pour le canal/catégorie spécifié. |
|
Date
|
consent_date | True | date-time |
Date de réception de la réponse de consentement (par exemple : « 2020-09-18T04:13:56Z »). |
|
Déclaration de consentement
|
consent_statement | string |
L’énoncé auquel la constituante a répondu lors de la fourniture du consentement. |
|
|
Avis de confidentialité
|
privacy_notice | string |
Avis de confidentialité fourni à la constituante. |
Retours
Consentement constituant créé
Créer un lot cadeau
Crée un lot cadeau.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Descriptif
|
batch_description | string |
Description du lot. |
|
|
Nombre attendu
|
expected_number | integer |
Nombre de cadeaux attendus dans le lot. |
|
|
Total attendu
|
expected_batch_total | double |
Valeur totale des cadeaux dans le lot. |
|
|
Numéro de lot
|
batch_number | string |
Identificateur unique spécifique au lot. |
Retours
Lot cadeau 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. |
Retours
Participant créé
Créer un téléphone constituant
Crée un téléphone constituant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID constituant
|
constituent_id | True | string |
ID d’enregistrement système de la constituante associée au téléphone. |
|
Type
|
type | True | string |
Type de téléphone. |
|
Number
|
number | True | string |
Numéro de téléphone. |
|
Primaire?
|
primary | boolean |
C’est le téléphone principal de la constituante ? |
|
|
N’appelez pas ?
|
do_not_call | boolean |
Le constituant peut-il être contacté à ce numéro ? |
|
|
Inactif?
|
inactive | boolean |
Ce numéro de téléphone est-il inactif ? |
Retours
Téléphone constituant 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éé
- Corps
- EventApi.CreatedEvent
Créer une action constituante
Crée une action constituante.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID constituant
|
constituent_id | True | string |
ID d’enregistrement système de la constituante associée à l’action. |
|
Catégorie
|
category | True | string |
Canal ou intention de l’interaction constituante. |
|
Terminé?
|
completed | boolean |
L’action est-elle terminée ? Si le système est configuré pour utiliser des états d’action personnalisés, cette valeur est basée sur la valeur d’état de l’action. |
|
|
Effectué le
|
completed_date | date-time |
Date à laquelle l’action a été terminée (par exemple : '2020-09-18T04:13:56Z'). |
|
|
Date
|
date | True | date-time |
Date de l’action (par exemple : '2020-09-18T04:13:56Z'). |
|
Note
|
description | string |
Explication détaillée qui s’explique sur le résumé de l’action. |
|
|
Direction
|
direction | string |
Direction de l’action. |
|
|
Collecte de fonds
|
fundraisers | array of string |
Ensemble d’ID d’enregistrement système pour les collectes de fonds associées à l’action. |
|
|
Emplacement
|
location | string |
Emplacement de l’action. |
|
|
ID d’opportunité
|
opportunity_id | string |
ID d’enregistrement système de l’opportunité associée à l’action. |
|
|
Résultat
|
outcome | string |
Résultat de l’action. |
|
|
Priority
|
priority | string |
Priorité de l’action. |
|
|
Heure de début
|
start_time | string |
Heure de début de l’action. Utilise une heure de 24 heures au format HH :mm. |
|
|
Heure de fin
|
end_time | string |
Heure de fin de l’action. Utilise une heure de 24 heures au format HH :mm. |
|
|
Statut
|
status | string |
État de l’action. |
|
|
Résumé
|
summary | string |
Brève description de l’action qui apparaît en haut de l’enregistrement. Limite de caractères : 255. |
|
|
Type
|
type | string |
Description supplémentaire de l’action pour compléter la catégorie. |
Retours
Action créée
Créer une adresse constituante
Crée une adresse constituante.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID constituant
|
constituent_id | True | string |
ID d’enregistrement système du constituant associé à l’adresse. |
|
Type d’adresse
|
type | True | string |
Type d’adresse. |
|
Pays
|
country | string |
Pays de l’adresse (il peut s’agir de l’ID, du nom ou de l’abréviation). |
|
|
Lignes d’adresse
|
address_lines | string |
Lignes d’adresse. |
|
|
Ville
|
city | string |
Ville de l’adresse (ne pas utiliser en combinaison avec le champ banlieue). |
|
|
État
|
state | string |
État de l’adresse. |
|
|
Code postal
|
postal_code | string |
Code postal de l’adresse. |
|
|
Banlieue
|
suburb | string |
Banlieue de l’adresse (ne pas utiliser en combinaison avec le champ Ville). |
|
|
Commune
|
county | string |
Le comté de l’adresse. |
|
|
Source d’informations
|
information_source | string |
Source d’informations de l’adresse. |
|
|
Région
|
region | string |
Région de l’adresse. |
|
|
CHARRETTE
|
cart | string |
Itinéraire du transporteur (CART) pour l’adresse. |
|
|
LOT
|
lot | string |
Ligne de voyage (LOT) pour l’adresse. |
|
|
DPC
|
dpc | string |
Code de point de remise (DPC) pour l’adresse. |
|
|
Valide à partir de
|
start | date |
Date à laquelle la constituante a commencé à résider à cette adresse (par exemple : '2005-09-18'). |
|
|
Valide pour
|
end | date |
Date à laquelle la constituante a cessé de résider à cette adresse (par exemple : '2005-09-18'). |
|
|
Primaire?
|
preferred | boolean |
S’agit-il de l’adresse préférée de la constituante ? |
|
|
Ne pas envoyer de courrier électronique ?
|
do_not_mail | boolean |
Le constituant peut-il être contacté à cette adresse ? |
|
|
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. |
Retours
Adresse constituante créée
Créer une adresse e-mail constituante
Crée une adresse e-mail constituante.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID constituant
|
constituent_id | True | string |
ID d’enregistrement système du constituant associé à l’adresse e-mail. |
|
Type d’e-mail
|
type | True | string |
Type d’adresse e-mail. |
|
Adresse de messagerie
|
address | True | string |
Adresse e-mail. |
|
Primaire?
|
primary | boolean |
S’agit-il de l’adresse e-mail principale de la constituante ? |
|
|
N’envoyez pas d’e-mail ?
|
do_not_email | boolean |
Le constituant peut-il être contacté à cette adresse e-mail ? |
|
|
Inactif?
|
inactive | boolean |
Cette adresse e-mail est-elle inactive ? |
Retours
Adresse e-mail constituante créée
Créer une affectation de collecte de fonds
Crée une affectation de collecte de fonds.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de collecte de fonds
|
fundraiser_id | True | string |
ID d’enregistrement système de la collecte de fonds. |
|
ID constituant
|
constituent_id | True | string |
ID d’enregistrement système de la constituante affectée. |
|
Type
|
type | string |
Type de collecte de fonds. |
|
|
Début de l’affectation
|
start | date-time |
Date de début de l’affectation. |
|
|
Fin de l’affectation
|
end | date-time |
Date de fin de l’affectation. |
|
|
Montant
|
value | True | double |
Montant de l’objectif de collecte de fonds à solliciter auprès de la constituante affectée. |
|
ID de campagne
|
campaign_id | string |
ID d’enregistrement système de la campagne à laquelle les dons résultants seront appliqués. |
|
|
ID du fonds
|
fund_id | string |
ID d’enregistrement système du fonds auquel les dons résultants seront appliqués. |
|
|
ID d’appel
|
appeal_id | string |
ID d’enregistrement système de l’appel auquel les dons résultants seront appliqués. |
Retours
Création d’une affectation de collecte de fonds
Créer une liste à partir d’un ensemble d’enregistrements
Crée une liste filtrée sur le jeu d’enregistrements spécifié.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nom
|
name | True | string |
Nom de la liste. Limite de caractères : 50. |
|
Descriptif
|
description | True | string |
Description de la liste. |
|
Type de liste
|
list_type | True | string |
Détermine le type de liste à créer. |
|
Permissions
|
list_permissions | True | string |
Détermine si d’autres utilisateurs peuvent accéder à la liste. |
|
ID(s)
|
ids | True | array of string |
Identificateurs uniques pour les enregistrements contenus dans la liste (valeur maximale de 100 000 valeurs). |
Retours
Liste créée
- Corps
- ListApi.CreatedList
Créer une note constituante
Crée une note constituante.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID constituant
|
constituent_id | True | string |
ID d’enregistrement système de la constituante associée à la note. |
|
Type
|
type | True | string |
Type de note. |
|
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. |
|
|
Résumé
|
summary | string |
Résumé de la note. Limite de caractères : 50. |
|
|
Note
|
text | string |
Texte de la note. |
Retours
Note constituante créée
Créer une opportunité
Crée une nouvelle opportunité.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID constituant
|
constituent_id | True | string |
ID d’enregistrement système de la constituante associée à l’opportunité. |
|
Objectif
|
purpose | True | string |
Utilisation prévue pour toute somme levée suite à l’opportunité. |
|
Nom
|
name | True | string |
Nom qui identifie l’opportunité tout au long du programme, par exemple dans les listes ou dans les dossiers constituants. Limite de caractères : 255. |
|
Statut
|
status | string |
Le statut qui indique où se trouve l’opportunité dans le processus de sollicitation. |
|
|
Échéance
|
deadline | date-time |
Date d’objectif de l’occasion de produire un cadeau (par exemple : '2020-09-18T04:13:56Z'). |
|
|
Demander la date
|
ask_date | date-time |
Date à laquelle la sollicitation a été faite (ex : '2020-09-18T04:13:56Z'). |
|
|
value
|
value | double |
Valeur monétaire. |
|
|
Date attendue
|
expected_date | date-time |
Date à laquelle la perspective devrait donner suite à l’opportunité (par exemple : '2020-09-18T04:13:56Z'). |
|
|
value
|
value | double |
Valeur monétaire. |
|
|
Date de financement
|
funded_date | date-time |
Date à laquelle la perspective a donné suite à l’opportunité (par exemple : '2020-09-18T04:13:56Z'). |
|
|
value
|
value | double |
Valeur monétaire. |
|
|
ID de campagne
|
campaign_id | string |
ID d’enregistrement système de la campagne associée à l’opportunité. La campagne définit les objectifs globaux de collecte d’argent. |
|
|
ID du fonds
|
fund_id | string |
ID d’enregistrement système du fonds associé à l’opportunité. Le fonds désigne l’objectif financier spécifique d’un cadeau et identifie le compte financier de ce cadeau. |
|
|
ID constituant
|
constituent_id | string |
ID d’enregistrement système du constituant associé à la collecte de fonds. |
|
|
value
|
value | double |
Valeur monétaire. |
|
|
Inactif?
|
inactive | boolean |
L’opportunité est-elle inactive ? |
Retours
Opportunité créée
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 organisation constituante
Crée une organisation constituante.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nom
|
name | True | string |
Nom de l’organisation. Limite de caractères : 100. |
|
ID de recherche
|
lookup_id | string |
Identificateur défini par l’utilisateur pour la constituante. |
|
|
type
|
type | True | string |
Type d’adresse. |
|
country
|
country | string |
Pays de l’adresse (il peut s’agir de l’ID, du nom ou de l’abréviation). |
|
|
Lignes
|
address_lines | string |
Lignes d’adresse. Limite de caractères : 150. |
|
|
city
|
city | string |
Ville de l’adresse (ne pas utiliser en combinaison avec le champ banlieue). |
|
|
état
|
state | string |
État de l’adresse. |
|
|
code postal
|
postal_code | string |
Code postal de l’adresse. Limite de caractères : 12. |
|
|
banlieue
|
suburb | string |
Banlieue de l’adresse (ne pas utiliser en combinaison avec le champ Ville). |
|
|
comté
|
county | string |
Le comté de l’adresse. |
|
|
start
|
start | date |
Date à laquelle la constituante a commencé à résider à cette adresse (par exemple : '2005-09-18'). |
|
|
end
|
end | date |
Date à laquelle la constituante a cessé de résider à cette adresse (par exemple : '2005-09-18'). |
|
|
type
|
type | True | string |
Type de téléphone. |
|
nombre
|
number | True | string |
Numéro de téléphone. |
|
est primaire ?
|
primary | boolean |
Est-ce le numéro de téléphone principal de la constituante ? |
|
|
type
|
type | True | string |
Type d’adresse e-mail. |
|
address
|
address | True | string |
Adresse e-mail. |
|
est primaire ?
|
primary | boolean |
S’agit-il de l’adresse e-mail principale de la constituante ? |
|
|
type
|
type | True | string |
Type de présence en ligne. |
|
address
|
address | True | string |
Adresse web de la présence en ligne. |
|
est primaire ?
|
primary | boolean |
S’agit-il de la présence en ligne principale de la constituante ? |
|
|
Donne anonymement ?
|
gives_anonymously | boolean |
La constituante donne-t-elle anonymement ? |
|
|
Secteur d’activité
|
industry | string |
L’industrie de la constituante. |
|
|
Nombre d’employés
|
num_employees | integer |
Nombre d’employés de l’organisation. |
|
|
Correspond aux cadeaux ?
|
matches_gifts | boolean |
L’organisation correspond-elle aux cadeaux ? |
|
|
Facteur cadeau correspondant
|
matching_gift_factor | double |
Facteur cadeau correspondant. |
|
|
Correspondance minimale par cadeau
|
value | double |
Montant minimal de correspondance par cadeau pour la constituante. |
|
|
Correspondance maximale par cadeau
|
value | double |
Montant maximal de correspondance par cadeau pour la constituante. |
|
|
Correspondance minimale par constit
|
value | double |
Total des correspondances minimales pour la constituante. |
|
|
Correspondance maximale par constit
|
value | double |
Nombre maximal de correspondances pour la constituante. |
|
|
Notes de cadeau correspondantes
|
matching_gift_notes | string |
Notes de cadeau correspondantes pour la constituante. |
Retours
Création d’une organisation constituante
Créer une pièce jointe cadeau
Crée une pièce jointe cadeau.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID cadeau
|
parent_id | True | string |
ID d’enregistrement système du cadeau associé à la pièce jointe. |
|
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. |
Retours
Pièce jointe cadeau créée
Créer une pièce jointe constituante
Crée une pièce jointe constituante.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID constituant
|
parent_id | True | string |
ID d’enregistrement système du composant associé à la pièce jointe. |
|
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. |
Retours
Pièce jointe constituante créée
Créer une pièce jointe de campagne
Crée une pièce jointe de campagne.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de campagne
|
parent_id | True | string |
ID d’enregistrement système de la campagne associée à la pièce jointe. |
|
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. |
Retours
Pièce jointe de campagne créée
Créer une pièce jointe de fonds
Crée une pièce jointe de fonds.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID du fonds
|
parent_id | True | string |
ID d’enregistrement système du fonds associé à la pièce jointe. |
|
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. |
Retours
Pièce jointe de fonds créée
Créer une pièce jointe d’action
Crée une pièce jointe d’action.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’action
|
parent_id | True | string |
ID d’enregistrement système de l’action associée à la pièce jointe. |
|
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. |
Retours
Pièce jointe d’action créée
Créer une pièce jointe d’appel
Crée une pièce jointe d’appel.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’appel
|
parent_id | True | string |
ID d’enregistrement système de l’appel associé à la pièce jointe. |
|
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. |
Retours
Pièce jointe d’appel créée
Créer une pièce jointe d’opportunité
Crée une pièce jointe d’opportunité.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’opportunité
|
parent_id | True | string |
ID d’enregistrement système de l’opportunité associée à la pièce jointe. |
|
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. |
Retours
Pièce jointe d’opportunité créée
Créer une présence en ligne constituante
Crée une présence en ligne constituante.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID constituant
|
constituent_id | True | string |
ID d’enregistrement système du constituant associé à la présence en ligne. |
|
Type
|
type | True | string |
Type de présence en ligne. |
|
Lien
|
address | True | string |
Adresse web de la présence en ligne. |
|
Primaire?
|
primary | boolean |
S’agit-il de la présence en ligne principale de la constituante ? |
|
|
Inactif?
|
inactive | boolean |
Cette présence en ligne est-elle inactive ? |
Retours
Création d’une présence en ligne constituante
Créer une relation d’organisation
Crée une relation d’organisation. Si la relation est avec une autre constituante, une relation réciproque est créée pour cette constituante.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID constituant
|
constituent_id | True | string |
ID d’enregistrement système du constituant associé à la relation. |
|
Relation ID
|
relation_id | True | string |
ID d’enregistrement système de l’organisation associée. |
|
Type
|
type | string |
Type de relation que la relation représente. |
|
|
Type réciproque
|
reciprocal_type | string |
Décrit la relation de la constituante à l’organisation associée. |
|
|
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. |
|
|
Est-ce que le contact ?
|
is_organization_contact | boolean |
La constituante représente-t-elle cette organisation en tant que contact ? |
|
|
Type de contact
|
organization_contact_type | string |
Fournit un contexte pour les interactions avec la personne associée qui représente l’organisation en tant que contact. |
|
|
Poste
|
position | string |
Position de l’individu dans l’organisation. Limite de caractères : 50. |
|
|
L’entreprise principale est-elle principale ?
|
is_primary_business | boolean |
Est-ce que c’est l’entreprise principale de la constituante ? |
|
|
Remarques
|
comment | string |
Remarques supplémentaires sur la relation. |
Retours
Relation organisationnelle créée
Créer une relation individuelle
Crée une relation individuelle. Si la relation est avec une autre constituante, une relation réciproque est créée pour cette constituante.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID constituant
|
constituent_id | True | string |
ID d’enregistrement système du constituant associé à la relation. |
|
Relation ID
|
relation_id | True | string |
ID d’enregistrement système de l’individu associé. |
|
Type
|
type | string |
Type de relation que la relation représente. |
|
|
Type réciproque
|
reciprocal_type | string |
Décrit la relation de la constituante à la constituante associée. Par exemple, dans une relation entre un constituant masculin et un frère féminin, le type de relation réciproque serait frère. |
|
|
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. |
|
|
Le conjoint est-il ?
|
is_spouse | boolean |
L’individu associé est-il le conjoint de la constituante ? |
|
|
Est-ce que le chef de famille constituant ?
|
is_constituent_head_of_household | boolean |
Est-ce que la constituante est le chef du foyer ? |
|
|
Le conjoint est-il le chef de famille ?
|
is_spouse_head_of_household | boolean |
Le conjoint est-il le chef du foyer ? |
|
|
Remarques
|
comment | string |
Remarques supplémentaires sur la relation. |
Retours
Création d’une relation individuelle
Créer une éducation constituante
Crée une éducation constituante.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID constituant
|
constituent_id | True | string |
ID d’enregistrement système de la constituante associée à l’éducation. |
|
École
|
school | True | string |
Nom de l’établissement scolaire ou de l’établissement. |
|
Type
|
type | string |
Le type d’éducation. |
|
|
Classe de
|
class_of | string |
L’année où l’constituant est diplômé. |
|
|
Statut
|
status | string |
État de l’éducation. |
|
|
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. |
|
|
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. |
|
|
Degré
|
degree | string |
Degré reçu. |
|
|
GPA
|
gpa | double |
Moyenne du point de note. |
|
|
Objet de l’étude
|
subject_of_study | string |
L’objet de l’étude. |
|
|
Primaire?
|
primary | boolean |
Est-ce que c’est l’association primaire de la constituante ? |
|
|
Majors
|
majors | array of string |
Les grands cours d’étude. |
|
|
Mineurs
|
minors | array of string |
Les cours secondaires d’étude. |
|
|
Campus
|
campus | string |
Le campus. Limite de caractères : 50. |
|
|
Organisation sociale
|
social_organization | string |
L’organisation sociale. Limite de caractères : 50. |
|
|
Nom connu
|
known_name | string |
Nom connu. Limite de caractères : 50. |
|
|
Classe de degré
|
class_of_degree | string |
Classe de diplôme (applicable uniquement aux versions du Royaume-Uni). |
|
|
Département
|
department | string |
Nom du service éducation (applicable uniquement aux versions du Royaume-Uni). |
|
|
Faculté
|
faculty | string |
Nom de la faculté (applicable uniquement aux versions britanniques). |
|
|
Numéro d’inscription
|
registration_number | string |
Numéro d’inscription (applicable uniquement aux versions du Royaume-Uni). Limite de caractères : 50. |
Retours
Création d’une éducation constituante
Créer une évaluation constituante
Crée une évaluation constituante.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
Objet qui représente l’évaluation à créer. |
Retours
Évaluation constituante créée
Liste des constituants
Retourne une liste de constituants.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Liste
|
list_id | string |
Définit un identificateur de liste utilisé pour filtrer l’ensemble des constituants sur ceux inclus dans la liste spécifiée. Si cette valeur est définie, d’autres filtres spécifiés sont ignorés. |
|
|
Limit
|
limit | integer |
Représente le nombre d’enregistrements à retourner. La valeur par défaut est 500. La valeur maximale est de 5 000. |
|
|
Décalage
|
offset | integer |
Représente le nombre d’enregistrements à ignorer. Pour une utilisation avec la pagination. |
|
|
Code constituant
|
constituent_code | string |
Représente un code constituant pour filtrer la liste. Par exemple, « Membre du conseil » retourne uniquement les constituants avec un code constituant du conseil d’administration. |
|
|
ID constituant
|
constituent_id | string |
Représente une liste séparée par des virgules d’identificateurs constituants pour filtrer les résultats. Par exemple, « 280 1232 » retourne uniquement 280 constituants ou 1232. |
|
|
Catégorie de champ personnalisé
|
custom_field_category | string |
Représente une catégorie de champ personnalisée pour filtrer les résultats. Par exemple, « Anniversaire » retourne uniquement les constituants avec un champ personnalisé Anniversaire actif. |
|
|
État de collecte de fonds
|
fundraiser_status | string |
Représente une liste séparée par des virgules des états de collecte de fonds pour filtrer les résultats. Par exemple, « Actif, Aucun » retourne uniquement les constituants dont l’état de collecte de fonds est Actif ou Aucun. Les valeurs valides pour ce filtre sont Actives, Inactives et None. |
|
|
Inclure décédé ?
|
include_deceased | boolean |
Inclure les constituants décédés dans la réponse ? |
|
|
Inclure inactif ?
|
include_inactive | boolean |
Inclure des constituants inactifs dans la réponse ? |
|
|
Code postal
|
postal_code | string |
Représente une liste séparée par des virgules de codes postaux pour filtrer les résultats. Par exemple, « 29466,29492 » retourne uniquement les constituants dont l’adresse préférée a un code postal commençant par 29466 ou 29492, comme 29466, 29492 ou 29492-0727. |
|
|
Ajouté ou après
|
date_added | date-time |
Filtrez les résultats sur les constituants créés le 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 constituants modifiés ou après la date spécifiée (par exemple : '2020-09-18T04:13:56Z'). |
|
|
Trié par
|
sort | string |
Représente une liste de champs pour trier les résultats. Les résultats sont dans l’ordre croissant par défaut, et un signe « - » indique l’ordre décroissant. Par exemple, « date_added,-last » trie les constituants par le champ « date_added » dans l’ordre croissant, puis par le champ « dernier » dans l’ordre décroissant. |
Retours
Constituants
Lister les appels
Retourne une liste d’appels.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
Représente le nombre d’enregistrements à retourner. La valeur par défaut est 500. La valeur maximale est de 5 000. |
|
|
Décalage
|
offset | integer |
Représente le nombre d’enregistrements à ignorer. Pour une utilisation avec la pagination. |
|
|
Inclure inactif ?
|
include_inactive | boolean |
Inclure des appels inactifs ? |
|
|
Ajouté ou après
|
date_added | date-time |
Filtrez les résultats en appel 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 pour les appels modifiés ou après la date spécifiée (par exemple : « 2020-09-18T04:13:56Z »). |
Retours
Appels
Lister les notes constituantes
Répertorie les notes d’un constituant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID constituant
|
constituent_id | True | string |
ID d’enregistrement système de la constituante. |
Retours
Remarques
Lister les pièces jointes d’action
Répertorie les pièces jointes d’une action.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’action
|
action_id | True | string |
ID d’enregistrement système de l’action. |
Retours
Attachments
Lister les pièces jointes d’appel
Répertorie les pièces jointes pour un appel.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’appel
|
appeal_id | True | string |
ID d’enregistrement système de l’appel. |
Retours
Attachments
Lister les téléphones constituants
Répertorie les téléphones d’un constituant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID constituant
|
constituent_id | True | string |
ID d’enregistrement système de la constituante. |
|
Inclure inactif ?
|
include_inactive | boolean |
Inclure des téléphones inactifs ? |
Retours
Téléphones
Mettre à jour les détails de l’accusé de réception du cadeau
Met à jour les détails de l’accusé de réception d’un cadeau.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’accusé de réception
|
acknowledgement_id | True | string |
ID d’enregistrement système de l’accusé de réception cadeau à mettre à jour. Elle utilise l’ID du cadeau parent comme valeur. |
|
Statut
|
status | string |
État de l’accusé de réception. Lorsque l’état est défini sur DoNotAcknowledge, la lettre et la date doivent être null. Lorsque l’état est défini sur NeedsAcknowledgement, la date doit être null. |
|
|
Date
|
date | date-time |
Date associée à l’accusé de réception (par exemple : '2020-09-18T04:13:56Z'). |
|
|
Letter
|
letter | string |
Lettre associée à l’accusé de réception. |
Mettre à jour les détails des reçus de cadeau
Met à jour les détails du reçu pour un cadeau.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de reçu
|
receipt_id | True | string |
ID d’enregistrement système du reçu cadeau à mettre à jour. Elle utilise l’ID du cadeau parent comme valeur. |
|
Statut
|
status | string |
État de réception du cadeau. Lorsque l’état est défini sur NeedsReceipt ou DoNotReceipt, la date de réception doit être null. |
|
|
value
|
value | double |
Valeur monétaire. |
|
|
Date
|
date | date-time |
Date du reçu (par exemple : '2020-09-18T04:13:56Z'). |
|
|
Number
|
number | integer |
Numéro du reçu. |
Mettre à jour un alias constituant
Met à jour un alias constituant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’alias
|
alias_id | True | string |
ID d’enregistrement système de l’alias à mettre à jour. |
|
Alias
|
name | string |
Nom à utiliser comme alias de la constituante. Limite de caractères : 100. |
|
|
Type
|
type | string |
Type d’alias. |
Mettre à jour un champ personnalisé cadeau
Met à jour un champ personnalisé cadeau.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de champ personnalisé
|
custom_field_id | True | string |
ID d’enregistrement système du champ personnalisé à mettre à jour. |
|
body
|
body | True | dynamic |
Objet qui représente les propriétés du champ personnalisé à mettre à jour. |
Mettre à jour un champ personnalisé constituant
Met à jour un champ personnalisé constituant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de champ personnalisé
|
custom_field_id | True | string |
ID d’enregistrement système du champ personnalisé à mettre à jour. |
|
body
|
body | True | dynamic |
Objet qui représente les propriétés du champ personnalisé à mettre à jour. |
Mettre à jour un champ personnalisé de campagne
Met à jour un champ personnalisé de campagne.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de champ personnalisé
|
custom_field_id | True | string |
ID d’enregistrement système du champ personnalisé à mettre à jour. |
|
body
|
body | True | dynamic |
Objet qui représente les propriétés du champ personnalisé à mettre à jour. |
Mettre à jour un champ personnalisé de fonds
Met à jour un champ personnalisé de fonds.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de champ personnalisé
|
custom_field_id | True | string |
ID d’enregistrement système du champ personnalisé à mettre à jour. |
|
body
|
body | True | dynamic |
Objet qui représente les propriétés du champ personnalisé à mettre à jour. |
Mettre à jour un champ personnalisé d’action
Met à jour un champ personnalisé d’action.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de champ personnalisé
|
custom_field_id | True | string |
ID d’enregistrement système du champ personnalisé à mettre à jour. |
|
body
|
body | True | dynamic |
Objet qui représente les propriétés du champ personnalisé à mettre à jour. |
Mettre à jour un champ personnalisé d’appel
Met à jour un champ personnalisé d’appel.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de champ personnalisé
|
custom_field_id | True | string |
ID d’enregistrement système du champ personnalisé à mettre à jour. |
|
body
|
body | True | dynamic |
Objet qui représente les propriétés du champ personnalisé à mettre à jour. |
Mettre à jour un champ personnalisé d’opportunité
Met à jour un champ personnalisé d’opportunité.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de champ personnalisé
|
custom_field_id | True | string |
ID d’enregistrement système du champ personnalisé à mettre à jour. |
|
body
|
body | True | dynamic |
Objet qui représente les propriétés du champ personnalisé à mettre à jour. |
Mettre à jour un code constituant
Met à jour un code constituant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de code constituant
|
constituent_code_id | True | string |
ID d’enregistrement système du code constituant à mettre à jour. |
|
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. |
|
|
Sequence
|
sequence | integer |
Séquence numérique associée au code constituant. |
Mettre à jour un code de sollicitation constituant
Met à jour un code de sollicitation constituant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de code de sollicitation
|
constituent_solicit_code_id | True | string |
ID d’enregistrement système du code sollicité à mettre à jour. |
|
Solliciter du code
|
solicit_code | string |
Instructions de communication et/ou restrictions pour un constituant. |
|
|
Date de début
|
start_date | date |
Date de début du code de sollicitation (par exemple : « 2005-09-18 »). |
|
|
Date de fin
|
end_date | date |
Date de fin du code de sollicitation (par exemple : « 2005-09-18 »). |
Mettre à jour un constituant
Met à jour un constituant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID constituant
|
constituent_id | True | string |
ID d’enregistrement système de la constituante à mettre à jour. |
|
Titre
|
title | string |
Titre principal de la constituante (pour les individus uniquement). |
|
|
Prénom
|
first | string |
Prénom de la constituante (pour les individus uniquement). Limite de caractères : 50. |
|
|
Nom
|
last | string |
Nom de la constituante (pour les individus uniquement). Limite de caractères : 100. |
|
|
Nom de l’organisation
|
name | string |
Pour les personnes, il s’agit d’un champ calculé qui n’est pas applicable aux opérations de modification. Pour l’organisation, ce champ est requis et représente le nom de l’organisation. Limite de caractères : 100. |
|
|
Suffixe
|
suffix | string |
Suffixe principal de la constituante (pour les individus uniquement). |
|
|
Nom préféré
|
preferred_name | string |
Nom préféré de la constituante (pour les individus uniquement). Limite de caractères : 50. |
|
|
ID de recherche
|
lookup_id | string |
Identificateur défini par l’utilisateur pour la constituante. |
|
|
Gender
|
gender | string |
Le sexe de la constituante (pour les individus uniquement). |
|
|
Deuxième prénom
|
middle | string |
Le prénom de la constituante (pour les individus uniquement). Limite de caractères : 50. |
|
|
Ancien nom
|
former_name | string |
L’ancien nom de la constituante (pour les individus uniquement). Limite de caractères : 100. |
|
|
Titre 2
|
title_2 | string |
Titre secondaire de la constituante (pour les individus uniquement). |
|
|
Suffixe 2
|
suffix_2 | string |
Suffixe secondaire de la constituante (pour les individus uniquement). |
|
|
Situation de famille
|
marital_status | string |
L’état conjugal de la constituante (pour les individus uniquement). |
|
|
Donne anonymement ?
|
gives_anonymously | boolean |
La constituante donne-t-elle anonymement ? |
|
|
Inactif?
|
inactive | boolean |
La constituante est-elle inactive ? |
|
|
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. |
|
|
Lieu de naissance
|
birthplace | string |
Lieu de naissance de la constituante (pour les individus uniquement). |
|
|
Ethnicité
|
ethnicity | string |
L’ethnicité de la constituante (pour les individus uniquement). |
|
|
Revenu
|
income | string |
Revenu de la constituante (pour les particuliers uniquement). |
|
|
Religion
|
religion | string |
La religion de la constituante (pour les individus uniquement). |
|
|
Secteur d’activité
|
industry | string |
Industrie de la constituante (pour les organisations uniquement). |
|
|
Nombre d’employés
|
num_employees | integer |
Nombre d’employés de l’organisation. |
|
|
Correspond aux cadeaux ?
|
matches_gifts | boolean |
L’organisation correspond-elle aux cadeaux ? |
|
|
Facteur cadeau correspondant
|
matching_gift_factor | double |
Facteur cadeau correspondant (pour les organisations uniquement). |
|
|
Correspondance minimale par cadeau
|
value | double |
Montant minimal de correspondance par cadeau pour la constituante (pour les organisations uniquement). |
|
|
Correspondance maximale par cadeau
|
value | double |
Montant maximal de correspondance par cadeau pour la constituante (pour les organisations uniquement). |
|
|
Correspondance minimale par constit
|
value | double |
Total des correspondances minimales pour la constituante (pour les organisations uniquement). |
|
|
Correspondance maximale par constit
|
value | double |
Nombre maximal de correspondances pour la constituante (pour les organisations uniquement). |
|
|
Notes de cadeau correspondantes
|
matching_gift_notes | string |
Notes de cadeau correspondantes pour la constituante (pour les organisations uniquement). |
|
|
Décédé?
|
deceased | boolean |
La personne décédée est-elle décédée (pour les individus uniquement) ? |
|
|
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. |
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. |
Mettre à jour un téléphone constituant
Met à jour un téléphone constituant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de téléphone
|
phone_id | True | string |
ID d’enregistrement système du téléphone à mettre à jour. |
|
Type
|
type | string |
Type de téléphone. |
|
|
Number
|
number | string |
Numéro de téléphone. |
|
|
Primaire?
|
primary | boolean |
C’est le téléphone principal de la constituante ? |
|
|
N’appelez pas ?
|
do_not_call | boolean |
Le constituant peut-il être contacté à ce numéro ? |
|
|
Inactif?
|
inactive | boolean |
Ce numéro de téléphone est-il inactif ? |
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 action constituante
Met à jour une action constituante.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’action
|
action_id | True | string |
ID d’enregistrement système de l’action à mettre à jour. |
|
Catégorie
|
category | string |
Canal ou intention de l’interaction constituante. |
|
|
Terminé?
|
completed | boolean |
L’action est-elle terminée ? Si le système est configuré pour utiliser des états d’action personnalisés, cette valeur est basée sur la valeur d’état de l’action. |
|
|
Effectué le
|
completed_date | date-time |
Date à laquelle l’action a été terminée (par exemple : '2020-09-18T04:13:56Z'). |
|
|
Date
|
date | date-time |
Date de l’action (par exemple : '2020-09-18T04:13:56Z'). |
|
|
Note
|
description | string |
Explication détaillée qui s’explique sur le résumé de l’action. |
|
|
Direction
|
direction | string |
Direction de l’action. |
|
|
Collecte de fonds
|
fundraisers | array of string |
Ensemble d’ID d’enregistrement système pour les collectes de fonds associées à l’action. |
|
|
Emplacement
|
location | string |
Emplacement de l’action. |
|
|
ID d’opportunité
|
opportunity_id | string |
ID d’enregistrement système de l’opportunité associée à l’action. |
|
|
Résultat
|
outcome | string |
Résultat de l’action. |
|
|
Priority
|
priority | string |
Priorité de l’action. |
|
|
Heure de début
|
start_time | string |
Heure de début de l’action. Utilise une heure de 24 heures au format HH :mm. |
|
|
Heure de fin
|
end_time | string |
Heure de fin de l’action. Utilise une heure de 24 heures au format HH :mm. |
|
|
Statut
|
status | string |
État de l’action. |
|
|
Résumé
|
summary | string |
Brève description de l’action qui apparaît en haut de l’enregistrement. Limite de caractères : 255. |
|
|
Type
|
type | string |
Description supplémentaire de l’action pour compléter la catégorie. |
Mettre à jour une adresse constituante
Met à jour une adresse constituante.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’adresse
|
address_id | True | string |
ID d’enregistrement système de l’adresse à mettre à jour. |
|
Type d’adresse
|
type | string |
Type d’adresse. |
|
|
Pays
|
country | string |
Pays de l’adresse (il peut s’agir de l’ID, du nom ou de l’abréviation). |
|
|
Lignes d’adresse
|
address_lines | string |
Lignes d’adresse. |
|
|
Ville
|
city | string |
Ville de l’adresse (ne pas utiliser en combinaison avec le champ banlieue). |
|
|
État
|
state | string |
État de l’adresse. |
|
|
Code postal
|
postal_code | string |
Code postal de l’adresse. |
|
|
Banlieue
|
suburb | string |
Banlieue de l’adresse (ne pas utiliser en combinaison avec le champ Ville). |
|
|
Commune
|
county | string |
Le comté de l’adresse. |
|
|
Source d’informations
|
information_source | string |
Source d’informations de l’adresse. |
|
|
Région
|
region | string |
Région de l’adresse. |
|
|
CHARRETTE
|
cart | string |
Itinéraire du transporteur (CART) pour l’adresse. |
|
|
LOT
|
lot | string |
Ligne de voyage (LOT) pour l’adresse. |
|
|
DPC
|
dpc | string |
Code de point de remise (DPC) pour l’adresse. |
|
|
Valide à partir de
|
start | date |
Date à laquelle la constituante a commencé à résider à cette adresse (par exemple : '2005-09-18'). |
|
|
Valide pour
|
end | date |
Date à laquelle la constituante a cessé de résider à cette adresse (par exemple : '2005-09-18'). |
|
|
Primaire?
|
preferred | boolean |
S’agit-il de l’adresse préférée de la constituante ? |
|
|
Ne pas envoyer de courrier électronique ?
|
do_not_mail | boolean |
Le constituant peut-il être contacté à cette adresse ? |
|
|
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. |
Mettre à jour une adresse e-mail constituante
Met à jour une adresse e-mail constituante.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’adresse e-mail
|
email_address_id | True | string |
ID d’enregistrement système de l’adresse e-mail à mettre à jour. |
|
Type d’e-mail
|
type | string |
Type d’adresse e-mail. |
|
|
Adresse de messagerie
|
address | string |
Adresse e-mail. |
|
|
Primaire?
|
primary | boolean |
S’agit-il de l’adresse e-mail principale de la constituante ? |
|
|
N’envoyez pas d’e-mail ?
|
do_not_email | boolean |
Le constituant peut-il être contacté à cette adresse e-mail ? |
|
|
Inactif?
|
inactive | boolean |
Cette adresse e-mail est-elle inactive ? |
Mettre à jour une image de profil constituante
Met à jour l’image de profil actuelle pour un constituant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID constituant
|
constituent_id | True | string |
ID d’enregistrement système de la constituante dont l’image de profil doit être mise à jour. |
|
Nom de fichier
|
file_name | True | string |
Le nom du fichier. |
|
Document ID
|
document_id | True | uuid |
Identificateur de document. |
|
ID de miniature
|
thumbnail_id | True | uuid |
Identificateur du document miniature. |
Mettre à jour une note constituante
Met à jour une note constituante.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Note ID
|
note_id | True | string |
ID d’enregistrement système de la note à mettre à jour. |
|
Type
|
type | string |
Type de note. |
|
|
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. |
|
|
Résumé
|
summary | string |
Résumé de la note. Limite de caractères : 50. |
|
|
Note
|
text | string |
Texte de la note. |
Mettre à jour une opportunité
Met à jour une opportunité.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’opportunité
|
opportunity_id | True | string |
ID d’enregistrement système de l’opportunité de mise à jour. |
|
Objectif
|
purpose | string |
Utilisation prévue pour toute somme levée suite à l’opportunité. |
|
|
Nom
|
name | string |
Nom qui identifie l’opportunité tout au long du programme, par exemple dans les listes ou dans les dossiers constituants. Limite de caractères : 255. |
|
|
Statut
|
status | string |
Le statut qui indique où se trouve l’opportunité dans le processus de sollicitation. |
|
|
Échéance
|
deadline | date-time |
Date d’objectif de l’occasion de produire un cadeau (par exemple : '2020-09-18T04:13:56Z'). |
|
|
Demander la date
|
ask_date | date-time |
Date à laquelle la sollicitation a été faite (ex : '2020-09-18T04:13:56Z'). |
|
|
value
|
value | double |
Valeur monétaire. |
|
|
Date attendue
|
expected_date | date-time |
Date à laquelle la perspective devrait donner suite à l’opportunité (par exemple : '2020-09-18T04:13:56Z'). |
|
|
value
|
value | double |
Valeur monétaire. |
|
|
Date de financement
|
funded_date | date-time |
Date à laquelle la perspective a donné suite à l’opportunité (par exemple : '2020-09-18T04:13:56Z'). |
|
|
value
|
value | double |
Valeur monétaire. |
|
|
ID de campagne
|
campaign_id | string |
ID d’enregistrement système de la campagne associée à l’opportunité. La campagne définit les objectifs globaux de collecte d’argent. |
|
|
ID du fonds
|
fund_id | string |
ID d’enregistrement système du fonds associé à l’opportunité. Le fonds désigne l’objectif financier spécifique d’un cadeau et identifie le compte financier de ce cadeau. |
|
|
ID constituant
|
constituent_id | string |
ID d’enregistrement système du constituant associé à la collecte de fonds. |
|
|
value
|
value | double |
Valeur monétaire. |
|
|
Inactif?
|
inactive | boolean |
L’opportunité est-elle inactive ? |
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 cadeau
Met à jour une pièce jointe cadeau.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
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. |
Mettre à jour une pièce jointe constituante
Met à jour une pièce jointe constituante.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
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. |
Mettre à jour une pièce jointe de campagne
Met à jour une pièce jointe de campagne.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
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. |
Mettre à jour une pièce jointe de fonds
Met à jour une pièce jointe de fonds.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
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. |
Mettre à jour une pièce jointe d’action
Met à jour une pièce jointe d’action.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
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. |
Mettre à jour une pièce jointe d’appel
Met à jour une pièce jointe d’appel.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
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. |
Mettre à jour une pièce jointe d’opportunité
Met à jour une pièce jointe d’opportunité.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
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. |
Mettre à jour une présence en ligne constituante
Met à jour une présence en ligne constituante.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de présence en ligne
|
online_presence_id | True | string |
ID d’enregistrement système de la présence en ligne à mettre à jour. |
|
Type
|
type | string |
Type de présence en ligne. |
|
|
Lien
|
address | string |
Adresse web de la présence en ligne. |
|
|
Primaire?
|
primary | boolean |
S’agit-il de la présence en ligne principale de la constituante ? |
|
|
Inactif?
|
inactive | boolean |
Cette présence en ligne est-elle inactive ? |
Mettre à jour une relation constituante
Met à jour une relation pour un constituant. Si une relation réciproque existe, elle est également modifiée pour refléter les modifications. Cela n’inclut pas les modifications apportées à la propriété « comments », qui est spécifique à chaque enregistrement et peut être modifiée indépendamment sur chaque enregistrement.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de relation
|
relationship_id | True | string |
ID d’enregistrement système de la relation à mettre à jour. |
|
Type
|
type | string |
Type de relation que la relation représente. |
|
|
Type réciproque
|
reciprocal_type | string |
Décrit la relation de la constituante à la constituante associée. Par exemple, dans une relation entre un constituant masculin et un frère féminin, le type de relation réciproque serait frère. |
|
|
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. |
|
|
Le conjoint est-il ?
|
is_spouse | boolean |
L’individu associé est-il le conjoint de la constituante (s’applique-t-il uniquement aux relations entre individus) ? |
|
|
Est-ce que le chef de famille constituant ?
|
is_constituent_head_of_household | boolean |
Est-ce que la constituante est le chef du foyer ? |
|
|
Le conjoint est-il le chef de famille ?
|
is_spouse_head_of_household | boolean |
Le conjoint est-il le chef du foyer ? |
|
|
Remarques
|
comment | string |
Remarques supplémentaires sur la relation. |
|
|
Est-ce que le contact ?
|
is_organization_contact | boolean |
La constituante représente-t-elle cette organisation en tant que contact (s’applique uniquement aux relations entre les organisations et les individus) ? |
|
|
L’entreprise principale est-elle principale ?
|
is_primary_business | boolean |
S’agit-il de l’entreprise principale de la constituante (s’applique uniquement aux relations entre les organisations et les individus) ? |
|
|
Type de contact
|
organization_contact_type | string |
Fournit un contexte pour les interactions avec la personne associée qui représente l’organisation en tant que contact. S’applique uniquement aux relations entre les organisations et les individus. |
|
|
Poste
|
position | string |
Position de l’individu dans l’organisation. S’applique uniquement aux relations entre les organisations et les individus. Limite de caractères : 50. |
Mettre à jour une éducation constituante
Met à jour une éducation constituante.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’éducation
|
education_id | True | string |
ID d’enregistrement système de l’enregistrement d’éducation à mettre à jour. |
|
École
|
school | string |
Nom de l’établissement scolaire ou de l’établissement. |
|
|
Type
|
type | string |
Le type d’éducation. |
|
|
Classe de
|
class_of | string |
L’année où l’constituant est diplômé. |
|
|
Statut
|
status | string |
État de l’éducation. |
|
|
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. |
|
|
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. |
|
|
Degré
|
degree | string |
Degré reçu. |
|
|
GPA
|
gpa | double |
Moyenne du point de note. |
|
|
Objet de l’étude
|
subject_of_study | string |
L’objet de l’étude. |
|
|
Primaire?
|
primary | boolean |
Est-ce que c’est l’association primaire de la constituante ? |
|
|
Majors
|
majors | array of string |
Les grands cours d’étude. |
|
|
Mineurs
|
minors | array of string |
Les cours secondaires d’étude. |
|
|
Campus
|
campus | string |
Le campus. Limite de caractères : 50. |
|
|
Organisation sociale
|
social_organization | string |
L’organisation sociale. Limite de caractères : 50. |
|
|
Nom connu
|
known_name | string |
Nom connu. Limite de caractères : 50. |
|
|
Classe de degré
|
class_of_degree | string |
Classe de degré. |
|
|
Département
|
department | string |
Nom du service d’éducation. |
|
|
Faculté
|
faculty | string |
Nom de la faculté. |
|
|
Numéro d’inscription
|
registration_number | string |
Numéro d’inscription. Limite de caractères : 50. |
Obtenir le dernier cadeau constituant
Retourne le dernier cadeau pour un constituant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID constituant
|
constituent_id | True | string |
ID d’enregistrement système de la constituante. |
Retours
Donner un résumé
Obtenir le plus grand cadeau constituant
Retourne le plus grand cadeau pour un constituant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID constituant
|
constituent_id | True | string |
ID d’enregistrement système de la constituante. |
Retours
Donner un résumé
Obtenir l’état des prospects constituants
Retourne l’état actuel des prospects pour un constituant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID constituant
|
constituent_id | True | string |
ID d’enregistrement système de la constituante pour laquelle l’état de prospect doit être récupéré. |
Retours
État des prospects
Obtenir un appel
Retourne des informations sur un appel.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’appel
|
appeal_id | True | string |
ID d’enregistrement système de l’appel à obtenir. |
Retours
Appeal
Obtenir un cadeau
Retourne des informations sur un cadeau.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID cadeau
|
gift_id | True | string |
ID d’enregistrement système du cadeau à obtenir. |
Retours
Cadeau
- Corps
- GiftApi.GiftRead
Obtenir un constituant
Retourne des informations sur un constituant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID constituant
|
constituent_id | True | string |
ID d’enregistrement système de la constituante à obtenir. |
Retours
Constituant
Obtenir un don de durée de vie constituante
Retourne le résumé de la durée de vie d’un constituant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID constituant
|
constituent_id | True | string |
ID d’enregistrement système de la constituante. |
Retours
Don de durée de vie
Obtenir un fonds
Retourne des informations sur un fonds.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID du fonds
|
fund_id | True | string |
ID d’enregistrement système du fonds à obtenir. |
Retours
Fonds
- Corps
- FundraisingApi.FundRead
Obtenir un package
Retourne des informations sur un package.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID du package
|
package_id | True | string |
ID d’enregistrement système du package à obtenir. |
Retours
Package
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
- Corps
- EventApi.Participant
Obtenir un premier cadeau constituant
Retourne le premier cadeau pour un constituant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID constituant
|
constituent_id | True | string |
ID d’enregistrement système de la constituante. |
Retours
Donner un résumé
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
- Corps
- EventApi.Event
Obtenir une action constituante
Retourne des informations sur une action constituante.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’action
|
action_id | True | string |
ID d’enregistrement système de l’action à obtenir. |
Retours
Action
Obtenir une campagne
Retourne des informations sur une campagne.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de campagne
|
campaign_id | True | string |
ID d’enregistrement système de la campagne à obtenir. |
Retours
Campagne
Obtenir une image de profil constituante
Retourne l’image de profil actuelle d’un constituant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID constituant
|
constituent_id | True | string |
ID d’enregistrement système de la constituante pour laquelle l’image de profil doit être récupérée. |
Retours
Image du profil
Obtenir une opportunité
Retourne des informations sur une opportunité. Remarque : ce point de terminaison retourne la propriété d’état avec une latence d’environ 10 minutes.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’opportunité
|
opportunity_id | True | string |
ID d’enregistrement système de l’opportunité d’obtenir. |
Retours
Opportunité
Rechercher un constituant
Effectue une recherche constituante basée sur le texte de recherche fourni. Prend en charge le prénom, le nom, le nom préféré, l’ancien nom, l’alias, l’adresse e-mail, le numéro de téléphone, l’adresse ou l’ID de recherche. Les combinaisons de noms, telles que le prénom et le nom ou le nom préféré, sont valides, mais la recherche ne prend en charge qu’un seul paramètre à la fois. Par défaut, les recherches incluent les résultats qui ressemblent à vos critères. Par exemple, les recherches de « Smith » incluent des correspondances pour « Smyth » et d’autres orthographes alternatives. Cette recherche ne prend pas en charge les caractères génériques tels que * ou ?. Les résultats de la recherche sont limités à 500 enregistrements.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Texte de recherche
|
search_text | True | string |
Texte de recherche. Prend en charge le prénom, le nom, le nom préféré, l’ancien nom, l’alias, l’adresse e-mail, le numéro de téléphone, l’adresse ou l’ID de recherche. Les combinaisons de noms, telles que le prénom et le nom ou le nom préféré, sont valides, mais la recherche ne prend en charge qu’un seul paramètre à la fois. Par défaut, les recherches incluent les résultats qui ressemblent à vos critères. Par exemple, les recherches de « Smith » incluent des correspondances pour « Smyth » et d’autres orthographes alternatives. Cette recherche ne prend pas en charge les caractères génériques tels que * ou ?. Les résultats de la recherche sont limités à 500 enregistrements. |
|
État de collecte de fonds
|
fundraiser_status | string |
Représente une liste séparée par des virgules des états de collecte de fonds pour filtrer les résultats. Par exemple, « Actif, Aucun » retourne uniquement les constituants dont l’état de collecte de fonds est Actif ou Aucun. Les valeurs valides pour ce filtre sont Actives, Inactives et None. |
|
|
Inclure inactif ?
|
include_inactive | boolean |
Inclure des constituants inactifs dans la réponse ? |
|
|
Champ de recherche
|
search_field | string |
Représente un champ sur lequel effectuer une recherche. Actuellement, il prend uniquement en charge lookup_id. S’il est fourni avec search_text, un constituant avec lookup_id qui correspond à la search_text est retourné. |
|
|
Utilisez une recherche stricte ?
|
strict_search | boolean |
Excluez les constituants dont les noms ressemblent au texte de recherche, mais sont orthographiés différemment ? |
|
|
Limit
|
limit | integer |
Représente le nombre d’enregistrements à retourner. La valeur par défaut est 500. La valeur maximale est de 5 000. |
|
|
Décalage
|
offset | integer |
Représente le nombre d’enregistrements à ignorer. Pour une utilisation avec la pagination. |
Retours
Résultats de la recherche
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. |
|
|
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 actions constituantes
Répertorie les actions d’un constituant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID constituant
|
constituent_id | True | string |
ID d’enregistrement système de la constituante. |
Retours
Actions
Répertorier les adresses constituantes
Répertorie les adresses d’un constituant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID constituant
|
constituent_id | True | string |
ID d’enregistrement système de la constituante. |
|
Inclure inactif ?
|
include_inactive | boolean |
Inclure des adresses inactives ? |
Retours
Addresses
Répertorier les adresses e-mail constituantes
Répertorie les adresses e-mail d’un constituant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID constituant
|
constituent_id | True | string |
ID d’enregistrement système de la constituante. |
|
Inclure inactif ?
|
include_inactive | boolean |
Inclure des adresses e-mail inactives ? |
Retours
Adresses e-mail
Répertorier les affectations de collecte de fonds
Répertoriez les affectations d’une collecte de fonds.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de collecte de fonds
|
fundraiser_id | True | string |
ID d’enregistrement système de la collecte de fonds pour laquelle les affectations doivent être retournées. |
|
Limit
|
limit | integer |
Représente le nombre d’enregistrements à retourner. La valeur par défaut est 500. La valeur maximale est de 5 000. |
|
|
Décalage
|
offset | integer |
Représente le nombre d’enregistrements à ignorer. Pour une utilisation avec la pagination. |
Retours
Assignments
Répertorier les alias constituants
Répertorie les alias d’un constituant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID constituant
|
constituent_id | True | string |
ID d’enregistrement système de la constituante. |
Retours
Aliases
Répertorier les cadeaux
Retourne une liste de cadeaux.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Liste
|
list_id | string |
Définit un identificateur de liste utilisé pour filtrer l’ensemble de cadeaux sur ceux inclus dans la liste spécifiée. Si cette valeur est définie, d’autres filtres spécifiés sont ignorés. |
|
|
Type
|
gift_type | string |
Représente une liste séparée par des virgules de types cadeaux pour filtrer les résultats. Par exemple, « MatchingGiftPledge, RecurringGift » retourne uniquement des cadeaux de type MatchingGiftPledge ou RecurringGift. |
|
|
ID constituant
|
constituent_id | string |
Représente une liste séparée par des virgules d’identificateurs constituants pour filtrer les résultats. Par exemple, « 280 1232 » retourne uniquement les dons de 280 constituants ou 1232. |
|
|
ID de campagne
|
campaign_id | string |
Représente une liste séparée par des virgules d’identificateurs de campagne pour filtrer les résultats. Par exemple, « 506 918 » retourne uniquement des cadeaux à la campagne 506 ou campagne 918. |
|
|
ID du fonds
|
fund_id | string |
Représente une liste séparée par des virgules d’identificateurs de fonds pour filtrer les résultats. Par exemple, « 506 918 » ne retourne que des dons au fonds 506 ou 918. |
|
|
ID d’appel
|
appeal_id | string |
Représente une liste séparée par des virgules d’identificateurs d’appel pour filtrer les résultats. Par exemple, « 506 918 » ne retourne que des cadeaux pour appel 506 ou appel 918. |
|
|
Limit
|
limit | integer |
Représente le nombre d’enregistrements à retourner. La valeur par défaut est 500. La valeur maximale est de 5 000. |
|
|
Décalage
|
offset | integer |
Représente le nombre d’enregistrements à ignorer. Pour une utilisation avec la pagination. |
|
|
Date de départ du cadeau
|
start_gift_date | date-time |
Représente un filtre pour les cadeaux avec une date de cadeau le ou après la date spécifiée (par exemple : '2020-09-18T04:13:56Z'). |
|
|
Date de fin du cadeau
|
end_gift_date | date-time |
Représente un filtre pour les cadeaux avec une date de cadeau le ou avant la date spécifiée (par exemple : '2020-09-18T04:13:56Z'). |
|
|
Démarrer le montant du cadeau
|
start_gift_amount | double |
Représente un filtre pour les cadeaux dont le montant est supérieur ou égal au montant spécifié. |
|
|
Fin du montant du cadeau
|
end_gift_amount | double |
Représente un filtre pour les cadeaux dont le montant est inférieur ou égal au montant spécifié. |
|
|
Publier l’état
|
post_status | string |
Représente une liste séparée par des virgules d’états de publication cadeau pour filtrer les résultats. Par exemple, « DoNotPost, Post » renvoie uniquement les cadeaux marqués comme DoNotPost ou Post. |
|
|
État du reçu
|
receipt_status | string |
Représente une liste séparée par des virgules d’états de reçu cadeau pour filtrer les résultats. Par exemple, « DoNotReceipt, Reçu » retourne uniquement les cadeaux marqués comme DoNotReceipt ou Reçus. |
|
|
État de l’accusé de réception
|
acknowledgement_status | string |
Représente une liste séparée par des virgules des états d’accusé de réception cadeau pour filtrer les résultats. Par exemple, « DoNotAcknowledge,Knowledge », retourne uniquement les cadeaux marqués comme DoNotAcknowledge ou Reconnu. |
|
|
Ajouté ou après
|
date_added | date-time |
Filtrez les résultats en cadeaux 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 cadeaux modifiés ou après la date spécifiée (par exemple : « 2020-09-18T04:13:56Z »). |
Retours
Cadeaux
Répertorier les campagnes
Retourne une liste de campagnes.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
Représente le nombre d’enregistrements à retourner. La valeur par défaut est 500. La valeur maximale est de 5 000. |
|
|
Décalage
|
offset | integer |
Représente le nombre d’enregistrements à ignorer. Pour une utilisation avec la pagination. |
|
|
Inclure inactif ?
|
include_inactive | boolean |
Inclure des campagnes inactives ? |
|
|
Ajouté ou après
|
date_added | date-time |
Filtrez les résultats sur les campagnes créées 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 campagnes modifiées ou après la date spécifiée (par exemple : « 2020-09-18T04:13:56Z »). |
Retours
Campagnes
Répertorier les champs personnalisés constituants
Répertorie les champs personnalisés d’un constituant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID constituant
|
constituent_id | True | string |
ID d’enregistrement système de la constituante. |
Retours
Champs personnalisés
Répertorier les champs personnalisés de campagne
Répertorie les champs personnalisés d’une campagne.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de campagne
|
campaign_id | True | string |
ID d’enregistrement système de la campagne. |
Retours
Champs personnalisés
Répertorier les champs personnalisés du cadeau
Répertorie les champs personnalisés d’un cadeau.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID cadeau
|
gift_id | True | string |
ID d’enregistrement système du cadeau. |
Retours
Champs personnalisés
Répertorier les champs personnalisés du fonds
Répertorie les champs personnalisés d’un fonds.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID du fonds
|
fund_id | True | string |
ID d’enregistrement système du fonds. |
Retours
Champs personnalisés
Répertorier les champs personnalisés d’action
Répertorie les champs personnalisés d’une action.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’action
|
action_id | True | string |
ID d’enregistrement système de l’action. |
Retours
Champs personnalisés
Répertorier les champs personnalisés d’appel
Répertorie les champs personnalisés pour un appel.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’appel
|
appeal_id | True | string |
ID d’enregistrement système de l’appel. |
Retours
Champs personnalisés
Répertorier les champs personnalisés d’opportunité
Répertorie les champs personnalisés pour une opportunité.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’opportunité
|
opportunity_id | True | string |
ID d’enregistrement système de l’opportunité. |
Retours
Champs personnalisés
Répertorier les codes constituants
Répertorie les codes constituants d’un constituant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID constituant
|
constituent_id | True | string |
ID d’enregistrement système de la constituante. |
Retours
Codes constituants
Répertorier les codes de sollicitation des constituants
Répertorie les codes de sollicitation d’un constituant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID constituant
|
constituent_id | True | string |
ID d’enregistrement système de la constituante. |
Retours
Codes de sollicitation
Répertorier les collectes de fonds constituantes
Répertorie les affectations de collecte de fonds pour une constituante.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID constituant
|
constituent_id | True | string |
ID d’enregistrement système de la constituante. |
|
Inclure inactif ?
|
include_inactive | boolean |
Inclure des affectations de collecte de fonds inactives ? |
Retours
Affectations de collecte de fonds
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 enregistrements de consentement constituants
Répertorie les enregistrements de consentement d’un constituant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID constituant
|
constituent_id | True | string |
ID d’enregistrement système de la constituante. |
|
Le plus récent uniquement ?
|
most_recent_only | boolean |
Incluez uniquement les enregistrements de consentement les plus récents pour chaque combinaison de catégories de canaux dans la réponse ? |
Retours
Enregistrements de consentement
Répertorier les fonds
Retourne une liste de fonds.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
Représente le nombre d’enregistrements à retourner. La valeur par défaut est 500. La valeur maximale est de 5 000. |
|
|
Décalage
|
offset | integer |
Représente le nombre d’enregistrements à ignorer. Pour une utilisation avec la pagination. |
|
|
Inclure inactif ?
|
include_inactive | boolean |
Inclure des fonds inactifs ? |
|
|
Ajouté ou après
|
date_added | date-time |
Filtrez les résultats sur les fonds créé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 fonds modifiés ou après la date spécifiée (par exemple : '2020-09-18T04:13:56Z'). |
Retours
Fonds
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 lots de cadeaux
Répertoriez les lots de cadeaux.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Numéro de lot
|
batch_number | string |
Représente un filtre pour les résultats qui correspondent au nombre spécifié. |
|
|
Approuvé?
|
approved | boolean |
Représente un filtre pour l’état du lot cadeau. |
|
|
Y a-t-il des exceptions ?
|
has_exceptions | boolean |
Représente un filtre pour déterminer si le lot cadeau contient des exceptions. |
|
|
Limit
|
limit | integer |
Représente le nombre d’enregistrements à retourner. La valeur par défaut est 500. La valeur maximale est de 5 000. |
|
|
Décalage
|
offset | integer |
Représente le nombre d’enregistrements à ignorer. Pour une utilisation avec la pagination. |
|
|
Texte de recherche
|
search_text | string |
Représente un filtre pour le texte inclus dans les champs de description de lot ou de numéro de lot. |
|
|
Créé par
|
created_by | string |
Représente un filtre pour les lots de cadeaux créés par l’utilisateur spécifié. |
Retours
Lots de cadeaux
Répertorier les opportunités
Retourne une liste d’opportunités.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Liste
|
list_id | string |
Définit un identificateur de liste utilisé pour filtrer l’ensemble d’opportunités pour ceux inclus dans la liste spécifiée. Si cette valeur est définie, d’autres filtres spécifiés sont ignorés. |
|
|
ID constituant
|
constituent_id | string |
Représente une liste séparée par des virgules d’identificateurs constituants pour filtrer les résultats. Par exemple, « 280 1232 » retourne uniquement les opportunités de la constituante 280 ou constituante 1232. |
|
|
Limit
|
limit | integer |
Représente le nombre d’enregistrements à retourner. La valeur par défaut est 500. La valeur maximale est de 5 000. |
|
|
Décalage
|
offset | integer |
Représente le nombre d’enregistrements à ignorer. Pour une utilisation avec la pagination. |
|
|
Inclure inactif ?
|
include_inactive | boolean |
Inclure des opportunités inactives ? |
|
|
Ajouté ou après
|
date_added | date-time |
Filtrez les résultats sur les opportunités créées 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 opportunités modifiées ou après la date spécifiée (par exemple : « 2020-09-18T04:13:56Z »). |
Retours
Possibilités
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 packages
Retourne une liste de packages.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’appel
|
appeal_id | string |
Représente une liste séparée par des virgules d’identificateurs d’appel pour filtrer les résultats. Par exemple, « 506 918 » retourne uniquement les packages d’appel 506 ou d’appel 918. |
|
|
Limit
|
limit | integer |
Représente le nombre d’enregistrements à retourner. La valeur par défaut est 500. La valeur maximale est de 5 000. |
|
|
Décalage
|
offset | integer |
Représente le nombre d’enregistrements à ignorer. Pour une utilisation avec la pagination. |
|
|
Inclure inactif ?
|
include_inactive | boolean |
Inclure des packages inactifs ? |
|
|
Ajouté ou après
|
date_added | date-time |
Filtrez les résultats sur les packages 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 packages modifiés ou après la date spécifiée (par exemple : « 2020-09-18T04:13:56Z »). |
Retours
Packages
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 constituantes
Répertorie les pièces jointes d’un constituant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID constituant
|
constituent_id | True | string |
ID d’enregistrement système de la constituante. |
Retours
Attachments
Répertorier les pièces jointes de cadeau
Répertorie les pièces jointes pour un cadeau.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID cadeau
|
gift_id | True | string |
ID d’enregistrement système du cadeau. |
Retours
Attachments
Répertorier les pièces jointes de campagne
Répertorie les pièces jointes d’une campagne.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de campagne
|
campaign_id | True | string |
ID d’enregistrement système de la campagne. |
Retours
Attachments
Répertorier les pièces jointes de fonds
Répertorie les pièces jointes d’un fonds.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID du fonds
|
fund_id | True | string |
ID d’enregistrement système du fonds. |
Retours
Attachments
Répertorier les pièces jointes d’opportunité
Répertorie les pièces jointes pour une opportunité.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’opportunité
|
opportunity_id | True | string |
ID d’enregistrement système de l’opportunité. |
Retours
Attachments
Répertorier les présences en ligne constituantes
Répertorie les présences en ligne d’un constituant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID constituant
|
constituent_id | True | string |
ID d’enregistrement système de la constituante. |
|
Inclure inactif ?
|
include_inactive | boolean |
Inclure des présences en ligne inactives ? |
Retours
Présences en ligne
Répertorier les relations constituantes
Répertorie les relations d’un constituant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID constituant
|
constituent_id | True | string |
ID d’enregistrement système de la constituante. |
|
Limit
|
limit | integer |
Représente le nombre d’enregistrements à retourner. La valeur par défaut est 500. Il n’y a pas de maximum. |
|
|
Décalage
|
offset | integer |
Représente le nombre d’enregistrements à ignorer. Pour une utilisation avec la pagination. |
Retours
Relations interpersonnelles
Répertorier les éducations constituantes
Répertorie les dossiers d’éducation d’un constituant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID constituant
|
constituent_id | True | string |
ID d’enregistrement système de la constituante. |
Retours
Éducations
Répertorier les évaluations des constituants
Retourne la liste des évaluations d’un constituant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID constituant
|
constituent_id | True | string |
ID d’enregistrement système de la constituante |
|
Inclure inactif ?
|
include_inactive | boolean |
Inclure des évaluations inactives ? |
|
|
Seulement le plus récent ?
|
most_recent_only | boolean |
Incluez uniquement les évaluations les plus récentes ? |
Retours
Évaluations
Supprimer un code constituant
Supprime un code constituant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de code constituant
|
constituent_code_id | True | string |
ID d’enregistrement système du code constituant à supprimer. |
Définitions
CommPrefApi.ConstituentConsentRead
Représente une entité de consentement pour un constituant.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système de l’enregistrement de consentement. |
|
Canal
|
channel | string |
Canal auquel la réponse de consentement s’applique. |
|
Catégorie
|
category | string |
Catégorie à laquelle la réponse de consentement s’applique. |
|
Origine
|
source | string |
Source de la réponse de consentement de la constituante. |
|
Réponse
|
constituent_consent_response | string |
Comment l’constituant a répondu au consentement pour le canal/catégorie spécifié. |
|
Date
|
consent_date | date-time |
Date à laquelle la réponse de consentement a été reçue. |
|
Déclaration de consentement
|
consent_statement | string |
L’énoncé auquel la constituante a répondu lors de la fourniture du consentement. |
|
Avis de confidentialité
|
privacy_notice | string |
Avis de confidentialité fourni à la constituante. |
|
Date d’ajout
|
date_added | date-time |
Date à laquelle la réponse de consentement a été ajoutée. |
|
Ajouté par
|
user_name | string |
Utilisateur qui a ajouté la réponse de consentement. |
CommPrefApi.ConstituentConsentReadCollection
Enregistrements de consentement
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nombre
|
count | integer |
Nombre d’enregistrements de consentement dans la liste. |
|
value
|
value | array of CommPrefApi.ConstituentConsentRead |
Ensemble d’enregistrements de consentement inclus dans la réponse. |
CommPrefApi.ConstituentSolicitCodeRead
Solliciter du code
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système du code de sollicitation constituant. |
|
Solliciter du code
|
solicit_code | string |
Instructions de communication et/ou restrictions pour un constituant. |
|
Date de début
|
start_date | date |
Date de début du code de sollicitation (par exemple : « 2005-09-18 »). |
|
Date de fin
|
end_date | date |
Date de fin du code de sollicitation (par exemple : « 2005-09-18 »). |
CommPrefApi.ConstituentSolicitCodeReadCollection
Codes de sollicitation
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nombre
|
count | integer |
Nombre de codes de sollicitation constituants dans la liste. |
|
value
|
value | array of CommPrefApi.ConstituentSolicitCodeRead |
Ensemble de codes de sollicitation constituants inclus dans la réponse. |
CommPrefApi.CreatedConstituentConsent
Consentement constituant créé
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID de l’enregistrement de consentement nouvellement créé. |
CommPrefApi.CreatedConstituentSolicitCode
Code de sollicitation constituant créé
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID du code de sollicitation constituant nouvellement créé. |
ConstituentApi.ActionAttachmentRead
Attachment
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système de la pièce jointe. |
|
ID d’action
|
parent_id | string |
ID d’enregistrement système de l’action associée à 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. |
ConstituentApi.ActionCustomFieldRead
Champ personnalisé
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système du champ personnalisé. |
|
ID d’action
|
parent_id | string |
ID d’enregistrement système de l’action associée au champ personnalisé. |
|
Catégorie
|
category | string |
Catégorie de champ personnalisé. |
|
Type
|
type | string |
Type de données que le champ personnalisé représente. |
|
Valeur
|
value |
Valeur du champ personnalisé. |
|
|
Date
|
date | date |
Date du champ personnalisé. |
|
Commentaire
|
comment | string |
Commentaire sur le champ personnalisé. Limite de caractères : 50. |
|
Date d’ajout
|
date_added | date-time |
Date de création du champ personnalisé. |
|
Date de modification
|
date_modified | date-time |
Date de dernière modification du champ personnalisé. |
ConstituentApi.ActionRead
Action
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système de l’action. |
|
ID constituant
|
constituent_id | string |
ID d’enregistrement système de la constituante associée à l’action. |
|
Catégorie
|
category | string |
Canal ou intention de l’interaction constituante. |
|
Terminé?
|
completed | boolean |
L’action est-elle terminée ? Si le système est configuré pour utiliser des états d’action personnalisés, cette valeur est basée sur la valeur d’état de l’action. |
|
Effectué le
|
completed_date | date-time |
Date à laquelle l’action a été terminée. |
|
Date
|
date | date-time |
Date de l’action. |
|
Note
|
description | string |
Explication détaillée qui s’explique sur le résumé de l’action. |
|
Direction
|
direction | string |
Direction de l’action. |
|
Collecte de fonds
|
fundraisers | array of string |
Ensemble d’ID d’enregistrement système pour les collectes de fonds associées à l’action. |
|
Emplacement
|
location | string |
Emplacement de l’action. |
|
ID d’opportunité
|
opportunity_id | string |
ID d’enregistrement système de l’opportunité associée à l’action. |
|
Résultat
|
outcome | string |
Résultat de l’action. |
|
Priority
|
priority | string |
Priorité de l’action. |
|
Heure de début
|
start_time | string |
Heure de début de l’action. Utilise une heure de 24 heures au format HH :mm. |
|
Heure de fin
|
end_time | string |
Heure de fin de l’action. Utilise une heure de 24 heures au format HH :mm. |
|
Statut
|
status | string |
État de l’action. |
|
Code de statut
|
status_code | string |
Code d’état de l’action. Cette propriété est retournée uniquement lorsque le système est configuré pour utiliser des états d’action personnalisés. |
|
État calculé
|
computed_status | string |
État de l’action calculée. Si le système n’est pas configuré pour utiliser des états d’action personnalisés, ce champ calcule l’état en fonction des propriétés terminées et de date. Si ce n’est pas le cas, le champ calcule l’état en fonction de la propriété date de l’action et indique si la propriété État de l’action est configurée comme terminée. |
|
Résumé
|
summary | string |
Brève description de l’action qui apparaît en haut de l’enregistrement. Limite de caractères : 255. |
|
Type
|
type | string |
Description supplémentaire de l’action pour compléter la catégorie. |
|
Date d’ajout
|
date_added | date-time |
Date de création de l’action. |
|
Date de modification
|
date_modified | date-time |
Date de la dernière modification de l’action. |
ConstituentApi.AddressRead
Adresse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système de l’adresse. |
|
Type
|
type | string |
Type d’adresse. |
|
Pays
|
country | string |
Pays de l’adresse (il peut s’agir de l’ID, du nom ou de l’abréviation). |
|
Lignes d’adresse
|
address_lines | string |
Lignes d’adresse. |
|
Ville
|
city | string |
Ville de l’adresse (ne pas utiliser en combinaison avec le champ banlieue). |
|
État
|
state | string |
État de l’adresse. |
|
Code postal
|
postal_code | string |
Code postal de l’adresse. |
|
Banlieue
|
suburb | string |
Banlieue de l’adresse (ne pas utiliser en combinaison avec le champ Ville). |
|
Commune
|
county | string |
Le comté de l’adresse. |
|
Adresse mise en forme
|
formatted_address | string |
Adresse mise en forme dans le format configuré du pays. |
|
Source d’informations
|
information_source | string |
Source d’informations de l’adresse. |
|
Région
|
region | string |
Région de l’adresse. |
|
CHARRETTE
|
cart | string |
Itinéraire du transporteur (CART) pour l’adresse. |
|
LOT
|
lot | string |
Ligne de voyage (LOT) pour l’adresse. |
|
DPC
|
dpc | string |
Code de point de remise (DPC) pour l’adresse. |
|
Valide à partir de
|
start | date-time |
Date à laquelle la constituante a commencé à résider à cette adresse. |
|
Valide pour
|
end | date-time |
Date à laquelle la constituante a cessé de résider à cette adresse. |
|
Primaire?
|
preferred | boolean |
S’agit-il de l’adresse préférée de la constituante ? |
|
Inactif?
|
inactive | boolean |
L’adresse est-elle inactive (c’est-à-dire que la date actuelle est antérieure à une date de fin) ? |
|
Ne pas envoyer de courrier électronique ?
|
do_not_mail | boolean |
Le constituant peut-il être contacté à cette adresse ? |
|
jour
|
seasonal_start.d | integer |
Jour de la date floue. |
|
month
|
seasonal_start.m | integer |
Mois à la date approximative. |
|
année
|
seasonal_start.y | integer |
L’année dans la date approximative. |
|
jour
|
seasonal_end.d | integer |
Jour de la date floue. |
|
month
|
seasonal_end.m | integer |
Mois à la date approximative. |
|
année
|
seasonal_end.y | integer |
L’année dans la date approximative. |
|
Date d’ajout
|
date_added | date-time |
Date de création de l’adresse. |
|
Date de modification
|
date_modified | date-time |
Date de la dernière modification de l’adresse. |
ConstituentApi.AliasRead
Alias
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système de l’alias. |
|
Alias
|
name | string |
Nom à utiliser comme alias de la constituante. |
|
Type
|
type | string |
Type d’alias. |
ConstituentApi.ApiCollectionOfAddressRead
Addresses
| 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 ConstituentApi.AddressRead |
Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection. |
ConstituantApi.ApiCollectionOfActionAttachmentRead
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 ConstituentApi.ActionAttachmentRead |
Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection. |
ConstituentApi.ApiCollectionOfActionCustomFieldRead
Champs personnalisés
| 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 ConstituentApi.ActionCustomFieldRead |
Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection. |
ConstituentApi.ApiCollectionOfActionRead
Actions
| 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 ConstituentApi.ActionRead |
Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection. |
ConstituentApi.ApiCollectionOfAliasRead
Aliases
| 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 ConstituentApi.AliasRead |
Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection. |
ConstituentApi.ApiCollectionOfConstituentAttachmentRead
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 ConstituentApi.ConstituentAttachmentRead |
Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection. |
ConstituentApi.ApiCollectionOfConstituentCodeRead
Codes constituants
| 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 ConstituentApi.ConstituentCodeRead |
Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection. |
ConstituentApi.ApiCollectionOfConstituentCustomFieldRead
Champs personnalisés
| 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 ConstituentApi.ConstituentCustomFieldRead |
Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection. |
ConstituentApi.ApiCollectionOfConstituentRead
Constituants
| 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 ConstituentApi.ConstituentRead |
Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection. |
ConstituentApi.ApiCollectionOfEducationRead
Éducations
| 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 ConstituentApi.EducationRead |
Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection. |
ConstituentApi.ApiCollectionOfEmailAddressRead
Adresses e-mail
| 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 ConstituentApi.EmailAddressRead |
Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection. |
ConstituentApi.ApiCollectionOfFundraiserAssignmentRead
Affectations de collecte de fonds
| 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 ConstituentApi.FundraiserAssignmentRead |
Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection. |
ConstituantApi.ApiCollectionOfNoteRead
Remarques
| 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 ConstituentApi.NoteRead |
Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection. |
ConstituentApi.ApiCollectionOfOnlinePresenceRead
Présences en ligne
| 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 ConstituentApi.OnlinePresenceRead |
Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection. |
ConstituentApi.ApiCollectionOfPhoneRead
Téléphones
| 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 ConstituentApi.PhoneRead |
Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection. |
ConstituentApi.ApiCollectionOfRatingRead
Évaluations
| 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 ConstituentApi.RatingRead |
Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection. |
ConstituentApi.ApiCollectionOfRelationshipRead
Relations interpersonnelles
| 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 ConstituentApi.RelationshipRead |
Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection. |
ConstituentApi.ApiCollectionOfSearchResultRead
Résultats de la recherche
| 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 ConstituentApi.SearchResultRead |
Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection. |
ConstituentApi.AppealRead
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système de l’appel. |
|
descriptif
|
description | string |
Description de l’appel. |
ConstituentApi.CampaignRead
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système de la campagne. |
|
descriptif
|
description | string |
Description de la campagne. |
ConstituentApi.ConstituentAttachmentRead
Attachment
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système de la pièce jointe. |
|
ID constituant
|
parent_id | string |
ID d’enregistrement système du composant 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. |
ConstituentApi.ConstituentCodeRead
Code constituant
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système du code constituant. |
|
ID constituant
|
constituent_id | string |
ID d’enregistrement système de la constituante associée au code constituant. |
|
Code constituant
|
description | string |
Code constituant. |
|
jour
|
start.d | integer |
Jour de la date floue. |
|
month
|
start.m | integer |
Mois à la date approximative. |
|
année
|
start.y | integer |
L’année dans la date approximative. |
|
jour
|
end.d | integer |
Jour de la date floue. |
|
month
|
end.m | integer |
Mois à la date approximative. |
|
année
|
end.y | integer |
L’année dans la date approximative. |
|
Inactif?
|
inactive | boolean |
Le code constituant est-il inactif ? |
|
Sequence
|
sequence | integer |
Séquence numérique associée au code constituant. |
|
Date d’ajout
|
date_added | date-time |
Date de création du code constituant. |
|
Date de modification
|
date_modified | date-time |
Date à laquelle le code constituant a été modifié pour la dernière fois. |
ConstituentApi.ConstituentCustomFieldRead
Champ personnalisé
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système du champ personnalisé. |
|
ID constituant
|
parent_id | string |
ID d’enregistrement système du constituant associé au champ personnalisé. |
|
Catégorie
|
category | string |
Catégorie de champ personnalisé. |
|
Type
|
type | string |
Type de données que le champ personnalisé représente. |
|
Valeur
|
value |
Valeur du champ personnalisé. |
|
|
Date
|
date | date |
Date du champ personnalisé. |
|
Commentaire
|
comment | string |
Commentaire sur le champ personnalisé. Limite de caractères : 50. |
|
Date d’ajout
|
date_added | date-time |
Date de création du champ personnalisé. |
|
Date de modification
|
date_modified | date-time |
Date de dernière modification du champ personnalisé. |
ConstituentApi.ConstituentRead
Constituant
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système de la constituante. Ce n’est pas le même que l’identificateur de constituant pouvant être défini par l’utilisateur, qui est stocké dans le lookup_id. |
|
Type
|
type | string |
Type de constituant. |
|
Titre
|
title | string |
Titre principal de la constituante (pour les individus uniquement). |
|
Prénom
|
first | string |
Prénom de la constituante (pour les individus uniquement). |
|
Nom
|
last | string |
Nom de la constituante (pour les individus uniquement). |
|
Nom
|
name | string |
Pour les personnes, ce champ est le nom complet de la constituante en fonction des paramètres de nom complet de l’organisation cible. Pour les organisations, il s’agit du nom de l’organisation. |
|
Nom préféré
|
preferred_name | string |
Nom préféré de la constituante (pour les individus uniquement). |
|
Suffixe
|
suffix | string |
Suffixe principal de la constituante (pour les individus uniquement). |
|
ID de recherche
|
lookup_id | string |
Identificateur défini par l’utilisateur pour la constituante. |
|
ID
|
email.id | string |
ID d’enregistrement système de l’adresse e-mail. |
|
type
|
email.type | string |
Type d’adresse e-mail. |
|
address
|
email.address | string |
Adresse e-mail. |
|
n’envoyez pas d’e-mail ?
|
email.do_not_email | boolean |
Le constituant peut-il être contacté à cette adresse e-mail ? |
|
inactif?
|
email.inactive | boolean |
Cette adresse e-mail est-elle inactive ? |
|
date ajoutée
|
email.date_added | date-time |
Date de création de l’adresse e-mail. |
|
date de modification
|
email.date_modified | date-time |
Date de dernière modification de l’adresse e-mail. |
|
ID
|
phone.id | string |
ID d’enregistrement système du téléphone. |
|
type
|
phone.type | string |
Type de téléphone. |
|
nombre
|
phone.number | string |
Numéro de téléphone. |
|
n’appelle pas ?
|
phone.do_not_call | boolean |
Le constituant peut-il être contacté à ce numéro ? |
|
inactif?
|
phone.inactive | boolean |
Ce numéro de téléphone est-il inactif ? |
|
date ajoutée
|
phone.date_added | date-time |
Date de création du téléphone. |
|
date de modification
|
phone.date_modified | date-time |
Date de la dernière modification du téléphone. |
|
ID
|
online_presence.id | string |
ID d’enregistrement système de la présence en ligne. |
|
type
|
online_presence.type | string |
Type de présence en ligne. |
|
link
|
online_presence.address | string |
Adresse web de la présence en ligne. |
|
inactif?
|
online_presence.inactive | boolean |
Cette présence en ligne est-elle inactive ? |
|
date ajoutée
|
online_presence.date_added | date-time |
Date de création de la présence en ligne. |
|
date de modification
|
online_presence.date_modified | date-time |
Date de la dernière modification de la présence en ligne. |
|
ID
|
address.id | string |
ID d’enregistrement système de l’adresse. |
|
type
|
address.type | string |
Type d’adresse. |
|
country
|
address.country | string |
Pays de l’adresse (il peut s’agir de l’ID, du nom ou de l’abréviation). |
|
Lignes
|
address.address_lines | string |
Lignes d’adresse. |
|
city
|
address.city | string |
Ville de l’adresse (ne pas utiliser en combinaison avec le champ banlieue). |
|
état
|
address.state | string |
État de l’adresse. |
|
code postal
|
address.postal_code | string |
Code postal de l’adresse. |
|
banlieue
|
address.suburb | string |
Banlieue de l’adresse (ne pas utiliser en combinaison avec le champ Ville). |
|
comté
|
address.county | string |
Le comté de l’adresse. |
|
Formaté
|
address.formatted_address | string |
Adresse mise en forme dans le format configuré du pays. |
|
valide à partir de
|
address.start | date-time |
Date à laquelle la constituante a commencé à résider à cette adresse. |
|
valide pour
|
address.end | date-time |
Date à laquelle la constituante a cessé de résider à cette adresse. |
|
inactif?
|
address.inactive | boolean |
L’adresse est-elle inactive (c’est-à-dire que la date actuelle est antérieure à une date de fin) ? |
|
ne pas envoyer de courrier électronique ?
|
address.do_not_mail | boolean |
Le constituant peut-il être contacté à cette adresse ? |
|
jour
|
address.seasonal_start.d | integer |
Jour de la date floue. |
|
month
|
address.seasonal_start.m | integer |
Mois à la date approximative. |
|
année
|
address.seasonal_start.y | integer |
L’année dans la date approximative. |
|
jour
|
address.seasonal_end.d | integer |
Jour de la date floue. |
|
month
|
address.seasonal_end.m | integer |
Mois à la date approximative. |
|
année
|
address.seasonal_end.y | integer |
L’année dans la date approximative. |
|
date ajoutée
|
address.date_added | date-time |
Date de création de l’adresse. |
|
date de modification
|
address.date_modified | date-time |
Date de la dernière modification de l’adresse. |
|
Gender
|
gender | string |
Le sexe de la constituante (pour les individus uniquement). |
|
Deuxième prénom
|
middle | string |
Le prénom de la constituante (pour les individus uniquement). |
|
Ancien nom
|
former_name | string |
L’ancien nom de la constituante (pour les individus uniquement). |
|
Titre 2
|
title_2 | string |
Titre secondaire de la constituante (pour les individus uniquement). |
|
Suffixe 2
|
suffix_2 | string |
Suffixe secondaire de la constituante (pour les individus uniquement). |
|
Staus conjugal
|
marital_status | string |
L’état conjugal de la constituante (pour les individus uniquement). |
|
Donne anonymement ?
|
gives_anonymously | boolean |
La constituante donne-t-elle anonymement ? |
|
Inactif?
|
inactive | boolean |
La constituante est-elle inactive ? |
|
jour
|
birthdate.d | integer |
Jour de la date floue. |
|
month
|
birthdate.m | integer |
Mois à la date approximative. |
|
année
|
birthdate.y | integer |
L’année dans la date approximative. |
|
Lieu de naissance
|
birthplace | string |
Lieu de naissance de la constituante (pour les individus uniquement). |
|
Ethnicité
|
ethnicity | string |
L’ethnicité de la constituante (pour les individus uniquement). |
|
Revenu
|
income | string |
Revenu de la constituante (pour les particuliers uniquement). |
|
Religion
|
religion | string |
La religion de la constituante (pour les individus uniquement). |
|
Secteur d’activité
|
industry | string |
Industrie de la constituante (pour les organisations uniquement). |
|
Nombre d’employés
|
num_employees | integer |
Nombre d’employés de l’organisation. |
|
Correspond aux cadeaux ?
|
matches_gifts | boolean |
L’organisation correspond-elle aux cadeaux ? |
|
Facteur cadeau correspondant
|
matching_gift_factor | double |
Facteur cadeau correspondant (pour les organisations uniquement). |
|
Correspondance minimale par cadeau
|
matching_gift_per_gift_min.value | double |
Montant minimal de correspondance par cadeau pour la constituante (pour les organisations uniquement). |
|
Correspondance maximale par cadeau
|
matching_gift_per_gift_max.value | double |
Montant maximal de correspondance par cadeau pour la constituante (pour les organisations uniquement). |
|
Correspondance minimale par constit
|
matching_gift_total_min.value | double |
Total des correspondances minimales pour la constituante (pour les organisations uniquement). |
|
Correspondance maximale par constit
|
matching_gift_total_max.value | double |
Nombre maximal de correspondances pour la constituante (pour les organisations uniquement). |
|
Notes de cadeau correspondantes
|
matching_gift_notes | string |
Notes de cadeau correspondantes pour la constituante (pour les organisations uniquement). |
|
Âge
|
age | integer |
L’âge de la constituante, tel qu’il est calculé en fonction de la propriété de date de naissance (pour les individus uniquement). |
|
Décédé?
|
deceased | boolean |
La personne décédée est-elle décédée (pour les individus uniquement) ? |
|
jour
|
deceased_date.d | integer |
Jour de la date floue. |
|
month
|
deceased_date.m | integer |
Mois à la date approximative. |
|
année
|
deceased_date.y | integer |
L’année dans la date approximative. |
|
État de collecte de fonds
|
fundraiser_status | string |
Indique si la constituante est une collecte de fonds (pour les individus uniquement). |
|
ID
|
spouse.id | string |
ID d’enregistrement système du conjoint. |
|
prénom
|
spouse.first | string |
Prénom du conjoint. |
|
nom
|
spouse.last | string |
Nom du conjoint. |
|
est-ce que le chef de famille ?
|
spouse.is_head_of_household | boolean |
Le conjoint est-il le chef du foyer ? |
|
Date d’ajout
|
date_added | date-time |
Date de création de la constituante. |
|
Date de modification
|
date_modified | date-time |
Date de la dernière modification de la constituante. |
ConstituentApi.CreatedAction
Action créée
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID de l’action nouvellement créée. |
ConstituantApi.CreatedActionAttachment
Pièce jointe d’action créée
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID de la pièce jointe de l’action nouvellement créée. |
ConstituentApi.CreatedActionCustomField
Champ personnalisé d’action créé
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID du champ personnalisé de l’action nouvellement créée. |
ConstituentApi.CreatedConstituentAddress
Adresse constituante créée
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID de l’adresse constituante nouvellement créée. |
ConstituentApi.CreatedConstituentAlias
Alias constituant créé
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID de l’alias constituant nouvellement créé. |
ConstituantApi.CreatedConstituentAttachment
Pièce jointe constituante créée
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID de la pièce jointe qui vient d’être créée. |
ConstituentApi.CreatedConstituentCode
Code constituant créé
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID du code constituant nouvellement créé. |
ConstituentApi.CreatedConstituentCustomField
Champ personnalisé constituant créé
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID du champ personnalisé qui vient d’être créé. |
ConstituentApi.CreatedConstituentEducation
Création d’une éducation constituante
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID de l’éducation constituante nouvellement créée. |
ConstituentApi.CreatedConstituentEmailAddress
Adresse e-mail constituante créée
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID de l’adresse e-mail constituante nouvellement créée. |
ConstituentApi.CreatedConstituentNote
Note constituante créée
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID de la note constituante nouvellement créée. |
ConstituentApi.CreatedConstituentOnlinePresence
Création d’une présence en ligne constituante
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID de la présence en ligne qui vient d’être créée. |
ConstituentApi.CreatedConstituentPhone
Téléphone constituant créé
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID du téléphone constituant nouvellement créé. |
ConstituantApi.CreatedConstituentRating
Évaluation constituante créée
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID de l’évaluation constituante nouvellement créée. |
ConstituentApi.CreatedIndividualConstituent
Création d’une constituante individuelle
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID de la constituante individuelle nouvellement créée. |
ConstituentApi.CreatedIndividualRelationship
Création d’une relation individuelle
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID de la relation individuelle nouvellement créée. |
ConstituentApi.CreatedOrganizationConstituent
Création d’une organisation constituante
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID de l’organisation nouvellement créée. |
ConstituentApi.CreatedOrganizationRelationship
Relation organisationnelle créée
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID de la relation d’organisation nouvellement créée. |
ConstituentApi.EducationRead
Education
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système de l’éducation. |
|
ID constituant
|
constituent_id | string |
ID d’enregistrement système de la constituante associée à l’éducation. |
|
École
|
school | string |
Nom de l’établissement scolaire ou de l’établissement. |
|
Type
|
type | string |
Le type d’éducation. |
|
Classe de
|
class_of | string |
L’année où l’constituant est diplômé. |
|
Statut
|
status | string |
État de l’éducation. |
|
jour
|
date_entered.d | integer |
Jour de la date floue. |
|
month
|
date_entered.m | integer |
Mois à la date approximative. |
|
année
|
date_entered.y | integer |
L’année dans la date approximative. |
|
jour
|
date_left.d | integer |
Jour de la date floue. |
|
month
|
date_left.m | integer |
Mois à la date approximative. |
|
année
|
date_left.y | integer |
L’année dans la date approximative. |
|
jour
|
date_graduated.d | integer |
Jour de la date floue. |
|
month
|
date_graduated.m | integer |
Mois à la date approximative. |
|
année
|
date_graduated.y | integer |
L’année dans la date approximative. |
|
Degré
|
degree | string |
Degré reçu. |
|
GPA
|
gpa | double |
Moyenne du point de note. |
|
Majors
|
majors | array of string |
Les grands cours d’étude. |
|
Mineurs
|
minors | array of string |
Les cours secondaires d’étude. |
|
L’éducation primaire est-elle ?
|
primary | boolean |
Est-ce que c’est l’association primaire de la constituante ? |
|
Campus
|
campus | string |
Le campus. |
|
Organisation sociale
|
social_organization | string |
L’organisation sociale. |
|
Nom connu
|
known_name | string |
Nom connu. |
|
Classe de degré
|
class_of_degree | string |
Classe de degré. |
|
Département
|
department | string |
Nom du service d’éducation. |
|
Faculté
|
faculty | string |
Nom de la faculté. |
|
Numéro d’inscription
|
registration_number | string |
Numéro d’inscription. |
|
Objet de l’étude
|
subject_of_study | string |
L’objet de l’étude. |
|
Date d’ajout
|
date_added | date-time |
Date de création de l’éducation. |
|
Date de modification
|
date_modified | date-time |
Date de la dernière modification de l’éducation. |
ConstituentApi.EmailAddressRead
Adresse de messagerie
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système de l’adresse e-mail. |
|
ID constituant
|
constituent_id | string |
ID d’enregistrement système du constituant associé à l’adresse e-mail. |
|
Type d’e-mail
|
type | string |
Type d’adresse e-mail. |
|
Adresse de messagerie
|
address | string |
Adresse e-mail. |
|
Primaire?
|
primary | boolean |
S’agit-il de l’adresse e-mail principale de la constituante ? |
|
N’envoyez pas d’e-mail ?
|
do_not_email | boolean |
Le constituant peut-il être contacté à cette adresse e-mail ? |
|
Inactif?
|
inactive | boolean |
Cette adresse e-mail est-elle inactive ? |
|
Date d’ajout
|
date_added | date-time |
Date de création de l’adresse e-mail. |
|
Date de modification
|
date_modified | date-time |
Date de dernière modification de l’adresse e-mail. |
ConstituantApi.FileDefinition
Définition de fichier
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de fichier
|
file_id | string |
L’identificateur du fichier. |
|
URL
|
file_upload_request.url | string |
URL à utiliser pour la demande de chargement. |
|
method
|
file_upload_request.method | string |
Méthode HTTP à utiliser avec la demande de chargement. |
|
headers
|
file_upload_request.headers | array of ConstituentApi.Header |
En-têtes à fournir lors de la demande. |
|
ID de miniature
|
thumbnail_id | string |
Identificateur de la miniature. |
|
URL
|
thumbnail_upload_request.url | string |
URL à utiliser pour la demande de chargement. |
|
method
|
thumbnail_upload_request.method | string |
Méthode HTTP à utiliser avec la demande de chargement. |
|
headers
|
thumbnail_upload_request.headers | array of ConstituentApi.Header |
En-têtes à fournir lors de la demande. |
ConstituentApi.FundraiserAssignmentRead
Affectation de collecte de fonds
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système de l’affectation de collecte de fonds. |
|
ID constituant
|
constituent_id | string |
ID d’enregistrement système de la constituante affectée à la collecte de fonds. |
|
ID de collecte de fonds
|
fundraiser_id | string |
ID d’enregistrement système de la collecte de fonds. |
|
Type
|
type | string |
Type de collecte de fonds. |
|
value
|
amount.value | double |
Valeur monétaire. |
|
ID de campagne
|
campaign_id | string |
ID d’enregistrement système de la campagne à laquelle appliquer des cadeaux résultants. |
|
ID du fonds
|
fund_id | string |
L’ID d’enregistrement système du fonds auquel les dons résultants doivent être appliqués. Si un fonds restreint est sélectionné, seules les campagnes et les appels associés à ce fonds peuvent être sélectionnés. |
|
ID d’appel
|
appeal_id | string |
L’ID du dossier système de l’appel que la collecte de fonds doit utiliser pour demander des dons. |
|
Date de début
|
start | date-time |
Date de début de l’affectation de collecte de fonds. |
|
Date de fin
|
end | date-time |
Date de fin de l’affectation de collecte de fonds. |
ConstituantApi.FundRead
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système du fonds. |
|
descriptif
|
description | string |
Description du fonds. |
ConstituentApi.GivingSummaryRead
Donner un résumé
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système du cadeau. |
|
Type
|
type | string |
Le type de cadeau. |
|
Date
|
date | date-time |
Date du cadeau. |
|
value
|
amount.value | double |
Valeur monétaire. |
|
Appeal
|
appeals | array of ConstituentApi.AppealRead |
Ensemble d’appels associés au cadeau. |
|
Campagne
|
campaigns | array of ConstituentApi.CampaignRead |
Ensemble de campagnes associées au cadeau. |
|
Fonds
|
funds | array of ConstituentApi.FundRead |
Ensemble de fonds associés au cadeau. |
ConstituentApi.Header
En-tête de demande utilisé pour charger la pièce jointe physique.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
nom
|
name | string |
Nom de l’en-tête. |
|
value
|
value | string |
Valeur de l’en-tête. |
ConstituentApi.LifetimeGivingRead
Don de durée de vie
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Années consécutives données
|
consecutive_years_given | integer |
Nombre d’années consécutives que la constituante a donnée. |
|
Nombre total d’années données
|
total_years_given | integer |
Nombre total d’années que la constituante a données. |
|
value
|
total_giving.value | double |
Valeur monétaire. |
|
value
|
total_pledge_balance.value | double |
Valeur monétaire. |
|
value
|
total_received_giving.value | double |
Valeur monétaire. |
|
value
|
total_committed_matching_gifts.value | double |
Valeur monétaire. |
|
value
|
total_received_matching_gifts.value | double |
Valeur monétaire. |
|
value
|
total_soft_credits.value | double |
Valeur monétaire. |
ConstituentApi.NoteRead
Note
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système de la note. |
|
ID constituant
|
constituent_id | string |
ID d’enregistrement système de la constituante associée à la note. |
|
Type
|
type | string |
Type de note. |
|
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. |
|
Résumé
|
summary | string |
Résumé de la note. |
|
Note
|
text | string |
Texte de la note. |
|
Date d’ajout
|
date_added | date-time |
Date de création de la note. |
|
Date de modification
|
date_modified | date-time |
Date de la dernière modification de la note. |
ConstituentApi.OnlinePresenceRead
Présence en ligne
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système de la présence en ligne. |
|
ID constituant
|
constituent_id | string |
ID d’enregistrement système du constituant associé à la présence en ligne. |
|
Type
|
type | string |
Type de présence en ligne. |
|
Lien
|
address | string |
Adresse web de la présence en ligne. |
|
Primaire?
|
primary | boolean |
S’agit-il de la présence en ligne principale de la constituante ? |
|
Inactif?
|
inactive | boolean |
Cette présence en ligne est-elle inactive ? |
|
Date d’ajout
|
date_added | date-time |
Date de création de la présence en ligne. |
|
Date de modification
|
date_modified | date-time |
Date de la dernière modification de la présence en ligne. |
ConstituentApi.PhoneRead
Téléphone
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système du téléphone. |
|
ID constituant
|
constituent_id | string |
ID d’enregistrement système de la constituante associée au téléphone. |
|
Type
|
type | string |
Type de téléphone. |
|
Number
|
number | string |
Numéro de téléphone. |
|
Primaire?
|
primary | boolean |
C’est le téléphone principal de la constituante ? |
|
N’appelez pas ?
|
do_not_call | boolean |
Le constituant peut-il être contacté à ce numéro ? |
|
Inactif?
|
inactive | boolean |
Ce numéro de téléphone est-il inactif ? |
|
Date d’ajout
|
date_added | date-time |
Date de création du téléphone. |
|
Date de modification
|
date_modified | date-time |
Date de la dernière modification du téléphone. |
ConstituentApi.ProfilePictureRead
Image du profil
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID constituant
|
constituent_id | string |
ID d’enregistrement système de la constituante associée à l’image de profil. |
|
URL
|
url | string |
URL de l’image de profil. L’URL contient une signature limitée dans le temps qui limite l’accès à 60 minutes. |
|
URL de miniature
|
thumbnail_url | string |
URL d’une miniature de l’image de profil. Contient une signature limitée dans le temps qui limite l’accès à 60 minutes. |
ConstituentApi.ProspectStatusRead
État des prospects
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Statut
|
status | string |
État actuel des prospects de la constituante. |
|
Jours écoulés
|
days_elapsed | integer |
Nombre total de jours dans l’état actuel des prospects en fonction de la date de début. |
|
Date de début
|
start | date-time |
Date de début de l’état du prospect. |
|
Commentaires
|
comments | string |
Commentaires sur l’état des prospects. |
ConstituentApi.RatingRead
Notation
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système de l’évaluation. |
|
ID constituant
|
constituent_id | string |
ID d’enregistrement système de la constituante associée à l’évaluation. |
|
Origine
|
source | string |
Source de la nouvelle évaluation. |
|
Catégorie
|
category | string |
Catégorie de l’évaluation. |
|
Date
|
date | date-time |
Date de l’évaluation. |
|
Descriptif
|
value |
Valeur de l’évaluation. |
|
|
Commentaires
|
comment | string |
Commentaire sur l’évaluation. |
|
Inactif?
|
inactive | boolean |
L’évaluation est-elle inactive ? |
|
Type
|
type | string |
Ce champ calculé indique le type de données que l’évaluation représente en fonction de la propriété de catégorie. |
ConstituentApi.RelationshipRead
Relation
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système de la relation. |
|
ID constituant
|
constituent_id | string |
ID d’enregistrement système du constituant associé à la relation. |
|
Relation ID
|
relation_id | string |
ID d’enregistrement système de la personne ou de l’organisation associée. |
|
ID de relation réciproque
|
reciprocal_relationship_id | string |
Identificateur de l’enregistrement de relation réciproque. Cette valeur est en lecture seule et est générée automatiquement lors de la création de la relation. Les modifications apportées à cet enregistrement seront également reflétées sur la réciproque, à l’exception de la propriété commentaires. |
|
Nom
|
name | string |
Nom de la constituante associée. Si la constituante associée est un individu, il s’agit du nom complet de la constituante en fonction des paramètres de nom complet de l’organisation cible. |
|
Type
|
type | string |
Type de relation que la relation représente. |
|
Type réciproque
|
reciprocal_type | string |
Décrit la relation de la constituante à la constituante associée. Par exemple, dans une relation entre un constituant masculin et un frère féminin, le type de relation réciproque serait frère. |
|
jour
|
start.d | integer |
Jour de la date floue. |
|
month
|
start.m | integer |
Mois à la date approximative. |
|
année
|
start.y | integer |
L’année dans la date approximative. |
|
jour
|
end.d | integer |
Jour de la date floue. |
|
month
|
end.m | integer |
Mois à la date approximative. |
|
année
|
end.y | integer |
L’année dans la date approximative. |
|
Le conjoint est-il ?
|
is_spouse | boolean |
L’individu associé est-il le conjoint de la constituante (s’applique-t-il uniquement aux relations entre individus) ? |
|
Est-ce que le chef de famille constituant ?
|
is_constituent_head_of_household | boolean |
Est-ce que la constituante est le chef du foyer ? |
|
Le conjoint est-il le chef de famille ?
|
is_spouse_head_of_household | boolean |
Le conjoint est-il le chef du foyer ? |
|
Remarques
|
comment | string |
Commentaire sur la relation. |
|
Est-ce que le contact ?
|
is_organization_contact | boolean |
La constituante représente-t-elle cette organisation en tant que contact (s’applique uniquement aux relations entre les organisations et les individus) ? |
|
L’entreprise principale est-elle principale ?
|
is_primary_business | boolean |
S’agit-il de l’entreprise principale de la constituante (s’applique uniquement aux relations entre les organisations et les individus) ? |
|
Type de contact
|
organization_contact_type | string |
Fournit un contexte pour les interactions avec la personne associée qui représente l’organisation en tant que contact. S’applique uniquement aux relations entre les organisations et les individus. |
|
Poste
|
position | string |
Position de l’individu dans l’organisation. S’applique uniquement aux relations entre les organisations et les individus. |
|
Date d’ajout
|
date_added | date-time |
Date de création de la relation. |
|
Date de modification
|
date_modified | date-time |
Date de la dernière modification de la relation. |
ConstituentApi.SearchResultRead
Résultat de la recherche
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système de la constituante. |
|
Nom
|
name | string |
Nom de la constituante. Pour les individus, ce champ calculé indique le nom complet de la constituante en fonction des paramètres de nom complet de l’organisation cible. |
|
Adresse
|
address | string |
Adresse par défaut de la constituante. |
|
Décédé?
|
deceased | boolean |
Est-ce que la constituante est décédée ? |
|
Messagerie électronique
|
string |
Adresse e-mail de la constituante. |
|
|
État de collecte de fonds
|
fundraiser_status | string |
Le statut de collecte de fonds de la constituante. Pour les individus, ce champ calculé indique si la constituante est Active, Inactive ou None. Pour les organisations, cette valeur sera toujours None. |
|
Inactif?
|
inactive | boolean |
La constituante est-elle inactive ? |
|
ID de recherche
|
lookup_id | string |
Identificateur défini par l’utilisateur pour la constituante. |
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.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.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. |
|
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
|
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. |
|
Seat
|
seat | string |
Affectation de siège pour le participant. |
|
Balise name
|
name_tag | string |
Balise de nom 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. |
FundraisingApi.ApiCollectionOfAppealAttachmentRead
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 FundraisingApi.AppealAttachmentRead |
Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection. |
FundraisingApi.ApiCollectionOfAppealCustomFieldRead
Champs personnalisés
| 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 FundraisingApi.AppealCustomFieldRead |
Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection. |
FundraisingApi.ApiCollectionOfAppealRead
Appels
| 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 FundraisingApi.AppealRead |
Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection. |
FundraisingApi.ApiCollectionOfCampaignAttachmentRead
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 FundraisingApi.CampaignAttachmentRead |
Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection. |
FundraisingApi.ApiCollectionOfCampaignCustomFieldRead
Champs personnalisés
| 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 FundraisingApi.CampaignCustomFieldRead |
Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection. |
FundraisingApi.ApiCollectionOfCampaignRead
Campagnes
| 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 FundraisingApi.CampaignRead |
Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection. |
FundraisingApi.ApiCollectionOfFundAttachmentRead
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 FundraisingApi.FundAttachmentRead |
Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection. |
FundraisingApi.ApiCollectionOfFundCustomFieldRead
Champs personnalisés
| 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 FundraisingApi.FundCustomFieldRead |
Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection. |
FundraisingApi.ApiCollectionOfFundRead
Fonds
| 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 FundraisingApi.FundRead |
Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection. |
FundraisingApi.ApiCollectionOfFundraiserAssignmentRead
Assignments
| 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 FundraisingApi.FundraiserAssignmentRead |
Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection. |
FundraisingApi.ApiCollectionOfPackageRead
Packages
| 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 FundraisingApi.PackageRead |
Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection. |
FundraisingApi.AppealAttachmentRead
Attachment
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système de la pièce jointe. |
|
ID d’appel
|
parent_id | string |
ID d’enregistrement système de l’appel 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. |
FundraisingApi.AppealCustomFieldRead
Champ personnalisé
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système du champ personnalisé. |
|
ID d’appel
|
parent_id | string |
ID d’enregistrement système de l’appel associé au champ personnalisé. |
|
Catégorie
|
category | string |
Catégorie de champ personnalisé. |
|
Type
|
type | string |
Type de données que le champ personnalisé représente. |
|
Valeur
|
value |
Valeur du champ personnalisé. |
|
|
Date
|
date | date |
Date du champ personnalisé. |
|
Commentaire
|
comment | string |
Commentaire sur le champ personnalisé. Limite de caractères : 50. |
|
Date d’ajout
|
date_added | date-time |
Date de création du champ personnalisé. |
|
Date de modification
|
date_modified | date-time |
Date de dernière modification du champ personnalisé. |
FundraisingApi.AppealRead
Appeal
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système de l’appel. |
|
Catégorie
|
category | string |
Catégorie de l’appel. |
|
Date d’ajout
|
date_added | date-time |
Date de création de l’appel. |
|
Date de modification
|
date_modified | date-time |
Date de la dernière modification de l’appel. |
|
Descriptif
|
description | string |
Nom complet de l’appel. |
|
Date de fin
|
end_date | date-time |
Date de fin de l’appel. |
|
value
|
goal.value | double |
Valeur monétaire. |
|
Inactif?
|
inactive | boolean |
L’appel est-il actif (c’est-à-dire que la date actuelle est postérieure à une date de début et avant toute date de fin) ? |
|
ID de recherche
|
lookup_id | string |
Identificateur défini par l’utilisateur pour l’appel. |
|
Date de début
|
start_date | date-time |
Date de début de l’appel. |
FundraisingApi.CampaignAttachmentRead
Attachment
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système de la pièce jointe. |
|
ID de campagne
|
parent_id | string |
ID d’enregistrement système de la campagne associée à 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. |
FundraisingApi.CampaignCustomFieldRead
Champ personnalisé
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système du champ personnalisé. |
|
ID de campagne
|
parent_id | string |
ID d’enregistrement système de la campagne associée au champ personnalisé. |
|
Catégorie
|
category | string |
Catégorie de champ personnalisé. |
|
Type
|
type | string |
Type de données que le champ personnalisé représente. |
|
Valeur
|
value |
Valeur du champ personnalisé. |
|
|
Date
|
date | date |
Date du champ personnalisé. |
|
Commentaire
|
comment | string |
Commentaire sur le champ personnalisé. Limite de caractères : 50. |
|
Date d’ajout
|
date_added | date-time |
Date de création du champ personnalisé. |
|
Date de modification
|
date_modified | date-time |
Date de dernière modification du champ personnalisé. |
FundraisingApi.CampaignRead
Campagne
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système de la campagne. |
|
Catégorie
|
category | string |
Catégorie de la campagne. |
|
Date d’ajout
|
date_added | date-time |
Date de création de la campagne. |
|
Date de modification
|
date_modified | date-time |
Date de la dernière modification de la campagne. |
|
Descriptif
|
description | string |
Nom complet de la campagne. |
|
Date de fin
|
end_date | date-time |
Date de fin de la campagne. |
|
value
|
goal.value | double |
Valeur monétaire. |
|
Inactif?
|
inactive | boolean |
La campagne est-elle inactive (c’est-à-dire que la date actuelle est postérieure à une date de début et avant toute date de fin) ? |
|
ID de recherche
|
lookup_id | string |
Identificateur défini par l’utilisateur pour la campagne. |
|
Date de début
|
start_date | date-time |
Date de début de la campagne. |
FundraisingApi.CreatedAppealAttachment
Pièce jointe d’appel créée
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID de la pièce jointe d’appel nouvellement créée. |
FundraisingApi.CreatedAppealCustomField
Champ personnalisé d’appel créé
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID du champ personnalisé d’appel nouvellement créé. |
FundraisingApi.CreatedCampaignAttachment
Pièce jointe de campagne créée
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID de la pièce jointe de la campagne nouvellement créée. |
FundraisingApi.CreatedCampaignCustomField
Champ personnalisé de campagne créé
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID du champ personnalisé de la campagne nouvellement créée. |
FundraisingApi.CreatedFundraiserAssignment
Création d’une affectation de collecte de fonds
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID de l’affectation de collecte de fonds nouvellement créée. |
FundraisingApi.CreatedFundAttachment
Pièce jointe de fonds créée
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID de la pièce jointe nouvellement créée. |
FundraisingApi.CreatedFundCustomField
Champ personnalisé de fonds créé
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID du champ personnalisé du fonds nouvellement créé. |
FundraisingApi.FundraisingAssignmentRead
Assignment
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système de l’affectation de collecte de fonds. |
|
ID constituant
|
constituent_id | string |
ID d’enregistrement système de la constituante affectée. |
|
Type
|
type | string |
Type de collecte de fonds. |
|
Début de l’affectation
|
start | date-time |
Date de début de l’affectation. |
|
Fin de l’affectation
|
end | date-time |
Date de fin de l’affectation. |
|
value
|
amount.value | double |
Valeur monétaire. |
|
ID de campagne
|
campaign_id | string |
ID d’enregistrement système de la campagne à laquelle les dons résultants seront appliqués. |
|
ID du fonds
|
fund_id | string |
ID d’enregistrement système du fonds auquel les dons résultants seront appliqués. |
|
ID d’appel
|
appeal_id | string |
ID d’enregistrement système de l’appel auquel les dons résultants seront appliqués. |
FundraisingApi.FundAttachmentRead
Attachment
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système de la pièce jointe. |
|
ID du fonds
|
parent_id | string |
ID d’enregistrement système du fonds 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. |
FundraisingApi.FundCustomFieldRead
Champ personnalisé
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système du champ personnalisé. |
|
ID du fonds
|
parent_id | string |
ID d’enregistrement système du fonds associé au champ personnalisé. |
|
Catégorie
|
category | string |
Catégorie de champ personnalisé. |
|
Type
|
type | string |
Type de données que le champ personnalisé représente. |
|
Valeur
|
value |
Valeur du champ personnalisé. |
|
|
Date
|
date | date |
Date du champ personnalisé. |
|
Commentaire
|
comment | string |
Commentaire sur le champ personnalisé. Limite de caractères : 50. |
|
Date d’ajout
|
date_added | date-time |
Date de création du champ personnalisé. |
|
Date de modification
|
date_modified | date-time |
Date de dernière modification du champ personnalisé. |
FundraisingApi.FundRead
Fonds
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système du fonds. |
|
Catégorie
|
category | string |
Catégorie du fonds. |
|
Date d’ajout
|
date_added | date-time |
Date de création du fonds. |
|
Date de modification
|
date_modified | date-time |
Date de la dernière modification du fonds. |
|
Descriptif
|
description | string |
Nom complet du fonds. |
|
Date de fin
|
end_date | date-time |
Date de fin du fonds. |
|
value
|
goal.value | double |
Valeur monétaire. |
|
Inactif?
|
inactive | boolean |
Le fonds est-il inactif (c’est-à-dire que la date actuelle est postérieure à une date de début et avant toute date de fin) ? |
|
ID de recherche
|
lookup_id | string |
Identificateur défini par l’utilisateur pour le fonds. |
|
Date de début
|
start_date | date-time |
Date de début du fonds. |
|
Type
|
type | string |
Type de fonds. |
FundraisingApi.PackageRead
Package
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système du package. |
|
ID d’appel
|
appeal_id | string |
ID d’enregistrement système de l’appel associé à ce package. |
|
Catégorie
|
category | string |
Catégorie du package. |
|
Date d’ajout
|
date_added | date-time |
Date de création du package. |
|
Date de modification
|
date_modified | date-time |
Date de la dernière modification du package. |
|
value
|
default_gift_amount.value | double |
Valeur monétaire. |
|
Descriptif
|
description | string |
Nom complet du package. |
|
Date de fin
|
end | date-time |
Date de fin du package. |
|
value
|
goal.value | double |
Valeur monétaire. |
|
Inactif?
|
inactive | boolean |
Le package est-il inactif (c’est-à-dire que la date actuelle est postérieure à une date de début et avant toute date de fin) ? |
|
ID de recherche
|
lookup_id | string |
Identificateur défini par l’utilisateur pour le package. |
|
Remarques
|
notes | string |
Notes sur le package. |
|
Nombre de destinataires
|
recipient_count | integer |
Nombre de destinataires du package. |
|
Date de début
|
start | date-time |
Date de début du package. |
GiftApi.AcknowledgementRead
Reconnaissance
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
date
|
date | date-time |
Date associée à l’accusé de réception. |
|
lettre
|
letter | string |
Lettre associée à l’accusé de réception. |
|
status
|
status | string |
État de l’accusé de réception. Les valeurs disponibles sont : ACKNOWLEDGED, NEEDSACKNOWLEDGEMENT et DONOTACKNOWLEDGE. |
GiftApi.ApiCollectionOfGiftAttachmentRead
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 GiftApi.GiftAttachmentRead |
Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection. |
GiftApi.ApiCollectionOfGiftCustomFieldRead
Champs personnalisés
| 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 GiftApi.GiftCustomFieldRead |
Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection. |
GiftApi.ApiCollectionOfGiftRead
Cadeaux
| 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 GiftApi.GiftRead |
Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection. |
GiftApi.BatchGiftAddResults
Contient une collection d’enregistrements d’erreurs de cadeau par lots et les cadeaux par lots ajoutés par l’opération
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Erreurs
|
errors | array of GiftApi.GiftBatchGiftError |
Erreurs de cadeau de lot associées à l’opération d’ajout de cadeau par lot |
|
Cadeaux
|
gifts | array of GiftApi.BatchGiftRead |
Collection de cadeaux par lots qui ont été ajoutés par l’opération d’ajout de cadeaux par lot |
GiftApi.GiftBatchGiftError
Représente des exceptions empêchant l’ajout d’éléments au lot.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
champ affecté
|
affected_field | string |
Champ affecté par l’erreur |
|
ID de lot
|
batch_id | string |
ID d’enregistrement système du lot |
|
code d’erreur d’exception
|
exception_error_code | integer |
Code d’erreur d’exception |
|
Message d’erreur d’exception
|
exception_error_message | string |
Message d’erreur d’exception |
|
nom d’erreur d’exception
|
exception_error_name | string |
Nom de l’erreur d’exception |
|
ID cadeau
|
gift_id | string |
ID d’enregistrement système du cadeau |
|
ID de recherche
|
lookup_id | string |
Identificateur défini par l’utilisateur pour le cadeau. |
GiftApi.BatchGiftRead
Cadeau batch
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de lot
|
batch_id | string |
ID du lot auquel le cadeau a été ajouté. |
|
Erreurs
|
errors | array of GiftApi.GiftBatchGiftError |
Erreurs associées au cadeau de lot. |
|
ID
|
id | string |
ID d’enregistrement système du cadeau de lot. |
|
ID de constituant
|
constituent_id | string |
ID d’enregistrement système de la constituante associée au cadeau. |
|
type
|
type | string |
Le type de cadeau. |
|
Sous-type
|
subtype | string |
Sous-type du cadeau. |
|
date
|
date | date-time |
Date du cadeau. |
|
value
|
amount.value | double |
Valeur monétaire. |
|
value
|
balance.value | double |
Valeur monétaire. |
|
numéro de lot
|
batch_number | string |
Numéro de lot associé à ce cadeau. |
|
status
|
gift_status | string |
Le statut du cadeau. |
|
anonyme?
|
is_anonymous | boolean |
Le cadeau est-il anonyme ? |
|
circonscription
|
constituency | string |
La circonscription du cadeau. |
|
ID de recherche
|
lookup_id | string |
Identificateur défini par l’utilisateur pour le cadeau. |
|
origin
|
origin | string |
L’origine du cadeau. |
|
publier l’état
|
post_status | string |
État du registre général du cadeau. Les valeurs disponibles sont Publiées, NotPosted et DoNotPost. Lorsque post_status est défini sur DoNotPost>, post_date doit être null. Lorsqu’elle est définie sur NotPosted, post_date est nécessaire, mais reste modifiable. Lorsqu’il est défini sur Publié, post_date est requis et n’est plus modifiable. |
|
date de publication
|
post_date | date-time |
Date à laquelle le cadeau a été publié dans le registre général. |
|
référence
|
reference | string |
Remarques pour suivre des détails spéciaux sur un cadeau, comme la motivation derrière elle ou une description détaillée d’un cadeau en nature. |
|
jour
|
recurring_gift_status_date.d | integer |
Jour de la date floue. |
|
month
|
recurring_gift_status_date.m | integer |
Mois à la date approximative. |
|
année
|
recurring_gift_status_date.y | integer |
L’année dans la date approximative. |
|
frequency
|
recurring_gift_schedule.frequency | string |
Fréquence d’installation du cadeau périodique à afficher. Les valeurs disponibles sont HEBDOMADAIRES, EVERY_TWO_WEEKS, EVERY_FOUR_WEEKS, MENSUELLES, TRIMESTRIELLES, ANNUELLES. |
|
start
|
recurring_gift_schedule.start_date | date-time |
Date de début du cadeau périodique. |
|
end
|
recurring_gift_schedule.end_date | date-time |
Date de fin du cadeau périodique. |
|
value
|
gift_aid_amount.value | double |
Valeur monétaire. |
|
statut de qualification d’aide-cadeau
|
gift_aid_qualification_status | string |
Ce champ calculé détermine l’état de qualification de l’Aide cadeau en fonction des informations de déclaration fiscale et du format de base de données. Les valeurs disponibles sont les suivantes : Qualifié, NotQualified et PartiellementQualified. Pour le Royaume-Uni uniquement. |
|
code cadeau
|
gift_code | string |
Valeur du code cadeau associée au cadeau. |
|
fractionnements de cadeaux
|
gift_splits | array of GiftApi.GiftSplitRead |
Ensemble de fractionnements de cadeaux associés au cadeau. |
|
collectes de fonds
|
fundraisers | array of GiftApi.GiftFundraiserRead |
Ensemble de collectes de fonds qui reçoivent un crédit pour le cadeau. |
|
Crédits souples
|
soft_credits | array of GiftApi.SoftCreditRead |
Ensemble de crédits souples associés au cadeau. |
|
Reçus
|
receipts | array of GiftApi.ReceiptRead |
Ensemble de reçus associés au cadeau. |
|
Remerciements
|
acknowledgements | array of GiftApi.AcknowledgementRead |
Ensemble d’accusés de réception associés au cadeau. |
|
Paiements
|
payments | array of GiftApi.PaymentRead |
Les paiements sur le cadeau. |
|
Cadeaux liés
|
linked_gifts | array of string |
Identificateurs d’autres cadeaux liés à ce cadeau. |
|
Date d’ajout
|
date_added | date-time |
Date de création du cadeau. |
|
Date de modification
|
date_modified | date-time |
Date de la dernière modification du cadeau. |
GiftApi.CreatedGift
Cadeau créé
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID du cadeau nouvellement créé. |
GiftApi.CreatedGiftAttachment
Pièce jointe cadeau créée
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID de la pièce jointe cadeau nouvellement créée. |
GiftApi.CreatedGiftCustomField
Champ personnalisé cadeau créé
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID du champ personnalisé cadeau nouvellement créé. |
GiftApi.GiftAttachmentRead
Attachment
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système de la pièce jointe. |
|
ID cadeau
|
parent_id | string |
ID d’enregistrement système du cadeau 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. |
GiftApi.GiftCustomFieldRead
Champ personnalisé
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système du champ personnalisé. |
|
ID cadeau
|
parent_id | string |
ID d’enregistrement système du cadeau associé au champ personnalisé. |
|
Catégorie
|
category | string |
Catégorie de champ personnalisé. |
|
Type
|
type | string |
Type de données que le champ personnalisé représente. |
|
Valeur
|
value |
Valeur du champ personnalisé. |
|
|
Date
|
date | date |
Date du champ personnalisé. |
|
Commentaire
|
comment | string |
Commentaire sur le champ personnalisé. Limite de caractères : 50. |
|
Date d’ajout
|
date_added | date-time |
Date de création du champ personnalisé. |
|
Date de modification
|
date_modified | date-time |
Date de dernière modification du champ personnalisé. |
GiftApi.GiftFundraiserRead
Collecte de fonds sur les cadeaux
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
value
|
amount.value | double |
Valeur monétaire. |
|
ID de collecte de fonds
|
constituent_id | string |
ID d’enregistrement système constituant pour la collecte de fonds associée au cadeau. |
GiftApi.GiftRead
Cadeau
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système du cadeau. |
|
ID constituant
|
constituent_id | string |
ID d’enregistrement système de la constituante associée au cadeau. |
|
Type
|
type | string |
Le type de cadeau. |
|
Sous-type
|
subtype | string |
Sous-type du cadeau. |
|
Date
|
date | date-time |
Date du cadeau. |
|
value
|
amount.value | double |
Valeur monétaire. |
|
value
|
balance.value | double |
Valeur monétaire. |
|
Numéro de lot
|
batch_number | string |
Numéro de lot associé à ce cadeau. |
|
Statut
|
gift_status | string |
Le statut du cadeau. |
|
Anonyme?
|
is_anonymous | boolean |
Le cadeau est-il anonyme ? |
|
Circonscription
|
constituency | string |
La circonscription du cadeau. |
|
ID de recherche
|
lookup_id | string |
Identificateur défini par l’utilisateur pour le cadeau. |
|
Origin
|
origin | string |
L’origine du cadeau. |
|
Publier l’état
|
post_status | string |
État du registre général du cadeau. Les valeurs disponibles sont Publiées, NotPosted et DoNotPost. Lorsque post_status est défini sur DoNotPost>, post_date doit être null. Lorsqu’elle est définie sur NotPosted, post_date est nécessaire, mais reste modifiable. Lorsqu’il est défini sur Publié, post_date est requis et n’est plus modifiable. |
|
Date de publication
|
post_date | date-time |
Date à laquelle le cadeau a été publié dans le registre général. |
|
Reference
|
reference | string |
Remarques pour suivre des détails spéciaux sur un cadeau, comme la motivation derrière elle ou une description détaillée d’un cadeau en nature. |
|
jour
|
recurring_gift_status_date.d | integer |
Jour de la date floue. |
|
month
|
recurring_gift_status_date.m | integer |
Mois à la date approximative. |
|
année
|
recurring_gift_status_date.y | integer |
L’année dans la date approximative. |
|
frequency
|
recurring_gift_schedule.frequency | string |
Fréquence d’installation du cadeau périodique à afficher. Les valeurs disponibles sont HEBDOMADAIRES, EVERY_TWO_WEEKS, EVERY_FOUR_WEEKS, MENSUELLES, TRIMESTRIELLES, ANNUELLES. |
|
start
|
recurring_gift_schedule.start_date | date-time |
Date de début du cadeau périodique. |
|
end
|
recurring_gift_schedule.end_date | date-time |
Date de fin du cadeau périodique. |
|
value
|
gift_aid_amount.value | double |
Valeur monétaire. |
|
Statut de qualification de l’aide cadeau
|
gift_aid_qualification_status | string |
Ce champ calculé détermine l’état de qualification de l’Aide cadeau en fonction des informations de déclaration fiscale et du format de base de données. Les valeurs disponibles sont les suivantes : Qualifié, NotQualified et PartiellementQualified. Pour le Royaume-Uni uniquement. |
|
Code cadeau
|
gift_code | string |
Valeur du code cadeau associée au cadeau. |
|
Fractionnements de cadeaux
|
gift_splits | array of GiftApi.GiftSplitRead |
Ensemble de fractionnements de cadeaux associés au cadeau. |
|
Collectes de fonds
|
fundraisers | array of GiftApi.GiftFundraiserRead |
Ensemble de collectes de fonds qui reçoivent un crédit pour le cadeau. |
|
Crédits souples
|
soft_credits | array of GiftApi.SoftCreditRead |
Ensemble de crédits souples associés au cadeau. |
|
Reçus
|
receipts | array of GiftApi.ReceiptRead |
Ensemble de reçus associés au cadeau. |
|
Remerciements
|
acknowledgements | array of GiftApi.AcknowledgementRead |
Ensemble d’accusés de réception associés au cadeau. |
|
Paiements
|
payments | array of GiftApi.PaymentRead |
Les paiements sur le cadeau. |
|
Cadeaux liés
|
linked_gifts | array of string |
Identificateurs d’autres cadeaux liés à ce cadeau. |
|
Date d’ajout
|
date_added | date-time |
Date de création du cadeau. |
|
Date de modification
|
date_modified | date-time |
Date de la dernière modification du cadeau. |
GiftApi.GiftSplitRead
Fractionnement du cadeau
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système du fractionnement du cadeau. |
|
value
|
amount.value | double |
Valeur monétaire. |
|
ID d’appel
|
appeal_id | string |
ID d’enregistrement système de l’appel associé au fractionnement du cadeau. |
|
ID de campagne
|
campaign_id | string |
ID d’enregistrement système de la campagne associée au fractionnement du cadeau. |
|
ID de fonds
|
fund_id | string |
ID d’enregistrement système du fonds associé au fractionnement du cadeau. |
|
value
|
gift_aid_amount.value | double |
Valeur monétaire. |
|
statut de qualification d’aide-cadeau
|
gift_aid_qualification_status | string |
Le statut de qualification de l’aide cadeau du fractionnement du cadeau. Les valeurs disponibles sont les suivantes : Qualifié et NotQualified. Pour le Royaume-Uni uniquement. |
|
ID de package
|
package_id | string |
ID d’enregistrement système du package associé au fractionnement cadeau. |
GiftApi.ReceiptRead
Reçu
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
value
|
amount.value | double |
Valeur monétaire. |
|
date
|
date | date-time |
Date du reçu. |
|
nombre
|
number | integer |
Numéro du reçu. |
|
status
|
status | string |
État du reçu. Les valeurs disponibles sont les suivantes : RECEIPTED, NEEDSRECEIPT et DONOTRECEIPT. |
GiftApi.PaymentRead
Paiement
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
jeton de compte
|
account_token | string |
Informations sur le compte jeton (par exemple, carte de crédit) du fournisseur de paiement externe. S’applique uniquement aux modes de paiement de « CreditCard » et « DirectDebit ». |
|
BBPS configuration ID
|
bbps_configuration_id | string |
ID de configuration BBPS. S’applique uniquement aux modes de paiement de « CreditCard » et « DirectDebit ». |
|
BBPS transaction ID
|
bbps_transaction_id | string |
ID de transaction BBPS. S’applique uniquement aux modes de paiement de « CreditCard » et « DirectDebit ». |
|
jour
|
check_date.d | integer |
Jour de la date floue. |
|
month
|
check_date.m | integer |
Mois à la date approximative. |
|
année
|
check_date.y | integer |
L’année dans la date approximative. |
|
vérifier le numéro
|
check_number | string |
Numéro de vérification. S’applique uniquement au mode de paiement de « PersonalCheck ». |
|
extraction de l’ID de transaction
|
checkout_transaction_id | string |
ID de transaction d’extraction. S’applique uniquement aux modes de paiement de « CreditCard » et « DirectDebit ». |
|
mode de paiement
|
payment_method | string |
Mode de paiement. Les valeurs disponibles sont répertoriées ci-dessous. |
|
référence
|
reference | string |
Référence. S’applique uniquement au mode de paiement « Autre ». |
|
jour
|
reference_date.d | integer |
Jour de la date floue. |
|
month
|
reference_date.m | integer |
Mois à la date approximative. |
|
année
|
reference_date.y | integer |
L’année dans la date approximative. |
GiftApi.SoftCreditRead
Crédit logiciel
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système du crédit logiciel. |
|
value
|
amount.value | double |
Valeur monétaire. |
|
ID de constituant
|
constituent_id | string |
ID d’enregistrement système de la constituante associée au crédit logiciel. |
|
ID cadeau
|
gift_id | string |
ID d’enregistrement système du cadeau associé au crédit logiciel. |
GiftBatchApi.ApiCollectionOfGiftBatch
Lots de cadeaux
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nombre
|
count | integer |
Nombre total de lots de cadeaux dans la réponse. |
|
value
|
value | array of GiftBatchApi.GiftBatch |
Ensemble d’éléments inclus dans la réponse. |
GiftBatchApi.CreatedBatch
Lot cadeau créé
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
batch_id | string |
ID d’enregistrement système du lot cadeau nouvellement créé. |
GiftBatchApi.GiftBatch
Représente l’objet de lot cadeau
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système du lot. |
|
descriptif
|
batch_description | string |
Description du lot. |
|
numéro de lot
|
batch_number | string |
Numéro de lot |
|
numéro projeté
|
projected_number_of_gifts | integer |
Nombre projeté de cadeaux dans le lot. |
|
nombre réel
|
number_of_gifts | integer |
Nombre réel de cadeaux dans le lot. |
|
montant projeté
|
projected_amount | double |
Valeur projetée des cadeaux dans le lot. |
|
montant réel
|
actual_amount | double |
Valeur réelle des cadeaux dans le lot. |
|
a-t-il des exceptions ?
|
has_exceptions | boolean |
Le lot a-t-il des exceptions ? |
|
approuvé?
|
is_approved | boolean |
Le lot est-il approuvé ? |
|
Créé par
|
created_by | string |
Nom de l’utilisateur qui a créé le lot. |
|
Date de création
|
created_on | date-time |
Date de création du lot. |
ListApi.CreatedList
Liste créée
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID de la liste nouvellement créée. |
OpportunityApi.ApiCollectionOfOpportunityAttachmentRead
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 OpportunityApi.OpportunityAttachmentRead |
Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection. |
OpportunityApi.ApiCollectionOfOpportunityCustomFieldRead
Champs personnalisés
| 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 OpportunityApi.OpportunityCustomFieldRead |
Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection. |
OpportunityApi.ApiCollectionOfOpportunityRead
Possibilités
| 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 OpportunityApi.OpportunityRead |
Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection. |
OpportunityApi.CreatedOpportunity
Opportunité créée
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID de l’opportunité nouvellement créée. |
OpportunityApi.CreatedOpportunityAttachment
Pièce jointe d’opportunité créée
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID de la pièce jointe d’opportunité nouvellement créée. |
OpportunityApi.CreatedOpportunityCustomField
Pièce jointe d’opportunité créée
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID de la pièce jointe d’opportunité nouvellement créée. |
OpportunityApi.Collecte de fonds
Collecte de fonds
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID constituant
|
constituent_id | string |
ID d’enregistrement système du constituant associé à la collecte de fonds. |
|
value
|
credit_amount.value | double |
Valeur monétaire. |
OpportunityApi.OpportunityAttachmentRead
Attachment
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système de la pièce jointe. |
|
ID d’opportunité
|
parent_id | string |
ID d’enregistrement système de l’opportunité associée à 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. |
OpportunityApi.OpportunityCustomFieldRead
Champ personnalisé
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système du champ personnalisé. |
|
ID d’opportunité
|
parent_id | string |
ID d’enregistrement système de l’opportunité associée au champ personnalisé. |
|
Catégorie
|
category | string |
Catégorie de champ personnalisé. |
|
Type
|
type | string |
Type de données que le champ personnalisé représente. |
|
Valeur
|
value |
Valeur du champ personnalisé. |
|
|
Date
|
date | date |
Date du champ personnalisé. |
|
Commentaire
|
comment | string |
Commentaire sur le champ personnalisé. Limite de caractères : 50. |
|
Date d’ajout
|
date_added | date-time |
Date de création du champ personnalisé. |
|
Date de modification
|
date_modified | date-time |
Date de dernière modification du champ personnalisé. |
OpportunityApi.OpportunityRead
Opportunité
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID d’enregistrement système de l’opportunité. |
|
ID constituant
|
constituent_id | string |
ID d’enregistrement système de la constituante associée à l’opportunité. |
|
Objectif
|
purpose | string |
Utilisation prévue pour toute somme levée suite à l’opportunité. |
|
Nom
|
name | string |
Nom qui identifie l’opportunité tout au long du programme, par exemple dans les listes ou dans les dossiers constituants. Limite de caractères : 255. |
|
Statut
|
status | string |
Le statut qui indique où se trouve l’opportunité dans le processus de sollicitation. |
|
Échéance
|
deadline | date-time |
Date d’objectif pour l’occasion de donner un cadeau. |
|
Demander la date
|
ask_date | date-time |
Date à laquelle la sollicitation a été faite. |
|
value
|
ask_amount.value | double |
Valeur monétaire. |
|
Date attendue
|
expected_date | date-time |
Date à laquelle la perspective devrait donner suite à l’opportunité. |
|
value
|
expected_amount.value | double |
Valeur monétaire. |
|
Date de financement
|
funded_date | date-time |
Date à laquelle la perspective a donné suite à l’opportunité. |
|
value
|
funded_amount.value | double |
Valeur monétaire. |
|
ID de campagne
|
campaign_id | string |
ID d’enregistrement système de la campagne associée à l’opportunité. La campagne définit les objectifs globaux de collecte d’argent. |
|
ID du fonds
|
fund_id | string |
ID d’enregistrement système du fonds associé à l’opportunité. Le fonds désigne l’objectif financier spécifique d’un cadeau et identifie le compte financier de ce cadeau. |
|
Collecte de fonds
|
fundraisers | array of OpportunityApi.Fundraiser |
Ensemble d’ID d’enregistrement système pour les collectes de fonds affectées à l’opportunité. |
|
Inactif?
|
inactive | boolean |
L’opportunité est-elle inactive ? |
|
linked_gifts
|
linked_gifts | array of string |
Le système enregistre les ID des cadeaux liés à l’opportunité. |
|
Date d’ajout
|
date_added | date-time |
Date de création de l’opportunité. |
|
Date de modification
|
date_modified | date-time |
Date de la dernière modification de l’opportunité. |