The referral management registry provides APIs to register the side-effects, and referrals for beneficiaries of a health campaign of the DIGIT platform. This document provides the configuration details for setting up the module.
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.
Knowledge of Project, Household, and Individual modules.
Functionalities
Provides APIs to create, update, and delete referrals and side-effects.
Provides APIs to bulk create, update, and delete referrals and side-effects.
Inactivates the status of referrals, side-effects post deletion.
Provides a search API for referral on unique ID, client reference unique ID, project beneficiary ID, side effect ID, referrer ID, and recipient ID.
Provides a search API for side effect on unique ID, client reference unique ID, project task ID.
Setup Details
*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
Application.properties file information:
Kafka topics persister configs for eGov persister:
The source code for an 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.
Refer to the Swagger API for YAML file details. Link:
