> For the complete documentation index, see [llms.txt](https://docs.digit.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.digit.org/health/v1.5/setup/configuration/service-configuration/household-registry.md).
# Household Registry
## Overview
The household service provides APIs to create households and household members for 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
1. Provides APIs to create, update, delete, and search households.
2. Provides APIs to bulk create, bulk update, and bulk delete households.
3. Provides APIs to create, update, delete, and search household members.
4. Provides APIs to bulk create, bulk update, and bulk delete household members.
## Setup Details
The source code for a [Household](https://github.com/egovernments/health-campaign-services/tree/v1.1.0/health-services/household) is present in the health-campaign-services Git repo. The spring boot application needs the **Lombok\*** extension added to the IDE to load it. Once the application is up and running, the API requests can be posted to the URL and the IDs can be generated.
**\***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
Refer to the Swagger API for YAML file details: [Household.yaml](https://github.com/egovernments/health-campaign-services/blob/v1.1.0/docs/health-api-specs/contracts/registries/household.yml)
**Application.properties file information*****:***
Kafka topics persister configs for eGov persister
```
household.consumer.bulk.delete.topic=delete-household-bulk-topic
household.consumer.bulk.create.topic=create-household-bulk-topic
household.consumer.bulk.update.topic=update-household-bulk-topic
household.kafka.create.topic=save-household-topic
household.kafka.update.topic=update-household-topic
household.kafka.delete.topic=delete-household-topic
h.kafka.create.topic=save-household-topic
h.kafka.update.topic=update-household-topic
household.member.kafka.create.topic=save-household-member-topic
household.member.kafka.update.topic=update-household-member-topic
household.member.kafka.delete.topic=delete-household-member-topic
household.member.consumer.bulk.create.topic=household-member-consumer-bulk-create-topic
household.member.consumer.bulk.update.topic=household-member-consumer-bulk-update-topic
household.member.consumer.bulk.delete.topic=household-member-consumer-bulk-delete-topic
```
#### URLs for the external API references:
* eGov-Individual Service -> egov.individual.host =[ ](https://health-dev.digit.org)
* eGvo mdms -> egov.mdms.host =[ https://health-dev.digit.org](https://health-dev.digit.org)/
* eGov -idGen -> egov.idgen.host =[ ](https://health-dev.digit.org)
* eGov-User Service -> egov.user.host =[ ](https://health-dev.digit.org)
## Configuration Details
#### Access MDMS configurations
**Action test: URL actions adding**
[**Action-test.json**](https://github.com/egovernments/health-campaign-mdms/blob/v1.1.0/data/default/ACCESSCONTROL-ACTIONS-TEST/actions-test.json)
```
{
"id": 1546,
"name": "Household Create",
"url": "/household/v1/_create",
"displayName": "Household Create",
"orderNumber": 0,
"parentModule": "",
"enabled": false,
"serviceCode": "household",
"code": "null",
"path": ""
},
{
"id": 1547,
"name": "Household Update",
"url": "/household/v1/_update",
"displayName": "Household Update",
"orderNumber": 0,
"parentModule": "",
"enabled": false,
"serviceCode": "household",
"code": "null",
"path": ""
},
{
"id": 1548,
"name": "Household Search",
"url": "/household/v1/_search",
"displayName": "Household Search",
"orderNumber": 0,
"parentModule": "",
"enabled": false,
"serviceCode": "household",
"code": "null",
"path": ""
},
{
"id": 1558,
"name": "Household Member Create",
"url": "/household/member/v1/_create",
"displayName": "Household Member Create",
"orderNumber": 0,
"parentModule": "",
"enabled": false,
"serviceCode": "household",
"code": "null",
"path": ""
},
{
"id": 1559,
"name": "Household Member Update",
"url": "/household/member/v1/_update",
"displayName": "Household Member Update",
"orderNumber": 0,
"parentModule": "",
"enabled": false,
"serviceCode": "household",
"code": "null",
"path": ""
},
{
"id": 1560,
"name": "Household Member Search",
"url": "/household/member/v1/_search",
"displayName": "Household Member Search",
"orderNumber": 0,
"parentModule": "",
"enabled": false,
"serviceCode": "household",
"code": "null",
"path": ""
},
{
"id": 1573,
"name": "Household Bulk Create",
"url": "/household/v1/bulk/_create",
"displayName": "Household Bulk Create",
"orderNumber": 0,
"parentModule": "",
"enabled": false,
"serviceCode": "household",
"code": "null",
"path": ""
},
{
"id": 1574,
"name": "Household Bulk Update",
"url": "/household/v1/bulk/_update",
"displayName": "Household Bulk Update",
"orderNumber": 0,
"parentModule": "",
"enabled": false,
"serviceCode": "household",
"code": "null",
"path": ""
},
{
"id": 1575,
"name": "Household Delete",
"url": "/household/v1/_delete",
"displayName": "Household Delete",
"orderNumber": 0,
"parentModule": "",
"enabled": false,
"serviceCode": "household",
"code": "null",
"path": ""
},
{
"id": 1576,
"name": "Household Bulk Delete",
"url": "/household/v1/bulk/_delete",
"displayName": "Household Bulk Delete",
"orderNumber": 0,
"parentModule": "",
"enabled": false,
"serviceCode": "household",
"code": "null",
"path": ""
},
{
"id": 1581,
"name": "Household Member Bulk Create",
"url": "/household/member/v1/bulk/_create",
"displayName": "Household Member Bulk Create",
"orderNumber": 0,
"parentModule": "",
"enabled": false,
"serviceCode": "household",
"code": "null",
"path": ""
},
{
"id": 1582,
"name": "Household Member Bulk Update",
"url": "/household/member/v1/bulk/_update",
"displayName": "Household Member Bulk Update",
"orderNumber": 0,
"parentModule": "",
"enabled": false,
"serviceCode": "household",
"code": "null",
"path": ""
},
{
"id": 1583,
"name": "Household Member Delete",
"url": "/household/member/v1/_delete",
"displayName": "Household Member Delete",
"orderNumber": 0,
"parentModule": "",
"enabled": false,
"serviceCode": "household",
"code": "null",
"path": ""
},
{
"id": 1584,
"name": "Household Member Bulk Delete",
"url": "/household/member/v1/bulk/_delete",
"displayName": "Household Member Bulk Delete",
"orderNumber": 0,
"parentModule": "",
"enabled": false,
"serviceCode": "household",
"code": "null",
"path": ""
},
```
**Access to role-based actions**
[**Roleaction.json**](https://github.com/egovernments/health-campaign-mdms/blob/v1.1.0/data/default/ACCESSCONTROL-ROLEACTIONS/roleactions.json)
```
{
"rolecode": "SYSTEM_ADMINISTRATOR",
"actionid": 1546,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "REGISTRAR",
"actionid": 1546,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "DISTRIBUTOR",
"actionid": 1546,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "DISTRIBUTOR",
"actionid": 1547,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "REGISTRAR",
"actionid": 1547,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "SYSTEM_ADMINISTRATOR",
"actionid": 1547,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "SYSTEM_ADMINISTRATOR",
"actionid": 1548,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "REGISTRAR",
"actionid": 1548,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "DISTRIBUTOR",
"actionid": 1548,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "SYSTEM_ADMINISTRATOR",
"actionid": 1558,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "REGISTRAR",
"actionid": 1558,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "DISTRIBUTOR",
"actionid": 1558,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "SYSTEM_ADMINISTRATOR",
"actionid": 1559,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "REGISTRAR",
"actionid": 1559,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "DISTRIBUTOR",
"actionid": 1559,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "SYSTEM_ADMINISTRATOR",
"actionid": 1560,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "REGISTRAR",
"actionid": 1560,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "DISTRIBUTOR",
"actionid": 1560,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "SYSTEM_ADMINISTRATOR",
"actionid": 1573,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "REGISTRAR",
"actionid": 1573,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "DISTRIBUTOR",
"actionid": 1573,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "SYSTEM_ADMINISTRATOR",
"actionid": 1574,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "REGISTRAR",
"actionid": 1574,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "DISTRIBUTOR",
"actionid": 1574,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "SYSTEM_ADMINISTRATOR",
"actionid": 1575,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "REGISTRAR",
"actionid": 1575,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "DISTRIBUTOR",
"actionid": 1575,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "SYSTEM_ADMINISTRATOR",
"actionid": 1576,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "REGISTRAR",
"actionid": 1576,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "DISTRIBUTOR",
"actionid": 1576,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "SYSTEM_ADMINISTRATOR",
"actionid": 1581,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "REGISTRAR",
"actionid": 1581,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "DISTRIBUTOR",
"actionid": 1581,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "SYSTEM_ADMINISTRATOR",
"actionid": 1582,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "REGISTRAR",
"actionid": 1582,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "DISTRIBUTOR",
"actionid": 1582,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "SYSTEM_ADMINISTRATOR",
"actionid": 1583,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "REGISTRAR",
"actionid": 1583,
"actioncode": "",
"tenantId": "default"
},
{
"rolecode": "DISTRIBUTOR",
"actionid": 1583,
"actioncode": "",
"tenantId": "default"
}
```
## **Persister Configuration**
[Household Persister Yaml](https://github.com/egovernments/health-campaign-config/blob/v1.1.0/egov-persister/household-persister.yml)
## **Indexer Configuration**
[Household Indexer Yaml](https://github.com/egovernments/health-campaign-config/blob/v1.1.0/egov-indexer/household-indexer.yml)
## Database Schema
## **Postman Collection**
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://docs.digit.org/health/v1.5/setup/configuration/service-configuration/household-registry.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
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.