Project

High level design document

Overview

The project service provides APIs to create, update and manage a generic project. A project can have one or more of the following constructs: staff, tasks, beneficiaries and facilities. Currently, this service is shared across the Health and Works platforms. All Works projects start with a project construct. The Works platform uses only 3 primary APIs: project create, update and search. For low-level design and other information on this service, click here.

Key Functionalities

• Creating, updating, and searching for a project

• Adding staff, tasks, resources and facilities to a project

Code

Module code

Deployment in Works

Integration

API Spec

Base path: /project/

Documentation for this service is available here.

Postman Collection

Click here to access the Postman collection used to test APIs. Import the link into Postman and follow the instructions to run the collection.

Master Data Types

The following primary masters are defined by this module and used for validations. Other common masters such as department, tenant etc..are also used by this module.

Module Name	Master Name	Sample Data
works	ProjectType	https://github.com/egovernments/works-mdms-data/blob/UAT/data/statea/works/ProjectType.json