So you are interested and would like to integrate Zip Codes web service into your application.
This tutorial will give all the necessary information about how to use Zip Codes web service.
There are three types of data that Zip Codes web service provide: zip code, city and area code.
There are number of possible uses of the Zip Codes web service:
- Find zip codes or cities within specified distance from any zip code or city
- Find user-defined locations (such as offices or stores) around zip code or city
- Find zip codes that cover a specific city or find a cities that specific zip code covers
- Find distance between 2 zip codes or cities
- Retrieve zip code or city coordinates
- Find area codes that cover a zip code or a city
To get started go through the following 5 step tutorial:
Connecting to Zip Codes web service
In order to use a web service you need to know its WSDL definition.
Zip Codes web service WSDL is here http://codebump.com/services/placelookup.asmx?wsdl
For users who orignially implemented the older version of the service there's a WSDL for backward compatibility (only use it if you already developed against
the older version and don't want to upgrade) http://codebump.com/services/zipcodelookup.asmx?wsdl
URLs above return a standard WSDL 1.1 that can be plugged in directly into your SOAP toolkit. For instructions on how to do it with your particular toolkit follow to step 4.
List of functions
+ Current Interface (click to expand/collapse)
+ Older interface (click to expand/collapse)
How to subscribe
If you are ready to start using Zip Codes web service you will need a subscription.
Even if you're just evaluating you will still need to subscribe.
Several subscription options are available including free evaluation plan.
- Yearly Plan - $32.00 per year
- Monthly Plan - $3.00 per month
- Free Plan - some restrictions apply
Create a subscription by clicking
Buy on the top menu.
You will be given a unique subscription ID that will allow you to use Zip Codes web service.
This unique ID is very important, you must submit it on every call to the web service.
See Step 4 for more information.
How to use it
If you reached this step you should already known basic functions and have a subscription.
Now the fun part - integration. Web services are relatively easy to integrate.
There are 2 ways to access Zip Codes web service: SOAP over HTTP POST and plain HTTP GET.
SOAP over HTTP POST is the widely accepted method of calling web services and should be supported by your
favorite SOAP toolkit. In case your environment does not support SOAP you can use HTTP GET by
generating URLs and parsing resulting XML.
+ Using SOAP (click to expand/collapse)
+ Using HTTP GET (click to expand/collapse)
User-Defined Places (UDPs) allows storage of custom locations in Zip Codes database and query them just like
a regular a zip code or city and state. The perfect scenario for UDPs is office or branch locator.
After the list of offices is uploaded and GetUserPlacesWithin() function can be used to lookup offices
around a zip code or city and state.
UDPs can be groupped into categories and search results can be narrowed down by categories.
Perfect example of that is different type of branches: full service and limited.
There are several ways to manage UDPs:
- Upload TAB delimited file using User-Defined Places screen under Your Account
- Enter custom locations by hand using User-Defined Places screen under Your Account
- Call SaveUserPlaces() service function to save custom locations
Samples and Demos
I have created a couple of sample application showing off how to use Zip Codes
web service. The C# Windows app is the most feature complete, it will allow you to call several web service methods as well as manage user-defined places.
C# Windows application
VB 6 Windows application
VB.NET Windows application