Express Entry:GlobalExpressFreeForm: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
Line 8: | Line 8: | ||
The GlobalExpressFreeForm service is provided as a means of retrieving all available address elements using a free form search. GlobalExpressFreeForm returns 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. | The GlobalExpressFreeForm service is provided as a means of retrieving all available address elements using a free form search. GlobalExpressFreeForm returns 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. | ||
= | |||
<h3 class="h3grey">Example Call</h3> | |||
<pre> | <pre> | ||
http://expressentry.melissadata.net/web/GlobalExpressFreeForm?format={FORMAT}&id={ID}&ff={FF}&country={COUNTRY}&maxrecords={MAXRECORDS}&nativecharset={true|false} | http://expressentry.melissadata.net/web/GlobalExpressFreeForm?format={FORMAT}&id={ID}&ff={FF}&country={COUNTRY}&maxrecords={MAXRECORDS}&nativecharset={true|false} | ||
</pre> | </pre> | ||
===Schema | :{|class="alternate01" cellspacing="0" | ||
;?format= | !Requested Field | ||
:The response will be formatted according to the value set here. | !Input | ||
:Valid values are: XML and JSON. | !style="border-right:0px;"|Description | ||
|- | |||
|Format | |||
|{XML, JSON} | |||
|The return format of the request. | |||
|- | |||
|ID | |||
|Text | |||
|The License Key or token | |||
|- | |||
|FF | |||
|Text | |||
| | |||
|- | |||
|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/Blank | |||
|Optional. Return results in the native character set for the country. | |||
|} | |||
<h3 class="h3grey">Schema</h3> | |||
:;?format= | |||
::The response will be formatted according to the value set here. | |||
::Valid values are: XML and JSON. | |||
;&id= | :;&id= | ||
:The ID element can contain your user ID, a complete License Key, or a token. | ::The ID element can contain your user ID, a complete License Key, or a token. | ||
;&ff= | :;&ff= | ||
:The service uses this term to complete addresses in Free Form. If the search term exceeds seven characters, subsequent searches will use the allwords option. Also, if no results are found before the seven character limit, the allwords search is used. | ::The service uses this term to complete addresses in Free Form. If the search term exceeds seven characters, subsequent searches will use the allwords option. Also, if no results are found before the seven character limit, the allwords search is used. | ||
;&country= | :;&country= | ||
:The ISO2Code or full country name of the country to search (Default US). | ::The ISO2Code or full country name of the country to search (Default US). | ||
;&maxrecords= | :;&maxrecords= | ||
:Maxrecords is provided to control the number of results returned from a request to the service. | ::Maxrecords is provided to control the number of results returned from a request to the service. | ||
;&nativecharset= | :;&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. | ::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 23:03, 31 December 2018
GlobalExpressFreeForm
The GlobalExpressFreeForm service is provided as a means of retrieving all available address elements using a free form search. GlobalExpressFreeForm returns 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.
Example Call
http://expressentry.melissadata.net/web/GlobalExpressFreeForm?format={FORMAT}&id={ID}&ff={FF}&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 FF Text 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/Blank 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.
- &ff=
- The service uses this term to complete addresses in Free Form. If the search term exceeds seven characters, subsequent searches will use the allwords option. Also, if no results are found before the seven character limit, the allwords search is used.
- &country=
- The ISO2Code or full country name of the country to search (Default US).
- &maxrecords=
- Maxrecords is provided to control the number of results returned from a request to the service.
- &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.