Express Entry:Filtering Responses

From Melissa Data Wiki
Jump to: navigation, 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



Filtering

Express Entry supports filtering of results in the U.S., using the GlobalExpressFreeForm endpoint, and by the following criteria:

  • Postal Code
  • ZIP Centroid
  • State
  • City - using all ZIP codes in a city to filter by that city
  • Distance from a point given with Latitude and Longitude
  • Residential/Business Delivery Indication

The filter type can be one of the following:

  • Blank: Move preferred addresses to the top of the list and keep existing results
  • White List: Only allow addresses that meet the criteria given
  • Black List: Only allow addresses that don’t meet the criteria given


Filters

Postal Code

Using this filter with a white list will restrict results to that ZIP Code. With a black list, it will eliminate addresses in that ZIP Code. Multiple postal codes may be selected as described in Example REST Requests.

ZIP Centroid

This filter supports white list searches only. It can be used to search for addresses that are within ‘x’ miles of a ZIP Code.

State

With this filter, addresses may be selected by state or states.

Latitude and Longitude

Addresses within range of a point defined by latitude and longitude are returned, all others are eliminated.

RBDI

Include or exclude addresses based on whether the addresses are Business, Residential, or Unknown.


Sorting by Distance from a Lat/Long Point

Express Entry supports sorting of results by distance from a latitude/longitude point, see the #9 example sorting REST request below.


Example REST Requests

Add the following parameters to enable filtering of results in Global Express Entry:

1. Preferred ZIP Code, results at top of list (leave &listwhite out to make addresses in the ZIP code appear at top of results, not filtering them out):

http://expressentry.melissadata.net/web/GlobalExpressFreeForm?id=xxxxxxxx&country=US&format=XML&FF=10640+se&maxrecords=100&filterterm=zip&filterlist=97086

2. Blacklist all addresses in given ZIP Code:

http://expressentry.melissadata.net/web/GlobalExpressFreeForm?id=xxxxxxxx&country=US&format=XML&FF=10640+se&maxrecords=100&filterterm=zip&filterlist=97086&listwhite=false

3. Multiple ZIP Codes:

http://expressentry.melissadata.net/web/GlobalExpressFreeForm?id=xxxxxxxx&country=US&format=XML&FF=liberty+st+SE&maxrecords=100&filterterm=ZIP&filterlist=97301,97302,97304&listwhite=true

4. Return addresses within 10 mile range of a ZIP code:

http://expressentry.melissadata.net/web/GlobalExpressFreeForm?id=xxxxxxxx&country=US&format=XML&FF=liberty+st+SE&maxrecords=100&filterterm=ZIPCentroid&filterlist=97301&listwhite=true&maxdistance=10

5. Preferred list of 2 states:

http://expressentry.melissadata.net/web/GlobalExpressFreeForm?id=xxxxxxxx&country=US&format=XML&FF=clatsop+st&maxrecords=100&filterterm=state&filterlist=OR,WA&listwhite=true

6. Within 12 miles of a point given by latitude and longitude:

http://expressentry.melissadata.net/web/GlobalExpressFreeForm?id=xxxxxxxx&country=US&format=XML&FF=10640+se&maxrecords=100&filterterm=latlong&filterlist=45.341283,-122.594696&maxdistance=12

7. RBDI - Residential addresses only:

http://expressentry.melissadata.net/web/GlobalExpressFreeForm?id=xxxxxxxx&country=US&format=XML&FF=7+SE+Harmony+rd&maxrecords=100&filterterm=rbdi&filterlist=r&listwhite=true

8. Results sorted by distance from a point with a maximum of 50 miles:

http://expressentry.melissadata.net/WEB/GlobalExpressFreeForm?id=xxxxxxxx&format=xml&country=US&maxrecords=100&ff=coventry+48154&filterterm=latlong&filterlist=42.397360,-83.379970&sortType=distance&maxDistance=50

9. Results sorted by distance from a latitude/longitude point, no maximum distance:

http://expressentry.melissadata.net/WEB/GlobalExpressFreeForm?id=xxxxxxxx&format=xml&country=US&maxrecords=100&ff=34111&filterterm=latlong&filterlist=42.397360,-83.379970&sortType=distance
Personal tools
Namespaces

Variants
Actions
Navigation
Products
Support