Freigeben über


Blackbaud Raisers Edge NXT-Bestandteile

Blackbaud Raiser es Edge NXT ist eine umfassende cloudbasierte Spenden- und Spendermanagement-Softwarelösung, die speziell für gemeinnützige Organisationen und die gesamte soziale Gute Community entwickelt wurde. Verwenden Sie den Konnektor "Bestandteile", um biografische Details, Kontaktinformationen und Beziehungen zu verwalten.

Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:

Dienstleistung Class Regions
Copilot Studio Premium Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Logik-Apps Norm Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche:
     – Azure Government-Regionen
     - Azure China-Regionen
     - US Department of Defense (DoD)
Power Apps - Nicht verfügbar
Power Automate Premium Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Kontakt
Name Blackbaud Support
URL https://www.blackbaud.com/support
Email skyapi@blackbaud.com
Connectormetadaten
Herausgeber Blackbaud, Inc.
Webseite https://www.blackbaud.com/products/blackbaud-raisers-edge-nxt
Datenschutzrichtlinie https://www.blackbaud.com/privacy-shield
Kategorien Vertrieb und CRM; Produktivität

Raisers Edge NXT ist eine umfassende cloudbasierte Spenden- und Spendermanagement-Softwarelösung, die speziell für gemeinnützige Organisationen und die gesamte soziale Gute Community entwickelt wurde.

Dieser Connector basiert auf der SKY-API von Blackbaud und bietet Vorgänge zur Verwaltung von Bestandteilen und verwandten Entitäten, die in The Raiser es Edge NXT gefunden wurden, einschließlich:

  • Bestandteile
  • Addresses
  • Telefone und E-Mails
  • Decknamen
  • Benutzerdefinierte Felder
  • Hinweise
  • Attachments
  • Beziehungen
  • und mehr…

Weitere Informationen finden Sie in der Dokumentation.

Voraussetzungen

Um diesen Connector zu verwenden, müssen Sie über ein Blackbaud ID-Konto mit Zugriff auf eine oder mehrere Blackbaud-Umgebungen verfügen.

Darüber hinaus muss der Administrator Ihrer Organisation auch eine Aktion auf Administratorebene innerhalb des Systems ausführen, damit dieser Connector auf Ihre Blackbaud-Umgebung zugreifen kann. Weitere Informationen zu diesen Voraussetzungen finden Sie in der Ersteinrichtungsdokumentation .

Wie erhalten Sie Anmeldeinformationen?

Der Administrator Ihrer Organisation sendet Ihnen eine Einladung zur Edge NXT-Umgebung der Organisation und konfiguriert Ihre Benutzerkontoberechtigungen innerhalb der Umgebung. Für die Verwendung dieses Connectors sind keine zusätzlichen Anmeldeinformationen erforderlich.

Bekannte Probleme und Einschränkungen

Der Connector wird im Kontext Ihres Benutzerkontos ausgeführt und unterliegt daher Ihren Benutzerberechtigungen innerhalb der Umgebung.

Drosselungsgrenzwerte

Name Aufrufe Verlängerungszeitraum
API-Aufrufe pro Verbindung 100 60 Sekunden

Aktionen

Abrufen eines Bestandteils

Gibt Informationen zu einem Bestandteil zurück.

Abrufen eines Bestandteils durch Nachschlage-ID

Gibt die Systemdatensatz-ID eines Bestandteils aus der angegebenen Nachschlage-ID zurück.

Abrufen eines Konstituierenden Profilbilds

Gibt das aktuelle Profilbild für einen Bestandteil zurück.

Aktualisieren einer Bestandteil-Onlinepräsenz

Aktualisiert eine Bestandteil-Onlinepräsenz.

Aktualisieren einer Bestandteiladresse

Aktualisiert eine Bestandteiladresse.

Aktualisieren einer Bestandteilanlage

Aktualisiert eine Bestandteilanlage.

Aktualisieren einer bestandteilen E-Mail-Adresse

Aktualisiert eine konstituierende E-Mail-Adresse.

Aktualisieren einer bestandteilen Notiz

Aktualisiert eine konstituierende Notiz.

Aktualisieren einer Konstituierenden Beziehung

Aktualisiert eine Beziehung für einen Bestandteil. Wenn eine gegenseitige Beziehung vorhanden ist, wird sie auch geändert, um die Änderungen widerzuspiegeln. Dies schließt keine Änderungen an der Eigenschaft "comments" ein, die für jeden Datensatz spezifisch ist und unabhängig von jedem Datensatz geändert werden kann.

Aktualisieren einer Teilerziehung

Aktualisiert eine teilgebende Ausbildung.

Aktualisieren eines benutzerdefinierten Bestandteilfelds

Aktualisiert ein benutzerdefiniertes Bestandteilfeld.

Aktualisieren eines Bestandteilalias

Aktualisiert einen Bestandteilalias.

Aktualisieren eines Bestandteilcodes

Aktualisiert einen Bestandteilcode.

Aktualisieren eines Bestandteils

Aktualisiert einen Bestandteil.

Aktualisieren eines Bestandteiltelefons

Aktualisiert ein Bestandteiltelefon.

Aktualisieren eines Bilds für ein Konstituierendes Profil

Aktualisiert das aktuelle Profilbild für einen Bestandteil.

Aktualisieren eines konstituierenden Solicit-Codes

Aktualisiert einen konstituierenden Solicit-Code.

Aktualisieren eines Namensformats für Bestandteile

Aktualisiert ein namensgebendes Format.

Aktualisieren eines primären Namensformats für bestandteile

Aktualisiert das primäre Namensformat für einen Bestandteil.

Anlagen auflisten

Listet die Anlagen für einen Bestandteil auf.

Auflisten von Bestandteiladressen

Listet die Adressen für einen Bestandteil auf.

Auflisten von Bestandteilaliasen

Listet die Aliase für einen Bestandteil auf.

Auflisten von Bestandteilnotizen

Listet die Notizen für einen Bestandteil auf.

Auflisten von Bestandteiltelefonen

Listet die Telefone für einen Bestandteil auf.

Auflisten von Bildungseinrichtungen

Listet die Education-Datensätze für einen Bestandteil auf.

Auflisten von E-Mail-Adressen

Listet die E-Mail-Adressen für einen Bestandteil auf.

Auflisten von Fundraisern

Listet die Fundraiserzuweisungen für einen Bestandteil auf.

Auflisten von Fundraiserzuweisungen

Auflisten der Zuordnungen für einen Fundraiser.

Auflisten von Konstituierenden Beziehungen

Listet die Beziehungen für einen Bestandteil auf.

Auflisten von Werbecodes für Bestandteile

Listet die Solicit Codes für einen Bestandteil auf.

Auflisten von Zustimmungsdatensätzen für Bestandteile

Listet die Zustimmungsdatensätze für einen Bestandteil auf.

Benutzerdefinierte Listenfelder

Listet die benutzerdefinierten Felder für einen Bestandteil auf.

Ehrenbeehrung erstellen

Erstellt eine neue Anerkennung.

Ehrenerkennungen auflisten

Listet die Anerkennungen für eine Anerkennung auf.

Erstellen einer Bestandteil-Onlinepräsenz

Erstellt eine neue Onlinepräsenz.

Erstellen einer Bestandteiladresse

Erstellt eine neue Konstituierende Adresse.

Erstellen einer Bestandteilanlage

Erstellt eine neue Anlage.

Erstellen einer bestandteilen Ausbildung

Erstellt eine neue bestandteilische Ausbildung.

Erstellen einer bestandteilen E-Mail-Adresse

Erstellt eine neue E-Mail-Adresse.

Erstellen einer einzelnen Beziehung

Erstellt eine neue einzelne Beziehung. Wenn die Beziehung mit einem anderen Bestandteil besteht, wird für diesen Bestandteil eine gegenseitige Beziehung erstellt.

Erstellen einer einzelnen Komponente

Erstellt einen neuen einzelnen Bestandteil.

Erstellen einer Fundraiserzuweisung

Erstellt eine neue Fundraiserzuordnung.

Erstellen einer Konstituierenden Notiz

Erstellt eine neue Konstituierende Notiz.

Erstellen einer Organisationsbeziehung

Erstellt eine neue Organisationsbeziehung. Wenn die Beziehung mit einem anderen Bestandteil besteht, wird für diesen Bestandteil eine gegenseitige Beziehung erstellt.

Erstellen einer Organisationskomponente

Erstellt einen neuen Organisationsbestandteil.

Erstellen einer teiligen Anerkennung

Erstellt eine neue teilgebende Anerkennung.

Erstellen eines benutzerdefinierten Bestandteilfelds

Erstellt ein neues benutzerdefiniertes Benutzerdefiniertes Feld.

Erstellen eines Bestandteil-Zustimmungsdatensatzes

Erstellt einen neuen zustimmungsgebenden Datensatz.

Erstellen eines Bestandteilcodes

Erstellt einen neuen Komponentencode.

Erstellen eines Bestandteiltelefons

Erstellt ein neues Bestandteiltelefon.

Erstellen eines konstituierenden Solicit-Codes

Erstellt einen neuen Konstituierenden Solicit-Code.

Erstellen eines Namensformats für Bestandteile

Erstellt ein neues Namensformat.

Erstellen eines primären Namensformats für bestandteile

Erstellt ein primäres Namensformat für einen Bestandteil.

Erstellen eines Teilalias

Erstellt einen neuen Bestandteilalias.

Holen Sie sich eine teiligen Anerkennung

Gibt Details zu einer teiligen Hommage zurück.

In Bestandteil konvertieren

Wandelt einen Nicht-Bestandteil in einen Bestandteil um.

Liste der Teilerehrungen

Listet die Ehren für einen Bestandteil auf.

Listenkomponenten

Gibt eine Liste von Bestandteilen zurück.

Listenkomponentencodes

Listet die Komponentencodes für einen Bestandteil auf.

Löschen eines Bestandteilcodes

Löscht einen Bestandteilcode.

Mitgliedschaften auflisten

Listet die Mitgliedschaften für einen Bestandteil auf.

Onlinepräsenzen auflisten

Listet die Onlinepräsenzen für einen Bestandteil auf.

Suchen nach doppelten Bestandteilen

Durchsucht einzelne, organisationsbezogene und verwandte Kontaktdatensätze und bewertet potenzielle Duplikate basierend auf den angegebenen Suchfiltern. Datensätze, die mit mehreren Filtern übereinstimmen, rangieren höher als potenzielle Duplikate.

Suchen nach einem Bestandteil

Führt eine konstituierende Suche basierend auf dem bereitgestellten Suchtext aus. Unterstützt Vorname, Nachname, bevorzugter Name, früherer Name, Alias, E-Mail-Adresse, Telefonnummer, Adresse oder Nachschlage-ID. Namenskombinationen wie Vorname und Nachname oder bevorzugter Name und Nachname sind gültig, andernfalls unterstützt die Suche nur jeweils einen Parameter. Standardmäßig enthalten Suchvorgänge Ergebnisse, die ihren Kriterien ähneln. Suchvorgänge nach "Smith" enthalten z. B. Übereinstimmungen für "Smyth" und andere alternative Schreibweisen. Diese Suche unterstützt keine Wildcardzeichen wie * oder ?. Suchergebnisse sind auf 500 Datensätze beschränkt.

Suchen nach einem Bestandteil (erweitert)

Sucht mithilfe der angegebenen Filterkriterien nach Bestandteilen.

Zusammenfassung des Namensformats für Bestandteile abrufen

Gibt die Namensformatzusammenfassung für einen Bestandteil zurück.

Abrufen eines Bestandteils

Gibt Informationen zu einem Bestandteil zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Bestandteil-ID
constituent_id True string

Die Systemdatensatz-ID des abzurufenden Bestandteils.

Gibt zurück

Bestandteil

Abrufen eines Bestandteils durch Nachschlage-ID

Gibt die Systemdatensatz-ID eines Bestandteils aus der angegebenen Nachschlage-ID zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Nachschlage-ID
constituent_id True string

Die nachschlage-ID der Komponente.

Gibt zurück

Bestandteil-ID-Zuordnung

Abrufen eines Konstituierenden Profilbilds

Gibt das aktuelle Profilbild für einen Bestandteil zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Bestandteil-ID
constituent_id True string

Die Systemdatensatz-ID des Bestandteils, für den das Profilbild abgerufen werden soll.

Gibt zurück

Profilbild

Aktualisieren einer Bestandteil-Onlinepräsenz

Aktualisiert eine Bestandteil-Onlinepräsenz.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Onlinepräsenz-ID
online_presence_id True string

Die Systemdatensatz-ID der zu aktualisierenden Onlinepräsenz.

Typ
type string

Der Onlinepräsenztyp.

Link
address string

Die Webadresse für die Onlinepräsenz.

Primär?
primary boolean

Ist dies die primäre Onlinepräsenz des Wählers?

Inaktiv?
inactive boolean

Ist diese Onlinepräsenz inaktiv?

Aktualisieren einer Bestandteiladresse

Aktualisiert eine Bestandteiladresse.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Adress-ID
address_id True string

Die Systemdatensatz-ID der zu aktualisierenden Adresse.

Adresstyp
type string

Der Adresstyp.

Country
country string

Das Land der Adresse (kann die ID, der Name oder die Abkürzung sein).

Adresszeilen
address_lines string

Die Adresszeilen.

Stadt
city string

Die Stadt der Adresse (nicht in Kombination mit dem Feld "Vorort") verwenden.

Staat
state string

Das Bundesland der Adresse.

Postleitzahl
postal_code string

Die Postleitzahl der Adresse.

Vorort
suburb string

Der Vorort der Adresse (nicht in Kombination mit dem Feld "Ort") verwenden.

Bezirk
county string

Der Landkreis der Adresse.

Informationsquelle
information_source string

Die Informationsquelle für die Adresse.

Region
region string

Die Region für die Adresse.

KARREN
cart string

Die Netzbetreiberroute (CART) für die Adresse.

LOS
lot string

Die Reisezeile (LOT) für die Adresse.

DPC
dpc string

Der Zustellungspunktcode (Delivery Point Code, DPC) für die Adresse.

Gültig ab
start date

Das Datum, an dem der Konstituierende mit dieser Adresse begann (z. B. "2005-09-18").

Gültig bis
end date

Das Datum, an dem sich der Bestandteil nicht mehr an dieser Adresse befindet (z. B. "2005-09-18").

Primär?
preferred boolean

Ist dies die bevorzugte Adresse des Wählers?

Keine E-Mail senden?
do_not_mail boolean

Kann der Bestandteil an dieser Adresse kontaktiert werden?

Tag
d integer

Der Tag im Fuzzydatum.

Monat
m integer

Der Monat im Fuzzydatum.

Jahr
y integer

Das Jahr im Fuzzydatum.

Tag
d integer

Der Tag im Fuzzydatum.

Monat
m integer

Der Monat im Fuzzydatum.

Jahr
y integer

Das Jahr im Fuzzydatum.

Aktualisieren einer Bestandteilanlage

Aktualisiert eine Bestandteilanlage.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Anlagen-ID
attachment_id True string

Die Systemdatensatz-ID der zu aktualisierenden Anlage.

Name
name string

Der Name der Anlage. Zeichenlimit: 150.

Datum
date date-time

Das Datum der Anlage (z. B. '2020-09-18T04:13:56Z').

URL
url string

Die URL für die Anlage. Dies ist für Verknüpfungsanlagen erforderlich und gilt nicht für physische Anlagen.

Stichwörter
tags array of string

Die tags, die der Anlage zugeordnet sind.

Aktualisieren einer bestandteilen E-Mail-Adresse

Aktualisiert eine konstituierende E-Mail-Adresse.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
E-Mail-Adress-ID
email_address_id True string

Die Systemdatensatz-ID der zu aktualisierenden E-Mail-Adresse.

E-Mail-Typ
type string

Der Typ der E-Mail-Adresse.

E-Mail-Adresse
address string

Die E-Mail-Adresse.

Primär?
primary boolean

Ist dies die primäre E-Mail-Adresse des Bestandteils?

Keine E-Mail senden?
do_not_email boolean

Kann der Bestandteil an dieser E-Mail-Adresse kontaktiert werden?

Inaktiv?
inactive boolean

Ist diese E-Mail-Adresse inaktiv?

Aktualisieren einer bestandteilen Notiz

Aktualisiert eine konstituierende Notiz.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Notiz-ID
note_id True string

Die Systemdatensatz-ID der zu aktualisierenden Notiz.

Typ
type string

Der Notiztyp.

Tag
d integer

Der Tag im Fuzzydatum.

Monat
m integer

Der Monat im Fuzzydatum.

Jahr
y integer

Das Jahr im Fuzzydatum.

Zusammenfassung
summary string

Die Notizzusammenfassung. Zeichenlimit: 50.

Hinweis
text string

Der Notiztext.

Aktualisieren einer Konstituierenden Beziehung

Aktualisiert eine Beziehung für einen Bestandteil. Wenn eine gegenseitige Beziehung vorhanden ist, wird sie auch geändert, um die Änderungen widerzuspiegeln. Dies schließt keine Änderungen an der Eigenschaft "comments" ein, die für jeden Datensatz spezifisch ist und unabhängig von jedem Datensatz geändert werden kann.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Beziehungs-ID
relationship_id True string

Die Systemdatensatz-ID der zu aktualisierenden Beziehung.

Typ
type string

Der Typ der Beziehung, die die Beziehung darstellt.

Gegenseitiger Typ
reciprocal_type string

Beschreibt die Beziehung des Bestandteils zum zugehörigen Bestandteil. Beispielsweise wäre in einer Beziehung zwischen einem männlichen Bestandteil und einem weiblichen Gleichgeordneten der gegenseitige Beziehungstyp Bruder.

Tag
d integer

Der Tag im Fuzzydatum.

Monat
m integer

Der Monat im Fuzzydatum.

Jahr
y integer

Das Jahr im Fuzzydatum.

Tag
d integer

Der Tag im Fuzzydatum.

Monat
m integer

Der Monat im Fuzzydatum.

Jahr
y integer

Das Jahr im Fuzzydatum.

Ist Ehepartner?
is_spouse boolean

Gilt die verwandte Person des Ehegatten (nur für Beziehungen zwischen Einzelpersonen)?

Ist konstituierender Haushaltschef?
is_constituent_head_of_household boolean

Ist der Konstituierende der Haushaltschef?

Ist ehegatte Haushaltsleiter?
is_spouse_head_of_household boolean

Ist der Ehegatte der Kopf des Haushalts?

Hinweise
comment string

Weitere Hinweise zur Beziehung.

Ist Kontakt?
is_organization_contact boolean

Stellt die Komponente diese Organisation als Kontakt dar (gilt nur für Beziehungen zwischen Organisationen und Einzelpersonen)?

Ist primäres Geschäft?
is_primary_business boolean

Ist dies das Hauptgeschäft des Bestandteils (gilt nur für Beziehungen zwischen Organisationen und Einzelpersonen)?

Kontakttyp
organization_contact_type string

Stellt Kontext für Interaktionen mit der zugehörigen Person bereit, die die Organisation als Kontakt darstellt. Gilt nur für Beziehungen zwischen Organisationen und Einzelpersonen.

Position
position string

Die Position der Person in der Organisation. Gilt nur für Beziehungen zwischen Organisationen und Einzelpersonen. Zeichenlimit: 50.

Aktualisieren einer Teilerziehung

Aktualisiert eine teilgebende Ausbildung.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Education-ID
education_id True string

Die Systemdatensatz-ID des zu aktualisierenden Education-Datensatzes.

Schule
school string

Der Name der Schule/Einrichtung.

Typ
type string

Die Art der Ausbildung.

Klasse von
class_of string

Das Jahr, in dem der Konstituierende abschloss.

Der Status
status string

Der Status der Ausbildung.

Tag
d integer

Der Tag im Fuzzydatum.

Monat
m integer

Der Monat im Fuzzydatum.

Jahr
y integer

Das Jahr im Fuzzydatum.

Tag
d integer

Der Tag im Fuzzydatum.

Monat
m integer

Der Monat im Fuzzydatum.

Jahr
y integer

Das Jahr im Fuzzydatum.

Tag
d integer

Der Tag im Fuzzydatum.

Monat
m integer

Der Monat im Fuzzydatum.

Jahr
y integer

Das Jahr im Fuzzydatum.

Grad
degree string

Der Grad, der empfangen wurde.

GPA
gpa double

Der Notenpunktdurchschnitt.

Studienfach
subject_of_study string

Das Studienfach.

Primär?
primary boolean

Ist dies der Grundschulverband der Wähler?

Majore
majors array of string

Die Hauptstudiengänge.

Minderjährige
minors array of string

Die Nebenstudiengänge.

Campus
campus string

Der Campus. Zeichenlimit: 50.

Soziale Organisation
social_organization string

Die soziale Organisation. Zeichenlimit: 50.

Bekannter Name
known_name string

Der bekannte Name. Zeichenlimit: 50.

Gradklasse
class_of_degree string

Die Klasse des Abschlusses.

Abteilung
department string

Der Name der Bildungsabteilung.

Fakultät
faculty string

Der Name der Fakultät.

Registrierungsnummer
registration_number string

Die Registrierungsnummer. Zeichenlimit: 50.

Aktualisieren eines benutzerdefinierten Bestandteilfelds

Aktualisiert ein benutzerdefiniertes Bestandteilfeld.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID des benutzerdefinierten Felds
custom_field_id True string

Die Systemdatensatz-ID des zu aktualisierenden benutzerdefinierten Felds.

body
body True dynamic

Ein Objekt, das die Eigenschaften des zu aktualisierenden benutzerdefinierten Felds darstellt.

Aktualisieren eines Bestandteilalias

Aktualisiert einen Bestandteilalias.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Alias-ID
alias_id True string

Die Systemdatensatz-ID des zu aktualisierenden Alias.

Alias
name string

Der Name, der als Alias des Bestandteils verwendet werden soll. Zeichenlimit: 100.

Typ
type string

Der Aliastyp.

Aktualisieren eines Bestandteilcodes

Aktualisiert einen Bestandteilcode.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Komponentencode-ID
constituent_code_id True string

Die Systemdatensatz-ID des zu aktualisierenden Komponentencodes.

Tag
d integer

Der Tag im Fuzzydatum.

Monat
m integer

Der Monat im Fuzzydatum.

Jahr
y integer

Das Jahr im Fuzzydatum.

Tag
d integer

Der Tag im Fuzzydatum.

Monat
m integer

Der Monat im Fuzzydatum.

Jahr
y integer

Das Jahr im Fuzzydatum.

Sequence
sequence integer

Die numerische Sequenz, die dem Bestandteilcode zugeordnet ist.

Aktualisieren eines Bestandteils

Aktualisiert einen Bestandteil.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Bestandteil-ID
constituent_id True string

Die Systemdatensatz-ID des zu aktualisierenden Bestandteils.

Title
title string

Der Haupttitel des Bestandteils (nur für Einzelpersonen).

Vorname
first string

Der Vorname des Bestandteils (nur für Einzelpersonen). Zeichenlimit: 50.

Nachname
last string

Der Nachname des Bestandteils (nur für Einzelpersonen). Zeichenlimit: 100.

Name der Organisation
name string

Für Einzelpersonen ist dies ein berechnetes Feld, das nicht für Bearbeitungsvorgänge gilt. Für die Organisation ist dieses Feld erforderlich und stellt den Namen der Organisation dar. Zeichenlimit: 100.

Nachsilbe
suffix string

Das primäre Suffix des Bestandteils (nur für Einzelpersonen).

Bevorzugter Name
preferred_name string

Der bevorzugte Name des Bestandteils (nur für Einzelpersonen). Zeichenlimit: 50.

Nachschlage-ID
lookup_id string

Der benutzerdefinierte Bezeichner für den Bestandteil.

Geschlecht
gender string

Das Geschlecht des Wählers (nur für Einzelpersonen).

Zweiter Vorname
middle string

Der zweite Vorname des Bestandteils (nur für Einzelpersonen). Zeichenlimit: 50.

Ehemaliger Name
former_name string

Der ehemalige Name des Wählers (nur für Einzelpersonen). Zeichenlimit: 100.

Titel 2
title_2 string

Der sekundäre Titel des Bestandteils (nur für Einzelpersonen).

Suffix 2
suffix_2 string

Das sekundäre Suffix des Bestandteils (nur für Einzelpersonen).

Familienstand
marital_status string

Der Familienstand des Wählers (nur für Einzelpersonen).

Gibt anonym?
gives_anonymously boolean

Gibt der Bestandteil anonym?

Keine E-Mail anfordert?
requests_no_email boolean

Fordert die konstituierende Anforderung keine E-Mail an?

Ist ein Anwalt?
is_solicitor boolean

Ist der Konstituierende ein Anwalt?

Keine gültigen Adressen?
no_valid_address boolean

Hat der Bestandteil keine gültigen Adressen?

Inaktiv?
inactive boolean

Ist der Bestandteil inaktiv?

Tag
d integer

Der Tag im Fuzzydatum.

Monat
m integer

Der Monat im Fuzzydatum.

Jahr
y integer

Das Jahr im Fuzzydatum.

Geburtsort
birthplace string

Der Geburtsort des Bestandteils (nur für Einzelpersonen).

Ethnizität
ethnicity string

Die EthnischeItät des Bestandteils (nur für Einzelpersonen).

Ziel
target string

Das Ziel des Bestandteils.

Erlöse
income string

Das Einkommen für den Bestandteil (nur für Einzelpersonen).

Bontyp
receipt_type string

Der Belegtyp des Bestandteils.

Religion
religion string

Die Religion des Bestandteils (nur für Einzelpersonen).

Branche
industry string

Die Industrie des Bestandteils (nur für Organisationen).

Anzahl der Mitarbeiter
num_employees integer

Die Anzahl der Mitarbeiter in der Organisation.

Stimmt mit Geschenken überein?
matches_gifts boolean

Stimmt die Organisation mit Geschenken überein?

Passender Geschenkfaktor
matching_gift_factor double

Der passende Geschenkfaktor (nur für Organisationen).

Min Match pro Geschenk
value double

Der mindeste Übereinstimmungsbetrag pro Geschenk für den Bestandteil (nur für Organisationen).

Maximale Übereinstimmung pro Geschenk
value double

Der maximale Übereinstimmungsbetrag pro Geschenk für den Bestandteil (nur für Organisationen).

Min Übereinstimmung pro Constit
value double

Die Mindestanzahl der Übereinstimmungen für die Bestandteile (nur für Organisationen).

Maximale Übereinstimmung pro Constit
value double

Die maximale Übereinstimmungssumme für die Einzelnen (nur für Organisationen).

Abgleichen von Geschenknotizen
matching_gift_notes string

Die passenden Geschenknotizen für den Bestandteil (nur für Organisationen).

Verstorben?
deceased boolean

Ist der Teil des Verstorbenen (nur für Einzelpersonen)?

Tag
d integer

Der Tag im Fuzzydatum.

Monat
m integer

Der Monat im Fuzzydatum.

Jahr
y integer

Das Jahr im Fuzzydatum.

Ist Gedenken?
is_memorial boolean

Ist der Bestandteil ein Ehren-/Gedenktag?

Aktualisieren eines Bestandteiltelefons

Aktualisiert ein Bestandteiltelefon.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Telefon-ID
phone_id True string

Die Systemdatensatz-ID des zu aktualisierenden Telefons.

Typ
type string

Der Telefontyp.

Number
number string

Die Telefonnummer.

Primär?
primary boolean

Ist dies das primäre Telefon des Wählers?

Rufen Sie nicht an?
do_not_call boolean

Kann der Bestandteil an dieser Nummer kontaktiert werden?

Inaktiv?
inactive boolean

Ist diese Telefonnummer inaktiv?

Aktualisieren eines Bilds für ein Konstituierendes Profil

Aktualisiert das aktuelle Profilbild für einen Bestandteil.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Bestandteil-ID
constituent_id True string

Die Systemdatensatz-ID des Bestandteils, dessen Profilbild aktualisiert werden soll.

Dateiname
file_name True string

Der Name der Datei.

Dokument-ID
document_id True uuid

Der Dokumentbezeichner.

Miniaturansichts-ID
thumbnail_id True uuid

Der Bezeichner des Miniaturansichtsdokuments.

Aktualisieren eines konstituierenden Solicit-Codes

Aktualisiert einen konstituierenden Solicit-Code.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Anfordern von Code-ID
constituent_solicit_code_id True string

Die Systemdatensatz-ID des zu aktualisierenden Aufforderungscodes.

Anfordern von Code
solicit_code string

Kommunikationsanweisungen und/oder Einschränkungen für einen Bestandteil.

Startdatum
start_date date

Das Startdatum des Anmeldecodes (z. B. "2005-09-18").

Enddatum
end_date date

Das Enddatum des Anmeldecodes (z. B. "2005-09-18").

Aktualisieren eines Namensformats für Bestandteile

Aktualisiert ein namensgebendes Format.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Namensformat-ID
name_format_id True string

Die Systemdatensatz-ID des zu aktualisierenden Namensformats.

Typ
type string

Der Namensformattyp.

Benutzerdefiniertes Namensformat?
custom_format boolean

Ist ein benutzerdefiniertes Format?

Format
configuration_id string

Namensformatkonfiguration (erforderlich, es sei denn, es wird ein benutzerdefiniertes Format verwendet).

Benutzerdefinierter Name
formatted_name string

Formatierter Name (erforderlich, wenn ein benutzerdefiniertes Format verwendet wird). Zeichenlimit: 255.

Aktualisieren eines primären Namensformats für bestandteile

Aktualisiert das primäre Namensformat für einen Bestandteil.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Namensformat-ID
primary_name_format_id True string

Die Systemdatensatz-ID des zu aktualisierenden primären Namensformats.

Benutzerdefiniertes Namensformat?
custom_format boolean

Ist ein benutzerdefiniertes Format?

Format
configuration_id string

Namensformatkonfiguration (erforderlich, es sei denn, es wird ein benutzerdefiniertes Format verwendet).

Benutzerdefinierter Name
formatted_name string

Formatierter Name (erforderlich, wenn ein benutzerdefiniertes Format verwendet wird). Zeichenlimit: 255.

Anlagen auflisten

Listet die Anlagen für einen Bestandteil auf.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Bestandteil-ID
constituent_id True string

Die Systemdatensatz-ID des Bestandteils.

Gibt zurück

Attachments

Auflisten von Bestandteiladressen

Listet die Adressen für einen Bestandteil auf.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Bestandteil-ID
constituent_id True string

Die Systemdatensatz-ID des Bestandteils.

Inaktiv einschließen?
include_inactive boolean

Inaktive Adressen einschließen?

Gibt zurück

Addresses

Auflisten von Bestandteilaliasen

Listet die Aliase für einen Bestandteil auf.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Bestandteil-ID
constituent_id True string

Die Systemdatensatz-ID des Bestandteils.

Gibt zurück

Decknamen

Auflisten von Bestandteilnotizen

Listet die Notizen für einen Bestandteil auf.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Bestandteil-ID
constituent_id True string

Die Systemdatensatz-ID des Bestandteils.

Gibt zurück

Hinweise

Auflisten von Bestandteiltelefonen

Listet die Telefone für einen Bestandteil auf.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Bestandteil-ID
constituent_id True string

Die Systemdatensatz-ID des Bestandteils.

Inaktiv einschließen?
include_inactive boolean

Inaktive Telefone einschließen?

Gibt zurück

Telefone

Auflisten von Bildungseinrichtungen

Listet die Education-Datensätze für einen Bestandteil auf.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Bestandteil-ID
constituent_id True string

Die Systemdatensatz-ID des Bestandteils.

Gibt zurück

Ausbildungen

Auflisten von E-Mail-Adressen

Listet die E-Mail-Adressen für einen Bestandteil auf.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Bestandteil-ID
constituent_id True string

Die Systemdatensatz-ID des Bestandteils.

Inaktiv einschließen?
include_inactive boolean

Inaktive E-Mail-Adressen einschließen?

Gibt zurück

E-Mail-Adressen

Auflisten von Fundraisern

Listet die Fundraiserzuweisungen für einen Bestandteil auf.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Bestandteil-ID
constituent_id True string

Die Systemdatensatz-ID des Bestandteils.

Inaktiv einschließen?
include_inactive boolean

Inaktive Fundraiserzuweisungen einschließen?

Gibt zurück

Fundraiser-Zuordnungen

Auflisten von Fundraiserzuweisungen

Auflisten der Zuordnungen für einen Fundraiser.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Fundraiser ID
fundraiser_id True string

Die Systemdatensatz-ID des Fundraisers, für den Zuordnungen zurückgegeben werden sollen.

Limit
limit integer

Stellt die Anzahl der zurückzugebenden Datensätze dar. Der Standardwert ist 500. Das Maximum beträgt 5000.

Offset
offset integer

Stellt die Anzahl der zu überspringenden Datensätze dar. Zur Verwendung mit Paginierung.

Gibt zurück

Zuweisungen

Auflisten von Konstituierenden Beziehungen

Listet die Beziehungen für einen Bestandteil auf.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Bestandteil-ID
constituent_id True string

Die Systemdatensatz-ID des Bestandteils.

Limit
limit integer

Stellt die Anzahl der zurückzugebenden Datensätze dar. Der Standardwert ist 500. Es gibt kein Maximum.

Offset
offset integer

Stellt die Anzahl der zu überspringenden Datensätze dar. Zur Verwendung mit Paginierung.

Gibt zurück

Beziehungen

Auflisten von Werbecodes für Bestandteile

Listet die Solicit Codes für einen Bestandteil auf.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Bestandteil-ID
constituent_id True string

Die Systemdatensatz-ID des Bestandteils.

Gibt zurück

Anwaltscodes

Auflisten von Zustimmungsdatensätzen für Bestandteile

Listet die Zustimmungsdatensätze für einen Bestandteil auf.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Bestandteil-ID
constituent_id True string

Die Systemdatensatz-ID des Bestandteils.

Nur die aktuellsten?
most_recent_only boolean

Fügen Sie nur die neuesten Zustimmungsdatensätze für jede Kanalkategoriekombination in die Antwort ein?

Gibt zurück

Zustimmungsdatensätze

Benutzerdefinierte Listenfelder

Listet die benutzerdefinierten Felder für einen Bestandteil auf.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Bestandteil-ID
constituent_id True string

Die Systemdatensatz-ID des Bestandteils.

Gibt zurück

Benutzerdefinierte Felder

Ehrenbeehrung erstellen

Erstellt eine neue Anerkennung.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Tribute ID
tribute_id True integer

Die Systemdatensatz-ID der mit der Anerkennung verbundenen Anerkennung.

Beziehungs-ID
relationship_id integer

Die Systemdatensatz-ID der Beziehung (wenn NULL, stellt dies eine Selbsterkennung dar).

Brief-ID
letter_id integer

Die Brief-ID.

Gibt zurück

Ehrenbeehrung geschaffen

Ehrenerkennungen auflisten

Listet die Anerkennungen für eine Anerkennung auf.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Tribute ID
tributeId True integer

Die Systemdatensatz-ID der Hommage.

Gibt zurück

Ehrenerkennungen

Erstellen einer Bestandteil-Onlinepräsenz

Erstellt eine neue Onlinepräsenz.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Bestandteil-ID
constituent_id True string

Die Systemdatensatz-ID des Bestandteils, der der Onlinepräsenz zugeordnet ist.

Typ
type True string

Der Onlinepräsenztyp.

Link
address True string

Die Webadresse für die Onlinepräsenz.

Primär?
primary boolean

Ist dies die primäre Onlinepräsenz des Wählers?

Inaktiv?
inactive boolean

Ist diese Onlinepräsenz inaktiv?

Gibt zurück

Onlinepräsenz erstellt

Erstellen einer Bestandteiladresse

Erstellt eine neue Konstituierende Adresse.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Bestandteil-ID
constituent_id True string

Die Systemdatensatz-ID des Mit der Adresse verknüpften Bestandteils.

Adresstyp
type True string

Der Adresstyp.

Country
country string

Das Land der Adresse (kann die ID, der Name oder die Abkürzung sein).

Adresszeilen
address_lines string

Die Adresszeilen.

Stadt
city string

Die Stadt der Adresse (nicht in Kombination mit dem Feld "Vorort") verwenden.

Staat
state string

Das Bundesland der Adresse.

Postleitzahl
postal_code string

Die Postleitzahl der Adresse.

Vorort
suburb string

Der Vorort der Adresse (nicht in Kombination mit dem Feld "Ort") verwenden.

Bezirk
county string

Der Landkreis der Adresse.

Informationsquelle
information_source string

Die Informationsquelle für die Adresse.

Region
region string

Die Region für die Adresse.

KARREN
cart string

Die Netzbetreiberroute (CART) für die Adresse.

LOS
lot string

Die Reisezeile (LOT) für die Adresse.

DPC
dpc string

Der Zustellungspunktcode (Delivery Point Code, DPC) für die Adresse.

Gültig ab
start date

Das Datum, an dem der Konstituierende mit dieser Adresse begann (z. B. "2005-09-18").

Gültig bis
end date

Das Datum, an dem sich der Bestandteil nicht mehr an dieser Adresse befindet (z. B. "2005-09-18").

Primär?
preferred boolean

Ist dies die bevorzugte Adresse des Wählers?

Keine E-Mail senden?
do_not_mail boolean

Kann der Bestandteil an dieser Adresse kontaktiert werden?

Tag
d integer

Der Tag im Fuzzydatum.

Monat
m integer

Der Monat im Fuzzydatum.

Jahr
y integer

Das Jahr im Fuzzydatum.

Tag
d integer

Der Tag im Fuzzydatum.

Monat
m integer

Der Monat im Fuzzydatum.

Jahr
y integer

Das Jahr im Fuzzydatum.

Gibt zurück

Erstellte Konstituierende Adresse

Erstellen einer Bestandteilanlage

Erstellt eine neue Anlage.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Bestandteil-ID
parent_id True string

Die Systemdatensatz-ID des Bestandteils, der der Anlage zugeordnet ist.

Typ
type True string

Der Anlagentyp. Physische Anlagen werden hochgeladene Dateien wie Bilder, PDFs oder Word-Dokumente, die lokal oder im Netzwerk gespeichert werden. Sie werden im System gespeichert und verwaltet. Linkanlagen sind Links zu Dateien wie Bildern, Blogbeiträgen oder YouTube-Videos, die online oder in einem Cloudspeicherkonto gespeichert sind. Sie werden extern gespeichert und verwaltet.

Name
name string

Der Name der Anlage. Zeichenlimit: 150.

Datum
date date-time

Das Datum der Anlage (z. B. '2020-09-18T04:13:56Z'). Dieses Feld wird standardmäßig auf das aktuelle Datum und die aktuelle Uhrzeit festgelegt, wenn nicht angegeben.

URL
url string

Die URL für die Anlage. Dies ist für Verknüpfungsanlagen erforderlich und gilt nicht für physische Anlagen.

Dateiname
file_name string

Der Name der Datei. Zeichenlimit: 36. Nur für physische Anlagen.

Datei-ID
file_id string

Der Bezeichner der Datei. Zeichenlimit: 36. Nur für physische Anlagen.

Miniaturansichts-ID
thumbnail_id string

Der Bezeichner der Miniaturansicht. Zeichenlimit: 36. Nur für physische Anlagen.

Stichwörter
tags array of string

Die tags, die der Anlage zugeordnet sind.

Gibt zurück

Anlage erstellt

Erstellen einer bestandteilen Ausbildung

Erstellt eine neue bestandteilische Ausbildung.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Bestandteil-ID
constituent_id True string

Die Systemdatensatz-ID des Bestandteils, der der Ausbildung zugeordnet ist.

Schule
school True string

Der Name der Schule/Einrichtung.

Typ
type string

Die Art der Ausbildung.

Klasse von
class_of string

Das Jahr, in dem der Konstituierende abschloss.

Der Status
status string

Der Status der Ausbildung.

Tag
d integer

Der Tag im Fuzzydatum.

Monat
m integer

Der Monat im Fuzzydatum.

Jahr
y integer

Das Jahr im Fuzzydatum.

Tag
d integer

Der Tag im Fuzzydatum.

Monat
m integer

Der Monat im Fuzzydatum.

Jahr
y integer

Das Jahr im Fuzzydatum.

Tag
d integer

Der Tag im Fuzzydatum.

Monat
m integer

Der Monat im Fuzzydatum.

Jahr
y integer

Das Jahr im Fuzzydatum.

Grad
degree string

Der Grad, der empfangen wurde.

GPA
gpa double

Der Notenpunktdurchschnitt.

Studienfach
subject_of_study string

Das Studienfach.

Primär?
primary boolean

Ist dies der Grundschulverband der Wähler?

Majore
majors array of string

Die Hauptstudiengänge.

Minderjährige
minors array of string

Die Nebenstudiengänge.

Campus
campus string

Der Campus. Zeichenlimit: 50.

Soziale Organisation
social_organization string

Die soziale Organisation. Zeichenlimit: 50.

Bekannter Name
known_name string

Der bekannte Name. Zeichenlimit: 50.

Gradklasse
class_of_degree string

Die Klasse des Abschlusses (gilt nur für britische Versionen).

Abteilung
department string

Der Name der Bildungsabteilung (gilt nur für britische Versionen).

Fakultät
faculty string

Der Name der Fakultät (gilt nur für britische Versionen).

Registrierungsnummer
registration_number string

Die Registrierungsnummer (gilt nur für britische Versionen). Zeichenlimit: 50.

Gibt zurück

Bildung von Bestandteilen erstellt

Erstellen einer bestandteilen E-Mail-Adresse

Erstellt eine neue E-Mail-Adresse.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Bestandteil-ID
constituent_id True string

Die Systemdatensatz-ID des Bestandteils, der der E-Mail-Adresse zugeordnet ist.

E-Mail-Typ
type True string

Der Typ der E-Mail-Adresse.

E-Mail-Adresse
address True string

Die E-Mail-Adresse.

Primär?
primary boolean

Ist dies die primäre E-Mail-Adresse des Bestandteils?

Keine E-Mail senden?
do_not_email boolean

Kann der Bestandteil an dieser E-Mail-Adresse kontaktiert werden?

Inaktiv?
inactive boolean

Ist diese E-Mail-Adresse inaktiv?

Gibt zurück

Erstellte E-Mail-Adresse

Erstellen einer einzelnen Beziehung

Erstellt eine neue einzelne Beziehung. Wenn die Beziehung mit einem anderen Bestandteil besteht, wird für diesen Bestandteil eine gegenseitige Beziehung erstellt.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Bestandteil-ID
constituent_id True string

Die Systemdatensatz-ID des Mit der Beziehung verknüpften Bestandteils.

Beziehungs-ID
relation_id True string

Die Systemdatensatz-ID der zugehörigen Person.

Typ
type string

Der Typ der Beziehung, die die Beziehung darstellt.

Gegenseitiger Typ
reciprocal_type string

Beschreibt die Beziehung des Bestandteils zum zugehörigen Bestandteil. Beispielsweise wäre in einer Beziehung zwischen einem männlichen Bestandteil und einem weiblichen Gleichgeordneten der gegenseitige Beziehungstyp Bruder.

Tag
d integer

Der Tag im Fuzzydatum.

Monat
m integer

Der Monat im Fuzzydatum.

Jahr
y integer

Das Jahr im Fuzzydatum.

Tag
d integer

Der Tag im Fuzzydatum.

Monat
m integer

Der Monat im Fuzzydatum.

Jahr
y integer

Das Jahr im Fuzzydatum.

Ist Ehepartner?
is_spouse boolean

Ist die verwandte Person der Ehegatte?

Ist konstituierender Haushaltschef?
is_constituent_head_of_household boolean

Ist der Konstituierende der Haushaltschef?

Ist ehegatte Haushaltsleiter?
is_spouse_head_of_household boolean

Ist der Ehegatte der Kopf des Haushalts?

Hinweise
comment string

Weitere Hinweise zur Beziehung.

Gibt zurück

Individuelle Beziehung erstellt

Erstellen einer einzelnen Komponente

Erstellt einen neuen einzelnen Bestandteil.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Title
title string

Der Haupttitel des Bestandteils.

Vorname
first string

Der Vorname des Bestandteils. Zeichenlimit: 50.

Nachname
last True string

Der Nachname des Bestandteils. Zeichenlimit: 100.

Nachsilbe
suffix string

Das primäre Suffix des Bestandteils.

Nachschlage-ID
lookup_id string

Der benutzerdefinierte Bezeichner für den Bestandteil.

type
type True string

Der Adresstyp.

country
country string

Das Land der Adresse (kann die ID, der Name oder die Abkürzung sein).

Linien
address_lines string

Die Adresszeilen. Zeichenlimit: 150.

city
city string

Die Stadt der Adresse (nicht in Kombination mit dem Feld "Vorort") verwenden.

Staat
state string

Das Bundesland der Adresse.

Postleitzahl
postal_code string

Die Postleitzahl der Adresse. Zeichenlimit: 12.

Vorort
suburb string

Der Vorort der Adresse (nicht in Kombination mit dem Feld "Ort") verwenden.

Bezirk
county string

Der Landkreis der Adresse.

start
start date

Das Datum, an dem der Konstituierende mit dieser Adresse begann (z. B. "2005-09-18").

Ende
end date

Das Datum, an dem sich der Bestandteil nicht mehr an dieser Adresse befindet (z. B. "2005-09-18").

type
type True string

Der Telefontyp.

number
number True string

Die Telefonnummer.

ist primär?
primary boolean

Ist dies die primäre Telefonnummer des Wählers?

type
type True string

Der Typ der E-Mail-Adresse.

address
address True string

Die E-Mail-Adresse.

ist primär?
primary boolean

Ist dies die primäre E-Mail-Adresse des Bestandteils?

type
type True string

Der Onlinepräsenztyp.

address
address True string

Die Webadresse für die Onlinepräsenz.

ist primär?
primary boolean

Ist dies die primäre Onlinepräsenz des Wählers?

Bevorzugter Name
preferred_name string

Der bevorzugte Name des Bestandteils. Zeichenlimit: 50.

Zweiter Vorname
middle string

Der zweite Vorname des Bestandteils. Zeichenlimit: 50.

Ehemaliger Name
former_name string

Der frühere Name des Wählers. Zeichenlimit: 100.

Titel 2
title_2 string

Der sekundäre Titel des Bestandteils.

Suffix 2
suffix_2 string

Das sekundäre Suffix des Bestandteils.

Geschlecht
gender string

Das Geschlecht des Wählers.

Familienstand
marital_status string

Der Familienstand des Wählers.

Gibt anonym?
gives_anonymously boolean

Gibt der Bestandteil anonym?

Keine E-Mail anfordert?
requests_no_email boolean

Fordert die konstituierende Anforderung keine E-Mail an?

Ist ein Anwalt?
is_solicitor boolean

Ist der Konstituierende ein Anwalt?

Keine gültigen Adressen?
no_valid_address boolean

Hat der Bestandteil keine gültigen Adressen?

Tag
d integer

Der Tag im Fuzzydatum.

Monat
m integer

Der Monat im Fuzzydatum.

Jahr
y integer

Das Jahr im Fuzzydatum.

Geburtsort
birthplace string

Der Geburtsort des Konstituierenden.

Ethnizität
ethnicity string

Die Ethnischeität des Wählers.

Ziel
target string

Das Ziel des Bestandteils.

Erlöse
income string

Das Einkommen für den Bestandteil.

Bontyp
receipt_type string

Der Belegtyp des Bestandteils.

Religion
religion string

Die Religion des Bestandteils.

Benutzerdefinierte Adresse?
custom_format boolean

Ist der primäre Adressempfänger ein benutzerdefiniertes Format?

Adressformat
configuration_id string

Primäre Adressempfängerkonfiguration (erforderlich, es sei denn, es wird ein benutzerdefiniertes Format verwendet).

Benutzerdefinierter Adressname
formatted_name string

Primärer adressierter Name (erforderlich, wenn ein benutzerdefiniertes Format verwendet wird). Zeichenlimit: 255.

Benutzerdefinierte Anrede?
custom_format boolean

Ist die primäre Anrede ein benutzerdefiniertes Format?

Anredeformat
configuration_id string

Primäre Anredekonfiguration (erforderlich, es sei denn, es wird ein benutzerdefiniertes Format verwendet).

Benutzerdefinierter Anredename
formatted_name string

Primäre Anrede formatierter Name (erforderlich, wenn ein benutzerdefiniertes Format verwendet wird). Zeichenlimit: 255.

Ist Gedenken?
is_memorial boolean

Ist der Bestandteil ein Ehren-/Gedenktag?

Gibt zurück

Erstellt einzelne Bestandteile

Erstellen einer Fundraiserzuweisung

Erstellt eine neue Fundraiserzuordnung.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Fundraiser ID
fundraiser_id True string

Die Systemdatensatz-ID des Fundraisers.

Bestandteil-ID
constituent_id True string

Die Systemdatensatz-ID der zugewiesenen Komponente.

Typ
type string

Die Art des Fundraisers.

Zuordnung beginnt
start date-time

Der Anfangstermin der Aufgabe (z. B. '2020-09-18T04:13:56Z').

Zuordnung endet
end date-time

Das Enddatum der Aufgabe (z. B. '2020-09-18T04:13:56Z').

Betrag
value True double

Der Zielbetrag für den Fundraiser, der vom zugewiesenen Bestandteil angefordert werden soll.

Kampagnen-ID
campaign_id string

Die Systemdatensatz-ID der Kampagne, auf die resultierende Geschenke angewendet werden.

Fund-ID
fund_id string

Die Systemdatensatz-ID des Fonds, auf den resultierende Geschenke angewendet werden.

Berufungs-ID
appeal_id string

Die Systemdatensatz-ID des Aufrufs, auf den resultierende Geschenke angewendet werden.

Gibt zurück

Erstellt fundraiser assignment

Erstellen einer Konstituierenden Notiz

Erstellt eine neue Konstituierende Notiz.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Bestandteil-ID
constituent_id True string

Die Systemdatensatz-ID des Mit der Notiz verknüpften Bestandteils.

Typ
type True string

Der Notiztyp.

Tag
d integer

Der Tag im Fuzzydatum.

Monat
m integer

Der Monat im Fuzzydatum.

Jahr
y integer

Das Jahr im Fuzzydatum.

Zusammenfassung
summary string

Die Notizzusammenfassung. Zeichenlimit: 50.

Hinweis
text string

Der Notiztext.

Autor
author string

Der Notizautor. Wenn nicht angegeben, wird ein Standardsatz basierend auf dem Konto des Benutzers festgelegt. Zeichenlimit: 50.

Gibt zurück

Erstellter Bestandteilhinweis

Erstellen einer Organisationsbeziehung

Erstellt eine neue Organisationsbeziehung. Wenn die Beziehung mit einem anderen Bestandteil besteht, wird für diesen Bestandteil eine gegenseitige Beziehung erstellt.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Bestandteil-ID
constituent_id True string

Die Systemdatensatz-ID des Mit der Beziehung verknüpften Bestandteils.

Beziehungs-ID
relation_id True string

Die Systemdatensatz-ID der zugehörigen Organisation.

Typ
type string

Der Typ der Beziehung, die die Beziehung darstellt.

Gegenseitiger Typ
reciprocal_type string

Beschreibt die Beziehung des Bestandteils zur zugehörigen Organisation.

Tag
d integer

Der Tag im Fuzzydatum.

Monat
m integer

Der Monat im Fuzzydatum.

Jahr
y integer

Das Jahr im Fuzzydatum.

Tag
d integer

Der Tag im Fuzzydatum.

Monat
m integer

Der Monat im Fuzzydatum.

Jahr
y integer

Das Jahr im Fuzzydatum.

Ist Kontakt?
is_organization_contact boolean

Stellt die Komponente diese Organisation als Kontakt dar?

Kontakttyp
organization_contact_type string

Stellt Kontext für Interaktionen mit der zugehörigen Person bereit, die die Organisation als Kontakt darstellt.

Position
position string

Die Position der Person in der Organisation. Zeichenlimit: 50.

Ist primäres Geschäft?
is_primary_business boolean

Ist dies das Hauptgeschäft des Wählers?

Hinweise
comment string

Weitere Hinweise zur Beziehung.

Gibt zurück

Organisationsbeziehung erstellt

Erstellen einer Organisationskomponente

Erstellt einen neuen Organisationsbestandteil.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Name
name True string

Der Name der Organisation. Zeichenlimit: 100.

Nachschlage-ID
lookup_id string

Der benutzerdefinierte Bezeichner für den Bestandteil.

type
type True string

Der Adresstyp.

country
country string

Das Land der Adresse (kann die ID, der Name oder die Abkürzung sein).

Linien
address_lines string

Die Adresszeilen. Zeichenlimit: 150.

city
city string

Die Stadt der Adresse (nicht in Kombination mit dem Feld "Vorort") verwenden.

Staat
state string

Das Bundesland der Adresse.

Postleitzahl
postal_code string

Die Postleitzahl der Adresse. Zeichenlimit: 12.

Vorort
suburb string

Der Vorort der Adresse (nicht in Kombination mit dem Feld "Ort") verwenden.

Bezirk
county string

Der Landkreis der Adresse.

start
start date

Das Datum, an dem der Konstituierende mit dieser Adresse begann (z. B. "2005-09-18").

Ende
end date

Das Datum, an dem sich der Bestandteil nicht mehr an dieser Adresse befindet (z. B. "2005-09-18").

type
type True string

Der Telefontyp.

number
number True string

Die Telefonnummer.

ist primär?
primary boolean

Ist dies die primäre Telefonnummer des Wählers?

type
type True string

Der Typ der E-Mail-Adresse.

address
address True string

Die E-Mail-Adresse.

ist primär?
primary boolean

Ist dies die primäre E-Mail-Adresse des Bestandteils?

type
type True string

Der Onlinepräsenztyp.

address
address True string

Die Webadresse für die Onlinepräsenz.

ist primär?
primary boolean

Ist dies die primäre Onlinepräsenz des Wählers?

Gibt anonym?
gives_anonymously boolean

Gibt der Bestandteil anonym?

Keine E-Mail anfordert?
requests_no_email boolean

Fordert die konstituierende Anforderung keine E-Mail an?

Ist ein Anwalt?
is_solicitor boolean

Ist der Konstituierende ein Anwalt?

Keine gültigen Adressen?
no_valid_address boolean

Hat der Bestandteil keine gültigen Adressen?

Ziel
target string

Das Ziel des Bestandteils.

Erlöse
income string

Das Einkommen für den Bestandteil.

Bontyp
receipt_type string

Der Belegtyp des Bestandteils.

Branche
industry string

Die Industrie des Bestandteils.

Anzahl der Mitarbeiter
num_employees integer

Die Anzahl der Mitarbeiter in der Organisation.

Stimmt mit Geschenken überein?
matches_gifts boolean

Stimmt die Organisation mit Geschenken überein?

Passender Geschenkfaktor
matching_gift_factor double

Der passende Geschenkfaktor.

Min Match pro Geschenk
value double

Der mindeste Übereinstimmungsbetrag pro Geschenk für den Bestandteil.

Maximale Übereinstimmung pro Geschenk
value double

Der maximale Übereinstimmungsbetrag pro Geschenk für den Bestandteil.

Min Übereinstimmung pro Constit
value double

Die mindeste Übereinstimmungssumme für den Bestandteil.

Maximale Übereinstimmung pro Constit
value double

Die maximale Übereinstimmungssumme für den Bestandteil.

Abgleichen von Geschenknotizen
matching_gift_notes string

Die passenden Geschenknotizen für den Bestandteil.

Ist Gedenken?
is_memorial boolean

Ist der Bestandteil ein Ehren-/Gedenktag?

Gibt zurück

Erstellter Organisationsbestandteil

Erstellen einer teiligen Anerkennung

Erstellt eine neue teilgebende Anerkennung.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Bestandteil-ID
constituent_record_id True integer

Die Systemdatensatz-ID des Bestandteils, der der Hommage zugeordnet ist.

Tribute-Typ
tribute_type_id True integer

Der Hommagestyp.

Description
description string

Die Ehrungsbeschreibung.

Tag
d integer

Der Tag im Fuzzydatum.

Monat
m integer

Der Monat im Fuzzydatum.

Jahr
y integer

Das Jahr im Fuzzydatum.

Tag
d integer

Der Tag im Fuzzydatum.

Monat
m integer

Der Monat im Fuzzydatum.

Jahr
y integer

Das Jahr im Fuzzydatum.

Standardfonds-ID
default_fund_id integer

Die Systemdatensatz-ID des Standardfonds, der dem Tribut zugeordnet ist.

Hinweise
notes string

Die Ehrennotizen.

Aktiv?
is_active boolean

Ist diese Anerkennung aktiv?

Gibt zurück

Erschaffte Konstituierende Anerkennung

Erstellen eines benutzerdefinierten Bestandteilfelds

Erstellt ein neues benutzerdefiniertes Benutzerdefiniertes Feld.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
body
body True dynamic

Ein Objekt, das das zu erstellende benutzerdefinierte Feld darstellt.

Gibt zurück

Erstelltes benutzerdefiniertes Feld

Erstellen eines Bestandteil-Zustimmungsdatensatzes

Erstellt einen neuen zustimmungsgebenden Datensatz.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Bestandteil-ID
constituent_id True string

Die Systemdatensatz-ID des Mit dem Zustimmungsdatensatz verknüpften Bestandteils.

Kanal
channel True string

Der Kanal, für den die Zustimmungsantwort gilt.

Kategorie
category string

Die Kategorie, für die die Zustimmungsantwort gilt.

Quelle
source string

Die Quelle der Zustimmungsantwort des Bestandteils.

Antwort
constituent_consent_response True string

Wie der Bestandteil auf die Zustimmung für den angegebenen Kanal/die angegebene Kategorie geantwortet hat.

Datum
consent_date True date-time

Das Datum, an dem die Zustimmungsantwort empfangen wurde (z. B. '2020-09-18T04:13:56Z').

Zustimmungserklärung
consent_statement string

Die Erklärung, auf die der Bestandteil geantwortet hat, wenn er seine Zustimmung erteilt.

Datenschutzbestimmungen
privacy_notice string

Die Datenschutzhinweise, die dem Bestandteil zur Verfügung gestellt werden.

Gibt zurück

Erstellte Zustimmung zur Komponente

Erstellen eines Bestandteilcodes

Erstellt einen neuen Komponentencode.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Bestandteil-ID
constituent_id True string

Die Systemdatensatz-ID des Bestandteils, der dem Bestandteilcode zugeordnet ist.

Konstituierender Code
description True string

Der Bestandteilcode.

Tag
d integer

Der Tag im Fuzzydatum.

Monat
m integer

Der Monat im Fuzzydatum.

Jahr
y integer

Das Jahr im Fuzzydatum.

Tag
d integer

Der Tag im Fuzzydatum.

Monat
m integer

Der Monat im Fuzzydatum.

Jahr
y integer

Das Jahr im Fuzzydatum.

Sequence
sequence integer

Die numerische Sequenz, die dem Bestandteilcode zugeordnet ist.

Gibt zurück

Erstellter Komponentencode

Erstellen eines Bestandteiltelefons

Erstellt ein neues Bestandteiltelefon.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Bestandteil-ID
constituent_id True string

Die Systemdatensatz-ID des Bestandteils, der dem Telefon zugeordnet ist.

Typ
type True string

Der Telefontyp.

Number
number True string

Die Telefonnummer.

Primär?
primary boolean

Ist dies das primäre Telefon des Wählers?

Rufen Sie nicht an?
do_not_call boolean

Kann der Bestandteil an dieser Nummer kontaktiert werden?

Inaktiv?
inactive boolean

Ist diese Telefonnummer inaktiv?

Gibt zurück

Erstelltes Bestandteiltelefon

Erstellen eines konstituierenden Solicit-Codes

Erstellt einen neuen Konstituierenden Solicit-Code.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Bestandteil-ID
constituent_id True string

Die Systemdatensatz-ID des Bestandteils, der dem Solicit-Code zugeordnet ist.

Anfordern von Code
solicit_code True string

Kommunikationsanweisungen und/oder Einschränkungen für einen Bestandteil.

Startdatum
start_date date

Das Startdatum des Anmeldecodes (z. B. "2005-09-18").

Enddatum
end_date date

Das Enddatum des Anmeldecodes (z. B. "2005-09-18").

Gibt zurück

Erstellter Einholungscode

Erstellen eines Namensformats für Bestandteile

Erstellt ein neues Namensformat.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Bestandteil-ID
constituent_id True string

Die Systemdatensatz-ID des Bestandteils.

Typ
type True string

Der Namensformattyp.

Benutzerdefiniertes Namensformat?
custom_format boolean

Ist ein benutzerdefiniertes Format?

Format
configuration_id string

Namensformatkonfiguration (erforderlich, es sei denn, es wird ein benutzerdefiniertes Format verwendet).

Benutzerdefinierter Name
formatted_name string

Formatierter Name (erforderlich, wenn ein benutzerdefiniertes Format verwendet wird). Zeichenlimit: 255.

Gibt zurück

Erstelltes Namensformat

Erstellen eines primären Namensformats für bestandteile

Erstellt ein primäres Namensformat für einen Bestandteil.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Bestandteil-ID
constituent_id True string

Die Systemdatensatz-ID des Bestandteils.

Typ
primary_type True string

Der primäre Namensformattyp.

Benutzerdefiniertes Namensformat?
custom_format boolean

Ist ein benutzerdefiniertes Format?

Format
configuration_id string

Namensformatkonfiguration (erforderlich, es sei denn, es wird ein benutzerdefiniertes Format verwendet).

Benutzerdefinierter Name
formatted_name string

Formatierter Name (erforderlich, wenn ein benutzerdefiniertes Format verwendet wird). Zeichenlimit: 255.

Gibt zurück

Erstelltes Namensformat

Erstellen eines Teilalias

Erstellt einen neuen Bestandteilalias.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Bestandteil-ID
constituent_id True string

Die Systemdatensatz-ID des Mit dem Alias verknüpften Bestandteils.

Alias
name True string

Der Name, der als Alias des Bestandteils verwendet werden soll. Zeichenlimit: 100.

Typ
type string

Der Aliastyp.

Gibt zurück

Erstellter Bestandteilalias

Holen Sie sich eine teiligen Anerkennung

Gibt Details zu einer teiligen Hommage zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Tribute ID
tribute_id True string

Die Ehren-ID.

Gibt zurück

Tribut

In Bestandteil konvertieren

Wandelt einen Nicht-Bestandteil in einen Bestandteil um.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Nicht-Bestandteil-ID
non_constituent_id True string

Die Systemdatensatz-ID des nicht konstituierenden Datensatzes, der konvertiert werden soll.

ID
id string

Die Systemdatensatz-ID des Komponentencodes.

Tag
d integer

Der Tag im Fuzzydatum.

Monat
m integer

Der Monat im Fuzzydatum.

Jahr
y integer

Das Jahr im Fuzzydatum.

Tag
d integer

Der Tag im Fuzzydatum.

Monat
m integer

Der Monat im Fuzzydatum.

Jahr
y integer

Das Jahr im Fuzzydatum.

Sequenz
sequence integer

Die Sequenz des Konstituierenden Codes.

Gibt zurück

Konvertierter Bestandteil

Liste der Teilerehrungen

Listet die Ehren für einen Bestandteil auf.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Bestandteil-ID
constituentId True integer

Die Systemdatensatz-ID des Bestandteils.

Gibt zurück

Abgaben

Listenkomponenten

Gibt eine Liste von Bestandteilen zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
List
list_id string

Definiert einen Listenbezeichner, der zum Filtern der In der angegebenen Liste enthaltenen Komponenten verwendet wird. Wenn dieser Wert festgelegt ist, werden andere angegebene Filter ignoriert.

Limit
limit integer

Stellt die Anzahl der zurückzugebenden Datensätze dar. Der Standardwert ist 500. Das Maximum beträgt 5000.

Offset
offset integer

Stellt die Anzahl der zu überspringenden Datensätze dar. Zur Verwendung mit Paginierung.

Konstituierender Code
constituent_code string

Stellt einen Bestandteilcode zum Filtern der Liste dar. Beispielsweise gibt "Board Member" nur Bestandteile mit einem Gremiumsmitgliedscode zurück.

Bestandteil-ID
constituent_id string

Stellt eine durch Trennzeichen getrennte Liste der Komponentendatensatz-IDs dar, um die Ergebnisse zu filtern. Beispielsweise gibt "280.1232" nur den Bestandteil 280 oder den Bestandteil 1232 zurück.

Benutzerdefinierte Feldkategorie
custom_field_category string

Stellt eine benutzerdefinierte Feldkategorie zum Filtern der Ergebnisse dar. Beispielsweise gibt "Anniversary" nur Bestandteile mit einem aktiven benutzerdefinierten Anniversary-Feld zurück.

Fundraiser-Status
fundraiser_status string

Stellt eine durch Trennzeichen getrennte Liste der Fundraiserstatus dar, um die Ergebnisse zu filtern. Beispielsweise gibt "Aktiv", Keine" nur Bestandteile zurück, deren Fundraiserstatus "Aktiv" oder "Keine" ist. Gültige Werte für diesen Filter sind "Aktiv", "Inaktiv" und "None".

Schließe Verstorbene ein?
include_deceased boolean

Schließen Sie verstorbene Bestandteile in die Antwort ein?

Inaktiv einschließen?
include_inactive boolean

Inaktive Bestandteile in die Antwort einschließen?

Postleitzahl
postal_code string

Stellt eine durch Trennzeichen getrennte Liste der Postleitzahlen dar, um die Ergebnisse zu filtern. Beispielsweise gibt "29466.29492" nur Bestandteile zurück, deren bevorzugte Adresse eine Postleitzahl aufweist, die mit 29466 oder 29492 beginnt, z. B. 29466, 29492 oder 29492-0727.

Hinzugefügt am oder nach
date_added date-time

Filtern Sie die Ergebnisse nach Komponenten, die am oder nach dem angegebenen Datum erstellt wurden (z. B. '2020-09-18T04:13:56Z').

Geändert am oder nach
last_modified date-time

Filtern Sie die Ergebnisse nach komponenten, die am oder nach dem angegebenen Datum geändert wurden (z. B. '2020-09-18T04:13:56Z').

Sortiert nach
sort string

Stellt eine Liste von Feldern dar, nach denen die Ergebnisse sortiert werden sollen. Die Ergebnisse sind standardmäßig in aufsteigender Reihenfolge und ein "-"-Zeichen zeigt absteigende Reihenfolge an. Beispielsweise sortiert "date_added,-last" Bestandteile nach dem Feld "date_added" in aufsteigender Reihenfolge und dann nach dem Feld "zuletzt" in absteigender Reihenfolge.

Gibt zurück

Bestandteile

Listenkomponentencodes

Listet die Komponentencodes für einen Bestandteil auf.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Bestandteil-ID
constituent_id True string

Die Systemdatensatz-ID des Bestandteils.

Gibt zurück

Komponentencodes

Löschen eines Bestandteilcodes

Löscht einen Bestandteilcode.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Komponentencode-ID
constituent_code_id True string

Die Systemdatensatz-ID des zu löschenden Komponentencodes.

Mitgliedschaften auflisten

Listet die Mitgliedschaften für einen Bestandteil auf.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Bestandteil-ID
constituent_id True string

Die Systemdatensatz-ID des Bestandteils.

Gibt zurück

Memberships

Onlinepräsenzen auflisten

Listet die Onlinepräsenzen für einen Bestandteil auf.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Bestandteil-ID
constituent_id True string

Die Systemdatensatz-ID des Bestandteils.

Inaktiv einschließen?
include_inactive boolean

Inaktive Onlinepräsenzen einschließen?

Gibt zurück

Onlinepräsenzen

Suchen nach doppelten Bestandteilen

Durchsucht einzelne, organisationsbezogene und verwandte Kontaktdatensätze und bewertet potenzielle Duplikate basierend auf den angegebenen Suchfiltern. Datensätze, die mit mehreren Filtern übereinstimmen, rangieren höher als potenzielle Duplikate.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Nach-/Organisationsname
last_org_name True string

Ein Filter für Datensätze, die dem angegebenen Nachnamen oder Organisationsnamen entsprechen.

Vorname
first_name string

Ein Filter für einzelne Datensätze, die dem angegebenen Vornamen entsprechen.

Zweiter Vorname
middle_name string

Ein Filter für einzelne Datensätze, die dem angegebenen zweiten Namen entsprechen.

Nachsilbe
suffix string

Ein Filter für einzelne Datensätze, die dem angegebenen Suffix entsprechen.

Adressblock
address_block string

Ein Filter für Datensätze, die dem angegebenen Adressblock entsprechen.

Stadt
city string

Ein Filter für Datensätze, die der angegebenen Stadt entsprechen.

Staat
state string

Ein Filter für Datensätze, die dem angegebenen Zustand entsprechen.

Postleitzahl
post_code string

Ein Filter für Datensätze, die der angegebenen Postleitzahl entsprechen.

Email
email array

Ein Filter für Datensätze, die den angegebenen E-Mail-Adressen entsprechen.

Telefonnummer
phone array

Ein Filter für Datensätze, die den angegebenen Telefonnummern entsprechen.

Personen suchen?
search_individuals boolean

Nach duplizierten einzelnen Datensätzen suchen?

Suchaliasen?
search_aliases boolean

Suchen Sie nach dem Alias, wie durch den Parameter "Last/org name" angegeben?

Kontakte durchsuchen?
search_contacts boolean

Kontaktdatensätze für Beziehungen durchsuchen?

Limit
limit integer

Die Anzahl der Datensätze, die beim Auslagerungsergebnis zurückgegeben werden sollen (Standard = 3).

Offset
offset integer

Die Anzahl der Datensätze, die beim Auslagerungsergebnis übersprungen werden sollen.

Gibt zurück

Doppelte Suchergebnisse

Suchen nach einem Bestandteil

Führt eine konstituierende Suche basierend auf dem bereitgestellten Suchtext aus. Unterstützt Vorname, Nachname, bevorzugter Name, früherer Name, Alias, E-Mail-Adresse, Telefonnummer, Adresse oder Nachschlage-ID. Namenskombinationen wie Vorname und Nachname oder bevorzugter Name und Nachname sind gültig, andernfalls unterstützt die Suche nur jeweils einen Parameter. Standardmäßig enthalten Suchvorgänge Ergebnisse, die ihren Kriterien ähneln. Suchvorgänge nach "Smith" enthalten z. B. Übereinstimmungen für "Smyth" und andere alternative Schreibweisen. Diese Suche unterstützt keine Wildcardzeichen wie * oder ?. Suchergebnisse sind auf 500 Datensätze beschränkt.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Suchtext
search_text True string

Der Suchtext. Unterstützt Vorname, Nachname, bevorzugter Name, früherer Name, Alias, E-Mail-Adresse, Telefonnummer, Adresse oder Nachschlage-ID. Namenskombinationen wie Vorname und Nachname oder bevorzugter Name und Nachname sind gültig, andernfalls unterstützt die Suche nur jeweils einen Parameter. Standardmäßig enthalten Suchvorgänge Ergebnisse, die ihren Kriterien ähneln. Suchvorgänge nach "Smith" enthalten z. B. Übereinstimmungen für "Smyth" und andere alternative Schreibweisen. Diese Suche unterstützt keine Wildcardzeichen wie * oder ?. Suchergebnisse sind auf 500 Datensätze beschränkt.

Fundraiser statuses
fundraiser_status string

Stellt eine durch Trennzeichen getrennte Liste der Fundraiserstatus dar, um die Ergebnisse zu filtern. Beispielsweise gibt "Aktiv", Keine" nur Bestandteile zurück, deren Fundraiserstatus "Aktiv" oder "Keine" ist. Gültige Werte für diesen Filter sind "Aktiv", "Inaktiv" und "None".

Inaktiv einschließen?
include_inactive boolean

Inaktive Bestandteile in die Antwort einschließen?

Suchfeld
search_field string

Represents a field to search on. Derzeit unterstützt es nur lookup_id. Wenn sie mit search_text bereitgestellt wird, wird ein Bestandteil mit lookup_id zurückgegeben, der dem search_text entspricht.

Strenge Suche verwenden?
strict_search boolean

Bestandteile ausschließen, deren Namen wie der Suchtext klingen, aber anders geschrieben sind?

Limit
limit integer

Stellt die Anzahl der zurückzugebenden Datensätze dar. Der Standardwert ist 500. Das Maximum beträgt 5000.

Offset
offset integer

Stellt die Anzahl der zu überspringenden Datensätze dar. Zur Verwendung mit Paginierung.

Gibt zurück

Suchergebnisse

Suchen nach einem Bestandteil (erweitert)

Sucht mithilfe der angegebenen Filterkriterien nach Bestandteilen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Vorname
first_name string

Vorname.

Nachname
last_name string

Nachname des Bestandteils.

Nachschlage-ID
lookup_id string

Nachschlage-ID für die Komponente.

E-Mail-Adresse
email string

Konstituierende E-Mail-Adresse.

Telefonnummer
phone_number string

Telefonnummer.

Limit
limit integer

Stellt die Anzahl der zurückzugebenden Datensätze dar. Der Standardwert ist 500. Das Maximum beträgt 1000.

Adresszeilen
address_lines string

Adresszeilen.

Stadt
city string

Adresse Ort.

Staat
state string

Adressstatus.

Postleitzahl
post_code string

Adresse Postleitzahl.

Alias einschließen?
include_alias boolean

Alias bei der Suche nach nach dem Nachnamen einschließen?

Aliastyp
alias_type string

Aliastyp.

Maidenname einschließen?
include_maiden_name boolean

Bei der Suche nach dem Nachnamen maiden name einschließen?

Gibt zurück

Bestandteile

Zusammenfassung des Namensformats für Bestandteile abrufen

Gibt die Namensformatzusammenfassung für einen Bestandteil zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Bestandteil-ID
constituent_id True string

Die Systemdatensatz-ID des Bestandteils.

Gibt zurück

Namensformatzusammenfassung

Definitionen

CommPrefApi.ConstituentConsentRead

Stellt eine Zustimmungsentität für einen Bestandteil dar.

Name Pfad Typ Beschreibung
ID
id string

Die Systemdatensatz-ID des Zustimmungsdatensatzes.

Kanal
channel string

Der Kanal, für den die Zustimmungsantwort gilt.

Kategorie
category string

Die Kategorie, für die die Zustimmungsantwort gilt.

Quelle
source string

Die Quelle der Zustimmungsantwort des Bestandteils.

Antwort
constituent_consent_response string

Wie der Bestandteil auf die Zustimmung für den angegebenen Kanal/die angegebene Kategorie geantwortet hat.

Datum
consent_date date-time

Das Datum, an dem die Zustimmungsantwort empfangen wurde.

Zustimmungserklärung
consent_statement string

Die Erklärung, auf die der Bestandteil geantwortet hat, wenn er seine Zustimmung erteilt.

Datenschutzbestimmungen
privacy_notice string

Die Datenschutzhinweise, die dem Bestandteil zur Verfügung gestellt werden.

Datum hinzugefügt
date_added date-time

Das Datum, an dem die Zustimmungsantwort hinzugefügt wurde.

Hinzugefügt von
user_name string

Der Benutzer, der die Zustimmungsantwort hinzugefügt hat.

CommPrefApi.ConstituentConsentReadCollection

Zustimmungsdatensätze

Name Pfad Typ Beschreibung
Anzahl
count integer

Die Anzahl der Zustimmungsdatensätze in der Liste.

value
value array of CommPrefApi.ConstituentConsentRead

Der Satz von Zustimmungsdatensätzen, die in der Antwort enthalten sind.

CommPrefApi.ConstituentSolicitCodeRead

Anfordern von Code

Name Pfad Typ Beschreibung
ID
id string

Die Systemdatensatz-ID des konstituierenden Solicit-Codes.

Anfordern von Code
solicit_code string

Kommunikationsanweisungen und/oder Einschränkungen für einen Bestandteil.

Startdatum
start_date date

Das Startdatum des Anmeldecodes (z. B. "2005-09-18").

Enddatum
end_date date

Das Enddatum des Anmeldecodes (z. B. "2005-09-18").

CommPrefApi.ConstituentSolicitCodeReadCollection

Anwaltscodes

Name Pfad Typ Beschreibung
Anzahl
count integer

Die Anzahl der in der Liste aufgeführten Konstituierenden Solicit Codes.

value
value array of CommPrefApi.ConstituentSolicitCodeRead

Die Gruppe der in der Antwort enthaltenen Konstituierenden Solicit-Codes.

CommPrefApi.CreatedConstituentConsent

Erstellte Zustimmung zur Komponente

Name Pfad Typ Beschreibung
ID
id string

Die ID des neu erstellten Zustimmungsdatensatzes.

CommPrefApi.CreatedConstituentSolicitCode

Erstellter Einholungscode

Name Pfad Typ Beschreibung
ID
id string

Die ID des neu erstellten Konstituierenden Solicit-Codes.

ConstituentApi.AddressRead

Adresse

Name Pfad Typ Beschreibung
ID
id string

Die Systemdatensatz-ID der Adresse.

Typ
type string

Der Adresstyp.

Country
country string

Das Land der Adresse (kann die ID, der Name oder die Abkürzung sein).

Adresszeilen
address_lines string

Die Adresszeilen.

Stadt
city string

Die Stadt der Adresse (nicht in Kombination mit dem Feld "Vorort") verwenden.

Staat
state string

Das Bundesland der Adresse.

Postleitzahl
postal_code string

Die Postleitzahl der Adresse.

Vorort
suburb string

Der Vorort der Adresse (nicht in Kombination mit dem Feld "Ort") verwenden.

Bezirk
county string

Der Landkreis der Adresse.

Formatierte Adresse
formatted_address string

Die formatierte Adresse im konfigurierten Format des Landes.

Informationsquelle
information_source string

Die Informationsquelle für die Adresse.

Region
region string

Die Region für die Adresse.

KARREN
cart string

Die Netzbetreiberroute (CART) für die Adresse.

LOS
lot string

Die Reisezeile (LOT) für die Adresse.

DPC
dpc string

Der Zustellungspunktcode (Delivery Point Code, DPC) für die Adresse.

Gültig ab
start date-time

Das Datum, an dem der Konstituierende an dieser Adresse wohnte.

Gültig bis
end date-time

Das Datum, an dem der Bestandteil nicht mehr an dieser Adresse ansässig ist.

Primär?
preferred boolean

Ist dies die bevorzugte Adresse des Wählers?

Inaktiv?
inactive boolean

Ist die Adresse inaktiv (d. h., das aktuelle Datum liegt vor einem Enddatum)?

Keine E-Mail senden?
do_not_mail boolean

Kann der Bestandteil an dieser Adresse kontaktiert werden?

Tag
seasonal_start.d integer

Der Tag im Fuzzydatum.

Monat
seasonal_start.m integer

Der Monat im Fuzzydatum.

Jahr
seasonal_start.y integer

Das Jahr im Fuzzydatum.

Tag
seasonal_end.d integer

Der Tag im Fuzzydatum.

Monat
seasonal_end.m integer

Der Monat im Fuzzydatum.

Jahr
seasonal_end.y integer

Das Jahr im Fuzzydatum.

Datum hinzugefügt
date_added date-time

Das Datum, an dem die Adresse erstellt wurde.

Änderungsdatum
date_modified date-time

Das Datum, an dem die Adresse zuletzt geändert wurde.

ConstituentApi.AliasRead

Alias

Name Pfad Typ Beschreibung
ID
id string

Die Systemdatensatz-ID des Alias.

Alias
name string

Der Name, der als Alias des Bestandteils verwendet werden soll.

Typ
type string

Der Aliastyp.

ConstituentApi.ApiCollectionOfAddressRead

Addresses

Name Pfad Typ Beschreibung
Anzahl
count integer

Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.

value
value array of ConstituentApi.AddressRead

Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

ConstituentApi.ApiCollectionOfAliasRead

Decknamen

Name Pfad Typ Beschreibung
Anzahl
count integer

Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.

value
value array of ConstituentApi.AliasRead

Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

ConstituentApi.ApiCollectionOfConstituentAttachmentRead

Attachments

Name Pfad Typ Beschreibung
Anzahl
count integer

Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.

value
value array of ConstituentApi.ConstituentAttachmentRead

Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

ConstituentApi.ApiCollectionOfConstituentCodeRead

Komponentencodes

Name Pfad Typ Beschreibung
Anzahl
count integer

Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.

value
value array of ConstituentApi.ConstituentCodeRead

Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

ConstituentApi.ApiCollectionOfConstituentCustomFieldRead

Benutzerdefinierte Felder

Name Pfad Typ Beschreibung
Anzahl
count integer

Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.

value
value array of ConstituentApi.ConstituentCustomFieldRead

Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

ConstituentApi.ApiCollectionOfConstituentRead

Bestandteile

Name Pfad Typ Beschreibung
Anzahl
count integer

Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.

value
value array of ConstituentApi.ConstituentRead

Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

ConstituentApi.ApiCollectionOfEducationRead

Ausbildungen

Name Pfad Typ Beschreibung
Anzahl
count integer

Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.

value
value array of ConstituentApi.EducationRead

Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

ConstituentApi.ApiCollectionOfEmailAddressRead

E-Mail-Adressen

Name Pfad Typ Beschreibung
Anzahl
count integer

Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.

value
value array of ConstituentApi.EmailAddressRead

Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

ConstituentApi.ApiCollectionOfFundraiserAssignmentRead

Fundraiser-Zuordnungen

Name Pfad Typ Beschreibung
Anzahl
count integer

Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.

value
value array of ConstituentApi.FundraiserAssignmentRead

Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

ConstituentApi.ApiCollectionOfMembershipRead

Memberships

Name Pfad Typ Beschreibung
Anzahl
count integer

Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.

value
value array of ConstituentApi.MembershipRead

Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

ConstituentApi.ApiCollectionOfNoteRead

Hinweise

Name Pfad Typ Beschreibung
Anzahl
count integer

Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.

value
value array of ConstituentApi.NoteRead

Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

ConstituentApi.ApiCollectionOfOnlinePresenceRead

Onlinepräsenzen

Name Pfad Typ Beschreibung
Anzahl
count integer

Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.

value
value array of ConstituentApi.OnlinePresenceRead

Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

ConstituentApi.ApiCollectionOfPhoneRead

Telefone

Name Pfad Typ Beschreibung
Anzahl
count integer

Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.

value
value array of ConstituentApi.PhoneRead

Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

ConstituentApi.ApiCollectionOfRelationshipRead

Beziehungen

Name Pfad Typ Beschreibung
Anzahl
count integer

Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.

value
value array of ConstituentApi.RelationshipRead

Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

ConstituentApi.ApiCollectionOfSearchResultRead

Suchergebnisse

Name Pfad Typ Beschreibung
Anzahl
count integer

Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.

value
value array of ConstituentApi.SearchResultRead

Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

ConstituentApi.ConstituentAttachmentRead

Attachment

Name Pfad Typ Beschreibung
ID
id string

Die Systemdatensatz-ID der Anlage.

Bestandteil-ID
parent_id string

Die Systemdatensatz-ID des Bestandteils, der der Anlage zugeordnet ist.

Typ
type string

Der Anlagentyp. Physische Anlagen werden hochgeladene Dateien wie Bilder, PDFs oder Word-Dokumente, die lokal oder im Netzwerk gespeichert werden. Sie werden im System gespeichert und verwaltet. Linkanlagen sind Links zu Dateien wie Bildern, Blogbeiträgen oder YouTube-Videos, die online oder in einem Cloudspeicherkonto gespeichert sind. Sie werden extern gespeichert und verwaltet.

Name
name string

Der Name der Anlage. Zeichenlimit: 150.

Datum
date date-time

Das Datum der Anlage.

URL
url string

Die URL für die Anlage. Dies ist für Verknüpfungsanlagen erforderlich und gilt nicht für physische Anlagen.

Dateiname
file_name string

Der Name der Datei. Zeichenlimit: 36. Nur für physische Anlagen.

Datei-ID
file_id string

Der Bezeichner der Datei. Zeichenlimit: 36. Nur für physische Anlagen.

Miniaturansichts-ID
thumbnail_id string

Der Bezeichner der Miniaturansicht. Zeichenlimit: 36. Nur für physische Anlagen.

Miniaturansichts-URL
thumbnail_url string

Die URL für eine Miniaturansicht. Nur für physische Anlagen, die Bilder sind. Enthält eine zeitgebundene Signatur, die den Zugriff auf 60 Minuten beschränkt.

Inhaltstyp
content_type string

Der Inhaltstyp. Nur für physische Anlagen.

Dateigröße
file_size integer

Die Dateigröße in Byte. Nur für physische Anlagen.

Stichwörter
tags array of string

Die tags, die der Anlage zugeordnet sind.

ConstituentApi.ConstituentCodeRead

Konstituierender Code

Name Pfad Typ Beschreibung
ID
id string

Die Systemdatensatz-ID des Komponentencodes.

Bestandteil-ID
constituent_id string

Die Systemdatensatz-ID des Bestandteils, der dem Bestandteilcode zugeordnet ist.

Konstituierender Code
description string

Der Bestandteilcode.

Tag
start.d integer

Der Tag im Fuzzydatum.

Monat
start.m integer

Der Monat im Fuzzydatum.

Jahr
start.y integer

Das Jahr im Fuzzydatum.

Tag
end.d integer

Der Tag im Fuzzydatum.

Monat
end.m integer

Der Monat im Fuzzydatum.

Jahr
end.y integer

Das Jahr im Fuzzydatum.

Inaktiv?
inactive boolean

Ist der Bestandteilcode inaktiv?

Sequence
sequence integer

Die numerische Sequenz, die dem Bestandteilcode zugeordnet ist.

Datum hinzugefügt
date_added date-time

Das Datum, an dem der Konstituierende Code erstellt wurde.

Änderungsdatum
date_modified date-time

Das Datum, an dem der Konstituierende Code zuletzt geändert wurde.

ConstituentApi.ConstituentCustomFieldRead

Benutzerdefiniertes Feld

Name Pfad Typ Beschreibung
ID
id string

Die Systemdatensatz-ID des benutzerdefinierten Felds.

Bestandteil-ID
parent_id string

Die Systemdatensatz-ID des Bestandteils, der dem benutzerdefinierten Feld zugeordnet ist.

Kategorie
category string

Die Kategorie des benutzerdefinierten Felds.

Typ
type string

Der Datentyp, den das benutzerdefinierte Feld darstellt.

Wert
value

Der Wert des benutzerdefinierten Felds.

Textwert
text_value string

Der Textwert des benutzerdefinierten Felds.

Zahlenwert
number_value integer

Der numerische Wert des benutzerdefinierten Felds.

Datumswert
date_value date

Der Datumswert des benutzerdefinierten Felds.

Währungswert
currency_value double

Der Währungswert des benutzerdefinierten Felds.

Boolescher Wert
boolean_value boolean

Der boolesche Wert des benutzerdefinierten Felds.

Tabelleneintragswert
codetableentry_value string

Der Tabelleneintragswert des benutzerdefinierten Felds.

Bestandteil-ID-Wert
constituentid_value string

Der Id-Bestandteilwert des benutzerdefinierten Felds.

Tag
fuzzydate_value.d integer

Der Tag im Fuzzydatum.

Monat
fuzzydate_value.m integer

Der Monat im Fuzzydatum.

Jahr
fuzzydate_value.y integer

Das Jahr im Fuzzydatum.

Datum
date date

Das Datum im benutzerdefinierten Feld.

Kommentar
comment string

Der Kommentar für das benutzerdefinierte Feld. Zeichenlimit: 50.

Datum hinzugefügt
date_added date-time

Das Datum, an dem das benutzerdefinierte Feld erstellt wurde.

Änderungsdatum
date_modified date-time

Das Datum, an dem das benutzerdefinierte Feld zuletzt geändert wurde.

ConstituentApi.ConstituentRead

Bestandteil

Name Pfad Typ Beschreibung
ID
id string

Die Systemdatensatz-ID für den Bestandteil. Dies entspricht nicht dem benutzerdefinierten Bestandteilbezeichner, der im lookup_id gespeichert wird.

Typ
type string

Der Typ des Bestandteils.

Title
title string

Der Haupttitel des Bestandteils (nur für Einzelpersonen).

Vorname
first string

Der Vorname des Bestandteils (nur für Einzelpersonen).

Nachname
last string

Der Nachname des Bestandteils (nur für Einzelpersonen).

Name
name string

Bei Einzelpersonen ist dieses Feld der vollständige Name des Bestandteils basierend auf den Anzeigenameneinstellungen der Zielorganisation. Für Organisationen ist dies der Name der Organisation.

Bevorzugter Name
preferred_name string

Der bevorzugte Name des Bestandteils (nur für Einzelpersonen).

Nachsilbe
suffix string

Das primäre Suffix des Bestandteils (nur für Einzelpersonen).

Nachschlage-ID
lookup_id string

Der benutzerdefinierte Bezeichner für den Bestandteil.

ID
email.id string

Die Systemdatensatz-ID der E-Mail-Adresse.

type
email.type string

Der Typ der E-Mail-Adresse.

address
email.address string

Die E-Mail-Adresse.

keine E-Mail senden?
email.do_not_email boolean

Kann der Bestandteil an dieser E-Mail-Adresse kontaktiert werden?

inaktiv?
email.inactive boolean

Ist diese E-Mail-Adresse inaktiv?

hinzugefügtes Datum
email.date_added date-time

Das Datum, an dem die E-Mail-Adresse erstellt wurde.

Änderungsdatum
email.date_modified date-time

Das Datum, an dem die E-Mail-Adresse zuletzt geändert wurde.

ID
phone.id string

Die Systemdatensatz-ID des Telefons.

type
phone.type string

Der Telefontyp.

number
phone.number string

Die Telefonnummer.

nicht anrufen?
phone.do_not_call boolean

Kann der Bestandteil an dieser Nummer kontaktiert werden?

inaktiv?
phone.inactive boolean

Ist diese Telefonnummer inaktiv?

hinzugefügtes Datum
phone.date_added date-time

Das Datum, an dem das Telefon erstellt wurde.

Änderungsdatum
phone.date_modified date-time

Das Datum, an dem das Telefon zuletzt geändert wurde.

ID
online_presence.id string

Die Systemdatensatz-ID der Onlinepräsenz.

type
online_presence.type string

Der Onlinepräsenztyp.

link
online_presence.address string

Die Webadresse für die Onlinepräsenz.

inaktiv?
online_presence.inactive boolean

Ist diese Onlinepräsenz inaktiv?

hinzugefügtes Datum
online_presence.date_added date-time

Das Datum, an dem die Onlinepräsenz erstellt wurde.

Änderungsdatum
online_presence.date_modified date-time

Das Datum, an dem die Onlinepräsenz zuletzt geändert wurde.

ID
address.id string

Die Systemdatensatz-ID der Adresse.

type
address.type string

Der Adresstyp.

country
address.country string

Das Land der Adresse (kann die ID, der Name oder die Abkürzung sein).

Linien
address.address_lines string

Die Adresszeilen.

city
address.city string

Die Stadt der Adresse (nicht in Kombination mit dem Feld "Vorort") verwenden.

Staat
address.state string

Das Bundesland der Adresse.

Postleitzahl
address.postal_code string

Die Postleitzahl der Adresse.

Vorort
address.suburb string

Der Vorort der Adresse (nicht in Kombination mit dem Feld "Ort") verwenden.

Bezirk
address.county string

Der Landkreis der Adresse.

formatiert
address.formatted_address string

Die formatierte Adresse im konfigurierten Format des Landes.

gültig von
address.start date-time

Das Datum, an dem der Konstituierende an dieser Adresse wohnte.

gültig für
address.end date-time

Das Datum, an dem der Bestandteil nicht mehr an dieser Adresse ansässig ist.

inaktiv?
address.inactive boolean

Ist die Adresse inaktiv (d. h., das aktuelle Datum liegt vor einem Enddatum)?

keine E-Mail senden?
address.do_not_mail boolean

Kann der Bestandteil an dieser Adresse kontaktiert werden?

Tag
address.seasonal_start.d integer

Der Tag im Fuzzydatum.

Monat
address.seasonal_start.m integer

Der Monat im Fuzzydatum.

Jahr
address.seasonal_start.y integer

Das Jahr im Fuzzydatum.

Tag
address.seasonal_end.d integer

Der Tag im Fuzzydatum.

Monat
address.seasonal_end.m integer

Der Monat im Fuzzydatum.

Jahr
address.seasonal_end.y integer

Das Jahr im Fuzzydatum.

hinzugefügtes Datum
address.date_added date-time

Das Datum, an dem die Adresse erstellt wurde.

Änderungsdatum
address.date_modified date-time

Das Datum, an dem die Adresse zuletzt geändert wurde.

Geschlecht
gender string

Das Geschlecht des Wählers (nur für Einzelpersonen).

Zweiter Vorname
middle string

Der zweite Vorname des Bestandteils (nur für Einzelpersonen).

Ehemaliger Name
former_name string

Der ehemalige Name des Wählers (nur für Einzelpersonen).

Titel 2
title_2 string

Der sekundäre Titel des Bestandteils (nur für Einzelpersonen).

Suffix 2
suffix_2 string

Das sekundäre Suffix des Bestandteils (nur für Einzelpersonen).

Marital staus
marital_status string

Der Familienstand des Wählers (nur für Einzelpersonen).

Gibt anonym?
gives_anonymously boolean

Gibt der Bestandteil anonym?

Keine E-Mail anfordert?
requests_no_email boolean

Fordert die konstituierende Anforderung keine E-Mail an?

Ist ein Anwalt?
is_solicitor boolean

Ist der Konstituierende ein Anwalt?

Keine gültigen Adressen?
no_valid_address boolean

Hat der Bestandteil keine gültigen Adressen?

Inaktiv?
inactive boolean

Ist der Bestandteil inaktiv?

Tag
birthdate.d integer

Der Tag im Fuzzydatum.

Monat
birthdate.m integer

Der Monat im Fuzzydatum.

Jahr
birthdate.y integer

Das Jahr im Fuzzydatum.

Geburtsort
birthplace string

Der Geburtsort des Bestandteils (nur für Einzelpersonen).

Ethnizität
ethnicity string

Die EthnischeItät des Bestandteils (nur für Einzelpersonen).

Ziel
target string

Das Ziel des Bestandteils.

Erlöse
income string

Das Einkommen für den Bestandteil (nur für Einzelpersonen).

Bontyp
receipt_type string

Der Belegtyp des Bestandteils.

Religion
religion string

Die Religion des Bestandteils (nur für Einzelpersonen).

Branche
industry string

Die Industrie des Bestandteils (nur für Organisationen).

Anzahl der Mitarbeiter
num_employees integer

Die Anzahl der Mitarbeiter in der Organisation.

Stimmt mit Geschenken überein?
matches_gifts boolean

Stimmt die Organisation mit Geschenken überein?

Passender Geschenkfaktor
matching_gift_factor double

Der passende Geschenkfaktor (nur für Organisationen).

value
matching_gift_per_gift_min.value double

Der Betragswert.

value
matching_gift_per_gift_max.value double

Der Betragswert.

value
matching_gift_total_min.value double

Der Betragswert.

value
matching_gift_total_max.value double

Der Betragswert.

Abgleichen von Geschenknotizen
matching_gift_notes string

Die passenden Geschenknotizen für den Bestandteil (nur für Organisationen).

Alter
age integer

Das Alter des Bestandteils, wie auf der Grundlage des Geburtsdatums (nur für Einzelpersonen) berechnet.

Verstorben?
deceased boolean

Ist der Teil des Verstorbenen (nur für Einzelpersonen)?

Tag
deceased_date.d integer

Der Tag im Fuzzydatum.

Monat
deceased_date.m integer

Der Monat im Fuzzydatum.

Jahr
deceased_date.y integer

Das Jahr im Fuzzydatum.

Fundraiser-Status
fundraiser_status string

Gibt an, ob der Bestandteil ein Fundraiser ist (nur für Einzelpersonen).

Ist Gedenken?
is_memorial boolean

Ist der Bestandteil ein Ehren-/Gedenktag?

ID
spouse.id string

Die Systemdatensatz-ID des Ehepartners.

Vorname
spouse.first string

Vorname des Ehepartners.

Nachname
spouse.last string

Der Nachname des Ehegatten.

ist Haushaltsleiter?
spouse.is_head_of_household boolean

Ist der Ehegatte der Kopf des Haushalts?

Datum hinzugefügt
date_added date-time

Das Datum, an dem die Komponente erstellt wurde.

Änderungsdatum
date_modified date-time

Das Datum, an dem die Komponente zuletzt geändert wurde.

ConstituentApi.ConvertedConstituent

Konvertierter Bestandteil

Name Pfad Typ Beschreibung
ID
id string

Die ID des konvertierten Bestandteils.

ConstituentApi.CreatedConstituentAddress

Erstellte Konstituierende Adresse

Name Pfad Typ Beschreibung
ID
id string

Die ID der neu erstellten Bestandteiladresse.

ConstituentApi.CreatedConstituentAlias

Erstellter Bestandteilalias

Name Pfad Typ Beschreibung
ID
id string

Die ID des neu erstellten Komponentenalias.

ConstituentApi.CreatedConstituentAttachment

Anlage erstellt

Name Pfad Typ Beschreibung
ID
id string

Die ID der neu erstellten Anlage.

ConstituentApi.CreatedConstituentCode

Erstellter Komponentencode

Name Pfad Typ Beschreibung
ID
id string

Die ID des neu erstellten Komponentencodes.

ConstituentApi.CreatedConstituentCustomField

Erstelltes benutzerdefiniertes Feld

Name Pfad Typ Beschreibung
ID
id string

Die ID des neu erstellten benutzerdefinierten Felds.

ConstituentApi.CreatedConstituentEducation

Bildung von Bestandteilen erstellt

Name Pfad Typ Beschreibung
ID
id string

Die ID der neu erstellten Bildung.

ConstituentApi.CreatedConstituentEmailAddress

Erstellte E-Mail-Adresse

Name Pfad Typ Beschreibung
ID
id string

Die ID der neu erstellten E-Mail-Adresse.

ConstituentApi.CreatedConstituentNote

Erstellter Bestandteilhinweis

Name Pfad Typ Beschreibung
ID
id string

Die ID der neu erstellten Konstituierenden Notiz.

ConstituentApi.CreatedConstituentOnlinePresence

Onlinepräsenz erstellt

Name Pfad Typ Beschreibung
ID
id string

Die ID der neu erstellten Onlinepräsenz.

ConstituentApi.CreatedConstituentPhone

Erstelltes Bestandteiltelefon

Name Pfad Typ Beschreibung
ID
id string

Die ID des neu erstellten Bestandteiltelefons.

ConstituentApi.CreatedIndividualConstituent

Erstellt einzelne Bestandteile

Name Pfad Typ Beschreibung
ID
id string

Die ID des neu erstellten einzelnen Bestandteils.

ConstituentApi.CreatedIndividualRelationship

Individuelle Beziehung erstellt

Name Pfad Typ Beschreibung
ID
id string

Die ID der neu erstellten individuellen Beziehung.

ConstituentApi.CreatedNameFormat

Erstelltes Namensformat

Name Pfad Typ Beschreibung
ID
id string

Die ID des neu erstellten Namensformats.

ConstituentApi.CreatedOrganizationConstituent

Erstellter Organisationsbestandteil

Name Pfad Typ Beschreibung
ID
id string

Die ID der neu erstellten Organisationskomponente.

ConstituentApi.CreatedOrganizationRelationship

Organisationsbeziehung erstellt

Name Pfad Typ Beschreibung
ID
id string

Die ID der neu erstellten Organisationsbeziehung.

ConstituentApi.DuplicateSearchResult

Doppeltes Suchergebnis

Name Pfad Typ Beschreibung
ID
id string

Die Systemdatensatz-ID für den Bestandteil.

Name
name string

Der Name des Bestandteils. Bei Einzelpersonen gibt dieses berechnete Feld den vollständigen Namen des Bestandteils basierend auf den Anzeigenameneinstellungen der Zielorganisation an.

Anzeigename
display_name string

Der Anzeigename des Bestandteils.

Adresse
formatted_address string

Die formatierte primäre Adresse für den Bestandteil.

Verstorben?
deceased boolean

Ist der Bestandteil verstorben?

Ist ein Bestandteil?
is_constituent boolean

Ist der Datensatz ein Bestandteil?

Nachschlage-ID
constituent_id string

Der benutzerdefinierte Bezeichner für den Bestandteil.

Datum hinzugefügt
date_added date-time

Das Datum, an dem der Bestandteil hinzugefügt wurde.

Rang
rank string

Der Suchrang, der angibt, wofür der Bestandteil abgeglichen wurde.

ConstituentApi.DuplicateSearchResultCollection

Doppelte Suchergebnisse

Name Pfad Typ Beschreibung
Anzahl
count integer

Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.

value
value array of ConstituentApi.DuplicateSearchResult

Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

ConstituentApi.EducationRead

Education

Name Pfad Typ Beschreibung
ID
id string

Die Systemdatensatz-ID der Bildungseinrichtungen.

Bestandteil-ID
constituent_id string

Die Systemdatensatz-ID des Bestandteils, der der Ausbildung zugeordnet ist.

Schule
school string

Der Name der Schule/Einrichtung.

Typ
type string

Die Art der Ausbildung.

Klasse von
class_of string

Das Jahr, in dem der Konstituierende abschloss.

Der Status
status string

Der Status der Ausbildung.

Tag
date_entered.d integer

Der Tag im Fuzzydatum.

Monat
date_entered.m integer

Der Monat im Fuzzydatum.

Jahr
date_entered.y integer

Das Jahr im Fuzzydatum.

Tag
date_left.d integer

Der Tag im Fuzzydatum.

Monat
date_left.m integer

Der Monat im Fuzzydatum.

Jahr
date_left.y integer

Das Jahr im Fuzzydatum.

Tag
date_graduated.d integer

Der Tag im Fuzzydatum.

Monat
date_graduated.m integer

Der Monat im Fuzzydatum.

Jahr
date_graduated.y integer

Das Jahr im Fuzzydatum.

Grad
degree string

Der Grad, der empfangen wurde.

GPA
gpa double

Der Notenpunktdurchschnitt.

Majore
majors array of string

Die Hauptstudiengänge.

Minderjährige
minors array of string

Die Nebenstudiengänge.

Ist die Grundschulbildung?
primary boolean

Ist dies der Grundschulverband der Wähler?

Campus
campus string

Der Campus.

Soziale Organisation
social_organization string

Die soziale Organisation.

Bekannter Name
known_name string

Der bekannte Name.

Gradklasse
class_of_degree string

Die Klasse des Abschlusses.

Abteilung
department string

Der Name der Bildungsabteilung.

Fakultät
faculty string

Der Name der Fakultät.

Registrierungsnummer
registration_number string

Die Registrierungsnummer.

Studienfach
subject_of_study string

Das Studienfach.

Datum hinzugefügt
date_added date-time

Das Datum, an dem die Ausbildung erstellt wurde.

Änderungsdatum
date_modified date-time

Das Datum, an dem die Ausbildung zuletzt geändert wurde.

ConstituentApi.EmailAddressRead

E-Mail-Adresse

Name Pfad Typ Beschreibung
ID
id string

Die Systemdatensatz-ID der E-Mail-Adresse.

Bestandteil-ID
constituent_id string

Die Systemdatensatz-ID des Bestandteils, der der E-Mail-Adresse zugeordnet ist.

E-Mail-Typ
type string

Der Typ der E-Mail-Adresse.

E-Mail-Adresse
address string

Die E-Mail-Adresse.

Primär?
primary boolean

Ist dies die primäre E-Mail-Adresse des Bestandteils?

Keine E-Mail senden?
do_not_email boolean

Kann der Bestandteil an dieser E-Mail-Adresse kontaktiert werden?

Inaktiv?
inactive boolean

Ist diese E-Mail-Adresse inaktiv?

Datum hinzugefügt
date_added date-time

Das Datum, an dem die E-Mail-Adresse erstellt wurde.

Änderungsdatum
date_modified date-time

Das Datum, an dem die E-Mail-Adresse zuletzt geändert wurde.

ConstituentApi.FundraiserAssignmentRead

Fundraiserzuweisung

Name Pfad Typ Beschreibung
ID
id string

Die Systemdatensatz-ID der Fundraiser-Zuordnung.

Bestandteil-ID
constituent_id string

Die Systemdatensatz-ID des Bestandteils, der dem Fundraiser zugewiesen ist.

Fundraiser ID
fundraiser_id string

Die Systemdatensatz-ID des Fundraisers.

Typ
type string

Die Art des Fundraisers.

value
amount.value double

Der Geldwert.

Kampagnen-ID
campaign_id string

Die Systemdatensatz-ID der Kampagne, auf die resultierende Geschenke angewendet werden sollen.

Fund-ID
fund_id string

Die Systemdatensatz-ID des Fonds sollten alle resultierenden Geschenke angewendet werden. Wenn ein eingeschränkter Fonds ausgewählt wird, können nur Kampagnen und Rechtsmittel im Zusammenhang mit diesem Fonds ausgewählt werden.

Berufungs-ID
appeal_id string

Die Systemdatensatz-ID des Appells, den der Fundraiser zum Anfordern von Geschenken verwenden sollte.

Startdatum
start date-time

Der Starttermin der Fundraiserzuweisung.

Enddatum
end date-time

Endtermin der Fundraiserzuweisung.

ConstituentApi.MembershipMemberRead

Mitglied

Name Pfad Typ Beschreibung
ID
id string

Die Systemdatensatz-ID des Mitglieds.

Bestandteil-ID
constituent_id string

Die Systemdatensatz-ID des mit dem Mitglied verknüpften Bestandteils.

Ist primäres Mitglied?
primary boolean

Ist dies das primäre Mitglied?

ConstituentApi.MembershipRead

Membership

Name Pfad Typ Beschreibung
ID
id string

Die Systemdatensatz-ID der Mitgliedschaft.

Bestandteil-ID
constituent_id string

Die Systemdatensatz-ID des Mit der Mitgliedschaft verknüpften Bestandteils.

Programm
program string

Das Mitgliedschaftsprogramm.

Kategorie
category string

Die Mitgliedschaftskategorie.

Unterkategorie
subcategory string

Die Mitgliedschaftsunterkategorie.

Stehend
standing string

Der Mitgliedschaftsstatus.

Läuft ab
expires date-time

Das Datum, an dem die Mitgliedschaft abläuft.

Angegliedert
joined date-time

Das Datum, an dem die Mitgliedschaft aktiv wird.

value
dues.value double

Der Geldwert.

Elemente
members array of ConstituentApi.MembershipMemberRead

Die Gruppe der Mitglieder, die zur Mitgliedschaft gehören.

Datum hinzugefügt
date_added date-time

Das Datum, an dem die Mitgliedschaft erstellt wurde.

Änderungsdatum
date_modified date-time

Das Datum, an dem die Mitgliedschaft zuletzt geändert wurde.

ConstituentApi.NameFormatRead

Namensformate definieren, wie Bestandteile in der Kommunikation adressiert werden. Wie Sie auf Einzelpersonen verweisen, legt den Ton Ihrer Kommunikation mit ihnen fest und wie gut sie Ihre Interaktionen empfangen.

Name Pfad Typ Beschreibung
ID
id string

Die Systemdatensatz-ID des Namensformats.

type
type string

Der Namensformattyp.

benutzerdefiniertes Format?
custom_format boolean

Ist dies ein benutzerdefiniertes Format?

Konfigurations-ID
configuration_id string

Die Konfigurations-ID des Namensformats (für nicht benutzerdefinierte Formate).

Formatierter Name
formatted_name string

Der formatierte Name (für benutzerdefinierte Formate).

ConstituentApi.NameFormatSummaryRead

Namensformatzusammenfassung

Name Pfad Typ Beschreibung
ID
primary_addressee.id string

Die Systemdatensatz-ID des Namensformats.

type
primary_addressee.primary_type string

Der Namensformattyp.

benutzerdefiniertes Format?
primary_addressee.custom_format boolean

Ist dies ein benutzerdefiniertes Format?

Konfigurations-ID
primary_addressee.configuration_id string

Die Konfigurations-ID des Namensformats (für nicht benutzerdefinierte Formate).

Formatierter Name
primary_addressee.formatted_name string

Der formatierte Name (für benutzerdefinierte Formate).

ID
primary_salutation.id string

Die Systemdatensatz-ID des Namensformats.

type
primary_salutation.primary_type string

Der Namensformattyp.

benutzerdefiniertes Format?
primary_salutation.custom_format boolean

Ist dies ein benutzerdefiniertes Format?

Konfigurations-ID
primary_salutation.configuration_id string

Die Konfigurations-ID des Namensformats (für nicht benutzerdefinierte Formate).

Formatierter Name
primary_salutation.formatted_name string

Der formatierte Name (für benutzerdefinierte Formate).

Weitere Namensformate
additional_name_formats array of ConstituentApi.NameFormatRead

Die zusätzlichen Namensformate des Bestandteils.

ConstituentApi.NoteRead

Hinweis

Name Pfad Typ Beschreibung
ID
id string

Die Systemdatensatz-ID der Notiz.

Bestandteil-ID
constituent_id string

Die Systemdatensatz-ID des Mit der Notiz verknüpften Bestandteils.

Typ
type string

Der Notiztyp.

Tag
date.d integer

Der Tag im Fuzzydatum.

Monat
date.m integer

Der Monat im Fuzzydatum.

Jahr
date.y integer

Das Jahr im Fuzzydatum.

Zusammenfassung
summary string

Die Notizzusammenfassung.

Hinweis
text string

Der Notiztext.

Datum hinzugefügt
date_added date-time

Das Datum, an dem die Notiz erstellt wurde.

Änderungsdatum
date_modified date-time

Das Datum, an dem die Notiz zuletzt geändert wurde.

ConstituentApi.OnlinePresenceRead

Onlinepräsenz

Name Pfad Typ Beschreibung
ID
id string

Die Systemdatensatz-ID der Onlinepräsenz.

Bestandteil-ID
constituent_id string

Die Systemdatensatz-ID des Bestandteils, der der Onlinepräsenz zugeordnet ist.

Typ
type string

Der Onlinepräsenztyp.

Link
address string

Die Webadresse für die Onlinepräsenz.

Primär?
primary boolean

Ist dies die primäre Onlinepräsenz des Wählers?

Inaktiv?
inactive boolean

Ist diese Onlinepräsenz inaktiv?

Datum hinzugefügt
date_added date-time

Das Datum, an dem die Onlinepräsenz erstellt wurde.

Änderungsdatum
date_modified date-time

Das Datum, an dem die Onlinepräsenz zuletzt geändert wurde.

ConstituentApi.PhoneRead

Telefonnummer

Name Pfad Typ Beschreibung
ID
id string

Die Systemdatensatz-ID des Telefons.

Bestandteil-ID
constituent_id string

Die Systemdatensatz-ID des Bestandteils, der dem Telefon zugeordnet ist.

Typ
type string

Der Telefontyp.

Number
number string

Die Telefonnummer.

Primär?
primary boolean

Ist dies das primäre Telefon des Wählers?

Rufen Sie nicht an?
do_not_call boolean

Kann der Bestandteil an dieser Nummer kontaktiert werden?

Inaktiv?
inactive boolean

Ist diese Telefonnummer inaktiv?

Datum hinzugefügt
date_added date-time

Das Datum, an dem das Telefon erstellt wurde.

Änderungsdatum
date_modified date-time

Das Datum, an dem das Telefon zuletzt geändert wurde.

ConstituentApi.ProfilePictureRead

Profilbild

Name Pfad Typ Beschreibung
Bestandteil-ID
constituent_id string

Die Systemdatensatz-ID des Mit dem Profilbild verknüpften Bestandteils.

URL
url string

Die URL für das Profilbild. Die URL enthält eine zeitgebundene Signatur, die den Zugriff auf 60 Minuten beschränkt.

Miniaturansichts-URL
thumbnail_url string

Die URL für eine Miniaturansicht des Profilbilds. Enthält eine zeitgebundene Signatur, die den Zugriff auf 60 Minuten beschränkt.

ConstituentApi.RelationshipRead

Beziehung

Name Pfad Typ Beschreibung
ID
id string

Die Systemdatensatz-ID der Beziehung.

Bestandteil-ID
constituent_id string

Die Systemdatensatz-ID des Mit der Beziehung verknüpften Bestandteils.

Beziehungs-ID
relation_id string

Die Systemdatensatz-ID der zugehörigen Person oder Organisation.

Gegenseitige Beziehungs-ID
reciprocal_relationship_id string

Der Bezeichner für den gegenseitigen Beziehungsdatensatz. Dieser Wert ist schreibgeschützt und wird automatisch generiert, wenn die Beziehung erstellt wird. Änderungen, die an diesem Datensatz vorgenommen wurden, werden auch auf den Gegenseitigkeitswechsel mit Ausnahme der Kommentareigenschaft widerzuspiegeln.

Name
name string

Der Name des zugehörigen Bestandteils. Wenn es sich bei dem zugehörigen Bestandteil um eine Einzelperson handelt, ist dies der vollständige Name des Bestandteils basierend auf den Anzeigenameneinstellungen der Zielorganisation.

Typ
type string

Der Typ der Beziehung, die die Beziehung darstellt.

Gegenseitiger Typ
reciprocal_type string

Beschreibt die Beziehung des Bestandteils zum zugehörigen Bestandteil. Beispielsweise wäre in einer Beziehung zwischen einem männlichen Bestandteil und einem weiblichen Gleichgeordneten der gegenseitige Beziehungstyp Bruder.

Tag
start.d integer

Der Tag im Fuzzydatum.

Monat
start.m integer

Der Monat im Fuzzydatum.

Jahr
start.y integer

Das Jahr im Fuzzydatum.

Tag
end.d integer

Der Tag im Fuzzydatum.

Monat
end.m integer

Der Monat im Fuzzydatum.

Jahr
end.y integer

Das Jahr im Fuzzydatum.

Ist Ehepartner?
is_spouse boolean

Gilt die verwandte Person des Ehegatten (nur für Beziehungen zwischen Einzelpersonen)?

Ist konstituierender Haushaltschef?
is_constituent_head_of_household boolean

Ist der Konstituierende der Haushaltschef?

Ist ehegatte Haushaltsleiter?
is_spouse_head_of_household boolean

Ist der Ehegatte der Kopf des Haushalts?

Hinweise
comment string

Der Kommentar zur Beziehung.

Ist Kontakt?
is_organization_contact boolean

Stellt die Komponente diese Organisation als Kontakt dar (gilt nur für Beziehungen zwischen Organisationen und Einzelpersonen)?

Ist primäres Geschäft?
is_primary_business boolean

Ist dies das Hauptgeschäft des Bestandteils (gilt nur für Beziehungen zwischen Organisationen und Einzelpersonen)?

Kontakttyp
organization_contact_type string

Stellt Kontext für Interaktionen mit der zugehörigen Person bereit, die die Organisation als Kontakt darstellt. Gilt nur für Beziehungen zwischen Organisationen und Einzelpersonen.

Position
position string

Die Position der Person in der Organisation. Gilt nur für Beziehungen zwischen Organisationen und Einzelpersonen.

Datum hinzugefügt
date_added date-time

Das Datum, an dem die Beziehung erstellt wurde.

Änderungsdatum
date_modified date-time

Das Datum, an dem die Beziehung zuletzt geändert wurde.

ConstituentApi.SearchResultRead

Suchergebnis

Name Pfad Typ Beschreibung
ID
id string

Die Systemdatensatz-ID des Bestandteils.

Name
name string

Der Name des Bestandteils. Bei Einzelpersonen gibt dieses berechnete Feld den vollständigen Namen des Bestandteils basierend auf den Anzeigenameneinstellungen der Zielorganisation an.

Adresse
address string

Die bevorzugte Adresse des Bestandteils.

Verstorben?
deceased boolean

Ist der Bestandteil verstorben?

Email
email string

Die E-Mail-Adresse des Bestandteils.

Fundraiser-Status
fundraiser_status string

Der Fundraiserstatus des Wählers. Bei Einzelpersonen gibt dieses berechnete Feld an, ob der Bestandteil "Aktiv", "Inaktiv" oder "None" ist. Für Organisationen lautet dieser Wert immer "None".

Inaktiv?
inactive boolean

Ist der Bestandteil inaktiv?

Nachschlage-ID
lookup_id string

Der benutzerdefinierte Bezeichner für den Bestandteil.

FundraisingApi.ApiCollectionOfFundraiserAssignmentRead

Zuweisungen

Name Pfad Typ Beschreibung
Anzahl
count integer

Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.

value
value array of FundraisingApi.FundraiserAssignmentRead

Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

FundraisingApi.CreatedFundraiserAssignment

Erstellt fundraiser assignment

Name Pfad Typ Beschreibung
ID
id string

Die ID der neu erstellten Fundraiserzuweisung.

FundraisingApi.FundraiserAssignmentRead

Zuweisung

Name Pfad Typ Beschreibung
ID
id string

Die Systemdatensatz-ID der Fundraiser-Zuordnung.

Bestandteil-ID
constituent_id string

Die Systemdatensatz-ID der zugewiesenen Komponente.

Typ
type string

Der Fundraisertyp.

Zuordnung beginnt
start date-time

Der Anfangstermin der Zuordnung.

Zuordnung endet
end date-time

Das Enddatum der Zuordnung.

value
amount.value double

Der Geldwert.

Kampagnen-ID
campaign_id string

Die Systemdatensatz-ID der Kampagne, auf die resultierende Geschenke angewendet werden.

Fund-ID
fund_id string

Die Systemdatensatz-ID des Fonds, auf den resultierende Geschenke angewendet werden.

Berufungs-ID
appeal_id string

Die Systemdatensatz-ID des Aufrufs, auf den resultierende Geschenke angewendet werden.

NXTDataIntegrationApi.ConstituentIdMap

Bestandteil-ID-Zuordnung

Name Pfad Typ Beschreibung
ID
system_record_id integer

Die id des bestandteilen Systemdatensatzes.

NXTDataIntegrationApi.ConstituentSearchResult

Suchergebnis

Name Pfad Typ Beschreibung
ID
record_id integer

Die Systemdatensatz-ID des Bestandteils.

Nachschlage-ID
constituent_id string

Die Bestandteil-ID.

Schlüsselindikator
key_indicator string

Der Schlüsselindikator für den Datensatz.

Vorname
first_name string

Der Vorname (nur Einzelpersonen).

Nachname
last_name string

Der Nachname (nur Einzelpersonen).

Zweiter Vorname
middle_name string

Der zweite Name (nur Einzelpersonen).

Bevorzugter Name
preferred_name string

Der bevorzugte Name (nur Einzelpersonen).

Ehemaliger Name
maiden_name string

Der frühere Name (nur Einzelpersonen).

Titel 1
title1 string

Titel 1 (nur Einzelpersonen).

Suffix 1
suffix1 string

Das Suffix 1 (nur Einzelne).

Geschlecht
gender string

Das Konstituierende Geschlecht (nur Einzelpersonen).

Tag
birth_date.d integer

Der Tag im Fuzzydatum.

Monat
birth_date.m integer

Der Monat im Fuzzydatum.

Jahr
birth_date.y integer

Das Jahr im Fuzzydatum.

Vorname des Ehepartners
spouse_first_name string

Vorname des Ehegatten (nur Einzelpersonen).

Nachname des Ehepartners
spouse_last_name string

Der Nachname des Ehegatten (nur Einzelpersonen).

Name der Organisation
org_name string

Der Name der Organisation (nur Organisationen).

Adressblock
address_block string

Der Adressblock.

Stadt und Bundesland
address_city_state string

Die Adresse Ort und Bundesland.

Postleitzahl
address_post_code string

Der Adresspostcode.

Primäre E-Mail-Adresse
primary_email string

Die primäre E-Mail.

Primäre Telefonnummer
primary_phone string

Das primäre Telefon.

Abgeglichener Alias
matched_alias string

Der übereinstimmene Aliasname (nur Einzelpersonen).

Übereinstimmene E-Mail
matched_email string

Die übereinstimmene E-Mail-Adresse.

Abgeglichenes Telefon
matched_phone string

Die übereinstimmene Telefonnummer.

Ist ein Bestandteil?
is_constituent boolean

Ist der Datensatz ein Bestandteil?

Ist verstorben?
is_deceased boolean

Ist der Datensatz verstorben?

Ist inaktiv?
is_inactive boolean

Ist der Datensatz inaktiv?

NXTDataIntegrationApi.ConstituentSearchResultCollection

Bestandteile

Name Pfad Typ Beschreibung
results
results array of NXTDataIntegrationApi.ConstituentSearchResult

Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

NXTDataIntegrationApi.CreatedConstituentTribute

Erschaffte Konstituierende Anerkennung

Name Pfad Typ Beschreibung
ID
id string

Die ID der neu geschaffenen Konstituierenden Ehren.

NXTDataIntegrationApi.CreatedTributeAcknowledgee

Ehrenbeehrung geschaffen

Name Pfad Typ Beschreibung
ID
id string

Die ID der neu geschaffenen Ehrenerkennung.

NXTDataIntegrationApi.Tribute

Tribut

Name Pfad Typ Beschreibung
ID
id integer

Die Systemdatensatz-ID der Hommage.

Bestandteil-ID
constituent_record_id integer

Die Systemdatensatz-ID des Bestandteils, der der Hommage zugeordnet ist.

Tribute-Typ
tribute_type_name string

Der Hommagestyp.

Tribute-Typ-ID
tribute_type_id integer

Die Ehrentyp-ID.

Description
description string

Die Ehrungsbeschreibung.

Tag
start_date.d integer

Der Tag im Fuzzydatum.

Monat
start_date.m integer

Der Monat im Fuzzydatum.

Jahr
start_date.y integer

Das Jahr im Fuzzydatum.

Tag
end_date.d integer

Der Tag im Fuzzydatum.

Monat
end_date.m integer

Der Monat im Fuzzydatum.

Jahr
end_date.y integer

Das Jahr im Fuzzydatum.

Standardfonds-ID
default_fund_id integer

Die Systemdatensatz-ID des Standardfonds, der dem Tribut zugeordnet ist.

Hinweise
notes string

Die Ehrennotizen.

Aktiv?
is_active boolean

Ist diese Anerkennung aktiv?

Sequence
sequence integer

Die Tributsequenz.

Datum hinzugefügt
date_added date-time

Das Datum, an dem die Hommage geschaffen wurde.

Änderungsdatum
date_modified date-time

Das Datum, an dem die Hommage zuletzt geändert wurde.

NXTDataIntegrationApi.TributeAcknowledgee

Anerkennung

Name Pfad Typ Beschreibung
ID
id integer

Die Systemdatensatz-ID der Anerkennung.

Tribute ID
tribute_id integer

Die Systemdatensatz-ID der mit der Anerkennung verbundenen Anerkennung.

Beziehungs-ID
relationships_id integer

Die Systemdatensatz-ID der Beziehung (wenn NULL, stellt dies eine Selbsterkennung dar).

Brief-ID
letter integer

Die Brief-ID.

Sequence
sequence integer

Die Anerkennungssequenz.

NXTDataIntegrationApi.TributeAcknowledgeeCollection

Ehrenerkennungen

Name Pfad Typ Beschreibung
Anzahl
count integer

Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.

value
value array of NXTDataIntegrationApi.TributeAcknowledgee

Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

NXTDataIntegrationApi.TributeCollection

Abgaben

Name Pfad Typ Beschreibung
Anzahl
count integer

Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.

value
value array of NXTDataIntegrationApi.Tribute

Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.