Blackbaud Raisers Edge NXT-componenten

Blackbaud Raiser's Edge NXT is een uitgebreide cloudoplossing voor fondsenwerving en donorbeheersoftware die speciaal is gebouwd voor non-profitorganisaties en de hele sociale goede gemeenschap. Gebruik de connector Voor samenstellende elementen om biografische gegevens, contactgegevens en relaties te beheren.

Deze connector is beschikbaar in de volgende producten en regio's:

Dienst	Class	Regions
Copilot Studio	Premium	Alle Power Automate-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD)
Logic-apps	Standaard	Alle Logic Apps-regio's , met uitzondering van het volgende: - Azure Government-regio's - Azure China-regio's - Us Department of Defense (DoD)
Power Apps	-	Niet beschikbaar
Power Automate	Premium	Alle Power Automate-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD)

Contactpersoon
Naam	Ondersteuning voor Blackbaud
URL	https://www.blackbaud.com/support
E-mailen	skyapi@blackbaud.com

Connectormetagegevens
Uitgever	Blackbaud, Inc.
Webpagina	https://www.blackbaud.com/products/blackbaud-raisers-edge-nxt
Privacybeleid	https://www.blackbaud.com/privacy-shield
Categorieën	Verkoop en CRM; Productiviteit

Raiser's Edge NXT is een uitgebreide cloudoplossing voor fondsenwerving en donorbeheersoftware die speciaal is gebouwd voor non-profitorganisaties en de hele sociale goede community.

Deze connector is gebouwd op de SKY-API van Blackbaud en biedt bewerkingen voor het beheren van samenstellende en gerelateerde entiteiten die zijn gevonden in The Raiser's Edge NXT, waaronder:

Kiezers
Addresses
Telefoons en e-mailberichten
Aliases
Aangepaste velden
Opmerkingen
Bijlagen
Relationships
en meer...

Raadpleeg de documentatie voor meer informatie.

Vereiste voorwaarden

Als u deze connector wilt gebruiken, moet u een Blackbaud ID-account hebben met toegang tot een of meer Blackbaud-omgevingen.

Daarnaast moet de beheerder van uw organisatie ook een actie op beheerdersniveau uitvoeren binnen het systeem om deze connector toegang te geven tot uw Blackbaud-omgeving. Meer informatie over deze vereisten vindt u in de eerste installatiedocumentatie .

Hoe kan ik referenties ophalen?

De beheerder van uw organisatie stuurt u een uitnodiging naar de Edge NXT-omgeving van de organisatie en configureert uw gebruikersaccountmachtigingen in de omgeving. Er zijn geen aanvullende referenties vereist voor het gebruik van deze connector.

Bekende problemen en beperkingen

De connector werkt in de context van uw gebruikersaccount en is daarom onderhevig aan uw gebruikersmachtigingen binnen de omgeving.

Beperkingslimieten

Name	Aanroepen	Verlengingsperiode
API-aanroepen per verbinding	100	60 seconden

Acties

Aangepaste velden weergeven	Hiermee worden de aangepaste velden voor een samenstellend element weergegeven.
Converteren naar samenstellend	Converteert een niet-samenstellende waarde naar een samenstellende waarde.
De indeling van een primaire naam van een samenstellende primaire naam bijwerken	Hiermee wordt de primaire naamindeling voor een samenstellende waarde bijgewerkt.
De indeling van een samenstellende naam bijwerken	Hiermee wordt de indeling van een samenstellende naam bijgewerkt.
Een aangepast veld maken	Hiermee maakt u een nieuw aangepast veld voor samenstellen.
Een aangepast veld voor samenstellen bijwerken	Hiermee wordt een aangepast veld bijgewerkt.
Een afzonderlijke relatie maken	Hiermee maakt u een nieuwe afzonderlijke relatie. Als de relatie met een andere component is, wordt er een wederzijdse relatie voor die samenstellende component gemaakt.
Een afzonderlijke samenstellende component maken	Hiermee maakt u een nieuwe afzonderlijke component.
Een code voor een samenstellend verzoek maken	Hiermee maakt u een nieuwe aanvraagcode voor samenstellende elementen.
Een eerbetoon bevestigen	Creëert een nieuw eerbetoon.
Een indeling voor een samenstellende naam maken	Hiermee maakt u een nieuwe indeling voor de naam van een samenstellende naam.
Een inzamelingstoewijzing maken	Hiermee maakt u een nieuwe inzamelingstoewijzing.
Een organisatie samenstellen	Hiermee maakt u een nieuwe organisatie samenstellen.
Een organisatierelatie maken	Hiermee maakt u een nieuwe organisatierelatie. Als de relatie met een andere component is, wordt er een wederzijdse relatie voor die samenstellende component gemaakt.
Een primaire naamnotatie voor een samenstellende primaire naam maken	Hiermee maakt u een primaire naamindeling voor een samenstellend onderdeel.
Een samenstellend adres bijwerken	Werkt een samenstellend adres bij.
Een samenstellend adres maken	Hiermee maakt u een nieuw samenstellend adres.
Een samenstellend e-mailadres bijwerken	Hiermee werkt u een samenstellend e-mailadres bij.
Een samenstellend e-mailadres maken	Hiermee maakt u een nieuw samenstellend e-mailadres.
Een samenstellend eerbetoon krijgen	Retourneert details over een samenstellend eerbetoon.
Een samenstellend eerbetoon maken	Creëert een nieuw hulde.
Een samenstellend onderwijs bijwerken	Werkt een samenstellend onderwijs bij.
Een samenstellend onderwijs maken	Hiermee maakt u een nieuw samenstellend onderwijs.
Een samenstellende advocaatcode bijwerken	Hiermee werkt u een code voor een samenstellend verzoek bij.
Een samenstellende alias bijwerken	Hiermee wordt een samenstellende alias bijgewerkt.
Een samenstellende alias maken	Hiermee maakt u een nieuwe samenstellende alias.
Een samenstellende bijlage bijwerken	Werkt een samenstellende bijlage bij.
Een samenstellende bijlage maken	Hiermee maakt u een nieuwe samenstellende bijlage.
Een samenstellende code bijwerken	Hiermee wordt een samenstellende code bijgewerkt.
Een samenstellende code maken	Hiermee maakt u een nieuwe samenstellende code.
Een samenstellende code verwijderen	Hiermee verwijdert u een samenstellende code.
Een samenstellende component bijwerken	Werkt een samenstellende component bij.
Een samenstellende component ophalen	Retourneert informatie over een samenstellend onderdeel.
Een samenstellende component zoeken	Voert een samenstellende zoekopdracht uit op basis van de opgegeven zoektekst. Ondersteunt voornaam, achternaam, voorkeursnaam, voormalige naam, alias, e-mailadres, telefoonnummer, adres of opzoek-id. Naamcombinaties zoals voornaam en achternaam of voorkeursnaam en achternaam zijn geldig, maar anders ondersteunt zoeken slechts één parameter tegelijk. Standaard bevatten zoekopdrachten resultaten die lijken op uw criteria. Zoekopdrachten naar 'Smith' bevatten bijvoorbeeld overeenkomsten voor 'Smyth' en andere alternatieve spelling. Deze zoekopdracht biedt geen ondersteuning voor jokertekens zoals * of ?. Zoekresultaten zijn beperkt tot 500 records.
Een samenstellende notitie bijwerken	Hiermee wordt een samenstellende notitie bijgewerkt.
Een samenstellende notitie maken	Hiermee maakt u een nieuwe samenstellende notitie.
Een samenstellende online aanwezigheid bijwerken	Hiermee wordt een samenstellende online aanwezigheid bijgewerkt.
Een samenstellende online aanwezigheid maken	Hiermee maakt u een nieuwe samenstellende online aanwezigheid.
Een samenstellende opzoek-id ophalen	Retourneert de systeemrecord-id van een onderdeel uit de opgegeven opzoek-id.
Een samenstellende profielafbeelding bijwerken	Hiermee werkt u de huidige profielfoto voor een samenstellende gebruiker bij.
Een samenstellende profielfoto ophalen	Retourneert de huidige profielfoto voor een samenstellend onderdeel.
Een samenstellende relatie bijwerken	Werkt een relatie voor een samenstellende component bij. Als er een wederzijdse relatie bestaat, wordt deze ook gewijzigd om de wijzigingen weer te geven. Dit omvat geen wijzigingen in de eigenschap 'opmerkingen', die specifiek is voor elke record en onafhankelijk van elke record kan worden gewijzigd.
Een samenstellende telefoon bijwerken	Werkt een samenstellende telefoon bij.
Een samenstellende telefoon maken	Hiermee maakt u een nieuwe samenstellende telefoon.
Een samenstellende toestemmingsrecord maken	Hiermee maakt u een nieuwe samenstellende toestemmingsrecord.
Inzamelingstoewijzingen vermelden	Vermeld de opdrachten voor een inzamelingsactie.
Lijst eerbetoon erkent	Geeft een overzicht van de erkenningen voor een eerbetoon.
Lijst samenstellende eerbetoon	Geeft een overzicht van de eerbetoons voor een samenstellend lid.
Lijst samenstellende fondsenwervers	Een lijst met de inzamelingsopdrachten voor een samenstellend onderdeel.
Samenstellende adressen vermelden	Geeft een lijst van de adressen voor een samenstellende component.
Samenstellende advocaatcodes vermelden	Hiermee worden de aanvraagcodes voor een samenstellend lid vermeld.
Samenstellende aliassen vermelden	Geeft een lijst van de aliassen voor een samenstellende component.
Samenstellende bijlagen vermelden	Geeft een lijst weer van de bijlagen voor een samenstellend onderdeel.
Samenstellende codes vermelden	Geeft een lijst weer van de samenstellende codes voor een samenstellend onderdeel.
Samenstellende e-mailadressen vermelden	Een lijst met de e-mailadressen voor een samenstellend onderdeel.
Samenstellende elementen vermelden	Retourneert een lijst met bestanddelen.
Samenstellende lidmaatschappen vermelden	Geeft een lijst weer van de lidmaatschappen voor een samenstellend lid.
Samenstellende notities vermelden	Geeft een lijst weer van de notities voor een samenstellend onderdeel.
Samenstellende onderwijslijsten vermelden	Geeft een lijst weer van de opleidingsrecords voor een samenstellend onderdeel.
Samenstellende online aanwezigheidsstatussen vermelden	Geeft een lijst weer van de online aanwezigheid voor een samenstellende gebruiker.
Samenstellende relaties vermelden	Geeft een lijst weer van de relaties voor een samenstellend onderdeel.
Samenstellende telefoons vermelden	Geeft een lijst weer van de telefoons voor een samenstellend onderdeel.
Samenstellende toestemmingsrecords vermelden	Geeft een lijst weer van de toestemmingsrecords voor een samenstellend onderdeel.
Samenvatting van indeling van samenstellende naam ophalen	Retourneert de samenvatting van de naamnotatie voor een samenstellende waarde.
Zoeken naar dubbele bestanddelen	Zoekt in afzonderlijke records, organisaties en gerelateerde contactpersonen en rangschikt potentiële duplicaten op basis van de opgegeven zoekfilters. Records die overeenkomen met meerdere filters rangschikken hoger als mogelijke duplicaten.
Zoeken naar een samenstellend onderdeel (uitgebreid)	Zoekt naar samenstellende records met behulp van de opgegeven filtercriteria.

Aangepaste velden weergeven

Bewerkings-id:: ListConstituentCustomFields

Hiermee worden de aangepaste velden voor een samenstellend element weergegeven.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van het samenstellende onderdeel.

Retouren

Aangepaste velden

Body: ConstituentApi.ApiCollectionOfConstituentCustomFieldRead

Converteren naar samenstellend

Bewerkings-id:: ConvertToConstituent

Converteert een niet-samenstellende waarde naar een samenstellende waarde.

Parameters

Name	Sleutel	Vereist	Type	Description
Niet-samenstellende id	non_constituent_id	True	string	De systeemrecord-id van de niet-samenstellende record die moet worden geconverteerd.
ID-kaart	id		string	De systeemrecord-id van de samenstellende code.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
volgorde	sequence		integer	De volgorde van de samenstellende code.

Retouren

Geconverteerde samenstellende elementen

Body: ConstituentApi.ConvertedConstituent

De indeling van een primaire naam van een samenstellende primaire naam bijwerken

Bewerkings-id:: EditConstituentPrimaryNameFormat

Hiermee wordt de primaire naamindeling voor een samenstellende waarde bijgewerkt.

Parameters

Name	Sleutel	Vereist	Type	Description
Naamnotatie-id	primary_name_format_id	True	string	De systeemrecord-id van de primaire naamindeling die moet worden bijgewerkt.
Aangepaste naamindeling?	custom_format		boolean	Is een aangepaste indeling?
Formaat	configuration_id		string	Configuratie van naamnotatie (vereist tenzij een aangepaste indeling wordt gebruikt).
Aangepaste naam	formatted_name		string	Opgemaakte naam (vereist wanneer een aangepaste indeling wordt gebruikt). Tekenlimiet: 255.

De indeling van een samenstellende naam bijwerken

Bewerkings-id:: EditConstituentNameFormat

Hiermee wordt de indeling van een samenstellende naam bijgewerkt.

Parameters

Name	Sleutel	Vereist	Type	Description
Naamnotatie-id	name_format_id	True	string	De systeemrecord-id van de naamindeling die moet worden bijgewerkt.
Typologie	type		string	Het type naamnotatie.
Aangepaste naamindeling?	custom_format		boolean	Is een aangepaste indeling?
Formaat	configuration_id		string	Configuratie van naamnotatie (vereist tenzij een aangepaste indeling wordt gebruikt).
Aangepaste naam	formatted_name		string	Opgemaakte naam (vereist wanneer een aangepaste indeling wordt gebruikt). Tekenlimiet: 255.

Een aangepast veld maken

Bewerkings-id:: CreateConstituentCustomField

Hiermee maakt u een nieuw aangepast veld voor samenstellen.

Parameters

Name	Sleutel	Vereist	Type	Description
body	body	True	dynamic	Een object dat het aangepaste veld vertegenwoordigt dat moet worden gemaakt.

Retouren

Aangepast veld gemaakt

Body: ConstituentApi.CreatedConstituentCustomField

Een aangepast veld voor samenstellen bijwerken

Bewerkings-id:: EditConstituentCustomField

Hiermee wordt een aangepast veld bijgewerkt.

Parameters

Name	Sleutel	Vereist	Type	Description
Aangepaste veld-id	custom_field_id	True	string	De systeemrecord-id van het aangepaste veld dat moet worden bijgewerkt.
body	body	True	dynamic	Een object dat de eigenschappen van het aangepaste veld vertegenwoordigt dat moet worden bijgewerkt.

Een afzonderlijke relatie maken

Bewerkings-id:: CreateIndividualRelationship

Hiermee maakt u een nieuwe afzonderlijke relatie. Als de relatie met een andere component is, wordt er een wederzijdse relatie voor die samenstellende component gemaakt.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van de samenstellende component die aan de relatie is gekoppeld.
Relatie-id	relation_id	True	string	De systeemrecord-id van de gerelateerde persoon.
Typologie	type		string	Het type relatie dat de relatie vertegenwoordigt.
Wederkerig type	reciprocal_type		string	Beschrijft de relatie van de samenstellende component met de gerelateerde component. Bijvoorbeeld, in een relatie tussen een mannelijke samenstellende en een vrouwelijke zus, zou het wederzijdse relatietype broer zijn.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
Is echtgenoot?	is_spouse		boolean	Is de gerelateerde persoon de echtgenoot van het kiesdistrict?
Is het hoofd van het huishouden?	is_constituent_head_of_household		boolean	Is het hoofd van het huishouden?
Is het hoofd van de echtgenoot van het huishouden?	is_spouse_head_of_household		boolean	Is de echtgenoot het hoofd van het huishouden?
Opmerkingen	comment		string	Aanvullende opmerkingen over de relatie.

Retouren

Afzonderlijke relatie gemaakt

Body: ConstituentApi.CreatedIndividualRelationship

Een afzonderlijke samenstellende component maken

Bewerkings-id:: CreateIndividualConstituent

Hiermee maakt u een nieuwe afzonderlijke component.

Parameters

Name	Sleutel	Vereist	Type	Description
Title	title		string	De primaire titel van de samenstellende persoon.
Voornaam	first		string	De voornaam van de samenstellende persoon. Tekenlimiet: 50.
Achternaam	last	True	string	De achternaam van de kiezer. Tekenlimiet: 100.
Achtervoegsel	suffix		string	Het primaire achtervoegsel van het samenstellende onderdeel.
Opzoek-id	lookup_id		string	De door de gebruiker gedefinieerde id voor de samenstellende gebruiker.
type	type	True	string	Het adrestype.
country	country		string	Het land van het adres (kan de id, naam of afkorting zijn).
lijnen	address_lines		string	De adresregels. Tekenlimiet: 150.
city	city		string	De plaats van het adres (gebruik niet in combinatie met het veld Buitenwijk).
state	state		string	De status van het adres.
postcode	postal_code		string	De postcode van het adres. Tekenlimiet: 12.
voorstad	suburb		string	De buitenwijk van het adres (gebruik niet in combinatie met het veld Plaats).
graafschap	county		string	De provincie van het adres.
start	start		date	De datum waarop de samenstelling op dit adres begon te wonen (bijvoorbeeld: 2005-09-18).
einde	end		date	De datum waarop de samenstelling niet meer op dit adres is gevestigd (bijvoorbeeld: 2005-09-18).
type	type	True	string	Het telefoontype.
nummer	number	True	string	Het telefoonnummer.
is primair?	primary		boolean	Is dit het primaire telefoonnummer van de kiezer?
type	type	True	string	Het type e-mailadres.
address	address	True	string	Het e-mailadres.
is primair?	primary		boolean	Is dit het primaire e-mailadres van de samenstellende gebruiker?
type	type	True	string	Het online aanwezigheidstype.
address	address	True	string	Het webadres voor de online aanwezigheid.
is primair?	primary		boolean	Is dit de primaire online aanwezigheid van de samenstellende gebruiker?
Voorkeursnaam	preferred_name		string	De voorkeursnaam van de samenstellende persoon. Tekenlimiet: 50.
Middelste naam	middle		string	De middelste naam van de samenstellende persoon. Tekenlimiet: 50.
Voormalige naam	former_name		string	De vroegere naam van de kiezer. Tekenlimiet: 100.
Titel 2	title_2		string	De secundaire titel van het kiesdistrict.
Achtervoegsel 2	suffix_2		string	Het secundaire achtervoegsel van het samenstellende onderdeel.
Geslacht	gender		string	Het geslacht van de kiezer.
Burgerlijke staat	marital_status		string	De burgerlijke staat van het kiesdistrict.
Geeft anoniem?	gives_anonymously		boolean	Geeft de kiezer anoniem?
Geen e-mail aanvragen?	requests_no_email		boolean	Heeft de samenstellende aanvraag geen e-mail?
Is een advocaat?	is_solicitor		boolean	Is de kiezer een advocaat?
Geen geldige adressen?	no_valid_address		boolean	Heeft de samenstelling geen geldige adressen?
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
Geboorteplaats	birthplace		string	De geboorteplaats van het kiesdistrict.
Etniciteit	ethnicity		string	De etniciteit van het kiesdistrict.
Doel	target		string	Het doel van het samenstellende onderdeel.
Inkomsten	income		string	Het inkomen voor de kiezers.
Ontvangstbewijstype	receipt_type		string	Het ontvangstbewijstype van het samenstellende onderdeel.
Godsdienst	religion		string	De religie van het kiesdistrict.
Aangepaste geadresseerde?	custom_format		boolean	Is de primaire geadresseerde een aangepaste indeling?
Adresee-indeling	configuration_id		string	Primaire adreslijstconfiguratie (vereist tenzij een aangepaste indeling wordt gebruikt).
Aangepaste naam van geadresseerde	formatted_name		string	De naam van de primaire geadresseerde die is opgemaakt (vereist wanneer een aangepaste indeling wordt gebruikt). Tekenlimiet: 255.
Aangepaste aanhef?	custom_format		boolean	Is de primaire aanhef een aangepaste indeling?
Aanhefindeling	configuration_id		string	Primaire aanhefconfiguratie (vereist tenzij een aangepaste indeling wordt gebruikt).
Aangepaste naam van aanhef	formatted_name		string	Primaire aanhefnotatie opgemaakte naam (vereist wanneer een aangepaste indeling wordt gebruikt). Tekenlimiet: 255.
Is herdenking?	is_memorial		boolean	Is de samenstellende een eer/herdenking?

Retouren

Afzonderlijke samenstellende elementen gemaakt

Body: ConstituentApi.CreatedIndividualConstituent

Een code voor een samenstellend verzoek maken

Bewerkings-id:: CreateConstituentSolicitCode

Hiermee maakt u een nieuwe aanvraagcode voor samenstellende elementen.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van de samenstelling die is gekoppeld aan de advocaatcode.
Code aanvragen	solicit_code	True	string	Communicatie-instructies en/of beperkingen voor een samenstellend onderdeel.
Begindatum	start_date		date	De begindatum van de aanvraagcode (bijvoorbeeld: '2005-09-18').
Einddatum	end_date		date	De einddatum van de aanvraagcode (bijvoorbeeld: '2005-09-18').

Retouren

Samengestelde advocaatcode gemaakt

Body: CommPrefApi.CreatedConstituentSolicitCode

Een eerbetoon bevestigen

Bewerkings-id:: CreateTributeAcknowledgee

Creëert een nieuw eerbetoon.

Parameters

Name	Sleutel	Vereist	Type	Description
Eerbetoon-id	tribute_id	True	integer	De systeemrecord-id van het eerbetoon dat aan de bevestiging is gekoppeld.
Relatie-id	relationship_id		integer	De systeemrecord-id van de relatie (indien null, dit vertegenwoordigt een zelfbevestiging).
Brief-id	letter_id		integer	De letter-id.

Retouren

Hulde bevestigd

Body: NXTDataIntegrationApi.CreatedTributeAcknowledgee

Een indeling voor een samenstellende naam maken

Bewerkings-id:: CreateConstituentNameFormat

Hiermee maakt u een nieuwe indeling voor de naam van een samenstellende naam.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van het samenstellende onderdeel.
Typologie	type	True	string	Het type naamnotatie.
Aangepaste naamindeling?	custom_format		boolean	Is een aangepaste indeling?
Formaat	configuration_id		string	Configuratie van naamnotatie (vereist tenzij een aangepaste indeling wordt gebruikt).
Aangepaste naam	formatted_name		string	Opgemaakte naam (vereist wanneer een aangepaste indeling wordt gebruikt). Tekenlimiet: 255.

Retouren

Naamnotatie gemaakt

Body: ConstituentApi.CreatedNameFormat

Een inzamelingstoewijzing maken

Bewerkings-id:: CreateFundraiserAssignment

Hiermee maakt u een nieuwe inzamelingstoewijzing.

Parameters

Name	Sleutel	Vereist	Type	Description
Inzamelings-id	fundraiser_id	True	string	De systeemrecord-id van de inzamelingsactie.
Samenstellende id	constituent_id	True	string	De systeemrecord-id van de toegewezen samenstellende component.
Typologie	type		string	Het type inzamelingsactie.
Opdracht wordt gestart	start		date-time	De begindatum van de opdracht (bijvoorbeeld: '2020-09-18T04:13:56Z').
Toewijzing eindigt	end		date-time	De einddatum van de opdracht (bijvoorbeeld: '2020-09-18T04:13:56Z').
Aantal	value	True	double	Het doelbedrag voor de inzamelingsactie om te vragen van de toegewezen kiezer.
Campagne-id	campaign_id		string	De systeemrecord-id van de campagne waarop resulterende geschenken worden toegepast.
Fonds-id	fund_id		string	De systeemrecord-id van het fonds waarop resulterende geschenken zullen worden toegepast.
Id van beroep	appeal_id		string	De systeemrecord-id van het beroep waarop resulterende geschenken zullen worden toegepast.

Retouren

Inzamelingstoewijzing gemaakt

Body: FundraisingApi.CreatedFundraiserAssignment

Een organisatie samenstellen

Bewerkings-id:: CreateOrganizationConstituent

Hiermee maakt u een nieuwe organisatie samenstellen.

Parameters

Name	Sleutel	Vereist	Type	Description
Naam	name	True	string	De naam van de organisatie. Tekenlimiet: 100.
Opzoek-id	lookup_id		string	De door de gebruiker gedefinieerde id voor de samenstellende gebruiker.
type	type	True	string	Het adrestype.
country	country		string	Het land van het adres (kan de id, naam of afkorting zijn).
lijnen	address_lines		string	De adresregels. Tekenlimiet: 150.
city	city		string	De plaats van het adres (gebruik niet in combinatie met het veld Buitenwijk).
state	state		string	De status van het adres.
postcode	postal_code		string	De postcode van het adres. Tekenlimiet: 12.
voorstad	suburb		string	De buitenwijk van het adres (gebruik niet in combinatie met het veld Plaats).
graafschap	county		string	De provincie van het adres.
start	start		date	De datum waarop de samenstelling op dit adres begon te wonen (bijvoorbeeld: 2005-09-18).
einde	end		date	De datum waarop de samenstelling niet meer op dit adres is gevestigd (bijvoorbeeld: 2005-09-18).
type	type	True	string	Het telefoontype.
nummer	number	True	string	Het telefoonnummer.
is primair?	primary		boolean	Is dit het primaire telefoonnummer van de kiezer?
type	type	True	string	Het type e-mailadres.
address	address	True	string	Het e-mailadres.
is primair?	primary		boolean	Is dit het primaire e-mailadres van de samenstellende gebruiker?
type	type	True	string	Het online aanwezigheidstype.
address	address	True	string	Het webadres voor de online aanwezigheid.
is primair?	primary		boolean	Is dit de primaire online aanwezigheid van de samenstellende gebruiker?
Geeft anoniem?	gives_anonymously		boolean	Geeft de kiezer anoniem?
Geen e-mail aanvragen?	requests_no_email		boolean	Heeft de samenstellende aanvraag geen e-mail?
Is een advocaat?	is_solicitor		boolean	Is de kiezer een advocaat?
Geen geldige adressen?	no_valid_address		boolean	Heeft de samenstelling geen geldige adressen?
Doel	target		string	Het doel van het samenstellende onderdeel.
Inkomsten	income		string	Het inkomen voor de kiezers.
Ontvangstbewijstype	receipt_type		string	Het ontvangstbewijstype van het samenstellende onderdeel.
Industrie	industry		string	De bedrijfstak van de samenstelling.
Aantal werknemers	num_employees		integer	Het aantal werknemers in de organisatie.
Komt overeen met cadeaus?	matches_gifts		boolean	Komt de organisatie overeen met cadeaus?
Overeenkomende cadeaufactor	matching_gift_factor		double	De overeenkomende cadeaufactor.
Minimale overeenkomst per cadeau	value		double	Het minimum matchbedrag per cadeau voor het samenstellende deel.
Maximale overeenkomst per cadeau	value		double	Het maximale matchbedrag per cadeau voor het samenstellende deel.
Minimale overeenkomst per constit	value		double	Het minimum matchtotaal voor de samenstellende waarde.
Maximale overeenkomst per constit	value		double	Het maximum matchtotaal voor de samenstellende waarde.
Overeenkomende cadeaunotities	matching_gift_notes		string	De overeenkomende cadeaunotities voor het samenstellende onderdeel.
Is herdenking?	is_memorial		boolean	Is de samenstellende een eer/herdenking?

Retouren

Samenstellende organisatie

Body: ConstituentApi.CreatedOrganizationConstituent

Een organisatierelatie maken

Bewerkings-id:: CreateOrganizationRelationship

Hiermee maakt u een nieuwe organisatierelatie. Als de relatie met een andere component is, wordt er een wederzijdse relatie voor die samenstellende component gemaakt.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van de samenstellende component die aan de relatie is gekoppeld.
Relatie-id	relation_id	True	string	De systeemrecord-id van de gerelateerde organisatie.
Typologie	type		string	Het type relatie dat de relatie vertegenwoordigt.
Wederkerig type	reciprocal_type		string	Beschrijft de relatie van het samenstellende onderdeel met de gerelateerde organisatie.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
Is het contact?	is_organization_contact		boolean	Vertegenwoordigt de samenstellende persoon deze organisatie als contactpersoon?
Type contact	organization_contact_type		string	Biedt context voor interacties met de gerelateerde persoon die de organisatie vertegenwoordigt als contactpersoon.
Position	position		string	De positie van de persoon in de organisatie. Tekenlimiet: 50.
Is primair bedrijf?	is_primary_business		boolean	Is dit het primaire bedrijf van de samenstellende onderneming?
Opmerkingen	comment		string	Aanvullende opmerkingen over de relatie.

Retouren

Organisatierelatie gemaakt

Body: ConstituentApi.CreatedOrganizationRelationship

Een primaire naamnotatie voor een samenstellende primaire naam maken

Bewerkings-id:: CreateConstituentPrimaryNameFormat

Hiermee maakt u een primaire naamindeling voor een samenstellend onderdeel.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van het samenstellende onderdeel.
Typologie	primary_type	True	string	Het type primaire naamnotatie.
Aangepaste naamindeling?	custom_format		boolean	Is een aangepaste indeling?
Formaat	configuration_id		string	Configuratie van naamnotatie (vereist tenzij een aangepaste indeling wordt gebruikt).
Aangepaste naam	formatted_name		string	Opgemaakte naam (vereist wanneer een aangepaste indeling wordt gebruikt). Tekenlimiet: 255.

Retouren

Naamnotatie gemaakt

Body: ConstituentApi.CreatedNameFormat

Een samenstellend adres bijwerken

Bewerkings-id:: EditConstituentAddress

Werkt een samenstellend adres bij.

Parameters

Name	Sleutel	Vereist	Type	Description
Adres-id	address_id	True	string	De systeemrecord-id van het adres dat moet worden bijgewerkt.
Adrestype	type		string	Het adrestype.
Country	country		string	Het land van het adres (kan de id, naam of afkorting zijn).
Adresregels	address_lines		string	De adresregels.
City	city		string	De plaats van het adres (gebruik niet in combinatie met het veld Buitenwijk).
Staat	state		string	De status van het adres.
Postcode	postal_code		string	De postcode van het adres.
Voorstad	suburb		string	De buitenwijk van het adres (gebruik niet in combinatie met het veld Plaats).
Regio	county		string	De provincie van het adres.
Informatiebron	information_source		string	De informatiebron voor het adres.
Regio	region		string	De regio voor het adres.
KAR	cart		string	De vervoerdersroute (CART) voor het adres.
LOT	lot		string	De reisregel (LOT) voor het adres.
DPC	dpc		string	De afleverpuntcode (DPC) voor het adres.
Geldig vanaf	start		date	De datum waarop de samenstelling op dit adres begon te wonen (bijvoorbeeld: 2005-09-18).
Geldig voor	end		date	De datum waarop de samenstelling niet meer op dit adres is gevestigd (bijvoorbeeld: 2005-09-18).
Primair?	preferred		boolean	Is dit het voorkeursadres van de kiezers?
Geen e-mail?	do_not_mail		boolean	Kan de samenstellende persoon op dit adres contact opnemen?
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.

Een samenstellend adres maken

Bewerkings-id:: CreateConstituentAddress

Hiermee maakt u een nieuw samenstellend adres.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van de samenstellende component die aan het adres is gekoppeld.
Adrestype	type	True	string	Het adrestype.
Country	country		string	Het land van het adres (kan de id, naam of afkorting zijn).
Adresregels	address_lines		string	De adresregels.
City	city		string	De plaats van het adres (gebruik niet in combinatie met het veld Buitenwijk).
Staat	state		string	De status van het adres.
Postcode	postal_code		string	De postcode van het adres.
Voorstad	suburb		string	De buitenwijk van het adres (gebruik niet in combinatie met het veld Plaats).
Regio	county		string	De provincie van het adres.
Informatiebron	information_source		string	De informatiebron voor het adres.
Regio	region		string	De regio voor het adres.
KAR	cart		string	De vervoerdersroute (CART) voor het adres.
LOT	lot		string	De reisregel (LOT) voor het adres.
DPC	dpc		string	De afleverpuntcode (DPC) voor het adres.
Geldig vanaf	start		date	De datum waarop de samenstelling op dit adres begon te wonen (bijvoorbeeld: 2005-09-18).
Geldig voor	end		date	De datum waarop de samenstelling niet meer op dit adres is gevestigd (bijvoorbeeld: 2005-09-18).
Primair?	preferred		boolean	Is dit het voorkeursadres van de kiezers?
Geen e-mail?	do_not_mail		boolean	Kan de samenstellende persoon op dit adres contact opnemen?
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.

Retouren

Samengesteld adres gemaakt

Body: ConstituentApi.CreatedConstituentAddress

Een samenstellend e-mailadres bijwerken

Bewerkings-id:: EditConstituentEmailAddress

Hiermee werkt u een samenstellend e-mailadres bij.

Parameters

Name	Sleutel	Vereist	Type	Description
E-mailadres-id	email_address_id	True	string	De systeemrecord-id van het e-mailadres dat moet worden bijgewerkt.
E-mailtype	type		string	Het type e-mailadres.
E-mailadres	address		string	Het e-mailadres.
Primair?	primary		boolean	Is dit het primaire e-mailadres van de samenstellende gebruiker?
Wilt u geen e-mail verzenden?	do_not_email		boolean	Kan de samenstellende persoon contact opnemen via dit e-mailadres?
Inactief?	inactive		boolean	Is dit e-mailadres inactief?

Een samenstellend e-mailadres maken

Bewerkings-id:: CreateConstituentEmailAddress

Hiermee maakt u een nieuw samenstellend e-mailadres.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van de samenstellende component die aan het e-mailadres is gekoppeld.
E-mailtype	type	True	string	Het type e-mailadres.
E-mailadres	address	True	string	Het e-mailadres.
Primair?	primary		boolean	Is dit het primaire e-mailadres van de samenstellende gebruiker?
Wilt u geen e-mail verzenden?	do_not_email		boolean	Kan de samenstellende persoon contact opnemen via dit e-mailadres?
Inactief?	inactive		boolean	Is dit e-mailadres inactief?

Retouren

Gemaakt e-mailadres

Body: ConstituentApi.CreatedConstituentEmailAddress

Een samenstellend eerbetoon krijgen

Bewerkings-id:: GetConstituentTribute

Retourneert details over een samenstellend eerbetoon.

Parameters

Name	Sleutel	Vereist	Type	Description
Eerbetoon-id	tribute_id	True	string	De eerbetoon-id.

Retouren

Schatting

Body: NXTDataIntegrationApi.Tribute

Een samenstellend eerbetoon maken

Bewerkings-id:: CreateConstituentTribute

Creëert een nieuw hulde.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_record_id	True	integer	De systeemrecord-id van het samenstellende onderdeel dat aan het eerbetoon is gekoppeld.
Eerbetoontype	tribute_type_id	True	integer	Het eerbetoontype.
Description	description		string	De eerbetoonsbeschrijving.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
Standaardfonds-id	default_fund_id		integer	De systeemrecord-id van het standaardfonds dat aan het eerbetoon is gekoppeld.
Opmerkingen	notes		string	De eerbetoonnotities.
Actief?	is_active		boolean	Is dit eerbetoon actief?

Retouren

Gemaakt samenstellend eerbetoon

Body: NXTDataIntegrationApi.CreatedConstituentTribute

Een samenstellend onderwijs bijwerken

Bewerkings-id:: EditConstituentEducation

Werkt een samenstellend onderwijs bij.

Parameters

Name	Sleutel	Vereist	Type	Description
Onderwijs-id	education_id	True	string	De systeemrecord-id van het onderwijsrecord dat moet worden bijgewerkt.
School	school		string	De naam van de school/vestiging.
Typologie	type		string	Het type onderwijs.
Klasse van	class_of		string	Het jaar dat de kiezer afstudeerde.
Toestand	status		string	De status van het onderwijs.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
Graad	degree		string	De graad ontvangen.
GPA	gpa		double	Het cijferpuntgemiddelde.
Onderwerp van studie	subject_of_study		string	Het onderwerp van de studie.
Primair?	primary		boolean	Is dit de basisschoolvereniging van het kiesdistrict?
Majors	majors		array of string	De hoofdvakken van studie.
Minderjarigen	minors		array of string	De secundaire studiecursussen.
Campus	campus		string	De campus. Tekenlimiet: 50.
Sociale organisatie	social_organization		string	De sociale organisatie. Tekenlimiet: 50.
Bekende naam	known_name		string	De bekende naam. Tekenlimiet: 50.
Graadklasse	class_of_degree		string	De graadklasse.
Afdeling	department		string	De naam van de onderwijsafdeling.
Faculteit	faculty		string	De naam van de faculteit.
Registratienummer	registration_number		string	Het registratienummer. Tekenlimiet: 50.

Een samenstellend onderwijs maken

Bewerkings-id:: CreateConstituentEducation

Hiermee maakt u een nieuw samenstellend onderwijs.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van de samenstellende elementen die aan het onderwijs zijn gekoppeld.
School	school	True	string	De naam van de school/vestiging.
Typologie	type		string	Het type onderwijs.
Klasse van	class_of		string	Het jaar dat de kiezer afstudeerde.
Toestand	status		string	De status van het onderwijs.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
Graad	degree		string	De graad ontvangen.
GPA	gpa		double	Het cijferpuntgemiddelde.
Onderwerp van studie	subject_of_study		string	Het onderwerp van de studie.
Primair?	primary		boolean	Is dit de basisschoolvereniging van het kiesdistrict?
Majors	majors		array of string	De hoofdvakken van studie.
Minderjarigen	minors		array of string	De secundaire studiecursussen.
Campus	campus		string	De campus. Tekenlimiet: 50.
Sociale organisatie	social_organization		string	De sociale organisatie. Tekenlimiet: 50.
Bekende naam	known_name		string	De bekende naam. Tekenlimiet: 50.
Graadklasse	class_of_degree		string	De graadklasse (alleen van toepassing op Britse versies).
Afdeling	department		string	De naam van de onderwijsafdeling (alleen van toepassing op britse versies).
Faculteit	faculty		string	De naam van de faculteit (alleen van toepassing op britse versies).
Registratienummer	registration_number		string	Het registratienummer (alleen van toepassing op britse versies). Tekenlimiet: 50.

Retouren

Samengesteld onderwijs

Body: ConstituentApi.CreatedConstituentEducation

Een samenstellende advocaatcode bijwerken

Bewerkings-id:: EditConstituentSolicitCode

Hiermee werkt u een code voor een samenstellend verzoek bij.

Parameters

Name	Sleutel	Vereist	Type	Description
Code-id aanvragen	constituent_solicit_code_id	True	string	De systeemrecord-id van de verzoekcode die moet worden bijgewerkt.
Code aanvragen	solicit_code		string	Communicatie-instructies en/of beperkingen voor een samenstellend onderdeel.
Begindatum	start_date		date	De begindatum van de aanvraagcode (bijvoorbeeld: '2005-09-18').
Einddatum	end_date		date	De einddatum van de aanvraagcode (bijvoorbeeld: '2005-09-18').

Een samenstellende alias bijwerken

Bewerkings-id:: EditConstituentAlias

Hiermee wordt een samenstellende alias bijgewerkt.

Parameters

Name	Sleutel	Vereist	Type	Description
Alias-id	alias_id	True	string	De systeemrecord-id van de alias die moet worden bijgewerkt.
Alias	name		string	De naam die moet worden gebruikt als de alias van het samenstellende onderdeel. Tekenlimiet: 100.
Typologie	type		string	Het aliastype.

Een samenstellende alias maken

Bewerkings-id:: CreateConstituentAlias

Hiermee maakt u een nieuwe samenstellende alias.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van de samenstellende component die aan de alias is gekoppeld.
Alias	name	True	string	De naam die moet worden gebruikt als de alias van het samenstellende onderdeel. Tekenlimiet: 100.
Typologie	type		string	Het aliastype.

Retouren

Samengestelde alias

Body: ConstituentApi.CreatedConstituentAlias

Een samenstellende bijlage bijwerken

Bewerkings-id:: EditConstituentAttachment

Werkt een samenstellende bijlage bij.

Parameters

Name	Sleutel	Vereist	Type	Description
Bijlage-ID	attachment_id	True	string	De systeemrecord-id van de bijlage die moet worden bijgewerkt.
Naam	name		string	De naam van de bijlage. Tekenlimiet: 150.
Datum	date		date-time	De datum van de bijlage (bijvoorbeeld: '2020-09-18T04:13:56Z').
URL	url		string	De URL voor de bijlage. Dit is vereist voor koppelingsbijlagen en niet van toepassing op fysieke bijlagen.
Tags	tags		array of string	De tags die aan de bijlage zijn gekoppeld.

Een samenstellende bijlage maken

Bewerkings-id:: CreateConstituentAttachment

Hiermee maakt u een nieuwe samenstellende bijlage.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	parent_id	True	string	De systeemrecord-id van het samenstellende onderdeel dat aan de bijlage is gekoppeld.
Typologie	type	True	string	Het bijlagetype. Fysieke bijlagen zijn geüploade bestanden, zoals afbeeldingen, PDF-bestanden of Word-documenten die lokaal of op het netwerk worden opgeslagen. Ze worden opgeslagen en beheerd in het systeem. Koppelingsbijlagen zijn koppelingen naar bestanden zoals afbeeldingen, blogberichten of YouTube-video's die online of in een cloudopslagaccount zijn. Ze worden extern opgeslagen en beheerd.
Naam	name		string	De naam van de bijlage. Tekenlimiet: 150.
Datum	date		date-time	De datum van de bijlage (bijvoorbeeld: '2020-09-18T04:13:56Z'). Dit veld wordt standaard ingesteld op de huidige datum en tijd, indien niet opgegeven.
URL	url		string	De URL voor de bijlage. Dit is vereist voor koppelingsbijlagen en niet van toepassing op fysieke bijlagen.
Bestandsnaam	file_name		string	De naam van het bestand. Tekenlimiet: 36. Alleen voor fysieke bijlagen.
Bestands-id	file_id		string	De id van het bestand. Tekenlimiet: 36. Alleen voor fysieke bijlagen.
Miniatuur-id	thumbnail_id		string	De id van de miniatuur. Tekenlimiet: 36. Alleen voor fysieke bijlagen.
Tags	tags		array of string	De tags die aan de bijlage zijn gekoppeld.

Retouren

Samengestelde bijlage gemaakt

Body: ConstituentApi.CreatedConstituentAttachment

Een samenstellende code bijwerken

Bewerkings-id:: EditConstituentCode

Hiermee wordt een samenstellende code bijgewerkt.

Parameters

Name	Sleutel	Vereist	Type	Description
Id van samenstellende code	constituent_code_id	True	string	De systeemrecord-id van de samenstellende code die moet worden bijgewerkt.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
Sequentie	sequence		integer	De numerieke reeks die is gekoppeld aan de samenstellende code.

Een samenstellende code maken

Bewerkings-id:: CreateConstituentCode

Hiermee maakt u een nieuwe samenstellende code.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van de samenstellende component die is gekoppeld aan de samenstellende code.
Samenstellende code	description	True	string	De samenstellende code.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
Sequentie	sequence		integer	De numerieke reeks die is gekoppeld aan de samenstellende code.

Retouren

Samengestelde code

Body: ConstituentApi.CreatedConstituentCode

Een samenstellende code verwijderen

Bewerkings-id:: DeleteConstituentCode

Hiermee verwijdert u een samenstellende code.

Parameters

Name	Sleutel	Vereist	Type	Description
Id van samenstellende code	constituent_code_id	True	string	De systeemrecord-id van de samenstellende code die moet worden verwijderd.

Een samenstellende component bijwerken

Bewerkings-id:: EditConstituent

Werkt een samenstellende component bij.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van de samenstellende onderdelen die moeten worden bijgewerkt.
Title	title		string	De primaire titel van de samenstellende persoon (alleen voor personen).
Voornaam	first		string	De voornaam van de samenstellende persoon (alleen voor personen). Tekenlimiet: 50.
Achternaam	last		string	De achternaam van de samenstellende persoon (alleen voor personen). Tekenlimiet: 100.
Organisatienaam	name		string	Voor personen is dit een berekend veld dat niet van toepassing is op bewerkingen. Dit veld is vereist voor de organisatie en vertegenwoordigt de naam van de organisatie. Tekenlimiet: 100.
Achtervoegsel	suffix		string	Het primaire achtervoegsel van het samenstellende onderdeel (alleen voor personen).
Voorkeursnaam	preferred_name		string	De voorkeursnaam van de samenstellende persoon (alleen voor personen). Tekenlimiet: 50.
Opzoek-id	lookup_id		string	De door de gebruiker gedefinieerde id voor de samenstellende gebruiker.
Geslacht	gender		string	Het geslacht van de kiezer (alleen voor individuen).
Middelste naam	middle		string	De middelste naam van de samenstellende persoon (alleen voor personen). Tekenlimiet: 50.
Voormalige naam	former_name		string	De vroegere naam van de samenstellende persoon (alleen voor personen). Tekenlimiet: 100.
Titel 2	title_2		string	De secundaire titel van het samenstellende onderdeel (alleen voor personen).
Achtervoegsel 2	suffix_2		string	Het secundaire achtervoegsel van het samenstellende onderdeel (alleen voor personen).
Burgerlijke staat	marital_status		string	De burgerlijke staat van het kiesdistrict (alleen voor individuen).
Geeft anoniem?	gives_anonymously		boolean	Geeft de kiezer anoniem?
Geen e-mail aanvragen?	requests_no_email		boolean	Heeft de samenstellende aanvraag geen e-mail?
Is een advocaat?	is_solicitor		boolean	Is de kiezer een advocaat?
Geen geldige adressen?	no_valid_address		boolean	Heeft de samenstelling geen geldige adressen?
Inactief?	inactive		boolean	Is de samenstellende component inactief?
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
Geboorteplaats	birthplace		string	De geboorteplaats van het kiesdistrict (alleen voor individuen).
Etniciteit	ethnicity		string	De etniciteit van de kiezers (alleen voor individuen).
Doel	target		string	Het doel van het samenstellende onderdeel.
Inkomsten	income		string	Het inkomen voor de samenstellende persoon (alleen voor individuen).
Ontvangstbewijstype	receipt_type		string	Het ontvangstbewijstype van het samenstellende onderdeel.
Godsdienst	religion		string	De godsdienst van het kiesdistrict (alleen voor individuen).
Industrie	industry		string	De bedrijfstak van het samenstellende onderdeel (alleen voor organisaties).
Aantal werknemers	num_employees		integer	Het aantal werknemers in de organisatie.
Komt overeen met cadeaus?	matches_gifts		boolean	Komt de organisatie overeen met cadeaus?
Overeenkomende cadeaufactor	matching_gift_factor		double	De overeenkomende cadeaufactor (alleen voor organisaties).
Minimale overeenkomst per cadeau	value		double	Het minimale matchbedrag per cadeau voor de samenstellende partij (alleen voor organisaties).
Maximale overeenkomst per cadeau	value		double	Het maximum aantal overeenkomsten per cadeau voor de samenstellende partij (alleen voor organisaties).
Minimale overeenkomst per constit	value		double	Het minimumovereenkomsttotaal voor de samenstellende partij (alleen voor organisaties).
Maximale overeenkomst per constit	value		double	Het maximum matchtotaal voor de samenstellende partij (alleen voor organisaties).
Overeenkomende cadeaunotities	matching_gift_notes		string	De overeenkomende cadeaunotities voor de samenstellende waarde (alleen voor organisaties).
Overleden?	deceased		boolean	Is de kiezer overleden (alleen voor individuen)?
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
Is herdenking?	is_memorial		boolean	Is de samenstellende een eer/herdenking?

Een samenstellende component ophalen

Bewerkings-id:: GetConstituent

Retourneert informatie over een samenstellend onderdeel.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van de samenstellende component die moet worden get.

Retouren

Bestanddeel

Body: ConstituentApi.ConstituentRead

Een samenstellende component zoeken

Bewerkings-id:: SearchConstituent

Voert een samenstellende zoekopdracht uit op basis van de opgegeven zoektekst. Ondersteunt voornaam, achternaam, voorkeursnaam, voormalige naam, alias, e-mailadres, telefoonnummer, adres of opzoek-id. Naamcombinaties zoals voornaam en achternaam of voorkeursnaam en achternaam zijn geldig, maar anders ondersteunt zoeken slechts één parameter tegelijk. Standaard bevatten zoekopdrachten resultaten die lijken op uw criteria. Zoekopdrachten naar 'Smith' bevatten bijvoorbeeld overeenkomsten voor 'Smyth' en andere alternatieve spelling. Deze zoekopdracht biedt geen ondersteuning voor jokertekens zoals * of ?. Zoekresultaten zijn beperkt tot 500 records.

Parameters

Name	Sleutel	Vereist	Type	Description
Zoektekst	search_text	True	string	De zoektekst. Ondersteunt voornaam, achternaam, voorkeursnaam, voormalige naam, alias, e-mailadres, telefoonnummer, adres of opzoek-id. Naamcombinaties zoals voornaam en achternaam of voorkeursnaam en achternaam zijn geldig, maar anders ondersteunt zoeken slechts één parameter tegelijk. Standaard bevatten zoekopdrachten resultaten die lijken op uw criteria. Zoekopdrachten naar 'Smith' bevatten bijvoorbeeld overeenkomsten voor 'Smyth' en andere alternatieve spelling. Deze zoekopdracht biedt geen ondersteuning voor jokertekens zoals * of ?. Zoekresultaten zijn beperkt tot 500 records.
Inzamelingsstatussen	fundraiser_status		string	Vertegenwoordigt een door komma's gescheiden lijst met inzamelingsstatussen om de resultaten te filteren. Bijvoorbeeld: 'Actief,Geen' retourneert alleen samenstellende elementen waarvan de inzamelingsstatus Actief of Geen is. Geldige waarden voor dit filter zijn Actief, Inactief en Geen.
Inactief opnemen?	include_inactive		boolean	Inactieve componenten opnemen in het antwoord?
Zoekveld	search_field		string	Vertegenwoordigt een veld waarop moet worden gezocht. Op dit moment wordt alleen lookup_id ondersteund. Als het wordt geleverd met search_text, wordt een samenstelling met lookup_id die overeenkomt met de search_text geretourneerd.
Strikt zoeken gebruiken?	strict_search		boolean	Sluit samenstellen waarvan de namen lijken op de zoektekst, uit, maar anders zijn gespeld?
Limit	limit		integer	Geeft het aantal records weer dat moet worden geretourneerd. De standaardwaarde is 500. Het maximum is 5000.
Offset	offset		integer	Geeft het aantal records aan dat moet worden overgeslagen. Voor gebruik met paginering.

Retouren

Zoekresultaten

Body: ConstituentApi.ApiCollectionOfSearchResultRead

Een samenstellende notitie bijwerken

Bewerkings-id:: EditConstituentNote

Hiermee wordt een samenstellende notitie bijgewerkt.

Parameters

Name	Sleutel	Vereist	Type	Description
Notitie-id	note_id	True	string	De systeemrecord-id van de notitie die moet worden bijgewerkt.
Typologie	type		string	Het type notitie.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
Samenvatting	summary		string	De samenvatting van de notitie. Tekenlimiet: 50.
Opmerking	text		string	De notitietekst.

Een samenstellende notitie maken

Bewerkings-id:: CreateConstituentNote

Hiermee maakt u een nieuwe samenstellende notitie.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van de samenstellende component die aan de notitie is gekoppeld.
Typologie	type	True	string	Het type notitie.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
Samenvatting	summary		string	De samenvatting van de notitie. Tekenlimiet: 50.
Opmerking	text		string	De notitietekst.
Author	author		string	De auteur van de notitie. Als dit niet is opgegeven, is er een standaardset ingesteld op basis van het account van de gebruiker. Tekenlimiet: 50.

Retouren

Samengestelde notitie

Body: ConstituentApi.CreatedConstituentNote

Een samenstellende online aanwezigheid bijwerken

Bewerkings-id:: EditConstituentOnlinePresence

Hiermee wordt een samenstellende online aanwezigheid bijgewerkt.

Parameters

Name	Sleutel	Vereist	Type	Description
Online aanwezigheids-id	online_presence_id	True	string	De systeemrecord-id van de online aanwezigheid die moet worden bijgewerkt.
Typologie	type		string	Het online aanwezigheidstype.
Link	address		string	Het webadres voor de online aanwezigheid.
Primair?	primary		boolean	Is dit de primaire online aanwezigheid van de samenstellende gebruiker?
Inactief?	inactive		boolean	Is deze online aanwezigheid inactief?

Een samenstellende online aanwezigheid maken

Bewerkings-id:: CreateConstituentOnlinePresence

Hiermee maakt u een nieuwe samenstellende online aanwezigheid.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van de samenstellende component die is gekoppeld aan de online aanwezigheid.
Typologie	type	True	string	Het online aanwezigheidstype.
Link	address	True	string	Het webadres voor de online aanwezigheid.
Primair?	primary		boolean	Is dit de primaire online aanwezigheid van de samenstellende gebruiker?
Inactief?	inactive		boolean	Is deze online aanwezigheid inactief?

Retouren

Samengestelde online aanwezigheid

Body: ConstituentApi.CreatedConstituentOnlinePresence

Een samenstellende opzoek-id ophalen

Bewerkings-id:: GetConstituentIdFromLookupId

Retourneert de systeemrecord-id van een onderdeel uit de opgegeven opzoek-id.

Parameters

Name	Sleutel	Vereist	Type	Description
Opzoek-id	constituent_id	True	string	De samenstellende opzoek-id.

Retouren

Toewijzing van samenstellende id's

Body: NXTDataIntegrationApi.ConstituentIdMap

Een samenstellende profielafbeelding bijwerken

Bewerkings-id:: EditConstituentProfilePicture

Hiermee werkt u de huidige profielfoto voor een samenstellende gebruiker bij.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van het samenstellende onderdeel waarvan de profielfoto moet worden bijgewerkt.
Bestandsnaam	file_name	True	string	De naam van het bestand.
Document-id	document_id	True	uuid	De document-id.
Miniatuur-id	thumbnail_id	True	uuid	De miniatuurdocument-id.

Een samenstellende profielfoto ophalen

Bewerkings-id:: GetConstituentProfilePicture

Retourneert de huidige profielfoto voor een samenstellend onderdeel.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van de samenstellende gebruiker voor wie de profielfoto moet worden opgehaald.

Retouren

Profielafbeelding

Body: ConstituentApi.ProfilePictureRead

Een samenstellende relatie bijwerken

Bewerkings-id:: EditConstituentRelationship

Werkt een relatie voor een samenstellende component bij. Als er een wederzijdse relatie bestaat, wordt deze ook gewijzigd om de wijzigingen weer te geven. Dit omvat geen wijzigingen in de eigenschap 'opmerkingen', die specifiek is voor elke record en onafhankelijk van elke record kan worden gewijzigd.

Parameters

Name	Sleutel	Vereist	Type	Description
Relatie-id	relationship_id	True	string	De systeemrecord-id van de relatie die moet worden bijgewerkt.
Typologie	type		string	Het type relatie dat de relatie vertegenwoordigt.
Wederkerig type	reciprocal_type		string	Beschrijft de relatie van de samenstellende component met de gerelateerde component. Bijvoorbeeld, in een relatie tussen een mannelijke samenstellende en een vrouwelijke zus, zou het wederzijdse relatietype broer zijn.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
Is echtgenoot?	is_spouse		boolean	Is de gerelateerde persoon de echtgenoot van het kiesdistrict (alleen van toepassing op relaties tussen individuen)?
Is het hoofd van het huishouden?	is_constituent_head_of_household		boolean	Is het hoofd van het huishouden?
Is het hoofd van de echtgenoot van het huishouden?	is_spouse_head_of_household		boolean	Is de echtgenoot het hoofd van het huishouden?
Opmerkingen	comment		string	Aanvullende opmerkingen over de relatie.
Is het contact?	is_organization_contact		boolean	Vertegenwoordigt de samenstellende persoon deze organisatie als contactpersoon (alleen van toepassing op relaties tussen organisaties en personen)?
Is primair bedrijf?	is_primary_business		boolean	Is dit het primaire bedrijf van de samenstellende afdeling (alleen van toepassing op relaties tussen organisaties en individuen)?
Type contact	organization_contact_type		string	Biedt context voor interacties met de gerelateerde persoon die de organisatie vertegenwoordigt als contactpersoon. Alleen van toepassing op relaties tussen organisaties en individuen.
Position	position		string	De positie van de persoon in de organisatie. Alleen van toepassing op relaties tussen organisaties en individuen. Tekenlimiet: 50.

Een samenstellende telefoon bijwerken

Bewerkings-id:: EditConstituentPhone

Werkt een samenstellende telefoon bij.

Parameters

Name	Sleutel	Vereist	Type	Description
Telefoon-id	phone_id	True	string	De systeemrecord-id van de telefoon die moet worden bijgewerkt.
Typologie	type		string	Het telefoontype.
Number	number		string	Het telefoonnummer.
Primair?	primary		boolean	Is dit de primaire telefoon van de samenstellende gebruiker?
Niet bellen?	do_not_call		boolean	Kan de samenstellende persoon contact opnemen met dit nummer?
Inactief?	inactive		boolean	Is dit telefoonnummer inactief?

Een samenstellende telefoon maken

Bewerkings-id:: CreateConstituentPhone

Hiermee maakt u een nieuwe samenstellende telefoon.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van het samenstellende onderdeel dat aan de telefoon is gekoppeld.
Typologie	type	True	string	Het telefoontype.
Number	number	True	string	Het telefoonnummer.
Primair?	primary		boolean	Is dit de primaire telefoon van de samenstellende gebruiker?
Niet bellen?	do_not_call		boolean	Kan de samenstellende persoon contact opnemen met dit nummer?
Inactief?	inactive		boolean	Is dit telefoonnummer inactief?

Retouren

Samengestelde telefoon

Body: ConstituentApi.CreatedConstituentPhone

Een samenstellende toestemmingsrecord maken

Bewerkings-id:: CreateConstituentConsent

Hiermee maakt u een nieuwe samenstellende toestemmingsrecord.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van de samenstellende component die is gekoppeld aan de toestemmingsrecord.
Channel	channel	True	string	Het kanaal waarop het toestemmingsantwoord van toepassing is.
Categorie	category		string	De categorie waarop het toestemmingsantwoord van toepassing is.
Bron	source		string	De bron van het toestemmingsantwoord van de samenstellende gebruiker.
Reactie	constituent_consent_response	True	string	Hoe de samenstellende functie heeft gereageerd op toestemming voor het opgegeven kanaal/de opgegeven categorie.
Datum	consent_date	True	date-time	De datum waarop het toestemmingsantwoord is ontvangen (bijvoorbeeld: '2020-09-18T04:13:56Z').
Toestemmingsverklaring	consent_statement		string	De verklaring waarop de samenstellende gebruiker heeft gereageerd bij het verstrekken van toestemming.
Privacyverklaring	privacy_notice		string	De privacyverklaring die aan de samenstellende gebruiker is verstrekt.

Retouren

Samenstellende toestemming gemaakt

Body: CommPrefApi.CreatedConstituentConsent

Inzamelingstoewijzingen vermelden

Bewerkings-id:: ListFundraiserAssignments

Vermeld de opdrachten voor een inzamelingsactie.

Parameters

Name	Sleutel	Vereist	Type	Description
Inzamelings-id	fundraiser_id	True	string	De systeemrecord-id van de inzamelingsactie voor wie opdrachten moeten worden geretourneerd.
Limit	limit		integer	Geeft het aantal records weer dat moet worden geretourneerd. De standaardwaarde is 500. Het maximum is 5000.
Offset	offset		integer	Geeft het aantal records aan dat moet worden overgeslagen. Voor gebruik met paginering.

Retouren

Assignments

Body: FundraisingApi.ApiCollectionOfFundraiserAssignmentRead

Lijst eerbetoon erkent

Bewerkings-id:: ListTributeAcknowledgees

Geeft een overzicht van de erkenningen voor een eerbetoon.

Parameters

Name	Sleutel	Vereist	Type	Description
Eerbetoon-id	tributeId	True	integer	De systeemrecord-id van het eerbetoon.

Retouren

Eerbetoon erkent

Body: NXTDataIntegrationApi.TributeAcknowledgeeCollection

Lijst samenstellende eerbetoon

Bewerkings-id:: ListConstituentTributes

Geeft een overzicht van de eerbetoons voor een samenstellend lid.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituentId	True	integer	De systeemrecord-id van het samenstellende onderdeel.

Retouren

Tributes

Body: NXTDataIntegrationApi.TributeCollection

Lijst samenstellende fondsenwervers

Bewerkings-id:: ListConstituentFundraiserAssignments

Een lijst met de inzamelingsopdrachten voor een samenstellend onderdeel.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van het samenstellende onderdeel.
Inactief opnemen?	include_inactive		boolean	Inactieve inzamelingsopdrachten opnemen?

Retouren

Inzamelingsopdrachten

Body: ConstituentApi.ApiCollectionOfFundraiserAssignmentRead

Samenstellende adressen vermelden

Bewerkings-id:: ListConstituentAddresses

Geeft een lijst van de adressen voor een samenstellende component.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van het samenstellende onderdeel.
Inactief opnemen?	include_inactive		boolean	Inactieve adressen opnemen?

Retouren

Addresses

Body: ConstituentApi.ApiCollectionOfAddressRead

Samenstellende advocaatcodes vermelden

Bewerkings-id:: ListConstituentSolicitCodes

Hiermee worden de aanvraagcodes voor een samenstellend lid vermeld.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van het samenstellende onderdeel.

Retouren

Vraagcodes

Body: CommPrefApi.ConstituentSolicitCodeReadCollection

Samenstellende aliassen vermelden

Bewerkings-id:: ListConstituentAliases

Geeft een lijst van de aliassen voor een samenstellende component.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van het samenstellende onderdeel.

Retouren

Aliases

Body: ConstituentApi.ApiCollectionOfAliasRead

Samenstellende bijlagen vermelden

Bewerkings-id:: ListConstituentAttachments

Geeft een lijst weer van de bijlagen voor een samenstellend onderdeel.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van het samenstellende onderdeel.

Retouren

Bijlagen

Body: ConstituentApi.ApiCollectionOfConstituentAttachmentRead

Samenstellende codes vermelden

Bewerkings-id:: ListConstituentCodes

Geeft een lijst weer van de samenstellende codes voor een samenstellend onderdeel.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van het samenstellende onderdeel.

Retouren

Samenstellende codes

Body: ConstituentApi.ApiCollectionOfConstituentCodeRead

Samenstellende e-mailadressen vermelden

Bewerkings-id:: ListConstituentEmailAddresses

Een lijst met de e-mailadressen voor een samenstellend onderdeel.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van het samenstellende onderdeel.
Inactief opnemen?	include_inactive		boolean	Niet-actieve e-mailadressen opnemen?

Retouren

E-mailadressen

Body: ConstituentApi.ApiCollectionOfEmailAddressRead

Samenstellende elementen vermelden

Bewerkings-id:: ListConstituents

Retourneert een lijst met bestanddelen.

Parameters

Name	Sleutel	Type	Description
List	list_id	string	Hiermee definieert u een lijst-id die wordt gebruikt om de set samenstellende elementen te filteren op die in de opgegeven lijst zijn opgenomen. Als deze waarde is ingesteld, worden andere opgegeven filters genegeerd.
Limit	limit	integer	Geeft het aantal records weer dat moet worden geretourneerd. De standaardwaarde is 500. Het maximum is 5000.
Offset	offset	integer	Geeft het aantal records aan dat moet worden overgeslagen. Voor gebruik met paginering.
Samenstellende code	constituent_code	string	Vertegenwoordigt een samenstellende code om de lijst te filteren. 'Board Member' retourneert bijvoorbeeld alleen samenstellende elementen met een code van een lid van de raad van bestuur.
Samenstellende id	constituent_id	string	Vertegenwoordigt een door komma's gescheiden lijst met samenstellende systeemrecord-id's om de resultaten te filteren. '280.1232' retourneert bijvoorbeeld alleen samenstellend 280 of samenstellend 1232.
Categorie aangepast veld	custom_field_category	string	Vertegenwoordigt een aangepaste veldcategorie om de resultaten te filteren. 'Jubileum' retourneert bijvoorbeeld alleen samenstellende elementen met een actief aangepast veld voor jubileum.
Inzamelingsstatus	fundraiser_status	string	Vertegenwoordigt een door komma's gescheiden lijst met inzamelingsstatussen om de resultaten te filteren. Bijvoorbeeld: 'Actief,Geen' retourneert alleen samenstellende elementen waarvan de inzamelingsstatus Actief of Geen is. Geldige waarden voor dit filter zijn Actief, Inactief en Geen.
Inclusief overledene?	include_deceased	boolean	Voeg overleden kiezers toe aan het antwoord?
Inactief opnemen?	include_inactive	boolean	Inactieve componenten opnemen in het antwoord?
Postcode	postal_code	string	Vertegenwoordigt een door komma's gescheiden lijst met postcodes om de resultaten te filteren. "29466.29492" retourneert bijvoorbeeld alleen samenstellende elementen waarvan het voorkeursadres een postcode heeft die begint met 29466 of 29492, zoals 29466, 29492 of 29492-0727.
Toegevoegd aan of na	date_added	date-time	Filter de resultaten op samenstellende elementen die zijn gemaakt op of na de opgegeven datum (bijvoorbeeld: '2020-09-18T04:13:56Z').
Gewijzigd op of na	last_modified	date-time	Filter de resultaten op onderdelen die zijn gewijzigd op of na de opgegeven datum (bijvoorbeeld: '2020-09-18T04:13:56Z').
Gesorteerd op	sort	string	Vertegenwoordigt een lijst met velden om de resultaten te sorteren. De resultaten zijn standaard in oplopende volgorde en een teken '-' geeft aflopende volgorde aan. Met 'date_added,-last' worden bijvoorbeeld samenstellen gesorteerd op het veld 'date_added' in oplopende volgorde en vervolgens op het veld 'laatste' in aflopende volgorde.

Retouren

Kiezers

Body: ConstituentApi.ApiCollectionOfConstituentRead

Samenstellende lidmaatschappen vermelden

Bewerkings-id:: ListConstituentMemberships

Geeft een lijst weer van de lidmaatschappen voor een samenstellend lid.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van het samenstellende onderdeel.

Retouren

Lidmaatschappen

Body: ConstituentApi.ApiCollectionOfMembershipRead

Samenstellende notities vermelden

Bewerkings-id:: ListConstituentNotes

Geeft een lijst weer van de notities voor een samenstellend onderdeel.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van het samenstellende onderdeel.

Retouren

Opmerkingen

Body: ConstituentApi.ApiCollectionOfNoteRead

Samenstellende onderwijslijsten vermelden

Bewerkings-id:: ListConstituentEducations

Geeft een lijst weer van de opleidingsrecords voor een samenstellend onderdeel.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van het samenstellende onderdeel.

Retouren

Opleidingen

Body: ConstituentApi.ApiCollectionOfEducationRead

Samenstellende online aanwezigheidsstatussen vermelden

Bewerkings-id:: ListConstituentOnlinePresences

Geeft een lijst weer van de online aanwezigheid voor een samenstellende gebruiker.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van het samenstellende onderdeel.
Inactief opnemen?	include_inactive		boolean	Inactieve online aanwezigheidsgegevens opnemen?

Retouren

Online aanwezigheidsgegevens

Body: ConstituentApi.ApiCollectionOfOnlinePresenceRead

Samenstellende relaties vermelden

Bewerkings-id:: ListConstituentRelationships

Geeft een lijst weer van de relaties voor een samenstellend onderdeel.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van het samenstellende onderdeel.
Limit	limit		integer	Geeft het aantal records weer dat moet worden geretourneerd. De standaardwaarde is 500. Er is geen maximum.
Offset	offset		integer	Geeft het aantal records aan dat moet worden overgeslagen. Voor gebruik met paginering.

Retouren

Relationships

Body: ConstituentApi.ApiCollectionOfRelationshipRead

Samenstellende telefoons vermelden

Bewerkings-id:: ListConstituentPhones

Geeft een lijst weer van de telefoons voor een samenstellend onderdeel.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van het samenstellende onderdeel.
Inactief opnemen?	include_inactive		boolean	Inactieve telefoons opnemen?

Retouren

Telefoons

Body: ConstituentApi.ApiCollectionOfPhoneRead

Samenstellende toestemmingsrecords vermelden

Bewerkings-id:: ListConstituentConsents

Geeft een lijst weer van de toestemmingsrecords voor een samenstellend onderdeel.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van het samenstellende onderdeel.
Alleen de meest recente?	most_recent_only		boolean	Alleen de meest recente toestemmingsrecords opnemen voor elke combinatie van kanaalcategorie in het antwoord?

Retouren

Toestemmingsrecords

Body: CommPrefApi.ConstituentConsentReadCollection

Samenvatting van indeling van samenstellende naam ophalen

Bewerkings-id:: GetConstituentNameFormatSummary

Retourneert de samenvatting van de naamnotatie voor een samenstellende waarde.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van het samenstellende onderdeel.

Retouren

Samenvatting van naamnotatie

Body: ConstituentApi.NameFormatSummaryRead

Zoeken naar dubbele bestanddelen

Bewerkings-id:: GetDuplicateSearchResults

Zoekt in afzonderlijke records, organisaties en gerelateerde contactpersonen en rangschikt potentiële duplicaten op basis van de opgegeven zoekfilters. Records die overeenkomen met meerdere filters rangschikken hoger als mogelijke duplicaten.

Parameters

Name	Sleutel	Vereist	Type	Description
Achternaam/organisatienaam	last_org_name	True	string	Een filter voor records die overeenkomen met de opgegeven achternaam of organisatienaam.
Voornaam	first_name		string	Een filter voor afzonderlijke records die overeenkomen met de opgegeven voornaam.
Middelste naam	middle_name		string	Een filter voor afzonderlijke records die overeenkomen met de opgegeven middelste naam.
Achtervoegsel	suffix		string	Een filter voor afzonderlijke records die overeenkomen met het opgegeven achtervoegsel.
Adresblok	address_block		string	Een filter voor records die overeenkomen met het opgegeven adresblok.
City	city		string	Een filter voor records die overeenkomen met de opgegeven plaats.
Staat	state		string	Een filter voor records die overeenkomen met de opgegeven status.
Postcode	post_code		string	Een filter voor records die overeenkomen met de opgegeven postcode.
E-mailen	email		array	Een filter voor records die overeenkomen met de opgegeven e-mailadressen.
Telefoon	phone		array	Een filter voor records die overeenkomen met de opgegeven telefoonnummers.
Personen zoeken?	search_individuals		boolean	Zoeken naar dubbele afzonderlijke records?
Zoekaliassen?	search_aliases		boolean	Zoeken op de alias, zoals opgegeven door de parameter Last/org name?
Contactpersonen zoeken?	search_contacts		boolean	Records van contactpersonen zoeken in relaties?
Limit	limit		integer	Het aantal records dat moet worden geretourneerd bij het wisselen van resultaten (Standaard = 3).
Offset	offset		integer	Het aantal records dat moet worden overgeslagen bij het wisselen van resultaten.

Retouren

Dubbele zoekresultaten

Body: ConstituentApi.DuplicateSearchResultCollection

Zoeken naar een samenstellend onderdeel (uitgebreid)

Bewerkings-id:: SearchConstituentEnhanced

Zoekt naar samenstellende records met behulp van de opgegeven filtercriteria.

Parameters

Name	Sleutel	Type	Description
Voornaam	first_name	string	Samenstellende voornaam.
Achternaam	last_name	string	Achternaam samenstellen.
Opzoek-id	lookup_id	string	Samenstellende opzoek-id.
E-mailadres	email	string	Samenstellend e-mailadres.
Telefoonnummer	phone_number	string	Telefoonnummer.
Limit	limit	integer	Geeft het aantal records weer dat moet worden geretourneerd. De standaardwaarde is 500. Het maximum is 1000.
Adresregels	address_lines	string	Adresregels.
City	city	string	Plaats van adres.
Staat	state	string	Adresstatus.
Postcode	post_code	string	Postcode.
Alias opnemen?	include_alias	boolean	Alias opnemen bij het zoeken op achternaam?
Aliastype	alias_type	string	Aliastype.
Inclusief meisjesnaam?	include_maiden_name	boolean	Wilt u een meisjesnaam opnemen bij het zoeken op achternaam?

Retouren

Kiezers

Body: NXTDataIntegrationApi.ConstituentSearchResultCollection

Definities

CommPrefApi.ConstituentConsentRead

Vertegenwoordigt een toestemmingsentiteit voor een samenstellende entiteit.

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van de toestemmingsrecord.
Channel	channel	string	Het kanaal waarop het toestemmingsantwoord van toepassing is.
Categorie	category	string	De categorie waarop het toestemmingsantwoord van toepassing is.
Bron	source	string	De bron van het toestemmingsantwoord van de samenstellende gebruiker.
Reactie	constituent_consent_response	string	Hoe de samenstellende functie heeft gereageerd op toestemming voor het opgegeven kanaal/de opgegeven categorie.
Datum	consent_date	date-time	De datum waarop het toestemmingsantwoord is ontvangen.
Toestemmingsverklaring	consent_statement	string	De verklaring waarop de samenstellende gebruiker heeft gereageerd bij het verstrekken van toestemming.
Privacyverklaring	privacy_notice	string	De privacyverklaring die aan de samenstellende gebruiker is verstrekt.
Datum toegevoegd	date_added	date-time	De datum waarop het toestemmingsantwoord is toegevoegd.
Toegevoegd door	user_name	string	De gebruiker die het toestemmingsantwoord heeft toegevoegd.

CommPrefApi.ConstituentConsentReadCollection

Toestemmingsrecords

Name	Pad	Type	Description
Aantal	count	integer	Het aantal toestemmingsrecords in de lijst.
waarde	value	array of CommPrefApi.ConstituentConsentRead	De set toestemmingsrecords die zijn opgenomen in het antwoord.

CommPrefApi.ConstituentSolicitCodeRead

Code aanvragen

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van de kiescode.
Code aanvragen	solicit_code	string	Communicatie-instructies en/of beperkingen voor een samenstellend onderdeel.
Begindatum	start_date	date	De begindatum van de aanvraagcode (bijvoorbeeld: '2005-09-18').
Einddatum	end_date	date	De einddatum van de aanvraagcode (bijvoorbeeld: '2005-09-18').

CommPrefApi.ConstituentSolicitCodeReadCollection

Vraagcodes

Name	Pad	Type	Description
Aantal	count	integer	Het aantal kiescodes in de lijst.
waarde	value	array of CommPrefApi.ConstituentSolicitCodeRead	De set samenstellende advocaatcodes die in het antwoord zijn opgenomen.

CommPrefApi.CreatedConstituentConsent

Samenstellende toestemming gemaakt

Name	Pad	Type	Description
ID-kaart	id	string	De id van de zojuist gemaakte toestemmingsrecord.

CommPrefApi.CreatedConstituentSolicitCode

Samengestelde advocaatcode gemaakt

Name	Pad	Type	Description
ID-kaart	id	string	De id van de zojuist gemaakte kiescode.

ConstituentApi.AddressRead

Adres

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van het adres.
Typologie	type	string	Het adrestype.
Country	country	string	Het land van het adres (kan de id, naam of afkorting zijn).
Adresregels	address_lines	string	De adresregels.
City	city	string	De plaats van het adres (gebruik niet in combinatie met het veld Buitenwijk).
Staat	state	string	De status van het adres.
Postcode	postal_code	string	De postcode van het adres.
Voorstad	suburb	string	De buitenwijk van het adres (gebruik niet in combinatie met het veld Plaats).
Regio	county	string	De provincie van het adres.
Opgemaakt adres	formatted_address	string	Het opgemaakte adres in de geconfigureerde indeling van het land.
Informatiebron	information_source	string	De informatiebron voor het adres.
Regio	region	string	De regio voor het adres.
KAR	cart	string	De vervoerdersroute (CART) voor het adres.
LOT	lot	string	De reisregel (LOT) voor het adres.
DPC	dpc	string	De afleverpuntcode (DPC) voor het adres.
Geldig vanaf	start	date-time	De datum waarop de samenstelling op dit adres begon te wonen.
Geldig voor	end	date-time	De datum waarop het samenstellende onderdeel niet meer op dit adres is gevestigd.
Primair?	preferred	boolean	Is dit het voorkeursadres van de kiezers?
Inactief?	inactive	boolean	Is het adres inactief (wat betekent dat de huidige datum vóór een einddatum valt)?
Geen e-mail?	do_not_mail	boolean	Kan de samenstellende persoon op dit adres contact opnemen?
day	seasonal_start.d	integer	De dag in de fuzzy datum.
maand	seasonal_start.m	integer	De maand op de fuzzy datum.
jaar	seasonal_start.y	integer	Het jaar op de fuzzy datum.
day	seasonal_end.d	integer	De dag in de fuzzy datum.
maand	seasonal_end.m	integer	De maand op de fuzzy datum.
jaar	seasonal_end.y	integer	Het jaar op de fuzzy datum.
Datum toegevoegd	date_added	date-time	De datum waarop het adres is gemaakt.
Datum gewijzigd	date_modified	date-time	De datum waarop het adres voor het laatst is gewijzigd.

ConstituentApi.AliasRead

Alias

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van de alias.
Alias	name	string	De naam die moet worden gebruikt als de alias van het samenstellende onderdeel.
Typologie	type	string	Het aliastype.

ConstituentApi.ApiCollectionOfAddressRead

Addresses

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of ConstituentApi.AddressRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

ConstituentApi.ApiCollectionOfAliasRead

Aliases

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of ConstituentApi.AliasRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

ConstituentApi.ApiCollectionOfConstituentAttachmentRead

Bijlagen

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of ConstituentApi.ConstituentAttachmentRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

ConstituentApi.ApiCollectionOfConstituentCodeRead

Samenstellende codes

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of ConstituentApi.ConstituentCodeRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

ConstituentApi.ApiCollectionOfConstituentCustomFieldRead

Aangepaste velden

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of ConstituentApi.ConstituentCustomFieldRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

ConstituentApi.ApiCollectionOfConstituentRead

Kiezers

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of ConstituentApi.ConstituentRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

ConstituentApi.ApiCollectionOfEducationRead

Opleidingen

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of ConstituentApi.EducationRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

ConstituentApi.ApiCollectionOfEmailAddressRead

E-mailadressen

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of ConstituentApi.EmailAddressRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

ConstituentApi.ApiCollectionOfFundraiserAssignmentRead

Inzamelingsopdrachten

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of ConstituentApi.FundraiserAssignmentRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

ConstituentApi.ApiCollectionOfMembershipRead

Lidmaatschappen

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of ConstituentApi.MembershipRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

ConstituentApi.ApiCollectionOfNoteRead

Opmerkingen

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of ConstituentApi.NoteRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

ConstituentApi.ApiCollectionOfOnlinePresenceRead

Online aanwezigheidsgegevens

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of ConstituentApi.OnlinePresenceRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

ConstituentApi.ApiCollectionOfPhoneRead

Telefoons

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of ConstituentApi.PhoneRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

ConstituentApi.ApiCollectionOfRelationshipRead

Relationships

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of ConstituentApi.RelationshipRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

ConstituentApi.ApiCollectionOfSearchResultRead

Zoekresultaten

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of ConstituentApi.SearchResultRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

ConstituentApi.ConstituentAttachmentRead

Attachment

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van de bijlage.
Samenstellende id	parent_id	string	De systeemrecord-id van het samenstellende onderdeel dat aan de bijlage is gekoppeld.
Typologie	type	string	Het bijlagetype. Fysieke bijlagen zijn geüploade bestanden, zoals afbeeldingen, PDF-bestanden of Word-documenten die lokaal of op het netwerk worden opgeslagen. Ze worden opgeslagen en beheerd in het systeem. Koppelingsbijlagen zijn koppelingen naar bestanden zoals afbeeldingen, blogberichten of YouTube-video's die online of in een cloudopslagaccount zijn. Ze worden extern opgeslagen en beheerd.
Naam	name	string	De naam van de bijlage. Tekenlimiet: 150.
Datum	date	date-time	De datum van de bijlage.
URL	url	string	De URL voor de bijlage. Dit is vereist voor koppelingsbijlagen en niet van toepassing op fysieke bijlagen.
Bestandsnaam	file_name	string	De naam van het bestand. Tekenlimiet: 36. Alleen voor fysieke bijlagen.
Bestands-id	file_id	string	De id van het bestand. Tekenlimiet: 36. Alleen voor fysieke bijlagen.
Miniatuur-id	thumbnail_id	string	De id van de miniatuur. Tekenlimiet: 36. Alleen voor fysieke bijlagen.
Miniatuur-URL	thumbnail_url	string	De URL voor een miniatuur. Voor fysieke bijlagen die alleen afbeeldingen zijn. Bevat een tijdsgebonden handtekening waarmee de toegang tot 60 minuten wordt beperkt.
Inhoudstype	content_type	string	Het inhoudstype. Alleen voor fysieke bijlagen.
Bestandsgrootte	file_size	integer	De bestandsgrootte in bytes. Alleen voor fysieke bijlagen.
Tags	tags	array of string	De tags die aan de bijlage zijn gekoppeld.

ConstituentApi.ConstituentCodeRead

Samenstellende code

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van de samenstellende code.
Samenstellende id	constituent_id	string	De systeemrecord-id van de samenstellende component die is gekoppeld aan de samenstellende code.
Samenstellende code	description	string	De samenstellende code.
day	start.d	integer	De dag in de fuzzy datum.
maand	start.m	integer	De maand op de fuzzy datum.
jaar	start.y	integer	Het jaar op de fuzzy datum.
day	end.d	integer	De dag in de fuzzy datum.
maand	end.m	integer	De maand op de fuzzy datum.
jaar	end.y	integer	Het jaar op de fuzzy datum.
Inactief?	inactive	boolean	Is de samenstellende code inactief?
Sequentie	sequence	integer	De numerieke reeks die is gekoppeld aan de samenstellende code.
Datum toegevoegd	date_added	date-time	De datum waarop de samenstellende code is gemaakt.
Datum gewijzigd	date_modified	date-time	De datum waarop de samenstellende code voor het laatst is gewijzigd.

ConstituentApi.ConstituentCustomFieldRead

Aangepast veld

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van het aangepaste veld.
Samenstellende id	parent_id	string	De systeemrecord-id van de samenstellende waarde die is gekoppeld aan het aangepaste veld.
Categorie	category	string	De categorie van het aangepaste veld.
Typologie	type	string	Het type gegevens dat het aangepaste veld vertegenwoordigt.
Waarde	value		De waarde van het aangepaste veld.
Tekstwaarde	text_value	string	De tekstwaarde van het aangepaste veld.
Getalwaarde	number_value	integer	De numerieke waarde van het aangepaste veld.
Datumwaarde	date_value	date	De datumwaarde van het aangepaste veld.
Valutawaarde	currency_value	double	De valutawaarde van het aangepaste veld.
Booleaanse waarde	boolean_value	boolean	De booleaanse waarde van het aangepaste veld.
Tabelinvoerwaarde	codetableentry_value	string	De tabelinvoerwaarde van het aangepaste veld.
Waarde voor samenstellende id	constituentid_value	string	De waarde van de samenstellende id van het aangepaste veld.
day	fuzzydate_value.d	integer	De dag in de fuzzy datum.
maand	fuzzydate_value.m	integer	De maand op de fuzzy datum.
jaar	fuzzydate_value.y	integer	Het jaar op de fuzzy datum.
Datum	date	date	De datum in het aangepaste veld.
Comment	comment	string	De opmerking over het aangepaste veld. Tekenlimiet: 50.
Datum toegevoegd	date_added	date-time	De datum waarop het aangepaste veld is gemaakt.
Datum gewijzigd	date_modified	date-time	De datum waarop het aangepaste veld voor het laatst is gewijzigd.

ConstituentApi.ConstituentRead

Bestanddeel

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id voor de samenstellende component. Dit is niet hetzelfde als de door de gebruiker gedefinieerde samenstellende id, die is opgeslagen in de lookup_id.
Typologie	type	string	Het type samenstellen.
Title	title	string	De primaire titel van de samenstellende persoon (alleen voor personen).
Voornaam	first	string	De voornaam van de samenstellende persoon (alleen voor personen).
Achternaam	last	string	De achternaam van de samenstellende persoon (alleen voor personen).
Naam	name	string	Voor personen is dit veld de volledige naam van het onderdeel op basis van de weergavenaaminstellingen van de doelorganisatie. Voor organisaties is dit de naam van de organisatie.
Voorkeursnaam	preferred_name	string	De voorkeursnaam van de samenstellende persoon (alleen voor personen).
Achtervoegsel	suffix	string	Het primaire achtervoegsel van het samenstellende onderdeel (alleen voor personen).
Opzoek-id	lookup_id	string	De door de gebruiker gedefinieerde id voor de samenstellende gebruiker.
ID-kaart	email.id	string	De systeemrecord-id van het e-mailadres.
type	email.type	string	Het type e-mailadres.
address	email.address	string	Het e-mailadres.
geen e-mail verzenden?	email.do_not_email	boolean	Kan de samenstellende persoon contact opnemen via dit e-mailadres?
inactief?	email.inactive	boolean	Is dit e-mailadres inactief?
datum toegevoegd	email.date_added	date-time	De datum waarop het e-mailadres is gemaakt.
datum gewijzigd	email.date_modified	date-time	De datum waarop het e-mailadres voor het laatst is gewijzigd.
ID-kaart	phone.id	string	De systeemrecord-id van de telefoon.
type	phone.type	string	Het telefoontype.
nummer	phone.number	string	Het telefoonnummer.
niet bellen?	phone.do_not_call	boolean	Kan de samenstellende persoon contact opnemen met dit nummer?
inactief?	phone.inactive	boolean	Is dit telefoonnummer inactief?
datum toegevoegd	phone.date_added	date-time	De datum waarop de telefoon is gemaakt.
datum gewijzigd	phone.date_modified	date-time	De datum waarop de telefoon voor het laatst is gewijzigd.
ID-kaart	online_presence.id	string	De systeemrecord-id van de online aanwezigheid.
type	online_presence.type	string	Het online aanwezigheidstype.
verbinden	online_presence.address	string	Het webadres voor de online aanwezigheid.
inactief?	online_presence.inactive	boolean	Is deze online aanwezigheid inactief?
datum toegevoegd	online_presence.date_added	date-time	De datum waarop de online aanwezigheid is gemaakt.
datum gewijzigd	online_presence.date_modified	date-time	De datum waarop de online aanwezigheid voor het laatst is gewijzigd.
ID-kaart	address.id	string	De systeemrecord-id van het adres.
type	address.type	string	Het adrestype.
country	address.country	string	Het land van het adres (kan de id, naam of afkorting zijn).
lijnen	address.address_lines	string	De adresregels.
city	address.city	string	De plaats van het adres (gebruik niet in combinatie met het veld Buitenwijk).
state	address.state	string	De status van het adres.
postcode	address.postal_code	string	De postcode van het adres.
voorstad	address.suburb	string	De buitenwijk van het adres (gebruik niet in combinatie met het veld Plaats).
graafschap	address.county	string	De provincie van het adres.
Geformatteerd	address.formatted_address	string	Het opgemaakte adres in de geconfigureerde indeling van het land.
geldig vanaf	address.start	date-time	De datum waarop de samenstelling op dit adres begon te wonen.
geldig tot	address.end	date-time	De datum waarop het samenstellende onderdeel niet meer op dit adres is gevestigd.
inactief?	address.inactive	boolean	Is het adres inactief (wat betekent dat de huidige datum vóór een einddatum valt)?
niet mailen?	address.do_not_mail	boolean	Kan de samenstellende persoon op dit adres contact opnemen?
day	address.seasonal_start.d	integer	De dag in de fuzzy datum.
maand	address.seasonal_start.m	integer	De maand op de fuzzy datum.
jaar	address.seasonal_start.y	integer	Het jaar op de fuzzy datum.
day	address.seasonal_end.d	integer	De dag in de fuzzy datum.
maand	address.seasonal_end.m	integer	De maand op de fuzzy datum.
jaar	address.seasonal_end.y	integer	Het jaar op de fuzzy datum.
datum toegevoegd	address.date_added	date-time	De datum waarop het adres is gemaakt.
datum gewijzigd	address.date_modified	date-time	De datum waarop het adres voor het laatst is gewijzigd.
Geslacht	gender	string	Het geslacht van de kiezer (alleen voor individuen).
Middelste naam	middle	string	De middelste naam van de samenstellende persoon (alleen voor personen).
Voormalige naam	former_name	string	De vroegere naam van de samenstellende persoon (alleen voor personen).
Titel 2	title_2	string	De secundaire titel van het samenstellende onderdeel (alleen voor personen).
Achtervoegsel 2	suffix_2	string	Het secundaire achtervoegsel van het samenstellende onderdeel (alleen voor personen).
Huwelijkse staus	marital_status	string	De burgerlijke staat van het kiesdistrict (alleen voor individuen).
Geeft anoniem?	gives_anonymously	boolean	Geeft de kiezer anoniem?
Geen e-mail aanvragen?	requests_no_email	boolean	Heeft de samenstellende aanvraag geen e-mail?
Is een advocaat?	is_solicitor	boolean	Is de kiezer een advocaat?
Geen geldige adressen?	no_valid_address	boolean	Heeft de samenstelling geen geldige adressen?
Inactief?	inactive	boolean	Is de samenstellende component inactief?
day	birthdate.d	integer	De dag in de fuzzy datum.
maand	birthdate.m	integer	De maand op de fuzzy datum.
jaar	birthdate.y	integer	Het jaar op de fuzzy datum.
Geboorteplaats	birthplace	string	De geboorteplaats van het kiesdistrict (alleen voor individuen).
Etniciteit	ethnicity	string	De etniciteit van de kiezers (alleen voor individuen).
Doel	target	string	Het doel van het samenstellende onderdeel.
Inkomsten	income	string	Het inkomen voor de samenstellende persoon (alleen voor individuen).
Ontvangstbewijstype	receipt_type	string	Het ontvangstbewijstype van het samenstellende onderdeel.
Godsdienst	religion	string	De godsdienst van het kiesdistrict (alleen voor individuen).
Industrie	industry	string	De bedrijfstak van het samenstellende onderdeel (alleen voor organisaties).
Aantal werknemers	num_employees	integer	Het aantal werknemers in de organisatie.
Komt overeen met cadeaus?	matches_gifts	boolean	Komt de organisatie overeen met cadeaus?
Overeenkomende cadeaufactor	matching_gift_factor	double	De overeenkomende cadeaufactor (alleen voor organisaties).
waarde	matching_gift_per_gift_min.value	double	De waarde van het bedrag.
waarde	matching_gift_per_gift_max.value	double	De waarde van het bedrag.
waarde	matching_gift_total_min.value	double	De waarde van het bedrag.
waarde	matching_gift_total_max.value	double	De waarde van het bedrag.
Overeenkomende cadeaunotities	matching_gift_notes	string	De overeenkomende cadeaunotities voor de samenstellende waarde (alleen voor organisaties).
Leeftijd	age	integer	De leeftijd van de samenstellende waarde, zoals berekend op basis van de eigenschap geboortedatum (alleen voor personen).
Overleden?	deceased	boolean	Is de kiezer overleden (alleen voor individuen)?
day	deceased_date.d	integer	De dag in de fuzzy datum.
maand	deceased_date.m	integer	De maand op de fuzzy datum.
jaar	deceased_date.y	integer	Het jaar op de fuzzy datum.
Inzamelingsstatus	fundraiser_status	string	Geeft aan of de samenstellende persoon een inzamelingsactie is (alleen voor personen).
Is herdenking?	is_memorial	boolean	Is de samenstellende een eer/herdenking?
ID-kaart	spouse.id	string	De systeemrecord-id van de echtgenoot.
voornaam	spouse.first	string	De voornaam van de echtgenoot.
achternaam	spouse.last	string	De achternaam van de echtgenoot.
Is het hoofd van het huishouden?	spouse.is_head_of_household	boolean	Is de echtgenoot het hoofd van het huishouden?
Datum toegevoegd	date_added	date-time	De datum waarop de samenstellende component is gemaakt.
Datum gewijzigd	date_modified	date-time	De datum waarop de samenstelling voor het laatst is gewijzigd.

ConstituentApi.ConvertedConstituent

Geconverteerde samenstellende elementen

Name	Pad	Type	Description
ID-kaart	id	string	De id van het geconverteerde onderdeel.

ConstituentApi.CreatedConstituentAddress

Samengesteld adres gemaakt

Name	Pad	Type	Description
ID-kaart	id	string	De id van het zojuist gemaakte samenstellende adres.

ConstituentApi.CreatedConstituentAlias

Samengestelde alias

Name	Pad	Type	Description
ID-kaart	id	string	De id van de zojuist gemaakte samenstellende alias.

ConstituentApi.CreatedConstituentAttachment

Samengestelde bijlage gemaakt

Name	Pad	Type	Description
ID-kaart	id	string	De id van de zojuist gemaakte bijlage.

ConstituentApi.CreatedConstituentCode

Samengestelde code

Name	Pad	Type	Description
ID-kaart	id	string	De id van de zojuist gemaakte samenstellende code.

ConstituentApi.CreatedConstituentCustomField

Aangepast veld gemaakt

Name	Pad	Type	Description
ID-kaart	id	string	De id van het zojuist gemaakte aangepaste veld.

ConstituentApi.CreatedConstituentEducation

Samengesteld onderwijs

Name	Pad	Type	Description
ID-kaart	id	string	De id van het nieuw gecreëerde samenstellende onderwijs.

ConstituentApi.CreatedConstituentEmailAddress

Gemaakt e-mailadres

Name	Pad	Type	Description
ID-kaart	id	string	De id van het zojuist gemaakte e-mailadres.

ConstituentApi.CreatedConstituentNote

Samengestelde notitie

Name	Pad	Type	Description
ID-kaart	id	string	De id van de zojuist gemaakte samenstellende notitie.

ConstituentApi.CreatedConstituentOnlinePresence

Samengestelde online aanwezigheid

Name	Pad	Type	Description
ID-kaart	id	string	De id van de zojuist gemaakte online aanwezigheid.

ConstituentApi.CreatedConstituentPhone

Samengestelde telefoon

Name	Pad	Type	Description
ID-kaart	id	string	De id van de zojuist gemaakte telefoon.

ConstituentApi.CreatedIndividualConstituent

Afzonderlijke samenstellende elementen gemaakt

Name	Pad	Type	Description
ID-kaart	id	string	De id van de zojuist gemaakte afzonderlijke samenstellende.

ConstituentApi.CreatedIndividualRelationship

Afzonderlijke relatie gemaakt

Name	Pad	Type	Description
ID-kaart	id	string	De id van de zojuist gemaakte afzonderlijke relatie.

ConstituentApi.CreatedNameFormat

Naamnotatie gemaakt

Name	Pad	Type	Description
ID-kaart	id	string	De id van de zojuist gemaakte naamindeling.

ConstituentApi.CreatedOrganizationConstituent

Samenstellende organisatie

Name	Pad	Type	Description
ID-kaart	id	string	De id van het zojuist gemaakte organisatieonderdeel.

ConstituentApi.CreatedOrganizationRelationship

Organisatierelatie gemaakt

Name	Pad	Type	Description
ID-kaart	id	string	De id van de zojuist gemaakte organisatierelatie.

ConstituentApi.DuplicateSearchResult

Dubbele zoekresultaten

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id voor de samenstellende component.
Naam	name	string	De naam van de samenstellende naam. Voor personen geeft dit berekende veld de volledige naam van het samenstellende onderdeel aan op basis van de weergavenaaminstellingen van de doelorganisatie.
Weergavenaam	display_name	string	De weergavenaam van het samenstellende onderdeel.
Adres	formatted_address	string	Het opgemaakte primaire adres voor de samenstellende component.
Overleden?	deceased	boolean	Is de kiezer overleden?
Is een kieskerende?	is_constituent	boolean	Is de record een samenstellend onderdeel?
Opzoek-id	constituent_id	string	De door de gebruiker gedefinieerde id voor de samenstellende gebruiker.
Datum toegevoegd	date_added	date-time	De datum waarop het samenstellende onderdeel is toegevoegd.
Rang	rank	string	De zoekrang die aangeeft waarop de samenstellende waarde overeenkomt.

ConstituentApi.DuplicateSearchResultCollection

Dubbele zoekresultaten

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of ConstituentApi.DuplicateSearchResult	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

ConstituentApi.EducationRead

Education

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van het onderwijs.
Samenstellende id	constituent_id	string	De systeemrecord-id van de samenstellende elementen die aan het onderwijs zijn gekoppeld.
School	school	string	De naam van de school/vestiging.
Typologie	type	string	Het type onderwijs.
Klasse van	class_of	string	Het jaar dat de kiezer afstudeerde.
Toestand	status	string	De status van het onderwijs.
day	date_entered.d	integer	De dag in de fuzzy datum.
maand	date_entered.m	integer	De maand op de fuzzy datum.
jaar	date_entered.y	integer	Het jaar op de fuzzy datum.
day	date_left.d	integer	De dag in de fuzzy datum.
maand	date_left.m	integer	De maand op de fuzzy datum.
jaar	date_left.y	integer	Het jaar op de fuzzy datum.
day	date_graduated.d	integer	De dag in de fuzzy datum.
maand	date_graduated.m	integer	De maand op de fuzzy datum.
jaar	date_graduated.y	integer	Het jaar op de fuzzy datum.
Graad	degree	string	De graad ontvangen.
GPA	gpa	double	Het cijferpuntgemiddelde.
Majors	majors	array of string	De hoofdvakken van studie.
Minderjarigen	minors	array of string	De secundaire studiecursussen.
Is het basisonderwijs?	primary	boolean	Is dit de basisschoolvereniging van het kiesdistrict?
Campus	campus	string	De campus.
Sociale organisatie	social_organization	string	De sociale organisatie.
Bekende naam	known_name	string	De bekende naam.
Graadklasse	class_of_degree	string	De graadklasse.
Afdeling	department	string	De naam van de onderwijsafdeling.
Faculteit	faculty	string	De naam van de faculteit.
Registratienummer	registration_number	string	Het registratienummer.
Onderwerp van studie	subject_of_study	string	Het onderwerp van de studie.
Datum toegevoegd	date_added	date-time	De datum waarop het onderwijs is gemaakt.
Datum gewijzigd	date_modified	date-time	De datum waarop het onderwijs voor het laatst is gewijzigd.

ConstituentApi.EmailAddressRead

E-mailadres

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van het e-mailadres.
Samenstellende id	constituent_id	string	De systeemrecord-id van de samenstellende component die aan het e-mailadres is gekoppeld.
E-mailtype	type	string	Het type e-mailadres.
E-mailadres	address	string	Het e-mailadres.
Primair?	primary	boolean	Is dit het primaire e-mailadres van de samenstellende gebruiker?
Wilt u geen e-mail verzenden?	do_not_email	boolean	Kan de samenstellende persoon contact opnemen via dit e-mailadres?
Inactief?	inactive	boolean	Is dit e-mailadres inactief?
Datum toegevoegd	date_added	date-time	De datum waarop het e-mailadres is gemaakt.
Datum gewijzigd	date_modified	date-time	De datum waarop het e-mailadres voor het laatst is gewijzigd.

ConstituentApi.FundraiserAssignmentRead

Inzamelingstoewijzing

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van de inzamelingstoewijzing.
Samenstellende id	constituent_id	string	De systeemrecord-id van het onderdeel dat is toegewezen aan de inzamelingsactie.
Inzamelings-id	fundraiser_id	string	De systeemrecord-id van de inzamelingsactie.
Typologie	type	string	Het type inzamelingsactie.
waarde	amount.value	double	De monetaire waarde.
Campagne-id	campaign_id	string	De systeemrecord-id van de campagne om resulterende geschenken toe te passen.
Fonds-id	fund_id	string	De systeemrecord-id van het fonds alle resulterende geschenken moeten worden toegepast. Indien een beperkt fonds is geselecteerd, kunnen alleen campagnes en beroep die aan dat fonds zijn gekoppeld, worden geselecteerd.
Id van beroep	appeal_id	string	De systeemrecord-id van het beroep dat de inzamelingsactie moet gebruiken om geschenken aan te vragen.
Begindatum	start	date-time	De begindatum van de inzamelingsopdracht.
Einddatum	end	date-time	De einddatum van de inzamelingsopdracht.

ConstituentApi.MembershipMemberRead

Lid

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van het lid.
Samenstellende id	constituent_id	string	De systeemrecord-id van de samenstellende component die aan het lid is gekoppeld.
Is primair lid?	primary	boolean	Is dit het primaire lid?

ConstituentApi.MembershipRead

Membership

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van het lidmaatschap.
Samenstellende id	constituent_id	string	De systeemrecord-id van de samenstellende component die aan het lidmaatschap is gekoppeld.
Programma	program	string	Het lidmaatschapsprogramma.
Categorie	category	string	De lidmaatschapscategorie.
Subcategorie	subcategory	string	De subcategorie lidmaatschap.
Stand	standing	string	De lidmaatschapsstatus.
Verloopt	expires	date-time	De datum waarop het lidmaatschap verloopt.
Toegetreden	joined	date-time	De datum waarop het lidmaatschap actief wordt.
waarde	dues.value	double	De monetaire waarde.
Members	members	array of ConstituentApi.MembershipMemberRead	De set leden die deel uitmaken van het lidmaatschap.
Datum toegevoegd	date_added	date-time	De datum waarop het lidmaatschap is gemaakt.
Datum gewijzigd	date_modified	date-time	De datum waarop het lidmaatschap voor het laatst is gewijzigd.

ConstituentApi.NameFormatRead

Naamnotaties definiëren hoe u adresserende elementen in de communicatie kunt aanpakken. Hoe u verwijst naar personen stelt de toon van uw communicatie met hen in en hoe goed ze uw interacties ontvangen.

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van de naamnotatie.
type	type	string	Het type naamnotatie.
aangepaste indeling?	custom_format	boolean	Is dit een aangepaste indeling?
configuratie-id	configuration_id	string	De configuratie-id van de naamindeling (voor niet-aangepaste indelingen).
opgemaakte naam	formatted_name	string	De opgemaakte naam (voor aangepaste notaties).

ConstituentApi.NameFormatSummaryRead

Samenvatting van naamnotatie

Name	Pad	Type	Description
ID-kaart	primary_addressee.id	string	De systeemrecord-id van de naamnotatie.
type	primary_addressee.primary_type	string	Het type naamnotatie.
aangepaste indeling?	primary_addressee.custom_format	boolean	Is dit een aangepaste indeling?
configuratie-id	primary_addressee.configuration_id	string	De configuratie-id van de naamindeling (voor niet-aangepaste indelingen).
opgemaakte naam	primary_addressee.formatted_name	string	De opgemaakte naam (voor aangepaste notaties).
ID-kaart	primary_salutation.id	string	De systeemrecord-id van de naamnotatie.
type	primary_salutation.primary_type	string	Het type naamnotatie.
aangepaste indeling?	primary_salutation.custom_format	boolean	Is dit een aangepaste indeling?
configuratie-id	primary_salutation.configuration_id	string	De configuratie-id van de naamindeling (voor niet-aangepaste indelingen).
opgemaakte naam	primary_salutation.formatted_name	string	De opgemaakte naam (voor aangepaste notaties).
Aanvullende naamindelingen	additional_name_formats	array of ConstituentApi.NameFormatRead	De aanvullende naamnotaties van het samenstellende onderdeel.

ConstituentApi.NoteRead

Opmerking

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van de notitie.
Samenstellende id	constituent_id	string	De systeemrecord-id van de samenstellende component die aan de notitie is gekoppeld.
Typologie	type	string	Het type notitie.
day	date.d	integer	De dag in de fuzzy datum.
maand	date.m	integer	De maand op de fuzzy datum.
jaar	date.y	integer	Het jaar op de fuzzy datum.
Samenvatting	summary	string	De samenvatting van de notitie.
Opmerking	text	string	De notitietekst.
Datum toegevoegd	date_added	date-time	De datum waarop de notitie is gemaakt.
Datum gewijzigd	date_modified	date-time	De datum waarop de notitie voor het laatst is gewijzigd.

ConstituentApi.OnlinePresenceRead

Online aanwezigheid

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van de online aanwezigheid.
Samenstellende id	constituent_id	string	De systeemrecord-id van de samenstellende component die is gekoppeld aan de online aanwezigheid.
Typologie	type	string	Het online aanwezigheidstype.
Link	address	string	Het webadres voor de online aanwezigheid.
Primair?	primary	boolean	Is dit de primaire online aanwezigheid van de samenstellende gebruiker?
Inactief?	inactive	boolean	Is deze online aanwezigheid inactief?
Datum toegevoegd	date_added	date-time	De datum waarop de online aanwezigheid is gemaakt.
Datum gewijzigd	date_modified	date-time	De datum waarop de online aanwezigheid voor het laatst is gewijzigd.

ConstituentApi.PhoneRead

Telefoon

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van de telefoon.
Samenstellende id	constituent_id	string	De systeemrecord-id van het samenstellende onderdeel dat aan de telefoon is gekoppeld.
Typologie	type	string	Het telefoontype.
Number	number	string	Het telefoonnummer.
Primair?	primary	boolean	Is dit de primaire telefoon van de samenstellende gebruiker?
Niet bellen?	do_not_call	boolean	Kan de samenstellende persoon contact opnemen met dit nummer?
Inactief?	inactive	boolean	Is dit telefoonnummer inactief?
Datum toegevoegd	date_added	date-time	De datum waarop de telefoon is gemaakt.
Datum gewijzigd	date_modified	date-time	De datum waarop de telefoon voor het laatst is gewijzigd.

ConstituentApi.ProfilePictureRead

Profielafbeelding

Name	Pad	Type	Description
Samenstellende id	constituent_id	string	De systeemrecord-id van het samenstellende onderdeel dat is gekoppeld aan de profielfoto.
URL	url	string	De URL voor de profielfoto. De URL bevat een tijdgebonden handtekening die de toegang tot 60 minuten beperkt.
Miniatuur-URL	thumbnail_url	string	De URL voor een miniatuur van de profielafbeelding. Bevat een tijdsgebonden handtekening waarmee de toegang tot 60 minuten wordt beperkt.

ConstituentApi.RelationshipRead

Relatie

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van de relatie.
Samenstellende id	constituent_id	string	De systeemrecord-id van de samenstellende component die aan de relatie is gekoppeld.
Relatie-id	relation_id	string	De systeemrecord-id van de gerelateerde persoon of organisatie.
Wederzijdse relatie-id	reciprocal_relationship_id	string	De id voor de wederzijdse relatierecord. Deze waarde is alleen-lezen en wordt automatisch gegenereerd wanneer de relatie wordt gemaakt. Wijzigingen die in deze record worden aangebracht, worden ook weerspiegeld in de wederkerigheid, met uitzondering van de eigenschap opmerkingen.
Naam	name	string	De naam van het gerelateerde onderdeel. Als de gerelateerde samenstellende persoon een persoon is, is dit de volledige naam van het onderdeel op basis van de weergavenaaminstellingen van de doelorganisatie.
Typologie	type	string	Het type relatie dat de relatie vertegenwoordigt.
Wederkerig type	reciprocal_type	string	Beschrijft de relatie van de samenstellende component met de gerelateerde component. Bijvoorbeeld, in een relatie tussen een mannelijke samenstellende en een vrouwelijke zus, zou het wederzijdse relatietype broer zijn.
day	start.d	integer	De dag in de fuzzy datum.
maand	start.m	integer	De maand op de fuzzy datum.
jaar	start.y	integer	Het jaar op de fuzzy datum.
day	end.d	integer	De dag in de fuzzy datum.
maand	end.m	integer	De maand op de fuzzy datum.
jaar	end.y	integer	Het jaar op de fuzzy datum.
Is echtgenoot?	is_spouse	boolean	Is de gerelateerde persoon de echtgenoot van het kiesdistrict (alleen van toepassing op relaties tussen individuen)?
Is het hoofd van het huishouden?	is_constituent_head_of_household	boolean	Is het hoofd van het huishouden?
Is het hoofd van de echtgenoot van het huishouden?	is_spouse_head_of_household	boolean	Is de echtgenoot het hoofd van het huishouden?
Opmerkingen	comment	string	De opmerking over de relatie.
Is het contact?	is_organization_contact	boolean	Vertegenwoordigt de samenstellende persoon deze organisatie als contactpersoon (alleen van toepassing op relaties tussen organisaties en personen)?
Is primair bedrijf?	is_primary_business	boolean	Is dit het primaire bedrijf van de samenstellende afdeling (alleen van toepassing op relaties tussen organisaties en individuen)?
Type contact	organization_contact_type	string	Biedt context voor interacties met de gerelateerde persoon die de organisatie vertegenwoordigt als contactpersoon. Alleen van toepassing op relaties tussen organisaties en individuen.
Position	position	string	De positie van de persoon in de organisatie. Alleen van toepassing op relaties tussen organisaties en individuen.
Datum toegevoegd	date_added	date-time	De datum waarop de relatie is gemaakt.
Datum gewijzigd	date_modified	date-time	De datum waarop de relatie voor het laatst is gewijzigd.

ConstituentApi.SearchResultRead

Zoekresultaat

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van het samenstellende onderdeel.
Naam	name	string	De naam van de samenstellende naam. Voor personen geeft dit berekende veld de volledige naam van het samenstellende onderdeel aan op basis van de weergavenaaminstellingen van de doelorganisatie.
Adres	address	string	Het voorkeursadres van de samenstellende kiezer.
Overleden?	deceased	boolean	Is de kiezer overleden?
E-mailen	email	string	Het e-mailadres van de samenstellende kiezer.
Inzamelingsstatus	fundraiser_status	string	De inzamelingsstatus van de kiezers. Voor personen geeft dit berekende veld aan of het samenstellende onderdeel actief, inactief of geen is. Voor organisaties is deze waarde altijd Geen.
Inactief?	inactive	boolean	Is de samenstellende component inactief?
Opzoek-id	lookup_id	string	De door de gebruiker gedefinieerde id voor de samenstellende gebruiker.

FondsenwervingApi.ApiCollectionOfFundraiserAssignmentRead

Assignments

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of FundraisingApi.FundraiserAssignmentRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

FondsenwervingApi.CreatedFundraiserAssignment

Inzamelingstoewijzing gemaakt

Name	Pad	Type	Description
ID-kaart	id	string	De id van de zojuist gemaakte inzamelingstoewijzing.

FondsenwervingApi.FundraiserAssignmentRead

Assignment

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van de inzamelingstoewijzing.
Samenstellende id	constituent_id	string	De systeemrecord-id van de toegewezen samenstellende component.
Typologie	type	string	Het inzamelingstype.
Opdracht wordt gestart	start	date-time	De begindatum van de opdracht.
Toewijzing eindigt	end	date-time	De einddatum van de opdracht.
waarde	amount.value	double	De monetaire waarde.
Campagne-id	campaign_id	string	De systeemrecord-id van de campagne waarop resulterende geschenken worden toegepast.
Fonds-id	fund_id	string	De systeemrecord-id van het fonds waarop resulterende geschenken zullen worden toegepast.
Id van beroep	appeal_id	string	De systeemrecord-id van het beroep waarop resulterende geschenken zullen worden toegepast.

NXTDataIntegrationApi.ConstituentIdMap

Toewijzing van samenstellende id's

Name	Pad	Type	Description
ID-kaart	system_record_id	integer	De record-id van het samenstellende systeem.

NXTDataIntegrationApi.ConstituentSearchResult

Zoekresultaat

Name	Pad	Type	Description
ID-kaart	record_id	integer	De systeemrecord-id van het samenstellende onderdeel.
Opzoek-id	constituent_id	string	De samenstellende id.
Sleutelindicator	key_indicator	string	De sleutelindicator voor de record.
Voornaam	first_name	string	De voornaam (alleen personen).
Achternaam	last_name	string	De achternaam (alleen personen).
Middelste naam	middle_name	string	De middelste naam (alleen personen).
Voorkeursnaam	preferred_name	string	De voorkeursnaam (alleen personen).
Voormalige naam	maiden_name	string	De voormalige naam (alleen personen).
Titel 1	title1	string	De titel 1 (alleen personen).
Achtervoegsel 1	suffix1	string	Het achtervoegsel 1 (alleen personen).
Geslacht	gender	string	Het samenstellende geslacht (alleen individuen).
day	birth_date.d	integer	De dag in de fuzzy datum.
maand	birth_date.m	integer	De maand op de fuzzy datum.
jaar	birth_date.y	integer	Het jaar op de fuzzy datum.
Voornaam van echtgenoot	spouse_first_name	string	De voornaam van de echtgenoot (alleen individuen).
Achternaam van echtgenoot	spouse_last_name	string	De achternaam van de echtgenoot (alleen individuen).
Organisatienaam	org_name	string	De naam van de organisatie (alleen organisaties).
Adresblok	address_block	string	Het adresblok.
Plaats en staat	address_city_state	string	De plaats en staat van het adres.
Postcode	address_post_code	string	De adrespostcode.
Primair e-mailadres	primary_email	string	Het primaire e-mailadres.
Primair telefoonnummer	primary_phone	string	De primaire telefoon.
Overeenkomende alias	matched_alias	string	De overeenkomende aliasnaam (alleen personen).
Overeenkomende e-mail	matched_email	string	Het overeenkomende e-mailadres.
Overeenkomende telefoon	matched_phone	string	Het overeenkomende telefoonnummer.
Is een kieskerende?	is_constituent	boolean	Is de record een samenstellend onderdeel?
Is overleden?	is_deceased	boolean	Is de record overleden?
Is inactief?	is_inactive	boolean	Is de record inactief?

NXTDataIntegrationApi.ConstituentSearchResultCollection

Kiezers

Name	Pad	Type	Description
results	results	array of NXTDataIntegrationApi.ConstituentSearchResult	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

NXTDataIntegrationApi.CreatedConstituentTribute

Gemaakt samenstellend eerbetoon

Name	Pad	Type	Description
ID-kaart	id	string	De id van het nieuw gecreëerde samenstellende eerbetoon.

NXTDataIntegrationApi.CreatedTributeAcknowledgee

Hulde bevestigd

Name	Pad	Type	Description
ID-kaart	id	string	De id van het nieuw gecreëerde eerbetoon erkent.

NXTDataIntegrationApi.Tribute

Schatting

Name	Pad	Type	Description
ID-kaart	id	integer	De systeemrecord-id van het eerbetoon.
Samenstellende id	constituent_record_id	integer	De systeemrecord-id van het samenstellende onderdeel dat aan het eerbetoon is gekoppeld.
Eerbetoontype	tribute_type_name	string	Het eerbetoontype.
Eerbetoon type id	tribute_type_id	integer	Het eerbetoon type ID.
Description	description	string	De eerbetoonsbeschrijving.
day	start_date.d	integer	De dag in de fuzzy datum.
maand	start_date.m	integer	De maand op de fuzzy datum.
jaar	start_date.y	integer	Het jaar op de fuzzy datum.
day	end_date.d	integer	De dag in de fuzzy datum.
maand	end_date.m	integer	De maand op de fuzzy datum.
jaar	end_date.y	integer	Het jaar op de fuzzy datum.
Standaardfonds-id	default_fund_id	integer	De systeemrecord-id van het standaardfonds dat aan het eerbetoon is gekoppeld.
Opmerkingen	notes	string	De eerbetoonnotities.
Actief?	is_active	boolean	Is dit eerbetoon actief?
Sequentie	sequence	integer	De eerbetoonreeks.
Datum toegevoegd	date_added	date-time	De datum waarop het eerbetoon werd gecreëerd.
Datum gewijzigd	date_modified	date-time	De datum waarop het eerbetoon voor het laatst is gewijzigd.

NXTDataIntegrationApi.TributeAcknowledgee

Eerbetoon bevestigen

Name	Pad	Type	Description
ID-kaart	id	integer	De systeemrecord-id van het eerbetoon erkent.
Eerbetoon-id	tribute_id	integer	De systeemrecord-id van het eerbetoon dat aan de bevestiging is gekoppeld.
Relatie-id	relationships_id	integer	De systeemrecord-id van de relatie (indien null, dit vertegenwoordigt een zelfbevestiging).
Brief-id	letter	integer	De letter-id.
Sequentie	sequence	integer	Het eerbetoon bevestigt de reeks.

NXTDataIntegrationApi.TributeAcknowledgeeCollection

Eerbetoon erkent

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of NXTDataIntegrationApi.TributeAcknowledgee	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

NXTDataIntegrationApi.TributeCollection

Tributes

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of NXTDataIntegrationApi.Tribute	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

Delen via

Blackbaud Raisers Edge NXT-componenten

Vereiste voorwaarden

Hoe kan ik referenties ophalen?

Bekende problemen en beperkingen

Beperkingslimieten

Acties

Aangepaste velden weergeven

Parameters

Retouren

Converteren naar samenstellend

Parameters

Retouren

De indeling van een primaire naam van een samenstellende primaire naam bijwerken

Parameters

De indeling van een samenstellende naam bijwerken

Parameters

Een aangepast veld maken

Parameters

Retouren

Een aangepast veld voor samenstellen bijwerken

Parameters

Een afzonderlijke relatie maken

Parameters

Retouren

Een afzonderlijke samenstellende component maken

Parameters

Retouren

Een code voor een samenstellend verzoek maken

Parameters

Retouren

Een eerbetoon bevestigen

Parameters

Retouren

Een indeling voor een samenstellende naam maken

Parameters

Retouren

Een inzamelingstoewijzing maken

Parameters

Retouren

Een organisatie samenstellen

Parameters

Retouren

Een organisatierelatie maken

Parameters

Retouren

Een primaire naamnotatie voor een samenstellende primaire naam maken

Parameters

Retouren

Een samenstellend adres bijwerken

Parameters

Een samenstellend adres maken

Parameters

Retouren

Een samenstellend e-mailadres bijwerken

Parameters

Een samenstellend e-mailadres maken

Parameters

Retouren

Een samenstellend eerbetoon krijgen

Parameters

Retouren

Een samenstellend eerbetoon maken

Parameters

Retouren

Een samenstellend onderwijs bijwerken

Parameters

Een samenstellend onderwijs maken

Parameters

Retouren

Een samenstellende advocaatcode bijwerken

Parameters

Een samenstellende alias bijwerken

Parameters

Een samenstellende alias maken

Parameters

Retouren

Een samenstellende bijlage bijwerken

Parameters

Een samenstellende bijlage maken