Dartmouth API Developer Portal
Financial Aid Students API
Returns information about financial aid status for undergraduate students. Information is available for active aid years only.
Rating
| Attribute | Value |
|---|---|
| Highly Available | Yes |
| Cache Refresh Interval | 30 minutes |
| Filtering | Yes |
Required Scopes
| Scope | Description |
|---|---|
| api:financial_aid:read.sensitive | This scope is required in order to read financial aid status. Granting of this scope is via the Financial Aid Office |
| api:financial_aid:read.highlysensitive | This scope is required in order to read questbridge_scholar_code. Granting of this scope is via the Financial Aid Office |
| api:financial_aid:read.ssn | This scope is required in order to read ssn. Granting of this scope is via the Financial Aid Office |
| urn:dartmouth:people:private | This optional scope is required in order to get financial aid status for FERPA-protected students. Granting of this scope is via the Undergraduate Registrars Office |
Request
GET /api/financial_aid/students/{id}
Required Headers
Authorization: Bearer {jwt}
Parameters
| Parameter Name | Type | Description | Valid values | Required |
|---|
(standard filter parameters as documented in the introduction section of this portal)
Notes on usage
When {id} is excluded from the URL, all records are returned as a collection. Standard filtering via URL parameters is also available and returns a collection; the collection will be empty if no records are qualified by the filtering.
There is one record for each netid+aid_year_code.
This API will typically be used to get a set of records via filtering (e.g. aid_year_code=2122&is_application_complete=false)
Business Logic
The {id} attribute is a unique hexidecimal string generated when the object is initially cached.
Returns
| Status Code | Description |
|---|---|
| 200 | {id} requested exists or was not specified |
| 404 | {id} requested does not exist |
Sample Request
https://api.dartmouth.edu/api/financial_aid/students/6064b5c01a2da7e586f9986e
Sample Return
{
"aid_year_code": "2122",
"cache_date": "2023-07-19T20:11:22Z",
"comments": null,
"dartid": "F004HCV",
"id": "6064b5c01a2da7e586f9986e",
"is_application_complete": false,
"is_award_recipient": false,
"is_graduated": false,
"is_selected_for_verification": false,
"missing_material": [
"Free Application for Federal Student Aid (FAFSA) https://studentaid.gov/h/apply-for-aid/fafsa"
],
"mpn_requirement": null,
"netid": "f001abc",
"officer_initials": "KSP",
"parent_email_address": "parent@gmail.comXXX",
"pidm": 2946136,
"questbridge_scholar_code": null,
"school_id": "UG",
"ssn": "1112223333"
}