# Individual Registry ## Overview The individual registry provides APIs to create citizens or users to the DIGIT platform. This document provides the configuration details for setting up individuals. ## **Pre-requisites** * 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 is helpful. * Knowledge of eGov-mdms service, eGov-persister, eGov-idgen, eGov-indexer, and eGov-user will be helpful. ## **Functionalities** 1. Provides APIs to create, update, and delete individuals. 2. Provides APIs to bulk create, update, and delete individuals. 3. Inactivates the status of individuals post-deletion. 4. Provides a search API for individuals by name, individual ID, unique ID, and date of birth. ## **Setup** {% stepper %} {% step %} ### Clone or download the code from the GitHub repository The source code for the Individual module is located in the [Git repository here](https://github.com/egovernments/health-campaign-services/tree/v1.1.0/health-services/individual). Clone or download the code from this repository before proceeding. {% endstep %} {% step %} ### Add the Lombok extension/plugin The Individual module is a Spring Boot application that uses Lombok, a Java library. Add the Lombok extension/plugin to open and build the project in your IDE (like IntelliJ or Eclipse). {% endstep %} {% step %} ### Setup Lombok in IDEs Install the Lombok plugin directly from the IntelliJ plugins marketplace. * Download the Lombok jar file. * Add the following line to your `eclipse.ini` file (replace `lombok.jar` with the correct path to your Lombok jar): ``` -javaagent:lombok.jar ``` {% endstep %} {% step %} ### Run application Once Lombok is set up and the application is running (using your IDE or command line), you can start making API requests to the Individual service’s endpoints. {% endstep %} {% step %} ### Generate IDs When you send API requests, the system generates the required IDs automatically as part of its normal operation. {% endstep %} {% endstepper %} ## **API Details** The complete API specifications for the Individual Service are documented in the Swagger YAML file: * **Swagger API YAML:**-[individual.yaml](https://github.com/egovernments/health-campaign-services/blob/v1.1.0/docs/health-api-specs/contracts/registries/individual.yml) This YAML file contains: * API endpoints and methods * Request/response payloads * Data models and schema references * Error codes and descriptions #### Available API Endpoints
EndpointMethodDescription
/individual/v1/_createPOSTCreate/Add a new Individual
/individual/v1/bulk/_createPOSTCreate/Add Individuals in bulk
/individual/v1/_updatePOSTUpdate an existing Individual
/individual/v1/bulk/_updatePOSTUpdate existing Individuals in bulk
/individual/v1/_deletePOSTSoft delete an Individual and nested details
/individual/v1/bulk/_deletePOSTSoft delete Individuals in bulk
/individual/v1/_searchPOSTSearch for Individuals
**Properties format:** Kafka topics persister configs for eGov persister ``` individual.consumer.bulk.create.topic=individual-consumer-bulk-create-topic individual.consumer.bulk.update.topic=individual-consumer-bulk-update-topic individual.consumer.bulk.delete.topic=individual-consumer-bulk-delete-topic individual.producer.save.topic=save-individual-topic individual.producer.update.topic=update-individual-topic individual.producer.delete.topic=delete-individual-topic ``` **External Service URLs** Below are the URLs for external services that the Individual Service interacts with: | Service | Property Key | URL | | -------------------- | ---------------------- | ------------------------------------------------------------- | | eGov MDMS | egov.mdms.host | | | eGov ID Generation | egov.idgen.host | | | Localization Service | egov.localization.host | | | Project Service | egov.project.host | [http://unified-dev.digit.org](http://unified-dev.digit.org/) | ## **Configuration Details** Follow the details outlined below to configure and enable Individual API actions and access control using MDMS, role-action mapping, persister, and indexer configurations. ### **MDMS Configurations** #### Define Action URLs Add new actions in the MDMS actions configuration (e.g., `action-test.json`). Each action represents an API endpoint you wish to secure and manage: [**action-test.json**](https://github.com/egovernments/health-campaign-mdms/blob/DEV/data/default/ACCESSCONTROL-ACTIONS-TEST/actions-test.json) ``` { "id": 1549, "name": "Individual Create", "url": "/individual/v1/_create", "displayName": "Individual Create", "orderNumber": 0, "parentModule": "", "enabled": false, "serviceCode": "individual", "code": "null", "path": "" }, { "id": 1550, "name": "Individual Update", "url": "/individual/v1/_update", "displayName": "Individual Update", "orderNumber": 0, "parentModule": "", "enabled": false, "serviceCode": "individual", "code": "null", "path": "" }, { "id": 1551, "name": "Individual Search", "url": "/individual/v1/_search", "displayName": "Individual Search", "orderNumber": 0, "parentModule": "", "enabled": false, "serviceCode": "individual", "code": "null", "path": "" }, { "id": 1561, "name": "Individual Bulk Create", "url": "/individual/v1/bulk/_create", "displayName": "Individual Bulk Create", "orderNumber": 0, "parentModule": "", "enabled": false, "serviceCode": "individual", "code": "null", "path": "" }, { "id": 1562, "name": "Individual Bulk Update", "url": "/individual/v1/bulk/_update", "displayName": "Individual Bulk Update", "orderNumber": 0, "parentModule": "", "enabled": false, "serviceCode": "individual", "code": "null", "path": "" }, { "id": 1563, "name": "Individual Delete", "url": "/individual/v1/_delete", "displayName": "Individual Delete", "orderNumber": 0, "parentModule": "", "enabled": false, "serviceCode": "individual", "code": "null", "path": "" }, { "id": 1564, "name": "Individual Bulk Delete", "url": "/individual/v1/bulk/_delete", "displayName": "Individual Bulk Delete", "orderNumber": 0, "parentModule": "", "enabled": false, "serviceCode": "individual", "code": "null", "path": "" } ``` ### **Role-Action Mapping** #### Assign Actions to Roles Configure which user roles can access which API actions in `roleaction.json`. Map each action ID to the required roles: [**roleaction.json**](https://github.com/egovernments/health-campaign-mdms/blob/DEV/data/default/ACCESSCONTROL-ROLEACTIONS/roleactions.json)**.** Refer example below: ``` { "rolecode": "SYSTEM_ADMINISTRATOR", "actionid": 1549, "actioncode": "", "tenantId": "default" }, { "rolecode": "REGISTRAR", "actionid": 1549, "actioncode": "", "tenantId": "default" }, { "rolecode": "DISTRIBUTOR", "actionid": 1549, "actioncode": "", "tenantId": "default" }, { "rolecode": "SYSTEM_ADMINISTRATOR", "actionid": 1550, "actioncode": "", "tenantId": "default" }, { "rolecode": "REGISTRAR", "actionid": 1550, "actioncode": "", "tenantId": "default" }, { "rolecode": "DISTRIBUTOR", "actionid": 1550, "actioncode": "", "tenantId": "default" }, { "rolecode": "SYSTEM_ADMINISTRATOR", "actionid": 1551, "actioncode": "", "tenantId": "default" }, { "rolecode": "REGISTRAR", "actionid": 1551, "actioncode": "", "tenantId": "default" }, { "rolecode": "DISTRIBUTOR", "actionid": 1551, "actioncode": "", "tenantId": "default" }, { "rolecode": "SYSTEM_ADMINISTRATOR", "actionid": 1561, "actioncode": "", "tenantId": "default" }, { "rolecode": "REGISTRAR", "actionid": 1561, "actioncode": "", "tenantId": "default" }, { "rolecode": "DISTRIBUTOR", "actionid": 1561, "actioncode": "", "tenantId": "default" }, { "rolecode": "SYSTEM_ADMINISTRATOR", "actionid": 1562, "actioncode": "", "tenantId": "default" }, { "rolecode": "REGISTRAR", "actionid": 1562, "actioncode": "", "tenantId": "default" }, { "rolecode": "DISTRIBUTOR", "actionid": 1562, "actioncode": "", "tenantId": "default" }, { "rolecode": "SYSTEM_ADMINISTRATOR", "actionid": 1563, "actioncode": "", "tenantId": "default" }, { "rolecode": "REGISTRAR", "actionid": 1563, "actioncode": "", "tenantId": "default" }, { "rolecode": "DISTRIBUTOR", "actionid": 1563, "actioncode": "", "tenantId": "default" }, { "rolecode": "SYSTEM_ADMINISTRATOR", "actionid": 1564, "actioncode": "", "tenantId": "default" }, { "rolecode": "REGISTRAR", "actionid": 1564, "actioncode": "", "tenantId": "default" }, { "rolecode": "DISTRIBUTOR", "actionid": 1564, "actioncode": "", "tenantId": "default" }, ``` ## **Persister Configuration** Configure the persister service for the Individual module. This is typically done by adding/updating a YAML file (e.g., `individual-persister.yml`) - [Individual Persister Yaml](https://github.com/egovernments/health-campaign-config/blob/v1.1.0/egov-persister/individual-persister.yml)\ This YAML maps API operations to database persistence logic (topics, queries, etc.). ## Indexer Configuration Configure the indexer for the Individual module (e.g., `individual-indexer.yml`) - [Individual Indexer Yaml](https://github.com/egovernments/health-campaign-config/blob/v1.1.0/egov-indexer/individual-indexer.yml)\ This will ensure individual data is indexed and searchable as per business requirements. ## Database Schema
## Postman Collection [Click here to access](https://www.postman.com/sreejith-kanjarla-759135/hcm-collection/folder/zrhhudq/individual) the Postman collection. --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.digit.org/health/deploy/configuration/hcm-service-configuration/individual-registry.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.