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

Idgen

Persister

Indexer

Workflow

User

Attendance

Code

Module code

Helm charts

Integration

Base path: /muster-roll

API spec

Postman Collection

Steps to run the postman collection:

1. Import the postman collection for Muster Roll.

2. Import the environment variables required for running the postman collection which will create an environment ‘Muster Environment’.

3. MusterRoll requires the below services from Attendance Service API to be run prior to creating muster. So run the below services before running the musterRoll postman collection.

a) create Attendance register - https://<server>/attendance/v1/_create

b) Attendee enroll - https://<server>/attendance/attendee/v1/_create

c) Attendance log create - https://<server>/attendance/log/v1/_create

4. Update the current value of the variable ‘registerId’ in the ‘Muster Environment’ with the id returned by the response of the create attendance register ( in step 3 a)

5. Run the ‘Muster Roll Service’ postman collection as ‘Run Collection’ . It will run the /_estimate, /_create, /_update and /_search APIs success and validation error scenarios.

6. Muster will be created for the attendees enrolled in the attendance register (in step 3 b) using the attendance logs created (in step 3 c).

The current value of environment variables ‘musterRollId’ and ‘musterRollNumber’ will be set from the response of the /_create muster roll which will be used by /_update and /_search APIs.