Global Address Object:Output Parameters: Difference between revisions
No edit summary |
No edit summary |
||
| Line 64: | Line 64: | ||
{{CustomTOC}} | <div class="toclimit-2">{{CustomTOC}}</div> | ||
Though they are listed in mixed case, the parameters are not case sensitive. | Though they are listed in mixed case, the parameters are not case sensitive. | ||
| Line 70: | Line 70: | ||
==Output Detail Parameters== | ==Output Detail Parameters== | ||
===buildNumber=== | ===buildNumber=== | ||
Build number of the Global Address Object API. | |||
===databaseDate=== | ===databaseDate=== | ||
Release date of the database. | |||
===databaseExpirationDate=== | ===databaseExpirationDate=== | ||
Expiration date of the database. | |||
===dst=== | ===dst=== | ||
A true/false value delineating if the given address is in a time zone that supports Daylight Savings Time (DST). | |||
===initializeErrorString=== | ===initializeErrorString=== | ||
An error string detailing any failure or error in initializing the reference data file(s) and/or Global Address Object. | |||
===licensedCountries=== | ===licensedCountries=== | ||
A list of countries licensed for the license string set with [[Global Address Object:Setup Methods#SetLicenseString|SetLicenseString]]. | |||
===licenseStringExpirationDate=== | ===licenseStringExpirationDate=== | ||
Expiration date for the license string set with [[Global Address Object:Setup Methods#SetLicenseString|SetLicenseString]]. | |||
===remnants=== | ===remnants=== | ||
Any elements parsed from the input address data which could not be processed or were not relevant to the address processing are returned in the remnant parameter. | |||
===resultCodes=== | ===resultCodes=== | ||
Result code(s) generated for the address. Reference |[[Returned Result Codes:APIs#Global Address Object|Returned Result Codes]] for more information. | |||
===timezone=== | ===timezone=== | ||
Name of the timezone of the address. | |||
===utc=== | ===utc=== | ||
Coordinated Universal Time (Universal Time Coordinated). Code that designates the UTC offset for the given time zone of the address. This does not indicate differences due to daylight savings time. | |||
==Output Address Parameters== | ==Output Address Parameters== | ||
===organization=== | ===organization=== | ||
'''''Business''''' or '''''Company''''' | |||
===addressLine1=== | ===addressLine1=== | ||
Adress Lines 1-8 contain the unparsed address input. | |||
===addressLine2=== | ===addressLine2=== | ||
===addressLine3=== | ===addressLine3=== | ||
| Line 91: | Line 116: | ||
===addressLine7=== | ===addressLine7=== | ||
===addressLine8=== | ===addressLine8=== | ||
===country=== | ===country=== | ||
The country of the address. | |||
==Parsed Sub-Premises Parameters== | ==Parsed Sub-Premises Parameters== | ||
===building=== | ===building=== | ||
Descriptive name identifying an individual location. | |||
===subPremises=== | ===subPremises=== | ||
'''''Suite'''''. Alphanumeric code identifying an individual location. | |||
===subPremisesNumber=== | ===subPremisesNumber=== | ||
'''''Suite Number'''''. Sub premises number indicator within premises field. Parsed from the '''subPremises''' parameter. | |||
===subPremisesType=== | ===subPremisesType=== | ||
'''''Suite Name'''''. Sub premises type indicator within premises field. Parsed from the '''subPremises''' parameter. | |||
==Parsed Thoroughfare Parameters== | ==Parsed Thoroughfare Parameters== | ||
===premises=== | ===premises=== | ||
'''''Street Number'''''. | |||
===premisesNumber=== | ===premisesNumber=== | ||
Alphanumeric indicator within premises field. Parsed from the '''premises''' parameter. | |||
===premisesType=== | ===premisesType=== | ||
Leading premise type indicator within premises field. Parsed from the '''premises''' parameter. | |||
===thoroughfare=== | ===thoroughfare=== | ||
'''''Street'''''. Most common street or block data element. | |||
===thoroughfareLeadingType=== | ===thoroughfareLeadingType=== | ||
Leading thoroughfare type indicator parsed from the '''thoroughfare''' parameter. | |||
===thoroughfareName=== | ===thoroughfareName=== | ||
'''''Street Name'''''. Name indicator parsed from the '''thoroughfare''' parameter. | |||
===thoroughfarePostDirection=== | ===thoroughfarePostDirection=== | ||
'''''Street Post Direction'''''. Postfix directional parsed from the '''thoroughfare''' parameter. | |||
===thoroughfarePreDirection=== | ===thoroughfarePreDirection=== | ||
'''''Street PreDirection'''''. Prefix directional parsed from the '''thoroughfare''' parameter. | |||
===thoroughfareTrailingType=== | ===thoroughfareTrailingType=== | ||
'''''Street Suffix'''''. Trailing thoroughfare type indicator parsed from the '''thoroughfare''' parameter. | |||
===thoroughfareTypeAttached=== | ===thoroughfareTypeAttached=== | ||
==Parsed Dependent Thoroughfare Columns== | ==Parsed Dependent Thoroughfare Columns== | ||
===dependentThoroughfare=== | ===dependentThoroughfare=== | ||
'''''Dependent street''''' or block data element. | |||
===dependentThoroughfareConjunction=== | ===dependentThoroughfareConjunction=== | ||
===dependentThoroughfareLeadingType=== | ===dependentThoroughfareLeadingType=== | ||
Leading thoroughfare type indicator parsed from the '''dependentThoroughfare''' parameter. | |||
===dependentThoroughfareName=== | ===dependentThoroughfareName=== | ||
===dependentThoroughfarePostDirection=== | ===dependentThoroughfarePostDirection=== | ||
Postfix directional parsed from the '''dependentThoroughfare''' parameter. | |||
===dependentThoroughfarePreDirection=== | ===dependentThoroughfarePreDirection=== | ||
===dependentThoroughfareTrailingType=== | ===dependentThoroughfareTrailingType=== | ||
| Line 123: | Line 184: | ||
==Parsed Postal Facility Columns== | ==Parsed Postal Facility Columns== | ||
===carrierRoute=== | ===carrierRoute=== | ||
'''US Only'''. | |||
===parsedDeliveryInstallation=== | ===parsedDeliveryInstallation=== | ||
===parsedLockBox=== | ===parsedLockBox=== | ||
| Line 129: | Line 192: | ||
===parsedRouteService=== | ===parsedRouteService=== | ||
===postBox=== | ===postBox=== | ||
Post box information for a particular delivery point. | |||
===postalCode=== | ===postalCode=== | ||
'''''Zip (Plus 4)'''''. Complete postal code for a particular delivery point. In U.S. plus 4 is not required but will be appended if address is verified. | |||
===zipType=== | ===zipType=== | ||
'''US Only'''. | |||
==Parsed Regional Columns== | ==Parsed Regional Columns== | ||
===administrativeArea=== | ===administrativeArea=== | ||
'''''State'''''. Most common geographic data element. | |||
===cityAbbreviation=== | ===cityAbbreviation=== | ||
'''US Only'''. Official USPS abbreviation for the city or municipality name. | |||
===congressionalDistrict=== | ===congressionalDistrict=== | ||
'''US Only'''. Population-based. Congressional District of the address. | |||
===countyFips=== | ===countyFips=== | ||
'''US Only'''. Six-digit Federal Information Processing Standard (FIPS) code for the county. | |||
===countyName=== | ===countyName=== | ||
'''US Only'''. '''''Sub Administrative Area'''''. Smallest geographic data element. | |||
===dependentLocality=== | ===dependentLocality=== | ||
'''''Urbanization'''''. Smaller population center data element. Dependent on Locality. | |||
===doubleDependentLocality=== | ===doubleDependentLocality=== | ||
Smallest population center data element. | |||
===locality=== | ===locality=== | ||
'''''City'''''. Most common population center data element. | |||
===subAdministrativeArea=== | ===subAdministrativeArea=== | ||
'''''County'''''. Smallest geographic data element. | |||
===subNationalArea=== | ===subNationalArea=== | ||
Arbitrary administrative region below that of the sovereign state. | |||
===urbanization=== | ===urbanization=== | ||
'''US Only'''. '''''Dependent Locality'''''. Smaller population center data element. Dependent on Locality. | |||
==Extra Output Address Parameters== | ==Extra Output Address Parameters== | ||
===addressKey=== | ===addressKey=== | ||
Unique key generated for the address. Can be used by other Melissa Data products. | |||
===addressTypeCode=== | ===addressTypeCode=== | ||
One-character code for the type of address coded. | |||
===addressTypeString=== | ===addressTypeString=== | ||
===deliveryline=== | ===deliveryline=== | ||
===formattedAddress=== | ===formattedAddress=== | ||
===latitude=== | ===latitude=== | ||
Geographic coordinate for a particular delivery point. | |||
===localityLine=== | ===localityLine=== | ||
===longitude=== | ===longitude=== | ||
Geographic coordinate for a particular delivery point. | |||
==Extra Output Country Parameters== | ==Extra Output Country Parameters== | ||
| Line 160: | Line 258: | ||
===countryCode=== | ===countryCode=== | ||
===countryName=== | ===countryName=== | ||
Full country name. | |||
===iso2Code=== | ===iso2Code=== | ||
ISO 3166 2-character country code. | |||
===iso3Code=== | ===iso3Code=== | ||
ISO 3166 3-character country code. | |||
===isoCountryNumber=== | ===isoCountryNumber=== | ||
ISO 3166 3-digit numeric country code. | |||
[[Category:Global Address Object]] | [[Category:Global Address Object]] | ||
[[Category:Reference]] | [[Category:Reference]] | ||
Revision as of 21:01, 28 August 2014
← Global Address Object Reference
Though they are listed in mixed case, the parameters are not case sensitive.
Output Detail Parameters
buildNumber
Build number of the Global Address Object API.
databaseDate
Release date of the database.
databaseExpirationDate
Expiration date of the database.
dst
A true/false value delineating if the given address is in a time zone that supports Daylight Savings Time (DST).
initializeErrorString
An error string detailing any failure or error in initializing the reference data file(s) and/or Global Address Object.
licensedCountries
A list of countries licensed for the license string set with SetLicenseString.
licenseStringExpirationDate
Expiration date for the license string set with SetLicenseString.
remnants
Any elements parsed from the input address data which could not be processed or were not relevant to the address processing are returned in the remnant parameter.
resultCodes
Result code(s) generated for the address. Reference |Returned Result Codes for more information.
timezone
Name of the timezone of the address.
utc
Coordinated Universal Time (Universal Time Coordinated). Code that designates the UTC offset for the given time zone of the address. This does not indicate differences due to daylight savings time.
Output Address Parameters
organization
Business or Company
addressLine1
Adress Lines 1-8 contain the unparsed address input.
addressLine2
addressLine3
addressLine4
addressLine5
addressLine6
addressLine7
addressLine8
country
The country of the address.
Parsed Sub-Premises Parameters
building
Descriptive name identifying an individual location.
subPremises
Suite. Alphanumeric code identifying an individual location.
subPremisesNumber
Suite Number. Sub premises number indicator within premises field. Parsed from the subPremises parameter.
subPremisesType
Suite Name. Sub premises type indicator within premises field. Parsed from the subPremises parameter.
Parsed Thoroughfare Parameters
premises
Street Number.
premisesNumber
Alphanumeric indicator within premises field. Parsed from the premises parameter.
premisesType
Leading premise type indicator within premises field. Parsed from the premises parameter.
thoroughfare
Street. Most common street or block data element.
thoroughfareLeadingType
Leading thoroughfare type indicator parsed from the thoroughfare parameter.
thoroughfareName
Street Name. Name indicator parsed from the thoroughfare parameter.
thoroughfarePostDirection
Street Post Direction. Postfix directional parsed from the thoroughfare parameter.
thoroughfarePreDirection
Street PreDirection. Prefix directional parsed from the thoroughfare parameter.
thoroughfareTrailingType
Street Suffix. Trailing thoroughfare type indicator parsed from the thoroughfare parameter.
thoroughfareTypeAttached
Parsed Dependent Thoroughfare Columns
dependentThoroughfare
Dependent street or block data element.
dependentThoroughfareConjunction
dependentThoroughfareLeadingType
Leading thoroughfare type indicator parsed from the dependentThoroughfare parameter.
dependentThoroughfareName
dependentThoroughfarePostDirection
Postfix directional parsed from the dependentThoroughfare parameter.
dependentThoroughfarePreDirection
dependentThoroughfareTrailingType
dependentThoroughfareTypeAttached
Parsed Postal Facility Columns
carrierRoute
US Only.
parsedDeliveryInstallation
parsedLockBox
parsedPrivateMailboxName
parsedPrivateMailboxNumber
parsedRouteService
postBox
Post box information for a particular delivery point.
postalCode
Zip (Plus 4). Complete postal code for a particular delivery point. In U.S. plus 4 is not required but will be appended if address is verified.
zipType
US Only.
Parsed Regional Columns
administrativeArea
State. Most common geographic data element.
cityAbbreviation
US Only. Official USPS abbreviation for the city or municipality name.
congressionalDistrict
US Only. Population-based. Congressional District of the address.
countyFips
US Only. Six-digit Federal Information Processing Standard (FIPS) code for the county.
countyName
US Only. Sub Administrative Area. Smallest geographic data element.
dependentLocality
Urbanization. Smaller population center data element. Dependent on Locality.
doubleDependentLocality
Smallest population center data element.
locality
City. Most common population center data element.
subAdministrativeArea
County. Smallest geographic data element.
subNationalArea
Arbitrary administrative region below that of the sovereign state.
urbanization
US Only. Dependent Locality. Smaller population center data element. Dependent on Locality.
Extra Output Address Parameters
addressKey
Unique key generated for the address. Can be used by other Melissa Data products.
addressTypeCode
One-character code for the type of address coded.
addressTypeString
deliveryline
formattedAddress
latitude
Geographic coordinate for a particular delivery point.
localityLine
longitude
Geographic coordinate for a particular delivery point.
Extra Output Country Parameters
countryAbbreviation
countryCode
countryName
Full country name.
iso2Code
ISO 3166 2-character country code.
iso3Code
ISO 3166 3-character country code.
isoCountryNumber
ISO 3166 3-digit numeric country code.