eGov-Location

Owned by Kaviyarasan P
Apr 04, 2020
2 min read

INTRODUCTION



An eGov core application which provides location details of the tenant for which the services are being provided.



Requirements:



  1. Prior Knowledge of Java/J2EE.

  2. Prior Knowledge of Spring Boot.

  3. Prior Knowledge of REST APIs and related concepts like path parameters, headers, JSON etc.

  4. Prior knowledge of postgres.

  5. Knowledge of eGov Mdms service.



Functionality: 

 

The eGov location information also known as boundary date of ULB’s are defined in  different hierarchies ADMIN/ELECTION hierarchy which is defined by theAdministrators, Revenue hierarchy defined by the Revenue department.



The election hierarchy has the locations divided into several types like zone, election ward, block, street  and locality. The Revenue hierarchy has the locations divided into zone, ward, block and locality.



The model which defines the localities like zone, ward and etc is boundary object which contains information like name, lat, long, parent or children boundary if any. The boundaries come under each other in hierarchy like zone contains wards, ward contains blocks, block contains locality. The order in which the boundaries are contained in each other will differ based on the tenants.



Changes in v11-0-0 :

 

The boundary data has been moved to mdms from the master tables in DB. The boundary service fetches the JSON from mdms and parses it to the structure of boundary object as mentioned above.

 

 

 

FLOW DIAGRAM :



SETUP AND USAGE:

 

The Application is present among the core group of applications available in the eGov-services git repository.  The spring boot application needs lombok extension added in your IDE to load it. Once the application is up and running API requests can be posted to the url and ids can be generated. 



  • *in case of intellij the plugin can be installed directly, for eclipse the lombok jar location has to be added in eclipse.ini file in this format

-javaagent:lombok.jar.



For the API information please refer the swagger yaml 



GOTO : https://editor.swagger.io/  and click on file -> import url 



Then add the raw url of the API doc in the pop up. 



https://raw.githubusercontent.com/egovernments/egov-services/master/docs/egov-location/contracts/v11-0-0.yml



Incase the url is unavailable, please go to the docs folder of egov-services git repo and find the yaml for egov-filestroe.

 

The application needs redis cache running along with the DB.



To work any of the file storages there are some application properties which needs to be configured.

ACCESS:

Please use the following postman collection to access apis of localization services.