> 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/public-finance/v2.3/exemplar/mgramseva/user-manual/tech-user-manual/household-register.md).

# Household Register

**Link** → {base url}/mgramseva/home/householdRegister

![](https://2287351256-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FujRjzdG1LUqcmmuo2t2T%2Fuploads%2F7363fgogumrLlmakn1Pg%2FHousehold%20register.png?alt=media\&token=fb729929-f866-45df-8f33-bf2548987614)

Users are redirected to this screen if they select the Household Register tile/card on the home screen.

The Household Register tile/card is displayed to the user with `COLLECTION_OPERATOR` role.

### **User Interaction on Screen**

* From the text field, users can search connections by using connection ID.
* Users can see all the connections data of the selected tenant till the current date based on their payment status (Ex: All, Paid, Pending).
* Initially, only 10 connections are loaded for the selected tab. The pagination drop-down and right arrow click enable users to view more connections.
* By selecting any connection ID users are navigated to the View Consumer Details Screen.
* Click on the Download button to get all the household records in PDF format
* Click on Share to share the PDF in Whats App

![Household records in PDF format](https://2287351256-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FujRjzdG1LUqcmmuo2t2T%2Fuploads%2FSURhidvKRqBGsLVwDsJx%2FHousehold%20pdf%20format.png?alt=media\&token=e4d46744-99a9-46bf-afde-a0f39c0b0052)

### **File Path**

Primary Files :

{% embed url="<https://github.com/misdwss/punjab-mgramseva/blob/develop/frontend/mgramseva/lib/screeens/HouseholdRegister/HouseholdRegister.dart>" %}

{% embed url="<https://github.com/misdwss/punjab-mgramseva/blob/develop/frontend/mgramseva/lib/screeens/HouseholdRegister/HouseholdSearch.dart>" %}

{% embed url="<https://github.com/misdwss/punjab-mgramseva/blob/develop/frontend/mgramseva/lib/screeens/HouseholdRegister/HouseholdList.dart>" %}

{% embed url="<https://github.com/misdwss/punjab-mgramseva/blob/develop/frontend/mgramseva/lib/screeens/HouseholdRegister/household_pdf.dart>" %}

### **API Details**

| **End Point**                    | **Request Method** | **Request Info**                                                                                                                                                                                                                                                                                                             |
| -------------------------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| /`ws-services/wc/_search`        | POST               | <p><code>tenantId</code> : {}<br><code>offset</code> ; {}<br><code>limit</code> : {}<br><code>toDate</code> : {}<br><code>isCollectionCount</code>: {}</p><p><code>isBillPaid</code><br><code>connectionNumber</code>: {}<br><code>freeSearch</code>: {}</p><p><code>sortOrder</code>: {}</p><p><code>sortBy</code> : {}</p> |
| `/filestore/v1/files`            | POST               | <p><code>tenantId</code> : {}</p><p><code>module</code> : {}</p>                                                                                                                                                                                                                                                             |
| `/egov-url-shortening/shortener` | POST               | `url` : {}                                                                                                                                                                                                                                                                                                                   |

&#x20;

**Stack**

1 → Home Screen. + Household Register Screen

Pop → Household Register Screen→ Home Screen

2 → Home Screen. + Household Register Screen + View Consumer Details Screen

Pop → View Consumer Details Screen → Household Register Screen

&#x20;

**Widgets used from Library**

| **Widgets**      | **File Path**                                                                                                                                                                                                                                                    | **Description** |
| ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------- |
| `Pagination`     | [<img src="https://github.com/fluidicon.png" alt="" data-size="line">punjab-mgramseva/pagination.dart at develop · egovernments/punjab-mgramseva](https://github.com/egovernments/punjab-mgramseva/blob/develop/frontend/mgramseva/lib/widgets/pagination.dart)  | Pagination      |
| `BuildTextField` | [<img src="https://github.com/fluidicon.png" alt="" data-size="line">punjab-mgramseva/TextFieldBuilder.dart at master · misdwss/punjab-mgramseva](https://github.com/misdwss/punjab-mgramseva/blob/master/frontend/mgramseva/lib/widgets/TextFieldBuilder.dart)  | Text Field      |
| `BillsTable`     | [<img src="https://github.com/fluidicon.png" alt="" data-size="line">punjab-mgramseva/BillsTable.dart at master · misdwss/punjab-mgramseva](https://github.com/misdwss/punjab-mgramseva/blob/master/frontend/mgramseva/lib/components/Dashboard/BillsTable.dart) | Table           |
| `LabelText`      | [<img src="https://github.com/fluidicon.png" alt="" data-size="line">punjab-mgramseva/LabelText.dart at master · misdwss/punjab-mgramseva](https://github.com/misdwss/punjab-mgramseva/blob/master/frontend/mgramseva/lib/widgets/LabelText.dart)                | Title           |
| `SubLabelText`   | [<img src="https://github.com/fluidicon.png" alt="" data-size="line">punjab-mgramseva/SubLabel.dart at master · misdwss/punjab-mgramseva](https://github.com/misdwss/punjab-mgramseva/blob/master/frontend/mgramseva/lib/widgets/SubLabel.dart)                  | Subtitle        |

&#x20;

**Role Access Mapping**

```
case Routes.HOUSEHOLD:
    return ['COLLECTION_OPERATOR', 'SUPERUSER'];

```

### &#x20;**File Path**

Model → [<img src="https://github.com/fluidicon.png" alt="" data-size="line">punjab-mgramseva/water\_connection.dart at master · misdwss/punjab-mgramseva](https://github.com/misdwss/punjab-mgramseva/blob/master/frontend/mgramseva/lib/model/connection/water_connection.dart) , [<img src="https://github.com/fluidicon.png" alt="" data-size="line">punjab-mgramseva/water\_connections.dart at master · misdwss/punjab-mgramseva](https://github.com/misdwss/punjab-mgramseva/blob/master/frontend/mgramseva/lib/model/connection/water_connections.dart)

View → [<img src="https://github.githubassets.com/favicon.ico" alt="" data-size="line">https://github.com/misdwss/punjab-mgramseva/tree/develop/frontend/mgramseva/lib/screeens/HouseholdRegister - Connect to preview](https://github.com/misdwss/punjab-mgramseva/tree/develop/frontend/mgramseva/lib/screeens/HouseholdRegister)

Controller → <https://github.com/misdwss/punjab-mgramseva/blob/develop/frontend/mgramseva/lib/providers/household_register_provider.dart> , <https://github.com/misdwss/punjab-mgramseva/blob/develop/frontend/mgramseva/lib/repository/search_connection_repo.dart>

> [![Creative Commons License](https://i.creativecommons.org/l/by/4.0/80x15.png)*​*](http://creativecommons.org/licenses/by/4.0/)*All content on this page by* [*eGov Foundation*](https://egov.org.in/) *is licensed under a* [*Creative Commons Attribution 4.0 International License*](http://creativecommons.org/licenses/by/4.0/)*.*


---

# 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/public-finance/v2.3/exemplar/mgramseva/user-manual/tech-user-manual/household-register.md?ask=<question>&goal=<user_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.