Water Services
This is the egov application, which helps and gives flexibility to municipal and citizen to handle the water service like create water connection, search water connection, update water connection and creating property if not exists.
The setup of the Application is as follows
Requirements:
Knowledge of Java/J2EE(preferably Java 8 version)
Knowledge of Spring Boot and spring-boot microservices.
Knowledge of Git or any version control system.
Knowledge of RESTful Web services.
Knowledge of the Lombok library will helpful.
knowledge of eGov-mdms service, eGov-persister, eGov-idgen, eGov-sms, eGov-email,eGov-user, eGov-localization will be helpful.
Functionality:
Water Service provides multiple functionalities like creating water connection, updating water connection, search water connection on given criteria, creating property if not exists. The different functionalities provided by water services as follows -
Creating water connections.
Searching for water connections.
Updating water connections.
Creating a property registry for a water connection (If not exists).
Setup and usage:
The Application is present among the municipal services group of applications available in the eGov-services git repository. The spring boot application needs the 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
API Information :
please refer to 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 popup. please go to the docs folder in water services for YAML.
Application.properties File Information:
kafka topics persister configs for eGov persister
egov.waterservice.createwaterconnection = save-ws-connection
egov.waterservice.updatewaterconnection=update-ws-connection
URLs for the external API references:
eGvo mdms :-> egov.mdms.host = https://egov-micro-dev.egovernments.org
eGov -idGen :-> egov.idgen.host = https://egov-micro-dev.egovernments.org/
localization service :-> egov.localization.host = https://egov-micro-dev.egovernments.org
idGen Id formats :->
egov.idgen.wcid.name=waterservice.connection.id
egov.idgen.wcid.format=WS/[CITY.CODE]/[fy:yyyy-yy]/[SEQ_EGOV_COMMON]
Water Search Parameter Criteria:
connectionNumber, mobileNumber, ids (connection key).