Created
May 19, 2023 10:15
-
-
Save f0-x/9cde0bcc0ee1815ada982d0b9f4896e2 to your computer and use it in GitHub Desktop.
POST: Check Project's Eligibility
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
// POST: /checkFundingEligibility | |
// This API will check if the project is eligible for specific funding option of a funding cycle. | |
// 'request.json' | |
{ | |
// As each funding category is going to be unique with its own unique requirements | |
// | |
"fundingCategoryId": "1.0.6159e.c100c123", | |
"projectId": "1.0.3439e.c10012sf" | |
} | |
// Successfull 'response.json', when there are no failing requirements ✅ | |
{ | |
... | |
"isEligible": true, | |
"failingRequirements": null | |
... | |
} | |
// Error 'response.json', when there are some failing requirements ❌ | |
{ | |
... | |
"isEligible": false, | |
// An array of fields that fails the requirements of this funding category 🚧 | |
// We will require these fields to display appropriate messages of the failing | |
// requirements to the user. | |
"failingRequirements": [ | |
... | |
"categories", | |
"roles", | |
"subtitles", | |
... | |
] | |
... | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment