Personator Consumer:Response
Jump to navigation
Jump to search
| 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
Protocol Syntax JSON "AddressDeliveryInstallation":"string"SOAP/XML <AddressDeliveryInstallation>string</AddressDeliveryInstallation>
FormattedAddress
- This is a string value that is the address in the correct format for mailing from the country specified in the CountryOfOrigin element. This includes the Organization as the first line, one or more lines in the origin country’s format, and the destination country (if required). Separate lines will be delimited by what is specified in the option. See LineSeparator for more information.
Protocol Syntax JSON "FormattedAddress":"string"SOAP/XML <FormattedAddress>string</FormattedAddress>
Organization
- This is a string value that matches the Organization request element. It is not modified or populated by the Cloud Service.
Protocol Syntax JSON "Organization":"string"SOAP/XML <Organization>string</Organization>
AddressLine1
- These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.
Protocol Syntax JSON "AddressLine1":"string"SOAP/XML <AddressLine1>string</AddressLine1>
AddressLine2
- These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.
Protocol Syntax JSON "AddressLine2":"string"SOAP/XML <AddressLine2>string</AddressLine2>
AddressLine3
- These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.
Protocol Syntax JSON "AddressLine3":"string"SOAP/XML <AddressLine3>string</AddressLine3>
AddressLine4
- These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.
Protocol Syntax JSON "AddressLine4":"string"SOAP/XML <AddressLine4>string</AddressLine4>
AddressLine5
- These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.
Protocol Syntax JSON "AddressLine5":"string"SOAP/XML <AddressLine5>string</AddressLine5>
AddressLine6
- These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.
Protocol Syntax JSON "AddressLine6":"string"SOAP/XML <AddressLine6>string</AddressLine6>
AddressLine7
- These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.
Protocol Syntax JSON "AddressLine7":"string"SOAP/XML <AddressLine7>string</AddressLine7>
AddressLine8
- These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.
Protocol Syntax JSON "AddressLine8":"string"SOAP/XML <AddressLine8>string</AddressLine8>
SubPremises
- This is a string value that is the parsed SubPremises from the AddressLine elements.
- US Term: Suite
Protocol Syntax JSON "SubPremises":"string"SOAP/XML <SubPremises>string</SubPremises>
DoubleDependentLocality
- This is a string value that is the standardized contents of the DoubleDependentLocality element.
Protocol Syntax JSON "DoubleDependentLocality":"string"SOAP/XML <DoubleDependentLocality>string</DoubleDependentLocality>
DependentLocality
- This is a string value that is the standardized contents of the DependentLocality element.
Protocol Syntax JSON "DependentLocality":"string"SOAP/XML <DependentLocality>string</DependentLocality>
Locality
- This is a string value that is the standardized contents of the Locality element.
Protocol Syntax JSON "Locality":"string"SOAP/XML <Locality>string</Locality>
SubAdministrativeArea
- This is a string value that is the standardized contents of the SubAdministrativeArea element.
Protocol Syntax JSON "SubAdministrativeArea":"string"SOAP/XML <SubAdministrativeArea>string</SubAdministrativeArea>
AdministrativeArea
- This is a string value that is the standardized contents of the AdministrativeArea element.
Protocol Syntax JSON "AdministrativeArea":"string"SOAP/XML <AdministrativeArea>string</AdministrativeArea>
PostalCode
- This is a string value that is the standardized contents of the PostalCode element.
Protocol Syntax JSON "PostalCode":"string"SOAP/XML <PostalCode>string</PostalCode>
Appended Address Record Elements
AddressType
- This is an appended string value that returns a one-character code for the type of address coded. This element works only for US and Canadian addresses.
Protocol Syntax JSON "AddressType":"string"SOAP/XML <AddressType>string</AddressType>
AddressKey
- This is a string value that is a unique key for the address. Only for US and Canadian addresses.
- The AddressKey can be used by other Melissa Data services, such as Geocoder or RBDI.
Protocol Syntax JSON "AddressKey":"string"SOAP/XML <AddressKey>string</AddressKey>
SubNationalArea
- This is a string value that is the standardized contents of the SubNationalArea element.
Protocol Syntax JSON "SubNationalArea":"string"SOAP/XML <SubNationalArea>string</SubNationalArea>
CountryName
- This is a string value that is the standardized contents of the CountryName element.
Protocol Syntax JSON "CountryName":"string"SOAP/XML <CountryName>string</CountryName>
CountryISO3166_1_Alpha2
- This is a string value that is the parsed CountryISO3166_1_Alpha2 element from the input.
- For example:
Country Code United States US Canada CA Philippines PH
Protocol Syntax JSON "CountryISO3166_1_Alpha2":"string"SOAP/XML <CountryISO3166_1_Alpha2>string</CountryISO3166_1_Alpha2>
CountryISO3166_1_Alpha3
- This is a string value that is the parsed CountryISO3166_1_Alpha3 element from the input.
- For example:
Country Code United States USA Canada CAN Philippines PHL
Protocol Syntax JSON "CountryISO3166_1_Alpha3":"string"SOAP/XML <CountryISO3166_1_Alpha3>string</CountryISO3166_1_Alpha3>
CountryISO3166_1_Numeric
- This is a string value that is the parsed CountryISO3166_1_Numeric element from the input.
- For example:
Country Code United States 840 Canada 124 Philippines 608
Protocol Syntax JSON "CountryISO3166_1_Numeric":"string"SOAP/XML <CountryISO3166_1_Numeric>string</CountryISO3166_1_Numeric>
CountrySubdivisionCode
- This is the ISO3166-2 code for country subdivisions, usually the administrative area for a country. The format is the 2 letter country code followed by a dash followed by 2 or 3 characters or two numbers. Examples are: US-CA, CN-16, or AU-VIC.
- Currently, this field is only populated for some countries. These countries are: AU, BR, CA, CN, CR, DM, GT, HN, NI, MX, SV, US.
Protocol Syntax JSON "CountrySubdivisionCode":"string"SOAP/XML <CountrySubdivisionCode>string</CountrySubdivisionCode>
Thoroughfare
- This is a string value that is the parsed Thoroughfare element from the input.
Protocol Syntax JSON "Thoroughfare":"string"SOAP/XML <Thoroughfare>string</Thoroughfare>
ThoroughfarePreDirection
- This is a string value that is the parsed ThoroughfarePreDirection element from the input.
Protocol Syntax JSON "ThoroughfarePreDirection":"string"SOAP/XML <ThoroughfarePreDirection>string</ThoroughfarePreDirection>
ThoroughfareLeadingType
- This is a string value that is the parsed ThoroughfareLeadingType element from the input.
Protocol Syntax JSON "ThoroughfareLeadingType":"string"SOAP/XML <ThoroughfareLeadingType>string</ThoroughfareLeadingType>
ThoroughfareName
- This is a string value that is the parsed ThoroughfareName element from the input.
Protocol Syntax JSON "ThoroughfareName":"string"SOAP/XML <ThoroughfareName>string</ThoroughfareName>
ThoroughfareTrailingType
- This is a string value that is the parsed ThoroughfareTrailingType element from the input.
Protocol Syntax JSON "ThoroughfareTrailingType":"string"SOAP/XML <ThoroughfareTrailingType>string</ThoroughfareTrailingType>
ThoroughfarePostDirection
- This is a string value that is the parsed ThoroughfarePostDirection element from the input.
Protocol Syntax JSON "ThoroughfarePostDirection":"string"SOAP/XML <ThoroughfarePostDirection>string</ThoroughfarePostDirection>
DependentThoroughfare
- This is a string value that is the parsed DependentThoroughfare element from the input.
Protocol Syntax JSON "DependentThoroughfare":"string"SOAP/XML <DependentThoroughfare>string</DependentThoroughfare>
DependentThoroughfarePreDirection
- This is a string value that is the parsed DependentThoroughfarePreDirection element from the input.
Protocol Syntax JSON "DependentThoroughfarePreDirection":"string"SOAP/XML <DependentThoroughfarePreDirection>string</DependentThoroughfarePreDirection>
DependentThoroughfareLeadingType
- This is a string value that is the parsed DependentThoroughfareLeadingType element from the input.
Protocol Syntax JSON "DependentThoroughfareLeadingType":"string"SOAP/XML <DependentThoroughfareLeadingType>string</DependentThoroughfareLeadingType>
DependentThoroughfareName
- This is a string value that is the parsed DependentThoroughfareName element from the input.
Protocol Syntax JSON "DependentThoroughfareName":"string"SOAP/XML <DependentThoroughfareName>string</DependentThoroughfareName>
DependentThoroughfareTrailingType
- This is a string value that is the parsed DependentThoroughfareTrailingType element from the input.
Protocol Syntax JSON "DependentThoroughfareTrailingType":"string"SOAP/XML <DependentThoroughfareTrailingType>string</DependentThoroughfareTrailingType>
DependentThoroughfarePostDirection
- This is a string value that is the parsed DependentThoroughfarePostDirection element from the input.
Protocol Syntax JSON "DependentThoroughfarePostDirection":"string"SOAP/XML <DependentThoroughfarePostDirection>string</DependentThoroughfarePostDirection>
Building
- This is a string value that is the parsed Building element from the input.
Protocol Syntax JSON "Building":"string"SOAP/XML <Building>string</Building>
PremisesType
- This is a string value that is the parsed PremisesType element from the input.
Protocol Syntax JSON "PremisesType":"string"SOAP/XML <PremisesType>string</PremisesType>
PremisesNumber
- This is a string value that is the parsed PremisesNumber element from the input.
Protocol Syntax JSON "PremisesNumber":"string"SOAP/XML <PremisesNumber>string</PremisesNumber>
SubPremisesType
- This is a string value that is the parsed SubPremisesType element from the input.
Protocol Syntax JSON "SubPremisesType":"string"SOAP/XML <SubPremisesType>string</SubPremisesType>
SubPremisesNumber
- This is a string value that is the parsed SubPremisesNumber element from the input.
Protocol Syntax JSON "SubPremisesNumber":"string"SOAP/XML <SubPremisesNumber>string</SubPremisesNumber>
PostBox
- This is a string value that is the parsed PostBox element from the input.
Protocol Syntax JSON "PostBox":"string"SOAP/XML <PostBox>string</PostBox>
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>
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
Protocol Syntax JSON "SecondarySchoolDistrictCode":"string"SOAP/XML <SecondarySchoolDistrictCode>string</SecondarySchoolDistrictCode>
Protocol Syntax JSON "":"string"SOAP/XML <>string</>
Protocol Syntax JSON "":"string"SOAP/XML <>string</>
Protocol Syntax JSON "":"string"SOAP/XML <>string</>
Protocol Syntax JSON "":"string"SOAP/XML <>string</>
Protocol Syntax JSON "":"string"SOAP/XML <>string</>
Protocol Syntax JSON "":"string"SOAP/XML <>string</>
Protocol Syntax JSON "":"string"SOAP/XML <>string</>
Protocol Syntax JSON "":"string"SOAP/XML <>string</>
Protocol Syntax JSON "":"string"SOAP/XML <>string</>
Protocol Syntax JSON "":"string"SOAP/XML <>string</>
Protocol Syntax JSON "":"string"SOAP/XML <>string</>
Protocol Syntax JSON "":"string"SOAP/XML <>string</>
Protocol Syntax JSON "":"string"SOAP/XML <>string</>
Protocol Syntax JSON "":"string"SOAP/XML <>string</>