Web Service API
Documentation




 

This document describes the REST API and resources provided by ZIPCodeDownload Web Service.

WebService provide access to resources (data entities) via URI paths. To use a REST API, your application will make an HTTP request and parse the response. By default, the response format is XML. Because the REST API is based on open standards, you can use any web development language to access the API.

Most Comprehensive ZIP Code Data Available: USA5 and Canadian Postal Code Database.

How to use WebService: In WebService User Authentication is Necessary for every request and another necessary thing is country.Country is also necessary because on basis of country we can differentiate for which database user send the request.PageNumber or PostalCode parameter will also be necessary.Page size will be 100 if PageNumber parameter will be used. So http/https Service request like
"https://zipcodedownload.com:4430/?username=yourusername&password=yourpassword&country=country&pagenumber=1".

Country Parameter Abbreviation in URI:
For USA5 database in URI request parameter is country=us5
For Canada database in URI request parameter is country=ca

Available Filter's Parameters for Fetching Data through URI:
To filter out the result by using the different-different paramter's.
Available URI Parameter's are:
postalcode,cityname,areacode.

Rest FULL Call Examples For USA5 Data:
Http Request:"https://zipcodedownload.com:4430/?username=username&password=******&country=us5&cityname=Holtsville&pagenumber=1"
Response Result with Cityname=Holtsville:

 

Similarly User can filter out the data by passing the other parameter's in QueryString
URI request Parameter's example's are:
Filter by CityName=Holtsville and PostalCode=00501
"https://zipcodedownload.com:4430/?username=username&password=******&country=us5&cityname=Holtsville&postalcode=00501&pagenumber=1"
Filter by CityName=Holtsville and PostalCode=00501 and areacode=631
"https://zipcodedownload.com:4430/?username=username&password=******&country=us5&cityname=Holtsville&postalcode=00501&areacode=631"

Rest FULL Call Examples with Canadian Postal Code Database:
Http Request:"https://zipcodedownload.com:4430/?username=username&password=******&country=CA&cityname=Toronto&pagenumber=1".
Response Result with Cityname=Toronto:

 

Similarly User can filter out the data by passing the other parameter's in QueryString
URI request Parameter's example's are:
Filter by cityname=Toronto and postalcode=M3C0C1
"https://zipcodedownload.com:4430/?username=username&password=******&country=CA&cityname=Toronto&postalcode=M3C0C1&pagenumber=1"
Filter by cityname=Toronto and postalcode=M3C0C1 and areacode=416/647
"https://zipcodedownload.com:4430/?username=username&password=******&country=CA&cityname=Toronto&postalcode=M3C0C1&areacode=416/647"