Contribution Service

The Contribution microservice enables organizations to digitally plan, coordinate and manage crowdsourcing of assets for defined projects.

Contribution service offers the APIs for creating and managing projects, their nominations, setting and reading user preferences, reading the configuration, getting the list of tenants and projects reports, etc. It stores information about the sourcing projects, their nominations, and configuration.

Program APIs

Program APIs provide the ability to organizations to create and manage projects to get the crowdsourcing of assets.

Key features

  • Create project: This API creates the project to get the crowdsourcing of assets. Project by default is kept in draft mode and can be published later once the creator is ready to go live.

  • Update project: This API provides the ability to update the project details. For the published (Live) project only specific details are allowed to update e.g Project title, description, nomination and contribution dates.

  • Publish project: The contribution organization or individual contributor can view and contribute the assets to only publish the project. This API enables the ability to publish the project.

  • Unlist publish project: This API provides control to get the contribution only from the organization that created the project.

  • Project list: This API provides the list of projects available in a system. This API has the ability to apply filters.

  • List download: This API can be used to download the project details with insight full details like the number of nominations received, contribution received, sample received, contribution rejected, project metadata etc.

  • Read project: This API returns the entire project details.

Nomination APIs

Nomination APIs provide the ability to nominate and manage nominations made to the project.

API Documentation

Click here for Nomination APIs

Report API

Report API generates the report of the approved asset contributed to the project.

API Documentation

Click here for Report APIs

Configuration Search API

Configuration search API supports searching the configuration by its key and status. The configuration entity provides the ability to mark configuration as active/ inactive. This configuration entity can be used to maintain a variety of configurations such as email/ SMS template configuration.

API Documentation

Click here for Configuration Search API

Tenant List API

Tenant list API enables the ability to get a list of sourcing organizations that wants crowdsourcing of assets from the contributor for their projects. Tenant list API supports the filters, it can be used to get the active(live) / inactive tenant list.

API Documentation

Click here for Tenant List API

Preference API

Preference APIs provide the ability to add, update, read user and project preferences.

API Documentation

Click here for Preference API

API Documentation:

https://documenter.getpostman.com/view/25186239/2s935ivSkP

Source Code

Last updated