Difference between revisions of "Express Entry:ExpressFreeForm"

From Melissa Data Wiki
Jump to navigation Jump to search
 
(12 intermediate revisions by 2 users not shown)
Line 4: Line 4:


{{CustomTOC}}
{{CustomTOC}}
==URL==
{{URL-ExpressFreeForm}}


==ExpressFreeForm==
==ExpressFreeForm==
The ExpressFreeForm service is provided as a means of retrieving all available address elements without the logic of ExpressAddress. ExpressFreeForm returns AddressLine1, City, State, PostalCode, AddressKey, SuiteName, and SuiteCount.
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===
<h3 class="h3grey">Example Call</h3>
<pre>
<pre>
http://expressentry.melissadata.net/web/ExpressFreeForm?format={FORMAT}&id={ID}&ff={FF}&maxrecords={MAXRECORDS}
http://expressentry.melissadata.net/web/ExpressFreeForm?format={FORMAT}&id={ID}&ff={FF}&maxrecords={MAXRECORDS}&opt={poboxes:true}&cols={results}
</pre>
</pre>


===Schema===
:{|class="alternate01" cellspacing="0"
!Requested Field
!Input
!style="border-right:0px;"|Description
|-
|Format
|{XML, JSON}
|The return format of the request.
|-
|ID
|Text
|The License Key or token
|-
|ff
|Search terms delimited by %20 or space.
|The service uses a word-distance algorithm to find and display matches in an intuitive order.
|-
|Maxrecords
|Number
|The maximum number of records to return (required). (Default 10, Maximum 100)
|-
|Opt
|poboxes:true
|US Only: Return P.O. Boxes and military addresses
|-
|Cols
|results
|Return Address Object result codes for each address in the Extras field.
|}
 
 
<h3 class="h3grey">Schema</h3>
;?format=
;?format=
:The response will be formatted according to the value set here.
:The response will be formatted according to the value set here.
Line 19: Line 54:


;&id=
;&id=
:The ID element can contain your user ID, a complete license string, or a token.
:The ID element can contain your user ID, a complete License Key, or a token.


;&ff=
;&ff=
:The FF element performs a “Line1” search. If the search term exceeds seven characters, subsequent searches will use the allwords option.
: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=
: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.


:The default value is 10.
:The default value is 10 and the maximum is 100 records.
 
;&opt=
:When set to <code>poboxes:true</code>, U.S. Addresses will return P.O. Boxes and military addresses along with the usual address results. Multiple options for &opt can be delimited by semicolon.
 
;&cols=
:When set to <code>results</code> this will return the Address Object result codes for each address in the Extras field. For example, a USPS only address will return <code>AddrObjectResultCode": "AS01"</code>.




[[Category:Cloud Services]]
[[Category:Cloud Services]]
[[Category:Express Entry]]
[[Category:Express Entry]]

Latest revision as of 19:21, 5 August 2022

← 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/ExpressFreeForm
Secure https://expressentry.melissadata.net/web/ExpressFreeForm


JSON

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


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}&opt={poboxes:true}&cols={results}
Requested Field Input Description
Format {XML, JSON} The return format of the request.
ID Text The License Key or token
ff Search terms delimited by %20 or space. The service uses a word-distance algorithm to find and display matches in an intuitive order.
Maxrecords Number The maximum number of records to return (required). (Default 10, Maximum 100)
Opt poboxes:true US Only: Return P.O. Boxes and military addresses
Cols results Return Address Object result codes for each address in the Extras field.


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. 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 and the maximum is 100 records.
&opt=
When set to poboxes:true, U.S. Addresses will return P.O. Boxes and military addresses along with the usual address results. Multiple options for &opt can be delimited by semicolon.
&cols=
When set to results this will return the Address Object result codes for each address in the Extras field. For example, a USPS only address will return AddrObjectResultCode": "AS01".