Express Entry:ExpressAddress

From Melissa Data Wiki
Revision as of 01:25, 21 December 2023 by Admin (talk | contribs)
Jump to navigation Jump to search

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


JSON

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


ExpressAddress

The ExpressAddress service is consumed to retrieve U.S. results containing all of the available address elements of an address record: AddressLine1, City, State, PostalCode, SuiteName, SuiteRange, and SuiteCount.

A typical use of the ExpressAddress method is preceded by a call to the ExpressPostalCode service. The ExpressPostalCode service is provided as a means of retrieving postal code, city, and state combinations using the postal code as the search input.


Example Call

http://expressentry.melissadata.net/web/ExpressAddress?format={FORMAT}&id={ID}&line1={LINE1}&city={CITY}&state={STATE}&postalcode={POSTALCODE}&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
Line1 Search terms delimited by %20 or space. The actual words of the search term.
City Text Optional. The city of the address.
State Text Optional. The state of the address.
PostalCode Text Optional. The postal code of the address.
Maxrecords Number The maximum number of records to return. (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.
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.
&line1=
Line1 input typically contains house number and street information i.e. “100 Main St.” Line1 is used in combination with City, State, or PostalCode.
&city=
Using the City in a query will help refine results, limiting responses accordingly.
&state=
Using the State in a query will help refine results, limiting responses accordingly.
&postalcode=
Using the postal code in a query will help refine results, limiting responses accordingly.
&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".
When set to County this will return the county name field for CountyName in the Extras Object.