Difference between revisions of "Express Entry:GlobalExpressFreeForm"

From Melissa Data Wiki
Jump to navigation Jump to search
Line 4: Line 4:


{{CustomTOC}}
{{CustomTOC}}
==URL==
{{URL-GlobalExpressFreeForm}}


==GlobalExpressFreeForm==
==GlobalExpressFreeForm==

Revision as of 19:15, 1 February 2019

← Global Express Entry

Express Entry Navigation
Introduction
Global Getting Started
Endpoints
ExpressAddress
ExpressCityState
ExpressFreeForm
ExpressPostalCode
ExpressStreet
GlobalExpressAddress
GlobalExpressCountry
GlobalExpressLocalityAdministrativeArea
GlobalExpressFreeForm
  ↳  Filtering Responses
GlobalExpressPostalCode
GlobalExpressThoroughfare
Examples
XML Response
JSON Response
Global XML Response
Global JSON Response
Token Server
Result Codes
Result Code Use
Express Entry Result Codes
Sample Code



URL

REST

Use URL
Standard http://expressentry.melissadata.net/web/GlobalExpressFreeForm
Secure https://expressentry.melissadata.net/web/GlobalExpressFreeForm


JSON

Use URL
Standard http://expressentry.melissadata.net/jsonp/GlobalExpressFreeForm
Secure https://expressentry.melissadata.net/jsonp/GlobalExpressFreeForm


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|(blank)}
Requested Field Input Description
Format {XML, JSON} The return format of the request.
ID Text The License Key or token
FF Text The Free Form request.
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.