Personator Consumer:Response: Difference between revisions
No edit summary |
No edit summary |
||
Line 1,750: | Line 1,750: | ||
|SOAP/XML||<code><UrbanizationName>'''''string'''''</UrbanizationName></code> | |SOAP/XML||<code><UrbanizationName>'''''string'''''</UrbanizationName></code> | ||
|} | |} | ||
[[Category:Personator]] | [[Category:Personator]] |
Revision as of 21:47, 27 June 2017
Personator Consumer Navigation | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
| ||||||||
| ||||||||
| ||||||||
Sample Code |
A response is the result of a request. This consists of returned results codes, parsed address elements, and appended address information.
Depending on the protocol used to make the request, the response will be in a certain protocol. Personator supports the JSON, JSONP, SOAP, and XML protocols.
Field Names
This is a list of the response field names and their protocol naming conventions.
Field Name | Level | JSON/XML |
---|---|---|
Version | Response | Version |
Transmission Reference | TransmissionReference | |
Transmission Results | TransmissionResults | |
Total Records | TotalRecords | |
AddressDeliveryInstallation | Record | AddressDeliveryInstallation |
AddressExtras | AddressExtras | |
AddressHouseNumber | AddressHouseNumber | |
AddressKey | AddressKey | |
AddressLine1 | AddressLine1 | |
AddressLine2 | AddressLine2 | |
AddressLockBox | AddressLockBox | |
AddressPostDirection | AddressPostDirection | |
AddressPreDirection | AddressPreDirection | |
AddressPrivateMailboxName | AddressPrivateMailboxName | |
AddressPrivateMailboxRange | AddressPrivateMailboxRange | |
AddressRouteService | AddressRouteService | |
AddressStreetName | AddressStreetName | |
AddressStreetSuffix | AddressStreetSuffix | |
AddressSuiteName | AddressSuiteName | |
AddressSuiteNumber | AddressSuiteNumber | |
AddressTypeCode | AddressTypeCode | |
AreaCode | AreaCode | |
CBSACode | CBSACode | |
CBSADivisionCode | CBSADivisionCode | |
CBSADivisionLevel | CBSADivisionLevel | |
CBSADivisionTitle | CBSADivisionTitle | |
CBSALevel | CBSALevel | |
CBSATitle | CBSATitle | |
CarrierRoute | CarrierRoute | |
CensusBlock | CensusBlock | |
CensusKey | CensusKey | |
CensusTract | CensusTract | |
ChildrenAgeRange | ChildrenAgeRange | |
City | City | |
CityAbbreviation | CityAbbreviation | |
CompanyName | CompanyName | |
CongressionalDistrict | CongressionalDistrict | |
CountryCode | CountryCode | |
CountryName | CountryName | |
CountyFIPS | CountyFIPS | |
CountyName | CountyName | |
CountySubdivisionCode | CountySubdivisionCode | |
CountySubdivisionName | CountySubdivisionName | |
CreditCardUser | CreditCardUser | |
DateOfBirth | DateOfBirth | |
DateOfDeath | DateOfDeath | |
DeliveryIndicator | DeliveryIndicator | |
DeliveryPointCheckDigit | DeliveryPointCheckDigit | |
DeliveryPointCode | DeliveryPointCode | |
DemographicsGender | DemographicsGender | |
DemographicsResults | DemographicsResults | |
DomainName | DomainName | |
Education | Education | |
ElementarySchoolDistrictCode | ElementarySchoolDistrictCode | |
ElementarySchoolDistrictName | ElementarySchoolDistrictName | |
EmailAddress | EmailAddress | |
Gender | Gender | |
Gender2 | Gender2 | |
HouseholdIncome | HouseholdIncome | |
HouseholdSize | HouseholdSize | |
Latitude | Latitude | |
LengthOfResidence | LengthOfResidence | |
Longitude | Longitude | |
MailboxName | MailboxName | |
MaritalStatus | MaritalStatus | |
MelissaAddressKey | MelissaAddressKey | |
MelissaAddressKeyBase | MelissaAddressKeyBase | |
MoveDate | MoveDate | |
NameFirst | NameFirst | |
NameFirst2 | NameFirst2 | |
NameFull | NameFull | |
NameLast | NameLast | |
NameLast2 | NameLast2 | |
NameMiddle | NameMiddle | |
NameMiddle2 | NameMiddle2 | |
NamePrefix | NamePrefix | |
NamePrefix2 | NamePrefix2 | |
NameSuffix | NameSuffix | |
NameSuffix2 | NameSuffix2 | |
NewAreaCode | NewAreaCode | |
Occupation | Occupation | |
OwnRent | OwnRent | |
PhoneCountryCode | PhoneCountryCode | |
PhoneCountryName | PhoneCountryName | |
PhoneExtension | PhoneExtension | |
PhoneNumber | PhoneNumber | |
PhonePrefix | PhonePrefix | |
PhoneSuffix | PhoneSuffix | |
PlaceCode | PlaceCode | |
PlaceName | PlaceName | |
Plus4 | Plus4 | |
PoliticalParty | PoliticalParty | |
PostalCode | PostalCode | |
PresenceOfChildren | PresenceOfChildren | |
PresenceOfSenior | PresenceOfSenior | |
PrivateMailBox | PrivateMailBox | |
RecordExtras | RecordExtras | |
RecordID | RecordID | |
Reserved | Reserved | |
Results | Results | |
Salutation | Salutation | |
SecondarySchoolDistrictCode | SecondarySchoolDistrictCode | |
SecondarySchoolDistrictName | SecondarySchoolDistrictName | |
State | State | |
StateDistrictLower | StateDistrictLower | |
StateDistrictUpper | StateDistrictUpper | |
StateName | StateName | |
Suite | Suite | |
TopLevelDomain | TopLevelDomain | |
TypesOfVehicles | TypesOfVehicles | |
UTC | UTC | |
UnifiedSchoolDistrictCode | UnifiedSchoolDistrictCode | |
UnifiedSchoolDistrictName | UnifiedSchoolDistrictName | |
UrbanizationName | UrbanizationName |
Response Elements
The following elements are the basic options for each request. These apply to the entire response, not the individual records.
Version
- This is a string value that is the current revision number of Personator.
Protocol Syntax JSON "Version":"string"
SOAP/XML <Version>string</Version>
Transmission Reference
- This is a string value that serves as a unique identifier for this set of records. It is returned as sent by the Request Array, allowing you to match the Response to the Request.
Protocol Syntax JSON "TransmissionReference":"string"
SOAP/XML <TransmissionReference>string</TransmissionReference>
Transmission Results
- This is a string value that lists error codes from any errors caused by the most recent request as a whole.
- For a complete list of error codes, see Personator Result Codes.
Protocol Syntax JSON "TransmissionResults":"string"
SOAP/XML <TransmissionResults>string</TransmissionResults>
Total Records
- Displays the total number of records returned.
Protocol Syntax JSON "TotalRecords":"string"
SOAP/XML <TotalRecords>string</TotalRecords>
Response Record Elements
JSON will only contain the Records element.
Protocol Definition JSON Each record will be contained within [{}] under the Records element. SOAP XML
Each of the following elements are returned for each record in the Response Array.
Address Delivery Installation
eturns the parsed delivery installation for the address entered in the AddressLine field.
Protocol Syntax JSON "AddressDeliveryInstallation":"string"
SOAP/XML <AddressDeliveryInstallation>string</AddressDeliveryInstallation>
Address Extras
- Any extra information that does not fit in the AddressLine fields.
Protocol Syntax JSON "AddressExtras":"string"
SOAP/XML <AddressExtras>string</AddressExtras>
Address House Number
- Returns the parsed house number for the address entered in the AddressLine field.
Protocol Syntax JSON "AddressHouseNumber":"string"
SOAP/XML <AddressHouseNumber>string</AddressHouseNumber>
Address Key
- Returns a unique identifier for an address. This key can be used with other current and future Melissa services.
Protocol Syntax JSON "AddressKey":"string"
SOAP/XML <AddressKey>string</AddressKey>
Address Line 1
- 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.
Protocol Syntax JSON "AddressLine1":"string"
SOAP/XML <AddressLine1>string</AddressLine1>
Address Line 2
- 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 Address Line 1.
Protocol Syntax JSON "AddressLine2":"string"
SOAP/XML <AddressLine2>string</AddressLine2>
Address Lock Box
- Returns the parsed lock box number for the address entered in the AddressLine field.
Protocol Syntax JSON "AddressLockBox":"string"
SOAP/XML <AddressLockBox>string</AddressLockBox>
Address Post Direction
- Returns the parsed post-direction for the address entered in the AddressLine field.
Protocol Syntax JSON "AddressPostDirection":"string"
SOAP/XML <AddressPostDirection>string</AddressPostDirection>
Address Pre Direction
- Returns the parsed pre-direction for the address entered in the AddressLine field.
Protocol Syntax JSON "AddressPreDirection":"string"
SOAP/XML <AddressPreDirection>string</AddressPreDirection>
Address Private Mailbox Name
- Returns the parsed private mailbox name for the address entered in the AddressLine field.
Protocol Syntax JSON "AddressPrivateMailboxName":"string"
SOAP/XML <AddressPrivateMailboxName>string</AddressPrivateMailboxName>
Address Private Mailbox Range
- Returns the parsed private mailbox range for the address entered in the AddressLine field.
Protocol Syntax JSON "AddressPrivateMailboxRange":"string"
SOAP/XML <AddressPrivateMailboxRange>string</AddressPrivateMailboxRange>
Address Route Service
- Returns the parsed route service number for the address entered in the AddressLine field.
Protocol Syntax JSON "AddressRouteService":"string"
SOAP/XML <AddressRouteService>string</AddressRouteService>
Address Street Name
- Returns the parsed street name for the address entered in the AddressLine field.
Protocol Syntax JSON "AddressStreetName":"string"
SOAP/XML <AddressStreetName>string</AddressStreetName>
Address Street Suffix
- Returns the parsed street suffix for the address entered in the AddressLine field.
Protocol Syntax JSON "AddressStreetSuffix":"string"
SOAP/XML <AddressStreetSuffix>string</AddressStreetSuffix>
Address Suite Name
- Returns the parsed suite name for the address entered in the AddressLine field.
Protocol Syntax JSON "AddressSuiteName":"string"
SOAP/XML <AddressSuiteName>string</AddressSuiteName>
Address Suite Number
- Returns the parsed suite number for the address entered in the AddressLine field.
Protocol Syntax JSON "AddressSuiteNumber":"string"
SOAP/XML <AddressSuiteNumber>string</AddressSuiteNumber>
Address Type Code
- Returns a code for the address type in the AddressLine field. Please see the appendix for the list of possible codes.
Protocol Syntax JSON "AddressTypeCode":"string"
SOAP/XML <AddressTypeCode>string</AddressTypeCode>
Area Code
- Returns the parsed area code for the phone number entered in the Phone field.
Protocol Syntax JSON "AreaCode":"string"
SOAP/XML <AreaCode>string</AreaCode>
CBSA Code
- Census Bureau’s Core Based Statistical Area (CBSA). Returns the 5-digit code for the CBSA associated with the requested record.
Protocol Syntax JSON "CBSACode":"string"
SOAP/XML <CBSACode>string</CBSACode>
CBSA Division Code
- Returns the code for a division associated with the requested record, if any.
Protocol Syntax JSON "CBSADivisionCode":"string"
SOAP/XML <CBSADivisionCode>string</CBSADivisionCode>
CBSA Division Level
- Returns whether the CBSA division, if any, is metropolitan or micropolitan.
Protocol Syntax JSON "CBSADivisionLevel":"string"
SOAP/XML <CBSADivisionLevel>string</CBSADivisionLevel>
CBSA Division Title
- Returns the title for the CBSA division, if any.
Protocol Syntax JSON "CBSADivisionTitle":"string"
SOAP/XML <CBSADivisionTitle>string</CBSADivisionTitle>
CBSA Level
- Returns whether the CBSA is metropolitan or micropolitan.
Protocol Syntax JSON "CBSALevel":"string"
SOAP/XML <CBSALevel>string</CBSALevel>
CBSA Title
- Returns the title for the CBSA.
Protocol Syntax JSON "CBSATitle":"string"
SOAP/XML <CBSATitle>string</CBSATitle>
Carrier Route
- Returns a 4-character code defining the carrier route for this record.
Protocol Syntax JSON "CarrierRoute":"string"
SOAP/XML <CarrierRoute>string</CarrierRoute>
Census Block
- Returns a 4-digit string containing the census block number associated with the requested record.
Protocol Syntax JSON "CensusBlock":"string"
SOAP/XML <CensusBlock>string</CensusBlock>
Census Key
- Returns a 15 digit string containing the concatenated County FIPS, Census Tract and Census Block.
Protocol Syntax JSON "CensusKey":"string"
SOAP/XML <CensusKey>string</CensusKey>
Census Tract
- 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.
Protocol Syntax JSON "CensusTract":"string"
SOAP/XML <CensusTract>string</CensusTract>
!!!Children Age Range
Protocol Syntax JSON "ChildrenAgeRange":"string"
SOAP/XML <ChildrenAgeRange>string</ChildrenAgeRange>
City
- Returns the city entered in the City field.
Protocol Syntax JSON "City":"string"
SOAP/XML <City>string</City>
City Abbreviation
- Returns an abbreviation for the city entered in the City field, if any.
Protocol Syntax JSON "CityAbbreviation":"string"
SOAP/XML <CityAbbreviation>string</CityAbbreviation>
Company Name
- Returns the company name.
Protocol Syntax JSON "CompanyName":"string"
SOAP/XML <CompanyName>string</CompanyName>
Congressional District
- Returns the 2-digit congressional district that belongs to the requested record.
Protocol Syntax JSON "CongressionalDistrict":"string"
SOAP/XML <CongressionalDistrict>string</CongressionalDistrict>
Country Code
- Returns the country code for the country in the Country field.
Protocol Syntax JSON "CountryCode":"string"
SOAP/XML <CountryCode>string</CountryCode>
Country Name
- Returns the country name for the record.
Protocol Syntax JSON "CountryName":"string"
SOAP/XML <CountryName>string</CountryName>
County FIPS
- Returns the FIPS code for the county in the County field.
Protocol Syntax JSON "CountyFIPS":"string"
SOAP/XML <CountyFIPS>string</CountyFIPS>
County Name
- Returns the county name.
Protocol Syntax JSON "CountyName":"string"
SOAP/XML <CountyName>string</CountyName>
County Subdivision Code
- Returns a 5 digit string representing the County Subdivision Code for the requested record.
Protocol Syntax JSON "CountySubdivisionCode":"string"
SOAP/XML <CountySubdivisionCode>string</CountySubdivisionCode>
County Subdivision Name
- Returns the County Subdivision Name for the requested record.
Protocol Syntax JSON "CountySubdivisionName":"string"
SOAP/XML <CountySubdivisionName>string</CountySubdivisionName>
!!!Credit Card User
Protocol Syntax JSON "CreditCardUser":"string"
SOAP/XML <CreditCardUser>string</CreditCardUser>
Date Of Birth
- Returns the date of birth in the format YYYYMM. Accuracy is only to the month.
Protocol Syntax JSON "DateOfBirth":"string"
SOAP/XML <DateOfBirth>string</DateOfBirth>
Date Of Death
- Returns the full date of death in the format YYYYMMDD.
Protocol Syntax JSON "DateOfDeath":"string"
SOAP/XML <DateOfDeath>string</DateOfDeath>
Delivery Indicator
- Returns an indicator of whether an address is a business address or residential address.
Protocol Syntax JSON "DeliveryIndicator":"string"
SOAP/XML <DeliveryIndicator>string</DeliveryIndicator>
Delivery Point Check Digit
- Returns a string value containing the 1-digit delivery point check digit.
Protocol Syntax JSON "DeliveryPointCheckDigit":"string"
SOAP/XML <DeliveryPointCheckDigit>string</DeliveryPointCheckDigit>
Delivery Point Code
- Returns a string value containing the 2-digit delivery point code.
Protocol Syntax JSON "DeliveryPointCode":"string"
SOAP/XML <DeliveryPointCode>string</DeliveryPointCode>
Demographics Gender
- Returns gender based on demographics data.
Value Unknown Male Female Neutral
Protocol Syntax JSON "DemographicsGender":"string"
SOAP/XML <DemographicsGender>string</DemographicsGender>
Demographics Results
- If any demographics are enabled, Demographics Results will return a comma delimited string containing all the results of the demographics combined.
Protocol Syntax JSON "DemographicsResults":"string"
SOAP/XML <DemographicsResults>string</DemographicsResults>
Domain Name
- Returns the parsed domain name for the email entered in the Email field.
Protocol Syntax JSON "DomainName":"string"
SOAP/XML <DomainName>string</DomainName>
!!!Education
Protocol Syntax JSON "Education":"string"
SOAP/XML <Education>string</Education>
Elementary School District Code
- Returns a 5 digit string representing the Elementary School District Code for the requested record.
Protocol Syntax JSON "ElementarySchoolDistrictCode":"string"
SOAP/XML <ElementarySchoolDistrictCode>string</ElementarySchoolDistrictCode>
Elementary School District Name
- Returns the Elementary School District Name for the requested record.
Protocol Syntax JSON "ElementarySchoolDistrictName":"string"
SOAP/XML <ElementarySchoolDistrictName>string</ElementarySchoolDistrictName>
Email Address
- Returns the email address entered in the Email field.
Protocol Syntax JSON "EmailAddress":"string"
SOAP/XML <EmailAddress>string</EmailAddress>
Gender
- Returns a gender for the name in the FullName field.
Protocol Syntax JSON "Gender":"string"
SOAP/XML <Gender>string</Gender>
Gender 2
- Only used if 2 names are in the FullName field. Returns a gender for the second name in the FullName field.
Protocol Syntax JSON "Gender2":"string"
SOAP/XML <Gender2>string</Gender2>
Household Income
- Returns the range of the household's income.
Protocol Syntax JSON "HouseholdIncome":"string"
SOAP/XML <HouseholdIncome>string</HouseholdIncome>
!!!Household Size
Protocol Syntax JSON "HouseholdSize":"string"
SOAP/XML <HouseholdSize>string</HouseholdSize>
Latitude
- Returns the geocoded latitude for the address entered in the AddressLine field.
Protocol Syntax JSON "Latitude":"string"
SOAP/XML <Latitude>string</Latitude>
Length of Residence
- 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
Protocol Syntax JSON "LengthOfResidence":"string"
SOAP/XML <LengthOfResidence>string</LengthOfResidence>
Longitude
- Returns the geocoded longitude for the address entered in the AddressLine field.
Protocol Syntax JSON "Longitude":"string"
SOAP/XML <Longitude>string</Longitude>
Mailbox Name
- Returns the parsed mailbox name for the email entered in the Email field.
Protocol Syntax JSON "MailboxName":"string"
SOAP/XML <MailboxName>string</MailboxName>
Marital Status
- Returns the individual's marital status.
Protocol Syntax JSON "MaritalStatus":"string"
SOAP/XML <MaritalStatus>string</MaritalStatus>
Melissa Address Key
- Returns a unique key associated with an address.
Protocol Syntax JSON "MelissaAddressKey":"string"
SOAP/XML <MelissaAddressKey>string</MelissaAddressKey>
Melissa Address Key Base
- Returns a unique key associated with a building containing multiple suites/apartments.
Protocol Syntax JSON "MelissaAddressKeyBase":"string"
SOAP/XML <MelissaAddressKeyBase>string</MelissaAddressKeyBase>
Move Date
- Returns the date associated with the move address.
Protocol Syntax JSON "MoveDate":"string"
SOAP/XML <MoveDate>string</>MoveDate
Name First
- Returns the first name in the FullName field.
Protocol Syntax JSON "NameFirst":"string"
SOAP/XML <NameFirst>string</NameFirst>
Name First 2
- Only used if 2 names are in the FullName field. Returns the second name in the FullName field.
Protocol Syntax JSON "NameFirst2":"string"
SOAP/XML <NameFirst2>string</NameFirst2>
Name Full
- Returns the full name for the record.
Protocol Syntax JSON "NameFull":"string"
SOAP/XML <NameFull>string</NameFull>
Name Last
- Returns the last name in the FullName field.
Protocol Syntax JSON "NameLast":"string"
SOAP/XML <NameLast>string</NameLast>
Name Last 2
- Only used if 2 names are in the FullName field. Returns a last name for the second name in the FullName field.
Protocol Syntax JSON "NameLast2":"string"
SOAP/XML <NameLast2>string</NameLast2>
Name Middle
- Returns a middle name for the name in the FullName field.
Protocol Syntax JSON "NameMiddle":"string"
SOAP/XML <NameMiddle>string</NameMiddle>
Name Middle 2
- Only used if 2 names are in the FullName field. Returns a middle name for the second name in the FullName field.
Protocol Syntax JSON "NameMiddle2":"string"
SOAP/XML <NameMiddle2>string</NameMiddle2>
Name Prefix
- Returns a prefix for the name in the FullName field.
Protocol Syntax JSON "NamePrefix":"string"
SOAP/XML <NamePrefix>string</NamePrefix>
Name Prefix 2
- Only used if 2 names are in the FullName field. Returns a prefix for the second name in the FullName field.
Protocol Syntax JSON "NamePrefix2":"string"
SOAP/XML <NamePrefix2>string</NamePrefix2>
Name Suffix
- Returns a suffix for the name in the FullName field.
Protocol Syntax JSON "NameSuffix":"string"
SOAP/XML <NameSuffix>string</NameSuffix>
Name Suffix 2
- Only used if 2 names are in the FullName field. Returns a suffix for the second name in the FullName field.
Protocol Syntax JSON "NameSuffix2":"string"
SOAP/XML <NameSuffix2>string</NameSuffix2>
New Area Code
- Returns the parsed new area code for the phone number entered in the Phone field.
Protocol Syntax JSON "NewAreaCode":"string"
SOAP/XML <NewAreaCode>string</NewAreaCode>
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
Protocol Syntax JSON "Occupation":"string"
SOAP/XML <Occupation>string</Occupation>
Own Rent
- Returns the individual's status as owner or renter of the property.
Value Unknown Definite Renter Inferred Renter Inferred Owner Definite Owner
Protocol Syntax JSON "OwnRent":"string"
SOAP/XML <OwnRent>string</OwnRent>
Phone Country Code
- Returns the 2 character country code for the phone number entered in the Phone field.
Protocol Syntax JSON "PhoneCountryCode":"string"
SOAP/XML <PhoneCountryCode>string</PhoneCountryCode>
Phone Country Name
- Returns the full country name for the phone number entered in the Phone field.
Protocol Syntax JSON "PhoneCountryName":"string"
SOAP/XML <PhoneCountryName>string</PhoneCountryName>
Phone Extension
- Returns the parsed extension for the phone number entered in the Phone field.
Protocol Syntax JSON "PhoneExtension":"string"
SOAP/XML <PhoneExtension>string</PhoneExtension>
Phone Number
- Returns the standardized phone number for the record.
Protocol Syntax JSON "PhoneNumber":"string"
SOAP/XML <PhoneNumber>string</PhoneNumber>
Phone Prefix
- Returns the parsed prefix for the phone number entered in the Phone field.
Protocol Syntax JSON "PhonePrefix":"string"
SOAP/XML <PhonePrefix>string</PhonePrefix>
Phone Suffix
- Returns the parsed suffix for the phone number entered in the Phone field.
Protocol Syntax JSON "PhoneSuffix":"string"
SOAP/XML <PhoneSuffix>string</PhoneSuffix>
Place Code
- 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, Place Code will refer to that area.
Protocol Syntax JSON "PlaceCode":"string"
SOAP/XML <PlaceCode>string</PlaceCode>
Place Name
- 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, Place Name will refer to that area.
Protocol Syntax JSON "PlaceName":"string"
SOAP/XML <PlaceName>string</PlaceName>
Plus 4
- 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.
Protocol Syntax JSON "Plus4":"string"
SOAP/XML <Plus4>string</Plus4>
!!!Political Party
Protocol Syntax JSON "PoliticalParty":"string"
SOAP/XML <PoliticalParty>string</PoliticalParty>
Postal Code
- Returns the 9-digit postal code for U.S. addresses and 6-digit postal code for Canadian addresses.
Protocol Syntax JSON "PostalCode":"string"
SOAP/XML <PostalCode>string</PostalCode>
Presence Of Children
- Returns the presence of children in the household.
Protocol Syntax JSON "PresenceOfChildren":"string"
SOAP/XML <PresenceOfChildren>string</PresenceOfChildren>
Presence Of Senior
- Returns the presence of seniors in the household.
Protocol Syntax JSON "PresenceOfSenior":"string"
SOAP/XML <PresenceOfSenior>string</PresenceOfSenior>
Private MailBox
- 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.
Protocol Syntax JSON "PrivateMailBox":"string"
SOAP/XML <PrivateMailBox>string</PrivateMailBox>
!!!Record Extras
Protocol Syntax JSON "RecordExtras":"string"
SOAP/XML <RecordExtras>string</RecordExtras>
Record ID
- This is a string value that is a unique identifier for the current record if one was sent in the request. Use this element to match a request record and the corresponding response record.
Protocol Syntax JSON "RecordID":"string"
SOAP/XML <RecordID>string</RecordID>
!!!Reserved
Protocol Syntax JSON "Reserved":"string"
SOAP/XML <Reserved>string</Reserved>
Results
- This is a string value with comma delimited status, error codes, and change codes for the record.
- For a complete list of codes, see Personator Result Codes.
Protocol Syntax JSON "Results":"string"
SOAP/XML <Results>string</Results>
Salutation
- Returns a salutation for the name in the FullName field.
Protocol Syntax JSON "Salutation":"string"
SOAP/XML <Salutation>string</>Salutation
Secondary School District Code
- Returns a 5 digit string representing the Secondary School District Code for the requested record.
Protocol Syntax JSON "SecondarySchoolDistrictCode":"string"
SOAP/XML <SecondarySchoolDistrictCode>string</SecondarySchoolDistrictCode>
Secondary School District Name
- Returns the Secondary School District Name for the requested record.
Protocol Syntax JSON "SecondarySchoolDistrictName":"string"
SOAP/XML <SecondarySchoolDistrictName>string</SecondarySchoolDistrictName>
State
- Returns the state for the record.
Protocol Syntax JSON "State":"string"
SOAP/XML <State>string</State>
State District Lower
- Returns a 3 digit string representing the Lower State District Code for the requested record.
Protocol Syntax JSON "StateDistrictLower":"string"
SOAP/XML <StateDistrictLower>string</StateDistrictLower>
State District Upper
- Returns a 3 digit string representing the Upper State District Code for the requested record.
Protocol Syntax JSON "StateDistrictUpper":"string"
SOAP/XML <StateDistrictUpper>string</StateDistrictUpper>
State Name
- Returns the full name of the state entered in the State field.
Protocol Syntax JSON "StateName":"string"
SOAP/XML <StateName>string</StateName>
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.
Protocol Syntax JSON "Suite":"string"
SOAP/XML <Suite>string</Suite>
Top Level Domain
- Returns the parsed top-level domain name for the email entered in the Email field.
Protocol Syntax JSON "TopLevelDomain":"string"
SOAP/XML <TopLevelDomain>string</TopLevelDomain>
!!!Types Of Vehicles
Protocol Syntax JSON "":"string"
SOAP/XML <>string</>
UTC
- Returns the time zone of the requested record. All Melissa Data products express time zones in UTC (Coordinated Universal Time).
Protocol Syntax JSON "UTC":"string"
SOAP/XML <UTC>string</UTC>
Unified School District Code
- Returns a 5 digit string representing the Unified School District Code for the requested record.
Protocol Syntax JSON "UnifiedSchoolDistrictCode":"string"
SOAP/XML <UnifiedSchoolDistrictCode>string</UnifiedSchoolDistrictCode>
Unified School District Name
- Returns the Secondary Unified District Name for the requested record.
Protocol Syntax JSON "UnifiedSchoolDistrictName":"string"
SOAP/XML <UnifiedSchoolDistrictName>string</UnifiedSchoolDistrictName>
UrbanizationName
- Returns the urbanization name for the address entered in the AddressLine field. Usually only used if the address is in Puerto Rico.
Protocol Syntax JSON "UrbanizationName":"string"
SOAP/XML <UrbanizationName>string</UrbanizationName>