Express Entry:ExpressFreeForm: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (One intermediate revision by the same user not shown) | |||
| Line 42: | Line 42: | ||
|US Only: Return P.O. Boxes (default is to exclude P.O. Boxes from the response) | |US Only: Return P.O. Boxes (default is to exclude P.O. Boxes from the response) | ||
|- | |- | ||
|Cols | |rowspan="2"|Cols | ||
|results | |results | ||
|Return Address Object result codes for each address in the Extras field. | |Return Address Object result codes for each address in the Extras field. | ||
|- | |||
|County | |||
|Return County Name field for CountyName in the Extras Object. | |||
|} | |} | ||
| Line 69: | Line 72: | ||
;&cols= | ;&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>. | :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>. | ||
:When set to <code>County</code> this will return the county name field for CountyName in the Extras Object. | |||
[[Category:Cloud Services]] | [[Category:Cloud Services]] | ||
[[Category:Express Entry]] | [[Category:Express Entry]] | ||
Latest revision as of 01:28, 21 December 2023
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 (default is to exclude P.O. Boxes from the response) Cols results Return Address Object result codes for each address in the Extras field. County Return County Name field for CountyName in the Extras Object.
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 along with the usual address results. Multiple options for &opt can be delimited by semicolon.
- &cols=
- When set to
resultsthis will return the Address Object result codes for each address in the Extras field. For example, a USPS only address will returnAddrObjectResultCode": "AS01". - When set to
Countythis will return the county name field for CountyName in the Extras Object.