Difference between revisions of "Express Entry:ExpressFreeForm"

From Melissa Data Wiki
Jump to navigation Jump to search
Line 22: Line 22:
  
 
;&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.  The service uses a word-distance algorithm to find and display matches in an intuitive order.
  
 
;&maxrecords=
 
;&maxrecords=

Revision as of 17:54, 18 December 2015

← 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



ExpressFreeForm

The ExpressFreeForm endpoint is provided as a means of retrieving all available U.S. address elements with a Free Form query. ExpressFreeForm returns AddressLine1, City, State, PostalCode, AddressKey, SuiteName, and SuiteCount and the SuiteList and PlusFour lists.

Example Call

http://expressentry.melissadata.net/web/ExpressFreeForm?format={FORMAT}&id={ID}&ff={FF}&maxrecords={MAXRECORDS}

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 string, or a token.
&ff=
The service uses this term to complete addresses in Free Form. The service uses a word-distance algorithm to find and display matches in an intuitive order.
&maxrecords=
Maxrecords is provided to control the number of results returned from a request to the service.
The default value is 10.