Overview
The household service helps and provides APIs to create households and household members for the HCM. This document provides the configuration details for setting up the household registry.
Pre-requisites
Knowledge of Java/J2EE (preferably Java 8 version).
Knowledge of spring boot and spring-boot micro-services.
Knowledge of Git or any version control system.
Knowledge of RESTful web services.
Knowledge of the Lombok library is helpful.
Knowledge of eGov-mdms service, eGov-persister, eGov-idgen, eGov-indexer, and eGov-user will be helpful.
Functionalities
Provides APIs to create, update, delete, and search households.
Provides APIs to bulk create, bulk update, and bulk delete households.
Provides APIs to create, update, delete, and search household members.
Provides APIs to bulk create, bulk update, and bulk delete household members.
Setup details
*In the case of IntelliJ, the plugin can be installed directly. For eclipse, the Lombok jar location has to be added in the eclipse.ini file in this format javaagent:lombok.jar.
API Details
Application.properties file information:
Kafka topics persister configs for eGov persister
URLs for the external API references:
Configuration details
Access MDMS configurations
Action test: URL actions adding
Access to role-based actions
Persister configuration
Indexer configuration
Database schema
Postman collection
Last updated