About
Type: Read Only
Endpoint:
GET /api/scholarship/get-available-dollars/{awardCycleId}Description: Retrieves the available scholarship funds for all opportunities within a given award cycle.
Authentication
Requires a valid SpringAPI access token
See Authentication for details
Path Parameters
Parameter | Type | Required | Description |
awardCycleId | number | Yes | Unique identifier of the award cycle (from Award Cycles API) |
Success Response
200 OK
[
{
"id": 1,
"name": "STEM Excellence Scholarship",
"totalFunds": 50000,
"totalAwardAmount": 35000,
"totalAmountRemaining": 15000
}
]Response Fields
Field | Type | Description |
id | number | Unique identifier of the opportunity (scholarship) |
name | string | Name of the scholarship |
totalFunds | number | Total funds allocated |
totalAwardAmount | number | Total amount already awarded |
totalAmountRemaining | number | Remaining funds available |
Error Responses
HTTP Code | Description |
400 Bad Request | Invalid or malformed awardCycleId |
401 Unauthorized | Missing or invalid API token |
Notes
All monetary values are returned in USD
totalAmountRemaining is calculated as totalFunds - totalAwardAmount
Results are limited to opportunities accessible by the API token