Partager via


Blackbaud Raisers Edge NXT Constituents

Blackbaud Raiser’s Edge NXT est une solution logicielle complète de collecte de fonds et de gestion des donateurs basée sur le cloud conçue spécifiquement pour les organisations à but non lucratif et l’ensemble de la bonne communauté sociale. Utilisez le connecteur Constituants pour gérer les détails biographiques, les coordonnées et les relations constituantes.

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 - Non disponible
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 constituants et les entités associées trouvées dans le NXT edge de The Raiser, notamment :

  • Constituants
  • Addresses
  • Téléphones et e-mails
  • Aliases
  • Champs personnalisés
  • Remarques
  • Attachments
  • Relations interpersonnelles
  • et bien plus encore...

Pour plus d’informations, consultez la documentation.

Prerequisites

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

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

Comment obtenir des informations d’identification ?

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

Problèmes connus et limitations

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

Limitations

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

Actions

Convertir en constituant

Convertit un non-constituant en constituant.

Créer un alias constituant

Crée un alias constituant.

Créer un champ personnalisé constituant

Crée un champ personnalisé constituant.

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 enregistrement de consentement constituant

Crée un enregistrement de consentement constituant.

Créer un format de nom constituant

Crée un nouveau format de nom constituant.

Créer un format de nom principal constituant

Crée un format de nom principal pour un constituant.

Créer un hommage constituant

Crée un hommage constituant.

Créer un hommage reconnu

Crée un hommage reconnu.

Créer un téléphone constituant

Crée un téléphone constituant.

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 note constituante

Crée une note constituante.

Créer une organisation constituante

Crée une organisation constituante.

Créer une pièce jointe constituante

Crée une pièce jointe constituante.

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.

Liste des constituants

Retourne une liste de constituants.

Lister les accusés de réception d’hommage

Répertorie les accusés de réception pour un hommage.

Lister les notes constituantes

Répertorie les notes d’un constituant.

Lister les téléphones constituants

Répertorie les téléphones d’un constituant.

Mettre à jour un alias constituant

Met à jour un alias constituant.

Mettre à jour un champ personnalisé constituant

Met à jour un champ personnalisé constituant.

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 format de nom constituant

Met à jour un format de nom constituant.

Mettre à jour un format de nom principal constituant

Met à jour le format de nom principal d’un constituant.

Mettre à jour un téléphone constituant

Met à jour un téléphone constituant.

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 pièce jointe constituante

Met à jour une pièce jointe constituante.

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 résumé du format de nom de la constituante

Retourne le résumé du format de nom d’un constituant.

Obtenir un constituant

Retourne des informations sur un constituant.

Obtenir un constituant par ID de recherche

Retourne l’ID d’enregistrement système d’un constituant à partir de l’ID de recherche spécifié.

Obtenir un hommage constituant

Retourne des détails sur un hommage constituant.

Obtenir une image de profil constituante

Retourne l’image de profil actuelle d’un constituant.

Rechercher des constituants en double

Recherche des enregistrements de contacts individuels, de l’organisation et des enregistrements de contacts associés et classe les doublons potentiels en fonction des filtres de recherche spécifiés. Les enregistrements qui correspondent à plusieurs filtres sont classés plus hauts en tant que doublons potentiels.

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.

Rechercher un constituant (amélioré)

Recherche des enregistrements constituants à l’aide des critères de filtre donnés.

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 appartenances constituantes

Répertorie les appartenances à un constituant.

Répertorier les champs personnalisés constituants

Répertorie les champs personnalisés d’un constituant.

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 enregistrements de consentement constituants

Répertorie les enregistrements de consentement d’un constituant.

Répertorier les hommages constituants

Répertorie les hommages à un constituant.

Répertorier les pièces jointes constituantes

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

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.

Supprimer un code constituant

Supprime un code constituant.

Convertir en constituant

Convertit un non-constituant en constituant.

Paramètres

Nom Clé Obligatoire Type Description
ID non constituant
non_constituent_id True string

ID d’enregistrement système de l’enregistrement non constituant à convertir.

ID
id string

ID d’enregistrement système du 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.

Séquence
sequence integer

Séquence du code constituant.

Retours

Constituant converti

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 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 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 ?

Vous ne demande pas d’e-mail ?
requests_no_email boolean

La constituante ne demande-t-elle aucun e-mail ?

Est-ce qu’un avocat ?
is_solicitor boolean

Est-ce que la constituante est un avocat ?

Aucune adresse valide ?
no_valid_address boolean

La constituante n’a-t-elle pas d’adresses valides ?

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.

Cible
target string

Cible de la constituante.

Revenu
income string

Revenu de la constituante.

Type de reçu
receipt_type string

Type de reçu 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.

Est-ce que memorial ?
is_memorial boolean

Est-ce que la constituante est un honneur/memorial ?

Retours

Création d’une constituante individuelle

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 format de nom constituant

Crée un nouveau format de nom constituant.

Paramètres

Nom Clé Obligatoire Type Description
ID constituant
constituent_id True string

ID d’enregistrement système de la constituante.

Type
type True string

Type de format de nom.

Format de nom personnalisé ?
custom_format boolean

Est-ce qu’un format personnalisé ?

Format
configuration_id string

Configuration du format de nom (obligatoire, sauf si un format personnalisé est utilisé).

Nom personnalisé
formatted_name string

Nom mis en forme (obligatoire lorsqu’un format personnalisé est utilisé). Limite de caractères : 255.

Retours

Format de nom créé

Créer un format de nom principal constituant

Crée un format de nom principal pour un constituant.

Paramètres

Nom Clé Obligatoire Type Description
ID constituant
constituent_id True string

ID d’enregistrement système de la constituante.

Type
primary_type True string

Type de format de nom principal.

Format de nom personnalisé ?
custom_format boolean

Est-ce qu’un format personnalisé ?

Format
configuration_id string

Configuration du format de nom (obligatoire, sauf si un format personnalisé est utilisé).

Nom personnalisé
formatted_name string

Nom mis en forme (obligatoire lorsqu’un format personnalisé est utilisé). Limite de caractères : 255.

Retours

Format de nom créé

Créer un hommage constituant

Crée un hommage constituant.

Paramètres

Nom Clé Obligatoire Type Description
ID constituant
constituent_record_id True integer

ID d’enregistrement système de la constituante associée à l’hommage.

Type d’hommage
tribute_type_id True integer

Le type d’hommage.

Descriptif
description string

Description de l’hommage.

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.

ID de fonds par défaut
default_fund_id integer

ID d’enregistrement système du fonds par défaut associé à l’hommage.

Remarques
notes string

Les notes d’hommage.

Actif?
is_active boolean

Est-ce que cet hommage est actif ?

Retours

Hommage constituant créé

Créer un hommage reconnu

Crée un hommage reconnu.

Paramètres

Nom Clé Obligatoire Type Description
ID d’hommage
tribute_id True integer

ID d’enregistrement système de l’hommage associé à l’accusé de réception.

ID de relation
relationship_id integer

ID d’enregistrement système de la relation (s’il s’agit d’une valeur Null, il s’agit d’un accusé de réception automatique).

ID de lettre
letter_id integer

ID de lettre.

Retours

Reconnaissance de l’hommage 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 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 (par exemple : '2020-09-18T04:13:56Z').

Fin de l’affectation
end date-time

Date de fin de l’affectation (par exemple : '2020-09-18T04:13:56Z').

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

Auteur
author string

Auteur de la note. S’il n’est pas fourni, un jeu par défaut est défini en fonction du compte de l’utilisateur. Limite de caractères : 50.

Retours

Note constituante créée

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 ?

Vous ne demande pas d’e-mail ?
requests_no_email boolean

La constituante ne demande-t-elle aucun e-mail ?

Est-ce qu’un avocat ?
is_solicitor boolean

Est-ce que la constituante est un avocat ?

Aucune adresse valide ?
no_valid_address boolean

La constituante n’a-t-elle pas d’adresses valides ?

Cible
target string

Cible de la constituante.

Revenu
income string

Revenu de la constituante.

Type de reçu
receipt_type string

Type de reçu de la constituante.

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.

Est-ce que memorial ?
is_memorial boolean

Est-ce que la constituante est un honneur/memorial ?

Retours

Création d’une organisation constituante

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.

Étiquettes
tags array of string

Balises associées à la pièce jointe.

Retours

Pièce jointe constituante 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

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’ID d’enregistrement système 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 accusés de réception d’hommage

Répertorie les accusés de réception pour un hommage.

Paramètres

Nom Clé Obligatoire Type Description
ID d’hommage
tributeId True integer

ID d’enregistrement système de l’hommage.

Retours

Reconnaissances d’hommage

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 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 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é 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 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 ?

Vous ne demande pas d’e-mail ?
requests_no_email boolean

La constituante ne demande-t-elle aucun e-mail ?

Est-ce qu’un avocat ?
is_solicitor boolean

Est-ce que la constituante est un avocat ?

Aucune adresse valide ?
no_valid_address boolean

La constituante n’a-t-elle pas d’adresses valides ?

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

Cible
target string

Cible de la constituante.

Revenu
income string

Revenu de la constituante (pour les particuliers uniquement).

Type de reçu
receipt_type string

Type de reçu de la constituante.

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.

Est-ce que memorial ?
is_memorial boolean

Est-ce que la constituante est un honneur/memorial ?

Mettre à jour un format de nom constituant

Met à jour un format de nom constituant.

Paramètres

Nom Clé Obligatoire Type Description
ID de format de nom
name_format_id True string

ID d’enregistrement système du format de nom à mettre à jour.

Type
type string

Type de format de nom.

Format de nom personnalisé ?
custom_format boolean

Est-ce qu’un format personnalisé ?

Format
configuration_id string

Configuration du format de nom (obligatoire, sauf si un format personnalisé est utilisé).

Nom personnalisé
formatted_name string

Nom mis en forme (obligatoire lorsqu’un format personnalisé est utilisé). Limite de caractères : 255.

Mettre à jour un format de nom principal constituant

Met à jour le format de nom principal d’un constituant.

Paramètres

Nom Clé Obligatoire Type Description
ID de format de nom
primary_name_format_id True string

ID d’enregistrement système du format de nom principal à mettre à jour.

Format de nom personnalisé ?
custom_format boolean

Est-ce qu’un format personnalisé ?

Format
configuration_id string

Configuration du format de nom (obligatoire, sauf si un format personnalisé est utilisé).

Nom personnalisé
formatted_name string

Nom mis en forme (obligatoire lorsqu’un format personnalisé est utilisé). Limite de caractères : 255.

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

Étiquettes
tags array of string

Balises associées à la pièce jointe.

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 résumé du format de nom de la constituante

Retourne le résumé du format de nom 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

Résumé du format de nom

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 constituant par ID de recherche

Retourne l’ID d’enregistrement système d’un constituant à partir de l’ID de recherche spécifié.

Paramètres

Nom Clé Obligatoire Type Description
ID de recherche
constituent_id True string

ID de recherche constituant.

Retours

Carte d’ID constituante

Obtenir un hommage constituant

Retourne des détails sur un hommage constituant.

Paramètres

Nom Clé Obligatoire Type Description
ID d’hommage
tribute_id True string

ID d’hommage.

Retours

Tribut

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

Rechercher des constituants en double

Recherche des enregistrements de contacts individuels, de l’organisation et des enregistrements de contacts associés et classe les doublons potentiels en fonction des filtres de recherche spécifiés. Les enregistrements qui correspondent à plusieurs filtres sont classés plus hauts en tant que doublons potentiels.

Paramètres

Nom Clé Obligatoire Type Description
Nom/nom de l’organisation
last_org_name True string

Filtre pour les enregistrements qui correspondent au nom de famille ou au nom d’organisation spécifié.

Prénom
first_name string

Filtre pour les enregistrements individuels qui correspondent au prénom spécifié.

Deuxième prénom
middle_name string

Filtre pour les enregistrements individuels qui correspondent au prénom spécifié.

Suffixe
suffix string

Filtre pour les enregistrements individuels qui correspondent au suffixe spécifié.

Bloc d’adresses
address_block string

Filtre pour les enregistrements qui correspondent au bloc d’adresses spécifié.

Ville
city string

Filtre pour les enregistrements qui correspondent à la ville spécifiée.

État
state string

Filtre pour les enregistrements qui correspondent à l’état spécifié.

Code postal
post_code string

Filtre pour les enregistrements qui correspondent au code postal spécifié.

Messagerie électronique
email array

Filtre pour les enregistrements qui correspondent aux adresses e-mail spécifiées.

Téléphone
phone array

Filtre pour les enregistrements qui correspondent aux numéros de téléphone spécifiés.

Rechercher des individus ?
search_individuals boolean

Recherchez des enregistrements individuels en double ?

Rechercher des alias ?
search_aliases boolean

Effectuez une recherche par l’alias, comme spécifié par le paramètre Last/org name ?

Rechercher des contacts ?
search_contacts boolean

Rechercher des enregistrements de contact de relation ?

Limit
limit integer

Nombre d’enregistrements à retourner lors de la pagination des résultats (valeur par défaut = 3).

Décalage
offset integer

Nombre d’enregistrements à ignorer lors de la pagination des résultats.

Retours

Résultats de recherche en double

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

Rechercher un constituant (amélioré)

Recherche des enregistrements constituants à l’aide des critères de filtre donnés.

Paramètres

Nom Clé Obligatoire Type Description
Prénom
first_name string

Prénom de la constituante.

Nom
last_name string

Nom de famille constituant.

ID de recherche
lookup_id string

ID de recherche constituant.

Adresse de messagerie
email string

Adresse e-mail constituante.

Numéro de téléphone
phone_number string

Numéro de téléphone.

Limit
limit integer

Représente le nombre d’enregistrements à retourner. La valeur par défaut est 500. Le maximum est de 1 000.

Lignes d’adresse
address_lines string

Lignes d’adresse.

Ville
city string

Ville d’adresse.

État
state string

État de l’adresse.

Code postal
post_code string

Code postal d’adresse.

Inclure un alias ?
include_alias boolean

Inclure un alias lors de la recherche sur le nom ?

Type d’alias
alias_type string

Type d’alias.

Inclure un nom de jeune fille ?
include_maiden_name boolean

Incluez le nom de jeune fille lors de la recherche sur le nom ?

Retours

Constituants

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 appartenances constituantes

Répertorie les appartenances à un constituant.

Paramètres

Nom Clé Obligatoire Type Description
ID constituant
constituent_id True string

ID d’enregistrement système de la constituante.

Retours

Memberships

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 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 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 hommages constituants

Répertorie les hommages à un constituant.

Paramètres

Nom Clé Obligatoire Type Description
ID constituant
constituentId True integer

ID d’enregistrement système de la constituante.

Retours

Hommages

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

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

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.

ConstituentApi.ApiCollectionOfMembershipRead

Memberships

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

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

Étiquettes
tags array of string

Balises associées à la pièce jointe.

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

Valeur de texte
text_value string

Valeur de texte du champ personnalisé.

Valeur numérique
number_value integer

Valeur numérique du champ personnalisé.

Valeur de date
date_value date

Valeur de date du champ personnalisé.

Valeur monétaire
currency_value double

Valeur monétaire du champ personnalisé.

Valeur booléenne
boolean_value boolean

Valeur booléenne du champ personnalisé.

Valeur d’entrée de table
codetableentry_value string

Valeur d’entrée de table du champ personnalisé.

Valeur d’ID constituante
constituentid_value string

Valeur d’ID constituante du champ personnalisé.

jour
fuzzydate_value.d integer

Jour de la date floue.

month
fuzzydate_value.m integer

Mois à la date approximative.

année
fuzzydate_value.y integer

L’année dans la date approximative.

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 ?

Vous ne demande pas d’e-mail ?
requests_no_email boolean

La constituante ne demande-t-elle aucun e-mail ?

Est-ce qu’un avocat ?
is_solicitor boolean

Est-ce que la constituante est un avocat ?

Aucune adresse valide ?
no_valid_address boolean

La constituante n’a-t-elle pas d’adresses valides ?

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

Cible
target string

Cible de la constituante.

Revenu
income string

Revenu de la constituante (pour les particuliers uniquement).

Type de reçu
receipt_type string

Type de reçu de la constituante.

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

value
matching_gift_per_gift_min.value double

Valeur du montant.

value
matching_gift_per_gift_max.value double

Valeur du montant.

value
matching_gift_total_min.value double

Valeur du montant.

value
matching_gift_total_max.value double

Valeur du montant.

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

Est-ce que memorial ?
is_memorial boolean

Est-ce que la constituante est un honneur/memorial ?

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

Constituant converti

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

ID de la constituante convertie.

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

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

Format de nom créé

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

ID du format de nom nouvellement créé.

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

Résultat de la recherche en double

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.

Nom affiché
display_name string

Nom complet de la constituante.

Adresse
formatted_address string

Adresse primaire mise en forme pour la constituante.

Décédé?
deceased boolean

Est-ce que la constituante est décédée ?

Est-ce qu’un constituant ?
is_constituent boolean

Le dossier est-il un constituant ?

ID de recherche
constituent_id string

Identificateur défini par l’utilisateur pour la constituante.

Date d’ajout
date_added date-time

Date à laquelle la constituante a été ajoutée.

Classement
rank string

Classement de recherche indiquant ce qui a été mis en correspondance avec la constituante.

ConstituentApi.DuplicateSearchResultCollection

Résultats de recherche en double

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

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

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.

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.

ConstituentApi.MembershipMemberRead

Membre

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

ID d’enregistrement système du membre.

ID constituant
constituent_id string

ID d’enregistrement système de la constituante associée au membre.

Le membre principal est-il membre ?
primary boolean

Est-ce le membre principal ?

ConstituentApi.MembershipRead

Membership

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

ID d’enregistrement système de l’appartenance.

ID constituant
constituent_id string

ID d’enregistrement système du constituant associé à l’appartenance.

Programme
program string

Programme d’adhésion.

Catégorie
category string

Catégorie d’appartenance.

Sous-catégorie
subcategory string

Sous-catégorie d’appartenance.

Debout
standing string

État de l’appartenance.

Expire
expires date-time

Date d’expiration de l’appartenance.

Joint
joined date-time

Date à laquelle l’appartenance devient active.

value
dues.value double

Valeur monétaire.

Members
members array of ConstituentApi.MembershipMemberRead

Ensemble de membres appartenant à l’appartenance.

Date d’ajout
date_added date-time

Date de création de l’appartenance.

Date de modification
date_modified date-time

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

ConstituentApi.NameFormatRead

Les formats de nom définissent comment traiter les constituants dans les communications. La façon dont vous faites référence aux individus définit le ton de vos communications avec eux et comment ils reçoivent vos interactions.

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

ID d’enregistrement système du format de nom.

type
type string

Type de format de nom.

format personnalisé ?
custom_format boolean

Est-ce un format personnalisé ?

ID de configuration
configuration_id string

ID de configuration du format de nom (pour les formats non personnalisés).

nom mis en forme
formatted_name string

Nom mis en forme (pour les formats personnalisés).

ConstituentApi.NameFormatSummaryRead

Résumé du format de nom

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

ID d’enregistrement système du format de nom.

type
primary_addressee.primary_type string

Type de format de nom.

format personnalisé ?
primary_addressee.custom_format boolean

Est-ce un format personnalisé ?

ID de configuration
primary_addressee.configuration_id string

ID de configuration du format de nom (pour les formats non personnalisés).

nom mis en forme
primary_addressee.formatted_name string

Nom mis en forme (pour les formats personnalisés).

ID
primary_salutation.id string

ID d’enregistrement système du format de nom.

type
primary_salutation.primary_type string

Type de format de nom.

format personnalisé ?
primary_salutation.custom_format boolean

Est-ce un format personnalisé ?

ID de configuration
primary_salutation.configuration_id string

ID de configuration du format de nom (pour les formats non personnalisés).

nom mis en forme
primary_salutation.formatted_name string

Nom mis en forme (pour les formats personnalisés).

Formats de noms supplémentaires
additional_name_formats array of ConstituentApi.NameFormatRead

Formats de nom supplémentaires de la constituante.

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

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

NXTDataIntegrationApi.ConstituentIdMap

Carte d’ID constituante

Nom Chemin d’accès Type Description
ID
system_record_id integer

ID d’enregistrement système constituant.

NXTDataIntegrationApi.ConstituentSearchResult

Résultat de la recherche

Nom Chemin d’accès Type Description
ID
record_id integer

ID d’enregistrement système de la constituante.

ID de recherche
constituent_id string

ID constituant.

Indicateur clé
key_indicator string

Indicateur clé de l’enregistrement.

Prénom
first_name string

Prénom (individus uniquement).

Nom
last_name string

Nom (individus uniquement).

Deuxième prénom
middle_name string

Le prénom (individus uniquement).

Nom préféré
preferred_name string

Nom préféré (individus uniquement).

Ancien nom
maiden_name string

Ancien nom (individus uniquement).

Titre 1
title1 string

Titre 1 (individus uniquement).

Suffixe 1
suffix1 string

Suffixe 1 (individus uniquement).

Gender
gender string

Le genre constituant (individus uniquement).

jour
birth_date.d integer

Jour de la date floue.

month
birth_date.m integer

Mois à la date approximative.

année
birth_date.y integer

L’année dans la date approximative.

Prénom du conjoint
spouse_first_name string

Prénom du conjoint (individus uniquement).

Nom du conjoint
spouse_last_name string

Nom du conjoint (individus uniquement).

Nom de l’organisation
org_name string

Nom de l’organisation (organisations uniquement).

Bloc d’adresses
address_block string

Bloc d’adresses.

Ville et état
address_city_state string

Ville d’adresse et état.

Code postal
address_post_code string

Code de publication d’adresse.

Adresse e-mail principale
primary_email string

E-mail principal.

Numéro de téléphone principal
primary_phone string

Téléphone principal.

Alias mis en correspondance
matched_alias string

Nom de l’alias correspondant (individus uniquement).

E-mail mis en correspondance
matched_email string

Adresse e-mail correspondante.

Téléphone correspondant
matched_phone string

Numéro de téléphone correspondant.

Est-ce qu’un constituant ?
is_constituent boolean

Le dossier est-il un constituant ?

Est-ce décédé ?
is_deceased boolean

Le dossier est-il décédé ?

Est-ce inactif ?
is_inactive boolean

L’enregistrement est-il inactif ?

NXTDataIntegrationApi.ConstituentSearchResultCollection

Constituants

Nom Chemin d’accès Type Description
results
results array of NXTDataIntegrationApi.ConstituentSearchResult

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

NXTDataIntegrationApi.CreatedConstituentTribute

Hommage constituant créé

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

ID de l’hommage constituant nouvellement créé.

NXTDataIntegrationApi.CreatedTributeAcknowledgee

Reconnaissance de l’hommage créé

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

L’ID de l’hommage nouvellement créé reconnaît.

NXTDataIntegrationApi.Tribute

Tribut

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

ID d’enregistrement système de l’hommage.

ID constituant
constituent_record_id integer

ID d’enregistrement système de la constituante associée à l’hommage.

Type d’hommage
tribute_type_name string

Le type d’hommage.

ID de type d’hommage
tribute_type_id integer

ID de type d’hommage.

Descriptif
description string

Description de l’hommage.

jour
start_date.d integer

Jour de la date floue.

month
start_date.m integer

Mois à la date approximative.

année
start_date.y integer

L’année dans la date approximative.

jour
end_date.d integer

Jour de la date floue.

month
end_date.m integer

Mois à la date approximative.

année
end_date.y integer

L’année dans la date approximative.

ID de fonds par défaut
default_fund_id integer

ID d’enregistrement système du fonds par défaut associé à l’hommage.

Remarques
notes string

Les notes d’hommage.

Actif?
is_active boolean

Est-ce que cet hommage est actif ?

Sequence
sequence integer

Séquence d’hommage.

Date d’ajout
date_added date-time

Date de création de l’hommage.

Date de modification
date_modified date-time

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

NXTDataIntegrationApi.TributeAcknowledgee

Reconnaissance de l’hommage

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

ID d’enregistrement système de l’hommage reconnu.

ID d’hommage
tribute_id integer

ID d’enregistrement système de l’hommage associé à l’accusé de réception.

ID de relation
relationships_id integer

ID d’enregistrement système de la relation (s’il s’agit d’une valeur Null, il s’agit d’un accusé de réception automatique).

ID de lettre
letter integer

ID de lettre.

Sequence
sequence integer

L’hommage reconnaît la séquence.

NXTDataIntegrationApi.TributeAcknowledgeeCollection

Reconnaissances d’hommage

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 NXTDataIntegrationApi.TributeAcknowledgee

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

NXTDataIntegrationApi.TributeCollection

Hommages

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 NXTDataIntegrationApi.Tribute

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