# Muster Roll

## Overview

The Muster Roll service aggregates attendance logs from the attendance service based on some rules and presents an attendance aggregate for a time period (week or month) per individual. This can then be used to compute payments or other semantics. 

## Dependencies

* [DIGIT backbone services](https://core.digit.org/platform/core-services)
* [Idgen](https://core.digit.org/platform/core-services/id-generation-service)
* [Persister](https://core.digit.org/platform/core-services/persister-service)
* [Indexer](https://core.digit.org/platform/core-services/indexer-service)
* [Workflow](https://core.digit.org/platform/core-services/workflow-service)
* [User](https://core.digit.org/platform/core-services/user-services)
* [Attendance](/works/platform/architecture/low-level-design/services/attendance.md)

### Code

[Module code](https://github.com/egovernments/DIGIT-Works/tree/master/backend/muster-roll)

[Helm charts](https://github.com/egovernments/DIGIT-DevOps/tree/digit-works/deploy-as-code/helm/charts/digit-works/backend/muster-roll)

## API Specifications

**Base Path:** /muster-roll

### API Contract Link

{% embed url="<https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/DIGIT-Works/develop/backend/muster-roll-service/Muster-Roll-Service-1.0.0.yaml>" %}

## Data Model

### DB Schema Diagram

<figure><img src="/files/3IdhODJTQw1wqKKTc6lh" alt=""><figcaption></figcaption></figure>

### Web Sequence Diagrams

{% tabs %}
{% tab title="Create" %}

<figure><img src="/files/igBpKiHA0inEewhbATh3" alt=""><figcaption></figcaption></figure>

{% endtab %}

{% tab title="Second Tab" %}

<figure><img src="/files/FqVga7SorKs7SMtOEG7L" alt=""><figcaption></figcaption></figure>

{% endtab %}

{% tab title="Search" %}

<figure><img src="/files/scBuBWWjSHFtD6M6hCc3" alt=""><figcaption></figcaption></figure>

{% endtab %}
{% endtabs %}

### **Master Data**&#x20;

{% embed url="<https://github.com/egovernments/works-mdms-data/blob/DEV/data/pb/common-masters/MusterRoll.json>" %}

{% embed url="<https://github.com/egovernments/works-mdms-data/blob/DEV/data/pb/common-masters/WageSeekerSkills.json>" %}

## Related Topics

* [Functional specifications - Muster Roll](/works/specifications/functional-specifications/muster-roll.md)
* [Muster Roll service configuration](/works/setup/configure-works/service-configuration/muster-roll.md)
* [Muster Roll UI configuration](/works/reference-implementations/muktasoft-v2.2/deployment/configuration/ui-configuration/modules/muster-roll-cbo-application.md) - for MuktaSoft
* [Muster Roll user manual](/works/reference-implementations/muktasoft-v2.2/implementation/training-resources/user-manual/mobile-application-user-manual/cbo-getting-started/muster-rolls.md)


---

# 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/works/platform/architecture/low-level-design/services/muster-roll.md?ask=<question>
```

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.