Personator:Output Columns: Difference between revisions
Jump to navigation
Jump to search
Created page with "← Personator {{CustomTOC}} Default Columns AddressExtras Any extra information that does not fit in the AddressLine fields. AddressKey Returns a unique id..." |
No edit summary |
||
(8 intermediate revisions by the same user not shown) | |||
Line 2: | Line 2: | ||
{{CustomTOC}} | {{CustomTOC}} | ||
Default Columns | ==Default Columns== | ||
AddressExtras | ;AddressExtras | ||
Any extra information that does not fit in the AddressLine fields. | :Any extra information that does not fit in the AddressLine fields. | ||
AddressKey | |||
Returns a unique identifier for an address. This key can be used with other current and future Melissa | ;AddressKey | ||
:Returns a unique identifier for an address. This key can be used with other current and future Melissa services. | |||
AddressLine1 | |||
Returns the address entered in the AddressLine field. If two addresses were entered and only one is | ;AddressLine1 | ||
valid, the valid address is returned instead. This includes the suite and private mailbox. | :Returns the address entered in the AddressLine field. If two addresses were entered and only one is valid, the valid address is returned instead. This includes the suite and private mailbox. | ||
AddressLine2 | |||
If two addresses are passed into the AddressLine field, the second address is returned here. If only one | ;AddressLine2 | ||
of two addresses is valid, the valid address will be returned in AddressLine1. | :If two addresses are passed into the AddressLine field, the second address is returned here. If only one of two addresses is valid, the valid address will be returned in AddressLine1. | ||
;City | |||
City | :Returns the city entered in the City field. | ||
Returns the city entered in the City field. | |||
CompanyName | ;CompanyName | ||
Returns the company name. | :Returns the company name. | ||
EmailAddress | |||
Returns the email address entered in the Email field. | ;EmailAddress | ||
MelissaAddressKey | :Returns the email address entered in the Email field. | ||
Returns a unique key associated with an address. | |||
MelissaAddressKeyBase | ;MelissaAddressKey | ||
Returns a unique key associated with a building containing multiple suites/apartments. | :Returns a unique key associated with an address. | ||
NameFull | |||
Returns the full name for the record. | ;MelissaAddressKeyBase | ||
PhoneNumber | :Returns a unique key associated with a building containing multiple suites/apartments. | ||
Returns the standardized phone number for the record. | |||
PostalCode | ;NameFull | ||
Returns the 9-digit postal code for U.S. addresses and 6-digit postal code for Canadian addresses. | :Returns the full name for the record. | ||
State | |||
Returns the state for the record. | ;PhoneNumber | ||
No Group Columns | :Returns the standardized phone number for the record. | ||
These columns are not default and have no group. They normally will not be needed unless for specific | |||
legacy requirements. | ;PostalCode | ||
MoveDate | :Returns the 9-digit postal code for U.S. addresses and 6-digit postal code for Canadian addresses. | ||
Returns the date associated with the move address. | |||
;State | |||
:Returns the state for the record. | |||
Plus4 | |||
Returns the 4-digit plus4 for the input address. If this column is requested, the PostalCode field will | |||
only contain the 5-digit ZIP for U.S. addresses. | ==No Group Columns== | ||
PrivateMailBox | These columns are not default and have no group. They normally will not be needed unless for specific legacy requirements. | ||
Returns the private mail box number for the address in the AddressLine field, if any. Private mailboxes | |||
are private mail boxes in commercial mail receiving agencies, like a UPS Store. If requested, the Private | ;MoveDate | ||
mailbox will be populated in this field instead of the Address field. | :Returns the date associated with the move address. | ||
Suite | |||
Returns the suite for the address in the AddressLine field, if any. If requested, the suite will be | ;Plus4 | ||
populated in this field instead of the Address field. | :Returns the 4-digit plus4 for the input address. If this column is requested, the PostalCode field will only contain the 5-digit ZIP for U.S. addresses. | ||
Address Details Group Columns | |||
These columns are not default and belong to the GrpAddressDetails group. | ;PrivateMailBox | ||
AddressTypeCode | :Returns the private mail box number for the address in the AddressLine field, if any. Private mailboxes are private mail boxes in commercial mail receiving agencies, like a UPS Store. If requested, the Private mailbox will be populated in this field instead of the Address field. | ||
Returns a code for the address type in the AddressLine field. Please see the appendix for the list of | |||
possible codes. | ;Suite | ||
CarrierRoute | :Returns the suite for the address in the AddressLine field, if any. If requested, the suite will be populated in this field instead of the Address field. | ||
Returns a 4-character code defining the carrier route for this record. | |||
CityAbbreviation | ;Address Details Group Columns | ||
Returns an abbreviation for the city entered in the City field, if any. | :These columns are not default and belong to the GrpAddressDetails group. | ||
CountryCode | |||
Returns the country code for the country in the Country field. | ;AddressTypeCode | ||
CountryName | :Returns a code for the address type in the AddressLine field. Please see the appendix for the list of possible codes. | ||
Returns the country name for the record. | |||
DeliveryIndicator | ;CarrierRoute | ||
Returns an indicator of whether an address is a business address or residential address. | :Returns a 4-character code defining the carrier route for this record. | ||
;CityAbbreviation | |||
Code Definition | :Returns an abbreviation for the city entered in the City field, if any. | ||
B Business | |||
R Residential | ;CountryCode | ||
U Unknown | :Returns the country code for the country in the Country field. | ||
DeliveryPointCheckDigit | |||
Returns a string value containing the 1-digit delivery point check digit. | ;CountryName | ||
DeliveryPointCode | :Returns the country name for the record. | ||
Returns a string value containing the 2-digit delivery point code. | |||
StateName | ;DeliveryIndicator | ||
Returns the full name of the state entered in the State field. | :Returns an indicator of whether an address is a business address or residential address. | ||
UrbanizationName | |||
Returns the urbanization name for the address entered in the AddressLine field. Usually only used if | :{| class="alternate01" | ||
the address is in Puerto Rico. | !Code !! Definition | ||
UTC | |- | ||
Returns the time zone of the requested record. | |B||Business | ||
All Melissa Data products express time zones in UTC (Coordinated Universal Time). | |- | ||
Census Group Columns | |R||Residential | ||
These columns are not default and belong to the GrpCensus group. | |- | ||
CBSACode | |U||Unknown | ||
Census Bureau’s Core Based Statistical Area (CBSA). | |} | ||
Returns the 5-digit code for the CBSA associated with the requested record. | |||
CBSADivisionCode | ;DeliveryPointCheckDigit | ||
Returns the code for a division associated with the requested record, if any. | :Returns a string value containing the 1-digit delivery point check digit. | ||
;DeliveryPointCode | |||
CBSADivisionLevel | :Returns a string value containing the 2-digit delivery point code. | ||
Returns whether the CBSA division, if any, is metropolitan or micropolitan. | |||
CBSADivisionTitle | ;StateName | ||
Returns the title for the CBSA division, if any. | :Returns the full name of the state entered in the State field. | ||
CBSALevel | |||
Returns whether the CBSA is metropolitan or micropolitan. | ;UrbanizationName | ||
CBSATitle | :Returns the urbanization name for the address entered in the AddressLine field. Usually only used if the address is in Puerto Rico. | ||
Returns the title for the CBSA. | |||
CensusBlock | ;UTC | ||
Returns a 4-digit string containing the census block number associated with the requested record. | :Returns the time zone of the requested record. All Melissa Data products express time zones in UTC (Coordinated Universal Time). | ||
Census blocks are the smallest geographic area for which the Bureau of the Census collects and | |||
tabulates decennial census data. | ;Census Group Columns | ||
CensusTract | :These columns are not default and belong to the GrpCensus group. | ||
Returns a 4-to 6-digit string containing the census tract number associated with the requested record. | |||
Census tracts are small subdivisions of a county. | ;CBSACode | ||
CongressionalDistrict | :Census Bureau’s Core Based Statistical Area (CBSA). Returns the 5-digit code for the CBSA associated with the requested record. | ||
Returns the 2-digit congressional district that the requested record | |||
CountyFIPS | ;CBSADivisionCode | ||
Returns the FIPS code for the county in the County field. | :Returns the code for a division associated with the requested record, if any. | ||
FIPS code is a 5-digit code. The first two digits are a state code and the last three indicate the county | |||
within the state. | ;CBSADivisionLevel | ||
CountyName | :Returns whether the CBSA division, if any, is metropolitan or micropolitan. | ||
Returns the county name. | |||
PlaceCode, | ;CBSADivisionTitle | ||
:Returns the title for the CBSA division, if any. | |||
PlaceName | ;CBSALevel | ||
When ZIP codes overlap, the City field will always return the city that covers most of the ZIP area. If | :Returns whether the CBSA is metropolitan or micropolitan. | ||
the address is located outside of that city but within the ZIP Code, PlaceCode/PlaceName will refer to | |||
that area. | ;CBSATitle | ||
Census Group Columns 2 | :Returns the title for the CBSA. | ||
CensusKey | |||
Returns a 15 digit string containing the concatenated County FIPS, Census Tract and Census Block. | ;CensusBlock | ||
CountySubdivisionCode | :Returns a 4-digit string containing the census block number associated with the requested record. | ||
Returns a 5 digit string representing the County Subdivision Code for the requested record. | |||
CountySubdivisionName | :Census blocks are the smallest geographic area for which the Bureau of the Census collects and tabulates decennial census data. | ||
Returns the County Subdivision Name for the requested record. | |||
ElementarySchoolDistrictCode | ;CensusTract | ||
Returns a 5 digit string representing the Elementary School District Code for the requested record. | :Returns a 4-to 6-digit string containing the census tract number associated with the requested record. | ||
ElementarySchoolDistrictName | |||
Returns the Elementary School District Name for the requested record. | :Census tracts are small subdivisions of a county. | ||
SecondarySchoolDistrictCode | |||
Returns a 5 digit string representing the Secondary School District Code for the requested record. | ;CongressionalDistrict | ||
SecondarySchoolDistrictName | :Returns the 2-digit congressional district that belongs to the requested record. | ||
Returns the Secondary School District Name for the requested record. | |||
UnifiedSchoolDistrictCode | ;CountyFIPS | ||
Returns a 5 digit string representing the Unified School District Code for the requested record. | :Returns the FIPS code for the county in the County field. | ||
UnifiedSchoolDistrictName | |||
Returns the Secondary Unified District Name for the requested record. | :FIPS code is a 5-digit code. The first two digits are a state code and the last three indicate the county within the state. | ||
;CountyName | |||
StateDistrictUpper | :Returns the county name. | ||
Returns a 3 digit string representing the Upper State District Code for the requested record. | |||
StateDistrictLower | ;PlaceCode,PlaceName | ||
Returns a 3 digit string representing the Lower State District Code for the requested record. | :When ZIP codes overlap, the City field will always return the city that covers most of the ZIP area. If the address is located outside of that city but within the ZIP Code, PlaceCode/PlaceName will refer to that area. | ||
GeoCode Group Columns | ==Census Group Columns 2== | ||
These columns are not default and belong to the GrpGeocode group. | ;CensusKey | ||
Latitude | :Returns a 15 digit string containing the concatenated County FIPS, Census Tract and Census Block. | ||
Returns the geocoded latitude for the address entered in the AddressLine field. | |||
Longitude | ;CountySubdivisionCode | ||
Returns the geocoded longitude for the address entered in the AddressLine field. | :Returns a 5 digit string representing the County Subdivision Code for the requested record. | ||
Demographic Basic Group Columns | |||
If any demographics are enabled, <DemographicsResults> will return a comma delimited string | ;CountySubdivisionName | ||
containing all the results of the demographics combined. | :Returns the County Subdivision Name for the requested record. | ||
DateOfBirth | |||
Returns the date of birth in the format YYYYMM. Accuracy is only to the month. | ;ElementarySchoolDistrictCode | ||
HouseholdIncome | :Returns a 5 digit string representing the Elementary School District Code for the requested record. | ||
Returns the range of the household's income. | |||
Code Definition | ;ElementarySchoolDistrictName | ||
ID00 Unknown | :Returns the Elementary School District Name for the requested record. | ||
ID01 $0-$15,000 | |||
ID02 $15,001-$20,000 | ;SecondarySchoolDistrictCode | ||
ID03 $20,001-$30,000 | :Returns a 5 digit string representing the Secondary School District Code for the requested record. | ||
ID04 $30,001-$40,000 | |||
ID05 $40,001-$50,000 | ;SecondarySchoolDistrictName | ||
ID06 $50,001-$60,000 | :Returns the Secondary School District Name for the requested record. | ||
ID07 $60,001-$75,000 | |||
ID08 $75,001-$100,000 | ;UnifiedSchoolDistrictCode | ||
ID09 $100,001-$125,000 | :Returns a 5 digit string representing the Unified School District Code for the requested record. | ||
ID10 $125,001-$150,000 | |||
ID11 $150,001+ | ;UnifiedSchoolDistrictName | ||
:Returns the Secondary Unified District Name for the requested record. | |||
LengthOfResidence | ;StateDistrictUpper | ||
Returns the range of the individual's length of residency in their current address. | :Returns a 3 digit string representing the Upper State District Code for the requested record. | ||
Value | |||
Less than 1 year | ;StateDistrictLower | ||
1-2 years | :Returns a 3 digit string representing the Lower State District Code for the requested record. | ||
2-3 years | |||
3-4 years | ;GeoCode Group Columns | ||
4-5 years | :These columns are not default and belong to the GrpGeocode group. | ||
6-7 years | ;Latitude | ||
7-8 years | :Returns the geocoded latitude for the address entered in the AddressLine field. | ||
8-9 years | |||
9-10 years | ;Longitude | ||
10-11 years | :Returns the geocoded longitude for the address entered in the AddressLine field. | ||
11-12 years | |||
12-13 years | |||
13-14 years | ==Demographic Basic Group Columns== | ||
14-15 years | If any demographics are enabled, <DemographicsResults> will return a comma delimited string containing all the results of the demographics combined. | ||
15+ years | |||
Unknown | ;DateOfBirth | ||
PresenceOfChildren | :Returns the date of birth in the format YYYYMM. Accuracy is only to the month. | ||
Returns the presence of children in the household. | |||
Value | ;HouseholdIncome | ||
Unknown | :Returns the range of the household's income. | ||
No Children Present | |||
Children Present | :{| class="alternate01" | ||
MaritalStatus | !Code !! Definition | ||
Returns the individual's marital status. | |- | ||
Value | |ID00||Unknown | ||
Unknown | |- | ||
|ID01||$0-$15,000 | |||
|- | |||
|ID02||$15,001-$20,000 | |||
Definitely Single | |- | ||
Inferred Single | |ID03||$20,001-$30,000 | ||
Inferred Married | |- | ||
Definitely Married | |ID04||$30,001-$40,000 | ||
DateOfDeath | |- | ||
Returns the full date of death in the format YYYYMMDD. | |ID05||$40,001-$50,000 | ||
DemographicsGender | |- | ||
Returns gender based on demographics data. | |ID06||$50,001-$60,000 | ||
Value | |- | ||
|ID07||$60,001-$75,000 | |||
Male | |- | ||
Female | |ID08||$75,001-$100,000 | ||
Neutral | |- | ||
OwnRent | |ID09||$100,001-$125,000 | ||
Returns the individual's status as owner or renter of the property. | |- | ||
Value | |ID10||$125,001-$150,000 | ||
Unknown | |- | ||
Definite Renter | |ID11||$150,001+ | ||
Inferred Renter | |} | ||
Inferred Owner | |||
Definite Owner | ;LengthOfResidence | ||
Occupation | :Returns the range of the individual's length of residency in their current address. | ||
Returns the category for the individual's occupation. | |||
Value | :{| class="alternate01" | ||
Physician/Dentist | !Value | ||
Healthcare | |- | ||
Lawyer/Judge | |Less than 1 year | ||
|- | |||
|1-2 years | |||
|- | |||
Professional/Technical | |2-3 years | ||
Management | |- | ||
Teacher/Educator | |3-4 years | ||
Sales/Marketing | |- | ||
Clerical/Service Worker | |4-5 years | ||
Tradesmen/Laborer | |- | ||
Farmer | |5-6 years | ||
Student | |- | ||
Homemaker | |6-7 years | ||
Retired | |- | ||
Federal Employee | |7-8 years | ||
Unknown | |- | ||
Military | |8-9 years | ||
Military Retired | |- | ||
Other | |9-10 years | ||
Business Owner | |- | ||
Religious | |10-11 years | ||
Self Employed | |- | ||
Financial | |11-12 years | ||
Name Details Group Columns | |- | ||
|12-13 years | |||
|- | |||
|13-14 years | |||
|- | |||
|14-15 years | |||
|- | |||
|15+ years | |||
|- | |||
|Unknown | |||
|} | |||
;PresenceOfChildren | |||
:Returns the presence of children in the household. | |||
:{| class="alternate01" | |||
!Value | |||
|- | |||
|Unknown | |||
|- | |||
|No Children Present | |||
|- | |||
|Children Present | |||
|} | |||
;MaritalStatus | |||
:Returns the individual's marital status. | |||
:{| class="alternate01" | |||
!Value | |||
|- | |||
|Unknown | |||
|- | |||
|Definitely Single | |||
|- | |||
|Inferred Single | |||
|- | |||
|Inferred Married | |||
|- | |||
|Definitely Married | |||
|} | |||
;DateOfDeath | |||
:Returns the full date of death in the format YYYYMMDD. | |||
;DemographicsGender | |||
:Returns gender based on demographics data. | |||
:{| class="alternate01" | |||
!Value | |||
|- | |||
|Unknown | |||
|- | |||
|Male | |||
|- | |||
|Female | |||
|- | |||
|Neutral | |||
|} | |||
;OwnRent | |||
:Returns the individual's status as owner or renter of the property. | |||
:{| class="alternate01" | |||
!Value | |||
|- | |||
|Unknown | |||
|- | |||
|Definite Renter | |||
|- | |||
|Inferred Renter | |||
|- | |||
|Inferred Owner | |||
|- | |||
|Definite Owner | |||
|} | |||
;Occupation | |||
:Returns the category for the individual's occupation. | |||
:{| class="alternate01" | |||
!Value | |||
|- | |||
|Physician/Dentist | |||
|- | |||
|Healthcare | |||
|- | |||
|Lawyer/Judge | |||
|- | |||
|Professional/Technical | |||
|- | |||
|Management | |||
|- | |||
|Teacher/Educator | |||
|- | |||
|Sales/Marketing | |||
|- | |||
|Clerical/Service Worker | |||
|- | |||
|Tradesmen/Laborer | |||
|- | |||
|Farmer | |||
|- | |||
|Student | |||
|- | |||
|Homemaker | |||
|- | |||
|Retired | |||
|- | |||
|Federal Employee | |||
|- | |||
|Unknown | |||
|- | |||
|Military | |||
|- | |||
|Military Retired | |||
|- | |||
|Other | |||
|- | |||
|Business Owner | |||
|- | |||
|Religious | |||
|- | |||
|Self Employed | |||
|- | |||
|Financial | |||
|} | |||
==Name Details Group Columns== | |||
These columns are not default and belong to the GrpNameDetails group. | These columns are not default and belong to the GrpNameDetails group. | ||
Gender | |||
Returns a gender for the name in the FullName field. | ;Gender | ||
Gender2 | :Returns a gender for the name in the FullName field. | ||
Only used if 2 names are in the FullName field. Returns a gender for the second name in the FullName | |||
field. | ;Gender2 | ||
NameFirst | |||
Returns the first name in the FullName field. | :Only used if 2 names are in the FullName field. Returns a gender for the second name in the FullName field. | ||
;NameFirst | |||
NameFirst2 | :Returns the first name in the FullName field. | ||
Only used if 2 names are in the FullName field. Returns the second name in the FullName field. | |||
NameLast | ;NameFirst2 | ||
Returns the last name in the FullName field. | :Only used if 2 names are in the FullName field. Returns the second name in the FullName field. | ||
NameLast2 | |||
Only used if 2 names are in the FullName field. Returns a last name for the second name in the | ;NameLast | ||
FullName field. | :Returns the last name in the FullName field. | ||
NameMiddle | |||
Returns a middle name for the name in the FullName field. | ;NameLast2 | ||
NameMiddle2 | :Only used if 2 names are in the FullName field. Returns a last name for the second name in the FullName field. | ||
Only used if 2 names are in the FullName field. Returns a middle name for the second name in the | |||
FullName field. | ;NameMiddle | ||
NamePrefix | :Returns a middle name for the name in the FullName field. | ||
Returns a prefix for the name in the FullName field. | |||
NamePrefix2 | ;NameMiddle2 | ||
Only used if 2 names are in the FullName field. Returns a prefix for the second name in the FullName | :Only used if 2 names are in the FullName field. Returns a middle name for the second name in the FullName field. | ||
field. | |||
NameSuffix | ;NamePrefix | ||
Returns a suffix for the name in the FullName field. | :Returns a prefix for the name in the FullName field. | ||
NameSuffix2 | |||
Only used if 2 names are in the FullName field. Returns a suffix for the second name in the FullName | ;NamePrefix2 | ||
field. | :Only used if 2 names are in the FullName field. Returns a prefix for the second name in the FullName field. | ||
Salutation | |||
Returns a salutation for the name in the FullName field. | ;NameSuffix | ||
:Returns a suffix for the name in the FullName field. | |||
Parsed Address Group Columns | ;NameSuffix2 | ||
:Only used if 2 names are in the FullName field. Returns a suffix for the second name in the FullName field. | |||
;Salutation | |||
:Returns a salutation for the name in the FullName field. | |||
==Parsed Address Group Columns== | |||
These columns are not default and belong to the GrpParsedAddress group. | These columns are not default and belong to the GrpParsedAddress group. | ||
AddressDeliveryInstallation (Canada Only) | |||
Returns the parsed delivery installation for the address entered in the AddressLine field. | ;AddressDeliveryInstallation (Canada Only) | ||
AddressHouseNumber | :Returns the parsed delivery installation for the address entered in the AddressLine field. | ||
Returns the parsed house number for the address entered in the AddressLine field. | |||
AddressLockBox (Canada Only) | ;AddressHouseNumber | ||
Returns the parsed lock box number for the address entered in the AddressLine field. | :Returns the parsed house number for the address entered in the AddressLine field. | ||
AddressPostDirection | |||
Returns the parsed post-direction for the address entered in the AddressLine field. | ;AddressLockBox (Canada Only) | ||
AddressPreDirection | :Returns the parsed lock box number for the address entered in the AddressLine field. | ||
Returns the parsed pre-direction for the address entered in the AddressLine field. | |||
AddressPrivateMailboxName | ;AddressPostDirection | ||
Returns the parsed private mailbox name for the address entered in the AddressLine field. | :Returns the parsed post-direction for the address entered in the AddressLine field. | ||
AddressPrivateMailboxRange | |||
Returns the parsed private mailbox range for the address entered in the AddressLine field. | ;AddressPreDirection | ||
AddressRouteService (Canada Only) | :Returns the parsed pre-direction for the address entered in the AddressLine field. | ||
Returns the parsed route service number for the address entered in the AddressLine field. | |||
AddressStreetName | ;AddressPrivateMailboxName | ||
Returns the parsed street name for the address entered in the AddressLine field. | :Returns the parsed private mailbox name for the address entered in the AddressLine field. | ||
AddressStreetSuffix | |||
Returns the parsed street suffix for the address entered in the AddressLine field. | ;AddressPrivateMailboxRange | ||
:Returns the parsed private mailbox range for the address entered in the AddressLine field. | |||
AddressSuiteName | ;AddressRouteService (Canada Only) | ||
Returns the parsed suite name for the address entered in the AddressLine field. | :Returns the parsed route service number for the address entered in the AddressLine field. | ||
AddressSuiteNumber | |||
Returns the parsed suite number for the address entered in the AddressLine field. | ;AddressStreetName | ||
Parsed Email Group Columns | :Returns the parsed street name for the address entered in the AddressLine field. | ||
;AddressStreetSuffix | |||
:Returns the parsed street suffix for the address entered in the AddressLine field. | |||
;AddressSuiteName | |||
:Returns the parsed suite name for the address entered in the AddressLine field. | |||
;AddressSuiteNumber | |||
:Returns the parsed suite number for the address entered in the AddressLine field. | |||
==Parsed Email Group Columns== | |||
These columns are not default and belong to the GrpParsedEmail group. | These columns are not default and belong to the GrpParsedEmail group. | ||
DomainName | |||
Returns the parsed domain name for the email entered in the Email field. | ;DomainName | ||
MailboxName | :Returns the parsed domain name for the email entered in the Email field. | ||
Returns the parsed mailbox name for the email entered in the Email field. | |||
TopLevelDomain | ;MailboxName | ||
Returns the parsed top-level domain name for the email entered in the Email field. | :Returns the parsed mailbox name for the email entered in the Email field. | ||
Parsed Phone Group Columns | |||
;TopLevelDomain | |||
:Returns the parsed top-level domain name for the email entered in the Email field. | |||
==Parsed Phone Group Columns== | |||
These columns are not default and belong to the GrpParsedPhone group. | These columns are not default and belong to the GrpParsedPhone group. | ||
;AreaCode | |||
:Returns the parsed area code for the phone number entered in the Phone field. | |||
;NewAreaCode | |||
:Returns the parsed new area code for the phone number entered in the Phone field. | |||
;PhoneCountryCode | |||
:Returns the 2 character country code for the phone number entered in the Phone field. | |||
;PhoneCountryName | |||
:Returns the full country name for the phone number entered in the Phone field. | |||
;PhoneExtension | |||
:Returns the parsed extension for the phone number entered in the Phone field. | |||
;PhonePrefix | |||
:Returns the parsed prefix for the phone number entered in the Phone field. | |||
;PhoneSuffix | |||
:Returns the parsed suffix for the phone number entered in the Phone field. | |||
[[Category:Personator]] | [[Category:Personator]] |
Latest revision as of 23:16, 18 July 2017
Default Columns
- AddressExtras
- Any extra information that does not fit in the AddressLine fields.
- AddressKey
- Returns a unique identifier for an address. This key can be used with other current and future Melissa services.
- AddressLine1
- Returns the address entered in the AddressLine field. If two addresses were entered and only one is valid, the valid address is returned instead. This includes the suite and private mailbox.
- AddressLine2
- If two addresses are passed into the AddressLine field, the second address is returned here. If only one of two addresses is valid, the valid address will be returned in AddressLine1.
- City
- Returns the city entered in the City field.
- CompanyName
- Returns the company name.
- EmailAddress
- Returns the email address entered in the Email field.
- MelissaAddressKey
- Returns a unique key associated with an address.
- MelissaAddressKeyBase
- Returns a unique key associated with a building containing multiple suites/apartments.
- NameFull
- Returns the full name for the record.
- PhoneNumber
- Returns the standardized phone number for the record.
- PostalCode
- Returns the 9-digit postal code for U.S. addresses and 6-digit postal code for Canadian addresses.
- State
- Returns the state for the record.
No Group Columns
These columns are not default and have no group. They normally will not be needed unless for specific legacy requirements.
- MoveDate
- Returns the date associated with the move address.
- Plus4
- Returns the 4-digit plus4 for the input address. If this column is requested, the PostalCode field will only contain the 5-digit ZIP for U.S. addresses.
- PrivateMailBox
- Returns the private mail box number for the address in the AddressLine field, if any. Private mailboxes are private mail boxes in commercial mail receiving agencies, like a UPS Store. If requested, the Private mailbox will be populated in this field instead of the Address field.
- Suite
- Returns the suite for the address in the AddressLine field, if any. If requested, the suite will be populated in this field instead of the Address field.
- Address Details Group Columns
- These columns are not default and belong to the GrpAddressDetails group.
- AddressTypeCode
- Returns a code for the address type in the AddressLine field. Please see the appendix for the list of possible codes.
- CarrierRoute
- Returns a 4-character code defining the carrier route for this record.
- CityAbbreviation
- Returns an abbreviation for the city entered in the City field, if any.
- CountryCode
- Returns the country code for the country in the Country field.
- CountryName
- Returns the country name for the record.
- DeliveryIndicator
- Returns an indicator of whether an address is a business address or residential address.
Code Definition B Business R Residential U Unknown
- DeliveryPointCheckDigit
- Returns a string value containing the 1-digit delivery point check digit.
- DeliveryPointCode
- Returns a string value containing the 2-digit delivery point code.
- StateName
- Returns the full name of the state entered in the State field.
- UrbanizationName
- Returns the urbanization name for the address entered in the AddressLine field. Usually only used if the address is in Puerto Rico.
- UTC
- Returns the time zone of the requested record. All Melissa Data products express time zones in UTC (Coordinated Universal Time).
- Census Group Columns
- These columns are not default and belong to the GrpCensus group.
- CBSACode
- Census Bureau’s Core Based Statistical Area (CBSA). Returns the 5-digit code for the CBSA associated with the requested record.
- CBSADivisionCode
- Returns the code for a division associated with the requested record, if any.
- CBSADivisionLevel
- Returns whether the CBSA division, if any, is metropolitan or micropolitan.
- CBSADivisionTitle
- Returns the title for the CBSA division, if any.
- CBSALevel
- Returns whether the CBSA is metropolitan or micropolitan.
- CBSATitle
- Returns the title for the CBSA.
- CensusBlock
- Returns a 4-digit string containing the census block number associated with the requested record.
- Census blocks are the smallest geographic area for which the Bureau of the Census collects and tabulates decennial census data.
- CensusTract
- Returns a 4-to 6-digit string containing the census tract number associated with the requested record.
- Census tracts are small subdivisions of a county.
- CongressionalDistrict
- Returns the 2-digit congressional district that belongs to the requested record.
- CountyFIPS
- Returns the FIPS code for the county in the County field.
- FIPS code is a 5-digit code. The first two digits are a state code and the last three indicate the county within the state.
- CountyName
- Returns the county name.
- PlaceCode,PlaceName
- When ZIP codes overlap, the City field will always return the city that covers most of the ZIP area. If the address is located outside of that city but within the ZIP Code, PlaceCode/PlaceName will refer to that area.
Census Group Columns 2
- CensusKey
- Returns a 15 digit string containing the concatenated County FIPS, Census Tract and Census Block.
- CountySubdivisionCode
- Returns a 5 digit string representing the County Subdivision Code for the requested record.
- CountySubdivisionName
- Returns the County Subdivision Name for the requested record.
- ElementarySchoolDistrictCode
- Returns a 5 digit string representing the Elementary School District Code for the requested record.
- ElementarySchoolDistrictName
- Returns the Elementary School District Name for the requested record.
- SecondarySchoolDistrictCode
- Returns a 5 digit string representing the Secondary School District Code for the requested record.
- SecondarySchoolDistrictName
- Returns the Secondary School District Name for the requested record.
- UnifiedSchoolDistrictCode
- Returns a 5 digit string representing the Unified School District Code for the requested record.
- UnifiedSchoolDistrictName
- Returns the Secondary Unified District Name for the requested record.
- StateDistrictUpper
- Returns a 3 digit string representing the Upper State District Code for the requested record.
- StateDistrictLower
- Returns a 3 digit string representing the Lower State District Code for the requested record.
- GeoCode Group Columns
- These columns are not default and belong to the GrpGeocode group.
- Latitude
- Returns the geocoded latitude for the address entered in the AddressLine field.
- Longitude
- Returns the geocoded longitude for the address entered in the AddressLine field.
Demographic Basic Group Columns
If any demographics are enabled, <DemographicsResults> will return a comma delimited string containing all the results of the demographics combined.
- DateOfBirth
- Returns the date of birth in the format YYYYMM. Accuracy is only to the month.
- HouseholdIncome
- Returns the range of the household's income.
Code Definition ID00 Unknown ID01 $0-$15,000 ID02 $15,001-$20,000 ID03 $20,001-$30,000 ID04 $30,001-$40,000 ID05 $40,001-$50,000 ID06 $50,001-$60,000 ID07 $60,001-$75,000 ID08 $75,001-$100,000 ID09 $100,001-$125,000 ID10 $125,001-$150,000 ID11 $150,001+
- LengthOfResidence
- Returns the range of the individual's length of residency in their current address.
Value Less than 1 year 1-2 years 2-3 years 3-4 years 4-5 years 5-6 years 6-7 years 7-8 years 8-9 years 9-10 years 10-11 years 11-12 years 12-13 years 13-14 years 14-15 years 15+ years Unknown
- PresenceOfChildren
- Returns the presence of children in the household.
Value Unknown No Children Present Children Present
- MaritalStatus
- Returns the individual's marital status.
Value Unknown Definitely Single Inferred Single Inferred Married Definitely Married
- DateOfDeath
- Returns the full date of death in the format YYYYMMDD.
- DemographicsGender
- Returns gender based on demographics data.
Value Unknown Male Female Neutral
- OwnRent
- Returns the individual's status as owner or renter of the property.
Value Unknown Definite Renter Inferred Renter Inferred Owner Definite Owner
- Occupation
- Returns the category for the individual's occupation.
Value Physician/Dentist Healthcare Lawyer/Judge Professional/Technical Management Teacher/Educator Sales/Marketing Clerical/Service Worker Tradesmen/Laborer Farmer Student Homemaker Retired Federal Employee Unknown Military Military Retired Other Business Owner Religious Self Employed Financial
Name Details Group Columns
These columns are not default and belong to the GrpNameDetails group.
- Gender
- Returns a gender for the name in the FullName field.
- Gender2
- Only used if 2 names are in the FullName field. Returns a gender for the second name in the FullName field.
- NameFirst
- Returns the first name in the FullName field.
- NameFirst2
- Only used if 2 names are in the FullName field. Returns the second name in the FullName field.
- NameLast
- Returns the last name in the FullName field.
- NameLast2
- Only used if 2 names are in the FullName field. Returns a last name for the second name in the FullName field.
- NameMiddle
- Returns a middle name for the name in the FullName field.
- NameMiddle2
- Only used if 2 names are in the FullName field. Returns a middle name for the second name in the FullName field.
- NamePrefix
- Returns a prefix for the name in the FullName field.
- NamePrefix2
- Only used if 2 names are in the FullName field. Returns a prefix for the second name in the FullName field.
- NameSuffix
- Returns a suffix for the name in the FullName field.
- NameSuffix2
- Only used if 2 names are in the FullName field. Returns a suffix for the second name in the FullName field.
- Salutation
- Returns a salutation for the name in the FullName field.
Parsed Address Group Columns
These columns are not default and belong to the GrpParsedAddress group.
- AddressDeliveryInstallation (Canada Only)
- Returns the parsed delivery installation for the address entered in the AddressLine field.
- AddressHouseNumber
- Returns the parsed house number for the address entered in the AddressLine field.
- AddressLockBox (Canada Only)
- Returns the parsed lock box number for the address entered in the AddressLine field.
- AddressPostDirection
- Returns the parsed post-direction for the address entered in the AddressLine field.
- AddressPreDirection
- Returns the parsed pre-direction for the address entered in the AddressLine field.
- AddressPrivateMailboxName
- Returns the parsed private mailbox name for the address entered in the AddressLine field.
- AddressPrivateMailboxRange
- Returns the parsed private mailbox range for the address entered in the AddressLine field.
- AddressRouteService (Canada Only)
- Returns the parsed route service number for the address entered in the AddressLine field.
- AddressStreetName
- Returns the parsed street name for the address entered in the AddressLine field.
- AddressStreetSuffix
- Returns the parsed street suffix for the address entered in the AddressLine field.
- AddressSuiteName
- Returns the parsed suite name for the address entered in the AddressLine field.
- AddressSuiteNumber
- Returns the parsed suite number for the address entered in the AddressLine field.
Parsed Email Group Columns
These columns are not default and belong to the GrpParsedEmail group.
- DomainName
- Returns the parsed domain name for the email entered in the Email field.
- MailboxName
- Returns the parsed mailbox name for the email entered in the Email field.
- TopLevelDomain
- Returns the parsed top-level domain name for the email entered in the Email field.
Parsed Phone Group Columns
These columns are not default and belong to the GrpParsedPhone group.
- AreaCode
- Returns the parsed area code for the phone number entered in the Phone field.
- NewAreaCode
- Returns the parsed new area code for the phone number entered in the Phone field.
- PhoneCountryCode
- Returns the 2 character country code for the phone number entered in the Phone field.
- PhoneCountryName
- Returns the full country name for the phone number entered in the Phone field.
- PhoneExtension
- Returns the parsed extension for the phone number entered in the Phone field.
- PhonePrefix
- Returns the parsed prefix for the phone number entered in the Phone field.
- PhoneSuffix
- Returns the parsed suffix for the phone number entered in the Phone field.