Global Express Locality & Administrative Area

Request

GlobalExpressLocalityAdministrativeArea is provided as a means of retrieving locality and administrative area combinations using the locality name.

Query

diacriticreplaceboolean

True replaces diacritics in the address. False will keep current diacritics in the address results. If left blank, this defaults to False.

Enum:truefalse

Example:diacriticreplace=true

formatstring

Desired format of the response. Possible values are json, jsonp, or xml, depending on the endpoint.

Note: the base URL for JavaScript format request is https://expressentry.melissadata.net/jsonp/.

Enum:"xml""json""jsonp"

Example:format=json

idstring, (password)required

Required. The License Key issued by Melissa.

Example:id={REPLACE-WITH-YOUR-LICENSE-KEY}

maxrecordsnumber, <= 100

The maximum number of records to return.

Default:10

Example:maxrecords=20

nativecharsetboolean

True, False, or blank. 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.

Enum:truefalse

Example:nativecharset=true

administrativeareastring

Administrative Area, Province, State. The most common geographic data element.

Example:administrativearea=CA

countrystringrequired

Required. The ISO2Code or country name of the address.

Default:"US"

Example:country=US

localitystring

City, Locality, Municipality. The most common population center data element.

Example:locality=Rancho Santa Margarita

postalcodestring

Postal Code, ZIP. The complete postal code.

Example:postalcode=92688

Acceptstringrequired

Format of the response.

Enum:"application/json""application/javascript""*/*"

Example:*/*

Content-Typestringrequired

Format of the request.

Enum:"application/json""application/xml""application/javascript""*/*"

Example:*/*

curl -i -X GET \
  'https://expressentry.melissadata.net/web/GlobalExpressLocalityAdministrativeArea?id=%7BREPLACE-WITH-YOUR-LICENSE-KEY%7D&country=US' \
  -H 'Accept: */*' \
  -H 'Content-Type: */*'

Responses

Global Express Locality Administrative Area response

Body

Versionstring

The current service version number.

ResultCodestring

Lists result codes for the most recent request. For more information, see Global Express Entry Result Codes.

ErrorStringstring

Lists error codes from any errors caused by the most recent request. For more information, see Global Express Entry Result Codes.

ResultsArray of objects

Array with Address array(s) containing the record level fields.

Response

{
  "Version": "8.0.0.1249",
  "ResultCode": "XS02",
  "ErrorString": "",
  "Results": [
    { … },
    { … }
  ]
}