Difference between revisions of "Global Address Object:Output Parameters"
| Line 9: | Line 9: | ||
==Output Detail Parameters== | ==Output Detail Parameters== | ||
= | <h3 style="background-color:rgb(240,240,240);">buildNumber</h3> | ||
Build number of the Global Address Object API. | Build number of the Global Address Object API. | ||
= | <h3 style="background-color:rgb(240,240,240);">databaseDate</h3> | ||
Release date of the database. | Release date of the database. | ||
= | <h3 style="background-color:rgb(240,240,240);">databaseExpirationDate</h3> | ||
Expiration date of the database. | Expiration date of the database. | ||
= | <h3 style="background-color:rgb(240,240,240);">dst</h3> | ||
A true/false value delineating if the given address is in a time zone that supports Daylight Savings Time (DST). | A true/false value delineating if the given address is in a time zone that supports Daylight Savings Time (DST). | ||
= | <h3 style="background-color:rgb(240,240,240);">initializeErrorString</h3> | ||
An error string detailing any failure or error in initializing the reference data file(s) and/or Global Address Object. | An error string detailing any failure or error in initializing the reference data file(s) and/or Global Address Object. | ||
= | <h3 style="background-color:rgb(240,240,240);">licenseStringExpirationDate</h3> | ||
Expiration date for the License Key set with [[Global Address Object:Setup Methods#SetLicenseString|SetLicenseString]]. | Expiration date for the License Key set with [[Global Address Object:Setup Methods#SetLicenseString|SetLicenseString]]. | ||
= | <h3 style="background-color:rgb(240,240,240);">remnants</h3> | ||
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. | 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. | ||
= | <h3 style="background-color:rgb(240,240,240);">resultCodes</h3> | ||
Result code(s) generated for the address. Reference |[[Returned Result Codes:APIs#Global Address Object|Returned Result Codes]] for more information. | Result code(s) generated for the address. Reference |[[Returned Result Codes:APIs#Global Address Object|Returned Result Codes]] for more information. | ||
= | <h3 style="background-color:rgb(240,240,240);">timezone</h3> | ||
Name of the timezone of the address. | Name of the timezone of the address. | ||
= | <h3 style="background-color:rgb(240,240,240);">utc</h3> | ||
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. | 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== | ||
= | <h3 style="background-color:rgb(240,240,240);">organization</h3> | ||
'''''Business''''' or '''''Company''''' | '''''Business''''' or '''''Company''''' | ||
= | <h3 style="background-color:rgb(240,240,240);">addressLine1</h3> | ||
Adress Lines 1-8 will contain the full output address in the preferred format for that country. | Adress Lines 1-8 will contain the full output address in the preferred format for that country. | ||
= | <h3 style="background-color:rgb(240,240,240);">addressLine2</h3> | ||
= | <h3 style="background-color:rgb(240,240,240);">addressLine3</h3> | ||
= | <h3 style="background-color:rgb(240,240,240);">addressLine4</h3> | ||
= | <h3 style="background-color:rgb(240,240,240);">addressLine5</h3> | ||
= | <h3 style="background-color:rgb(240,240,240);">addressLine6</h3> | ||
= | <h3 style="background-color:rgb(240,240,240);">addressLine7</h3> | ||
= | <h3 style="background-color:rgb(240,240,240);">addressLine8</h3> | ||
= | <h3 style="background-color:rgb(240,240,240);">deliveryLine</h3> | ||
The delivery portion of the full address, from the sub-premise and house number to the dependent locality. Does not include area information like locality, administrative area, and postal code. | The delivery portion of the full address, from the sub-premise and house number to the dependent locality. Does not include area information like locality, administrative area, and postal code. | ||
= | <h3 style="background-color:rgb(240,240,240);">formattedAddress</h3> | ||
Mailing address. The full mailing address in the preferred format for the country of the address. | Mailing address. The full mailing address in the preferred format for the country of the address. | ||
==Parsed Sub-Premises Parameters== | ==Parsed Sub-Premises Parameters== | ||
= | <h3 style="background-color:rgb(240,240,240);">building</h3> | ||
Descriptive name identifying an individual location. | Descriptive name identifying an individual location. | ||
= | <h3 style="background-color:rgb(240,240,240);">subBuilding</h3> | ||
Descriptive name identifying an individual location. More specific than building. | Descriptive name identifying an individual location. More specific than building. | ||
= | <h3 style="background-color:rgb(240,240,240);">subBuildingNumber</h3> | ||
Sub building number indicator within building field. Parsed from the '''subBuilding''' parameter. | Sub building number indicator within building field. Parsed from the '''subBuilding''' parameter. | ||
= | <h3 style="background-color:rgb(240,240,240);">subBuildingType</h3> | ||
Sub building type indicator within building field. Parsed from the '''subBuilding''' parameter. | Sub building type indicator within building field. Parsed from the '''subBuilding''' parameter. | ||
= | <h3 style="background-color:rgb(240,240,240);">subPremises</h3> | ||
'''''Suite'''''. Alphanumeric code identifying an individual location. More specific than premises. | '''''Suite'''''. Alphanumeric code identifying an individual location. More specific than premises. | ||
= | <h3 style="background-color:rgb(240,240,240);">subPremisesNumber</h3> | ||
'''''Suite Number'''''. Sub premises number indicator within premises field. Parsed from the '''subPremises''' parameter. | '''''Suite Number'''''. Sub premises number indicator within premises field. Parsed from the '''subPremises''' parameter. | ||
= | <h3 style="background-color:rgb(240,240,240);">subPremisesType</h3> | ||
'''''Suite Name'''''. Sub premises type indicator within premises field. Parsed from the '''subPremises''' parameter. | '''''Suite Name'''''. Sub premises type indicator within premises field. Parsed from the '''subPremises''' parameter. | ||
= | <h3 style="background-color:rgb(240,240,240);">subPremisesLevel</h3> | ||
Alphanumeric code identifying an individual location. More specific than sub premises. | Alphanumeric code identifying an individual location. More specific than sub premises. | ||
= | <h3 style="background-color:rgb(240,240,240);">subPremisesLevelNumber</h3> | ||
Sub premises level number indicator within premises field. Parsed from the '''subPremisesLevel''' parameter. | Sub premises level number indicator within premises field. Parsed from the '''subPremisesLevel''' parameter. | ||
= | <h3 style="background-color:rgb(240,240,240);">subPremisesLevelType</h3> | ||
Sub premises level type indicator within premises field. Parsed from the '''subPremisesLevel''' parameter. | Sub premises level type indicator within premises field. Parsed from the '''subPremisesLevel''' parameter. | ||
==Parsed Thoroughfare Parameters== | ==Parsed Thoroughfare Parameters== | ||
= | <h3 style="background-color:rgb(240,240,240);">premises</h3> | ||
'''''Street Number'''''. | '''''Street Number'''''. | ||
= | <h3 style="background-color:rgb(240,240,240);">premisesNumber</h3> | ||
Alphanumeric indicator within premises field. Parsed from the '''premises''' parameter. | Alphanumeric indicator within premises field. Parsed from the '''premises''' parameter. | ||
= | <h3 style="background-color:rgb(240,240,240);">premisesType</h3> | ||
Leading premise type indicator within premises field. Parsed from the '''premises''' parameter. | Leading premise type indicator within premises field. Parsed from the '''premises''' parameter. | ||
= | <h3 style="background-color:rgb(240,240,240);">thoroughfare</h3> | ||
'''''Street'''''. Most common street or block data element. | '''''Street'''''. Most common street or block data element. | ||
= | <h3 style="background-color:rgb(240,240,240);">thoroughfareLeadingType</h3> | ||
Leading thoroughfare type indicator parsed from the '''thoroughfare''' parameter. | Leading thoroughfare type indicator parsed from the '''thoroughfare''' parameter. | ||
= | <h3 style="background-color:rgb(240,240,240);">thoroughfareName</h3> | ||
'''''Street Name'''''. Name indicator parsed from the '''thoroughfare''' parameter. | '''''Street Name'''''. Name indicator parsed from the '''thoroughfare''' parameter. | ||
= | <h3 style="background-color:rgb(240,240,240);">thoroughfarePostDirection</h3> | ||
'''''Street Post Direction'''''. Postfix directional parsed from the '''thoroughfare''' parameter. | '''''Street Post Direction'''''. Postfix directional parsed from the '''thoroughfare''' parameter. | ||
= | <h3 style="background-color:rgb(240,240,240);">thoroughfarePreDirection</h3> | ||
'''''Street PreDirection'''''. Prefix directional parsed from the '''thoroughfare''' parameter. | '''''Street PreDirection'''''. Prefix directional parsed from the '''thoroughfare''' parameter. | ||
= | <h3 style="background-color:rgb(240,240,240);">thoroughfareTrailingType</h3> | ||
'''''Street Suffix'''''. Trailing thoroughfare type indicator parsed from the '''thoroughfare''' parameter. | '''''Street Suffix'''''. Trailing thoroughfare type indicator parsed from the '''thoroughfare''' parameter. | ||
= | <h3 style="background-color:rgb(240,240,240);">thoroughfareTypeAttached</h3> | ||
Thoroughfare type connected to the thoroughfare name without a space. This is common in Germany. For example, "Berlinerstr." "str." stands for strasse and is the thoroughfare type attached, while "Berliner" is the thoroughfare name. | Thoroughfare type connected to the thoroughfare name without a space. This is common in Germany. For example, "Berlinerstr." "str." stands for strasse and is the thoroughfare type attached, while "Berliner" is the thoroughfare name. | ||
==Parsed Dependent Thoroughfare Columns== | ==Parsed Dependent Thoroughfare Columns== | ||
= | <h3 style="background-color:rgb(240,240,240);">dependentThoroughfare</h3> | ||
'''''Dependent street''''' or block data element. This is used when there are more than one thoroughfares with the same name in one locality. An adjoining thoroughfare is used to uniquely identify the target thoroughfare. | '''''Dependent street''''' or block data element. This is used when there are more than one thoroughfares with the same name in one locality. An adjoining thoroughfare is used to uniquely identify the target thoroughfare. | ||
= | <h3 style="background-color:rgb(240,240,240);">dependentThoroughfareLeadingType</h3> | ||
Thoroughfare type at the beginning of the dependent thoroughfare. The leading type is parsed from the '''dependentThoroughfare''' parameter. For example, if the dependent thoroughfare is "St. Hickory E," the dependent thoroughfare leading type would be "St." | Thoroughfare type at the beginning of the dependent thoroughfare. The leading type is parsed from the '''dependentThoroughfare''' parameter. For example, if the dependent thoroughfare is "St. Hickory E," the dependent thoroughfare leading type would be "St." | ||
= | <h3 style="background-color:rgb(240,240,240);">dependentThoroughfareName</h3> | ||
Dependent thoroughfare name parsed from the '''dependentThoroughfare''' parameter. For example, if the dependent thoroughfare is "E Hickory Ln," the dependent thoroughfare name would be "Hickory." | Dependent thoroughfare name parsed from the '''dependentThoroughfare''' parameter. For example, if the dependent thoroughfare is "E Hickory Ln," the dependent thoroughfare name would be "Hickory." | ||
= | <h3 style="background-color:rgb(240,240,240);">dependentThoroughfarePostDirection</h3> | ||
Cardinal directional at the end of the dependent thoroughfare. The postfix directional is parsed from the '''dependentThoroughfare''' parameter. For example, if the dependent thoroughfare is "Hickory Ln N," the dependent thoroughfare post direction would be "N." | Cardinal directional at the end of the dependent thoroughfare. The postfix directional is parsed from the '''dependentThoroughfare''' parameter. For example, if the dependent thoroughfare is "Hickory Ln N," the dependent thoroughfare post direction would be "N." | ||
= | <h3 style="background-color:rgb(240,240,240);">dependentThoroughfarePreDirection</h3> | ||
Cardinal directional at the beginning of the dependent thoroughfare. The prefix directional is parsed from the '''dependentThoroughfare''' parameter. For example, if the dependent thoroughfare is "W Hickory Ln," the dependent thoroughfare pre direction would be "W." | Cardinal directional at the beginning of the dependent thoroughfare. The prefix directional is parsed from the '''dependentThoroughfare''' parameter. For example, if the dependent thoroughfare is "W Hickory Ln," the dependent thoroughfare pre direction would be "W." | ||
= | <h3 style="background-color:rgb(240,240,240);">dependentThoroughfareTrailingType</h3> | ||
Thoroughfare type at the end of the dependent thoroughfare. The trailing type is parsed from the '''dependentThoroughfare''' parameter. For example, if the dependent thoroughfare is "W Hickory Ln," the dependent thoroughfare trailing type would be "Ln." | Thoroughfare type at the end of the dependent thoroughfare. The trailing type is parsed from the '''dependentThoroughfare''' parameter. For example, if the dependent thoroughfare is "W Hickory Ln," the dependent thoroughfare trailing type would be "Ln." | ||
= | <h3 style="background-color:rgb(240,240,240);">dependentThoroughfareTypeAttached</h3> | ||
Dependent thoroughfare type connected to the dependent thoroughfare name without a space. This is common in Germany. For example, "Berlinerstr." "str." stands for strasse and is the dependent thoroughfare type attached, while "Berliner" is the dependent thoroughfare name. | Dependent thoroughfare type connected to the dependent thoroughfare name without a space. This is common in Germany. For example, "Berlinerstr." "str." stands for strasse and is the dependent thoroughfare type attached, while "Berliner" is the dependent thoroughfare name. | ||
==Parsed Postal Facility Columns== | ==Parsed Postal Facility Columns== | ||
= | <h3 style="background-color:rgb(240,240,240);">postBox</h3> | ||
Post box information for a particular delivery point. | Post box information for a particular delivery point. | ||
= | <h3 style="background-color:rgb(240,240,240);">postalCode</h3> | ||
'''''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. | '''''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. | ||
= | <h3 style="background-color:rgb(240,240,240);">personalID</h3> | ||
Used by certain Post Offices to identify a recipient for a package. | Used by certain Post Offices to identify a recipient for a package. | ||
= | <h3 style="background-color:rgb(240,240,240);">postOfficeLocation</h3> | ||
==Parsed Regional Columns== | ==Parsed Regional Columns== | ||
= | <h3 style="background-color:rgb(240,240,240);">administrativeArea</h3> | ||
'''''State'''''. Most common geographic data element. | '''''State'''''. Most common geographic data element. | ||
= | <h3 style="background-color:rgb(240,240,240);">countyName</h3> | ||
'''US Only'''. '''''Sub Administrative Area'''''. Smallest geographic data element. | '''US Only'''. '''''Sub Administrative Area'''''. Smallest geographic data element. | ||
= | <h3 style="background-color:rgb(240,240,240);">dependentLocality</h3> | ||
'''''Urbanization'''''. Smaller population center data element. Dependent on Locality. | '''''Urbanization'''''. Smaller population center data element. Dependent on Locality. | ||
= | <h3 style="background-color:rgb(240,240,240);">doubleDependentLocality</h3> | ||
Smallest population center data element. | Smallest population center data element. | ||
= | <h3 style="background-color:rgb(240,240,240);">locality</h3> | ||
'''''City'''''. Most common population center data element. | '''''City'''''. Most common population center data element. | ||
= | <h3 style="background-color:rgb(240,240,240);">subAdministrativeArea</h3> | ||
'''''County'''''. Smallest geographic data element. | '''''County'''''. Smallest geographic data element. | ||
= | <h3 style="background-color:rgb(240,240,240);">subNationalArea</h3> | ||
Arbitrary administrative region below that of the sovereign state. | Arbitrary administrative region below that of the sovereign state. | ||
| Line 251: | Line 251: | ||
|} | |} | ||
= | <h3 style="background-color:rgb(240,240,240);">latitude</h3> | ||
North-south geographic coordinate for a particular delivery point. | North-south geographic coordinate for a particular delivery point. | ||
= | <h3 style="background-color:rgb(240,240,240);">longitude</h3> | ||
East-west geographic coordinate for a particular delivery point. | East-west geographic coordinate for a particular delivery point. | ||
==Extra Output Country Parameters== | ==Extra Output Country Parameters== | ||
= | <h3 style="background-color:rgb(240,240,240);">countryCode</h3> | ||
= | <h3 style="background-color:rgb(240,240,240);">countryName</h3> | ||
Full country name. Can be a nickname. | Full country name. Can be a nickname. | ||
= | <h3 style="background-color:rgb(240,240,240);">iso2Code</h3> | ||
ISO 3166 2-character country code. | ISO 3166 2-character country code. | ||
= | <h3 style="background-color:rgb(240,240,240);">iso3Code</h3> | ||
ISO 3166 3-character country code. | ISO 3166 3-character country code. | ||
= | <h3 style="background-color:rgb(240,240,240);">isoCountryNumber</h3> | ||
ISO 3166 3-digit numeric country code. | ISO 3166 3-digit numeric country code. | ||
= | <h3 style="background-color:rgb(240,240,240);">formalCountryName</h3> | ||
Official Name for the country. | Official Name for the country. | ||
Revision as of 23:48, 15 September 2017
← Global Address Object Reference
| Global Address Object Navigation | |||||
|---|---|---|---|---|---|
| |||||
| |||||
| |||||
| |||||
|
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.
licenseStringExpirationDate
Expiration date for the License Key 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 will contain the full output address in the preferred format for that country.
addressLine2
addressLine3
addressLine4
addressLine5
addressLine6
addressLine7
addressLine8
deliveryLine
The delivery portion of the full address, from the sub-premise and house number to the dependent locality. Does not include area information like locality, administrative area, and postal code.
formattedAddress
Mailing address. The full mailing address in the preferred format for the country of the address.
Parsed Sub-Premises Parameters
building
Descriptive name identifying an individual location.
subBuilding
Descriptive name identifying an individual location. More specific than building.
subBuildingNumber
Sub building number indicator within building field. Parsed from the subBuilding parameter.
subBuildingType
Sub building type indicator within building field. Parsed from the subBuilding parameter.
subPremises
Suite. Alphanumeric code identifying an individual location. More specific than premises.
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.
subPremisesLevel
Alphanumeric code identifying an individual location. More specific than sub premises.
subPremisesLevelNumber
Sub premises level number indicator within premises field. Parsed from the subPremisesLevel parameter.
subPremisesLevelType
Sub premises level type indicator within premises field. Parsed from the subPremisesLevel 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
Thoroughfare type connected to the thoroughfare name without a space. This is common in Germany. For example, "Berlinerstr." "str." stands for strasse and is the thoroughfare type attached, while "Berliner" is the thoroughfare name.
Parsed Dependent Thoroughfare Columns
dependentThoroughfare
Dependent street or block data element. This is used when there are more than one thoroughfares with the same name in one locality. An adjoining thoroughfare is used to uniquely identify the target thoroughfare.
dependentThoroughfareLeadingType
Thoroughfare type at the beginning of the dependent thoroughfare. The leading type is parsed from the dependentThoroughfare parameter. For example, if the dependent thoroughfare is "St. Hickory E," the dependent thoroughfare leading type would be "St."
dependentThoroughfareName
Dependent thoroughfare name parsed from the dependentThoroughfare parameter. For example, if the dependent thoroughfare is "E Hickory Ln," the dependent thoroughfare name would be "Hickory."
dependentThoroughfarePostDirection
Cardinal directional at the end of the dependent thoroughfare. The postfix directional is parsed from the dependentThoroughfare parameter. For example, if the dependent thoroughfare is "Hickory Ln N," the dependent thoroughfare post direction would be "N."
dependentThoroughfarePreDirection
Cardinal directional at the beginning of the dependent thoroughfare. The prefix directional is parsed from the dependentThoroughfare parameter. For example, if the dependent thoroughfare is "W Hickory Ln," the dependent thoroughfare pre direction would be "W."
dependentThoroughfareTrailingType
Thoroughfare type at the end of the dependent thoroughfare. The trailing type is parsed from the dependentThoroughfare parameter. For example, if the dependent thoroughfare is "W Hickory Ln," the dependent thoroughfare trailing type would be "Ln."
dependentThoroughfareTypeAttached
Dependent thoroughfare type connected to the dependent thoroughfare name without a space. This is common in Germany. For example, "Berlinerstr." "str." stands for strasse and is the dependent thoroughfare type attached, while "Berliner" is the dependent thoroughfare name.
Parsed Postal Facility Columns
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.
personalID
Used by certain Post Offices to identify a recipient for a package.
postOfficeLocation
Parsed Regional Columns
administrativeArea
State. Most common geographic data element.
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.
Extra Output Address Parameters
US Address Type Codes
| Code | Description |
|---|---|
| A | Alias |
| F | Firm or Company |
| G | General Delivery |
| H | Highrise or Business Complex |
| P | PO Box |
| R | Rural Route |
| S | Street or Residential |
Canadian Address Type Codes
| Code | Description |
|---|---|
| 1 | Street |
| 2 | Street Served by Route and GD |
| 3 | Lock Box |
| 4 | Route Service |
| 5 | General Delivery |
| B | LVR Street |
| C | Government Street |
| D | LVR Lock Box |
| E | Government Lock Box |
| L | LVR General Delivery |
| K | Building |
latitude
North-south geographic coordinate for a particular delivery point.
longitude
East-west geographic coordinate for a particular delivery point.
Extra Output Country Parameters
countryCode
countryName
Full country name. Can be a nickname.
iso2Code
ISO 3166 2-character country code.
iso3Code
ISO 3166 3-character country code.
isoCountryNumber
ISO 3166 3-digit numeric country code.
formalCountryName
Official Name for the country.