Constituent

A constituent, contact or organization member

A constituent record represents a member, donor, subscriber or other type of individual whose information is tracked in the Luminate Online database. A constituent record may include fields such as:

  1. name
  2. phone number(s)
  3. home address
  4. political districts (i.e. senator(s), representative)
  5. employment information (i.e. name of company, work address, work phone)
  6. educational background (i.e. name of college, year of graduation)
  7. relationships to other constituents (i.e. spouse, friend, boss)
  8. donation summary (i.e. total amount donated last year)
  9. interests (i.e. baby seals, global warming)
  10. group affiliations designated by the organization (i.e. Major Donors)
  11. custom fields defined by the organization (i.e. Political Party Affiliation)
Some fields in the Luminate Online constituent record are populated by the system and may not be modified by the client. For example, the system determines the congressional district automatically based on the constituent's street address. Other Constituent fields which are read-only via Web Services API are:
  • AffiliateAssignment
  • MatchedDonor
  • EmailOptInStatus
  • EmailStatus
  • HardBounceCount
  • SoftBounceCount
  • EngagementFactor1-10

Most fields in the constituent record have a single value. However, a constituent may belong to any number of groups and have any number of interests.

DataSync Web Services supports bidirectional synchronization of constituent records: when a record is added, updated or deleted in the client system, the web services can be used to make the same change in the Luminate Online database. Conversely, when a record is added, updated or deleted in the Luminate Online database (i.e. due to an online registration or profile change), the web services can be used to retrieve the change so that it can be made in the client system as well.

Fields

ConsId
nonNegativeInteger
The unique Luminate Online identifier for constituent records.
SiteId
nonNegativeInteger
The unique Luminate Online identifier for your site. Will have the same value for all records.
PredupStatus
string
Flag value indicating the state of the Constituent in the predup system. It can have 5 different states - match pending, matched, no matches, exception, and null.
AdminStatus
AdministratorStatus
Indicates whether this Constituent is an Administrator in the Luminate Online system
ConsName
Name
Constituent's name
UserName
normalizedString
Constituent's user name, supplied when logging into the Luminate Online system
CatId
normalizedString
Constituent's security category
MemberId
normalizedString
Unique ID assigned to the constituent by the client's registration system (client-defined). This field may be specified when a new record is created, or may be updated in an existing record. In the latter case, you must also provide a ConsId so the Constituent in question can be uniquely identified.
AffiliateCode
normalizedString
AffiliateAssignment
AffiliateAssignment
ExchangeId
normalizedString
OriginSrcCode
normalizedString
Source code for the Constituent record
OriginSubsrcCode
normalizedString
Sub-source code for the Constituent record
Active
ActiveStatus
Indicates whether the Constituent is registered user who can log in to the site
ActiveDetail
ActiveDetail
Flag providing additional detail on the Constituent's status; One of the following: Undefined, Unknown to Contact, Known to Contact, Accepted by Contact, Registered Contact, New Prospect, Interested Prospect, Removed by Administrator, Removed by Contact, Removed as Duplicate
Origin
Origin
Luminate Online feature through which Constituent initiated registration
OriginRefId
integer
DonorStatus
DonorStatus
Whether this Constituent has donated money to the site: Never, Undefined, Indirect, Direct, Unknown, Non-donor
MatchedDonor
boolean
Indicates whether any gifts made by this person are matched by an employer
CreationDate
dateTime
Timestamp indicating when the record was created
CreatedBy
integer
Constituent who created the record
ModifyDate
dateTime
Timestamp indicating when the record was last changed
LastChangeBy
integer
Constituent who last modified the record
LastLoginDate
dateTime
Date Constituent last logged in
UserPassword
normalizedString
Hexadecimal representation of Constituent's encrypted password, supplied when logging into the Luminate Online system
LastPasswordChangeDate
dateTime
Date the Constituent last changed his or her login password
PasswordType
PasswordType
The method used to generate the password: Undefined, DES (in the Luminate Online database, DES encrypted), LDAP (in an external database), Convio SHA (SHA-256 encrypted), Convio RSA
ReminderHint
normalizedString
Constituent's login password reminder hint
RegOptInNonce
decimal
Cookie
normalizedString
CookieSet
boolean
UploadChecksum
dateTime
Optionally stores a checksum for a set of fields when uploading Constituent data. Note the actual maximum value of this column is the same as a signed 64 bit number.
DownloadChecksum
dateTime
Optionally stores a checksum for a set of fields when downloading Constituent data. Note the actual maximum value of this column is the same as a signed 64 bit number.
DatasyncDate
dateTime
HomePhoneImportId
normalizedString
WorkPhoneImportId
normalizedString
MobilePhoneImportId
normalizedString
FaxPhoneImportId
normalizedString
PrimaryEmailImportId
normalizedString
SecondaryEmailImportId
normalizedString
HomeAddrImportId
normalizedString
WorkAddrImportId
normalizedString
OtherAddrImportId
normalizedString
EmployerAddrImportId
normalizedString
PrimaryBusinessOrgImportId
normalizedString
PrimaryBusinessRelLinkId
normalizedString
SoImportId
normalizedString
IndividualRelLink
normalizedString
ConsGender
normalizedString
Constituent's gender
BirthDate
dateTime
Constituent's date of birth
PrimaryEmail
normalizedString
Constituent's primary email address
AcceptsEmail
boolean
Indicates whether the Constituent will accept email from the site
PreferredEmailFormat
EmailFormat
Setting that determines if a participant has selected to receive emails that are HTML-formatted or in plain text
EmailOptOutNonce
decimal
EmailOptOutDate
dateTime
Timestamp that shows when a participant disabled the email Opt-In
EmailOptOutMethod
OptOutMethod
EmailOptOutRefId
integer
EmailStatus
EmailStatus
May be one of: Unknown, Good, Bad (soft bounce), Bad (hard bounce); set by the Email system based on results of Email Campaigns. Changes to this field by the system do not cause the record to appear in GetIncrementalUpdates.
HardBounceCount
integer
Count of the number of emails sent back as undeliverable because of an invalid email address
SoftBounceCount
integer
Total number of system emails returned to this user due to temporary mail server errors, such as Inbox Full. Emails returned due to soft bounce are re-tried by the system for two days. If the error condition persists, the Constituent's EmailStatus is updated and this count is incremented.
HomeAddress
Address
Constituent's home mailing address
StdHomeAddress
Address
The Constituent's home address, used by the Advocacy application as the Constituent's legal place of residence when determining representation districts
StdHomeAddressStatus
AddressStatus
One of: 0=Unknown (as entered), 1=Validated
StdHomeAddressModifyDate
dateTime
When the Constituent's home address record was last modified
WorkAddress
Address
Constituent's work address
OtherAddress
Address
Alternate mailing address for the Constituent
PreferredAddress
AddressType
Constituent's preferred mailing address
AcceptsPostalMail
boolean
Indicates whether the Constituent will accept postal mail
CongDistId
normalizedString
Identifier used by Advocacy for the U.S. House of Representatives district corresponding to the zip code of the Constituent's place of legal residence (StdHomeAddress)
CongDistIdOverride
normalizedString
The U.S. House of Representatives district ID for the Constituent manually entered (overrides CongDistId)
StateSenateDistId
normalizedString
Identifier used by Advocacy for the state Senate district corresponding to the zip code of the Constituent's place of legal residence (StdHomeAddress)
StateSenateDistIdOverride
normalizedString
The state Senate district ID for the Constituent manually entered (overrides StateSenateDistId)
StateHouseDistId
normalizedString
Identifier used by Advocacy for the state House of Representatives district corresponding to the zip code of the Constituent's place of legal residence (StdHomeAddress)
StateHouseDistIdOverride
normalizedString
The state House of Representatives district ID for the Constituent manually entered (overrides StateHouseDistId)
HomeCounty
normalizedString
Constituent's home county
HomeCountyOverride
normalizedString
Constituent's home county (manually entered, overrides HomeCounty
HomePhone
normalizedString
Constituent's home telephone number
PreferredPhone
PhoneType
Constituent's preferred phone number
EmployerAddress
Address
Business address of Constituent's employer.
Employer
normalizedString
Name of Constituent's employer
ConsOccupation
normalizedString
Constituent's occupation
ConsHighSchoolName
normalizedString
Constituent's secondary school name
ConsHighSchoolClass
integer
Constituent's secondary school graduating class year
ConsSchool1
PostSecondarySchool
Constituent's college or university (up to 6)
ConsSchool2
PostSecondarySchool
Constituent's college or university (up to 6)
ConsSchool3
PostSecondarySchool
Constituent's college or university (up to 6)
ConsSchool4
PostSecondarySchool
Constituent's college or university (up to 6)
ConsSchool5
PostSecondarySchool
Constituent's college or university (up to 6)
ConsSchool6
PostSecondarySchool
Constituent's college or university (up to 6)
SoName
Name
Name of the Constituent's spouse or partner
Relationship1
Relationship
A person related to the Constituent (up to 8)
Relationship2
Relationship
A person related to the Constituent (up to 8)
Relationship3
Relationship
A person related to the Constituent (up to 8)
Relationship4
Relationship
A person related to the Constituent (up to 8)
Relationship5
Relationship
A person related to the Constituent (up to 8)
Relationship6
Relationship
A person related to the Constituent (up to 8)
Relationship7
Relationship
A person related to the Constituent (up to 8)
Relationship8
Relationship
A person related to the Constituent (up to 8)
FirstTransaction
TransactionSummary
LastTransaction
TransactionSummary
A transaction summary of this Constituent's most recent monetary transaction
LargestTransaction
TransactionSummary
A transaction summary of this Constituent's largest monetary transaction
PrevYearTotal
AnnualTransactionSummary
Constituent's total donations during the previous calendar year
CurrYearTotal
AnnualTransactionSummary
LifetimeTotalTransAmount
decimal
Total monetary amount of transactions (donations, etc.) completed since the Constituent record was created
LifetimeTotalTransCount
integer
Total number of transactions completed since the Constituent record was created
TransRecencyPercentile
decimal
Percentile comparing how recently this constituent has donated compared to all other constituents
TransFrequencyPercentile
decimal
Percentile comparing how often this constituent donates, compared to all other constituents
TransMonValPercentile
decimal
Percentile comparing how much money this constituent has donated compared to all other constituents
ExternalFirstGiftDate
dateTime
ExternalFirstGiftAmount
decimal
ExternalLastGiftDate
dateTime
ExternalLastGiftAmount
decimal
ExternalLargestGiftDate
dateTime
ExternalLargestGiftAmount
decimal
ExternalYtdGiftAmount
decimal
ExternalYtdGiftCount
integer
ExternalLifetimeGiftAmount
decimal
ExternalLifetimeGiftCount
integer
EngagementFactor1
decimal
EngagementFactor2
decimal
EngagementFactor3
decimal
EngagementFactor4
decimal
EngagementFactor5
decimal
EngagementFactor6
decimal
EngagementFactor7
decimal
EngagementFactor8
decimal
EngagementFactor9
decimal
EngagementFactor10
decimal
PrevYearAlertResponseCount
integer
Number of alerts taken by the user in the previous year
CurrYearAlertResponseCount
integer
The number of Advocacy alerts the Constituent has responded to during the current calendar year
LifetimeAlertResponseCount
integer
Total responses to Advocacy alerts the Constituent has made since first interacting with this site
GroupId
nonNegativeInteger
Multiple values allowed
References the system-generated value identifying the primary Group to which this Constituent is assigned
InterestId
nonNegativeInteger
Multiple values allowed
References the Interest Category to which this Constituent belongs
CenterId
nonNegativeInteger
Multiple values allowed
The Center with which this constituent is associated (only used when Multi-Center support is installed)

Comments

Submitted by Pramod at 12:52 AM on December 5, 2013
How to i access title of name or suffix of name? i am able to get first name, middle name, last name but for suffix and title ... web service return null. please help

Leave a Comment

Nickname
Comment
Enter this word: