Express Entry:GlobalExpressAddress: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
Line 85: | Line 85: | ||
;&nativecharset= | ;&nativecharset= | ||
:When set to true, return results in the native character set for the country. | :When set to true, return results in the native character set for the country. When set to false, return transliterated results in the Latin character set. When set to blank (‘&nativecharset=’) return results in the input character set. | ||
[[Category:Cloud Services]] | [[Category:Cloud Services]] | ||
[[Category:Express Entry]] | [[Category:Express Entry]] |
Revision as of 20:50, 31 December 2018
GlobalExpressAddress
The GlobalExpressAddress service is consumed to retrieve results containing all of the available address elements of an address record: FormattedAddress, AddressLine1-8, CountryISO3166_1_Alpha2, CountryISO3166_1_Alpha3, CountryISO3166_1_Numeric, SubNationalArea, PremisesNumber, AdministrativeArea, SubadministrativeArea, locality, dependentlocality, doubledependentlocality, thoroughfare, dependentthoroughfare, building, postalcode, and postbox.
A typical use of the GlobalExpressAddress method is preceded by a call to the GlobalExpressPostalCode service. The GlobalExpressPostalCode service is provided as a means of retrieving postal code, locality, and administrative area combinations using the postal code as the search input.
Example Call
http://expressentry.melissadata.net/web/GlobalExpressAddress?format={FORMAT}&id={ID}&address1={ADDRESS1}&locality={LOCALITY}&administrativearea={ADMINISTRATIVEAREA}&postalcode={POSTALCODE}&country={COUNTRY}&maxrecords={MAXRECORDS}&nativecharset={True|False}
Requested Field | Input | Description | |
---|---|---|---|
Format | {XML, JSON} | The return format of the request. | |
ID | Text | The License Key or token | |
Address1 | Search terms delimited by %20 or space. | The actual words of the search term. | |
Locality | Text | Optional. The locality of the address. | |
AdministrativeArea | Text | Optional. The administrative area of the address. | |
PostalCode | Text | Optional. The postal code of the address. | |
Country | Text | The ISO2Code or country name of the address (required, Default US). | |
Maxrecords | Number | The maximum number of records to return (required). | |
Nativecharset | True/False | Optional. Return results in the native character set for the country. |
Schema
- ?format=
- The response will be formatted according to the value set here.
- Valid values are: XML and JSON.
- &id=
- The ID element can contain your user ID, a complete License Key, or a token.
- &address1-3=
- Address1-3 can be used in combination with Locality, Administrative Area, or PostalCode.
- &locality=
- Using the Locality in a query will help refine results, limiting responses accordingly.
- &administrativearea=
- Using the Administrative Area in a query will help refine results, limiting responses accordingly.
- &postalcode=
- Using the postal code in a query will help refine results, limiting responses accordingly.
- &country=
- The ISO2Code or full country name of the country to search (Required, Default US).
- &maxrecords=
- Maxrecords is provided to control the number of results returned from a request to the service (Required).
- &nativecharset=
- When set to true, return results in the native character set for the country. When set to false, return transliterated results in the Latin character set. When set to blank (‘&nativecharset=’) return results in the input character set.