Skip to content
This project will be a sub-component of phzipweb i.e. a public REST API that supplies data for states, provinces, cities and zip codes.
Java
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs/images
phzip-console
phzip-core
phzip-search
src
.appveyor.yml
.checkstyle
.gitignore
.travis.yml
LICENSE-notice.md
LICENSE.md
README.md
pom.xml

README.md

This project is a sub-component of phzipweb i.e. a public REST API that supplies data for states, provinces, cities and zip codes. Current version only supports US and Philippine data. Future release will also include full-text search.

As an individual component it can already be used by applications to populate drop down of states, provinces, counties, cities, phone area codes, and zip codes without relying on the database.

This component contains JSON files with hierarchical representation of featured country, provinces and cities. As such, the only dependency it has is gson that is used to deserialize JSON data file to serve clients.

Supports JDK 1.8 or higher.

Get it

<dependencies>
  ...
   <!-- To use core API -->
	<dependency>
		<groupId>io.dhilar.phzip</groupId>
		<artifactId>phzip-core</artifactId>
		<version>0.2.0</version>
	</dependency>
	<!-- To use search API -->
	<dependency>
		<groupId>io.dhilar.phzip</groupId>
		<artifactId>phzip-search</artifactId>
		<version>0.2.0</version>
	</dependency>
	<!-- To use console app -->
	<dependency>
		<groupId>io.dhilar.phzip</groupId>
		<artifactId>phzip-console</artifactId>
		<version>0.2.0</version>
	</dependency>
  ...
</dependencies>

Non-Maven

Download jars at Central Maven repository. Choose fat jar if you don't want to download individual dependencies.

Usage

Sample use case of loading data from PhZip to populate drop-down of provinces, states, counties, cities, zip codes, etc. in order to eliminate the tasks of creating your own lookup tables data and internal APIs of these known fix values.

Retrieval of customer information and loading of province data using province Id.

Documentation

Examples

You can’t perform that action at this time.