Dartmouth API Developer Portal

Financial Aid Loan Notices API

Returns information about financial aid loan notices for all students (from all schools). 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 loan notices. 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 loan notices for FERPA-protected students. Granting of this scope is via the Undergraduate Registrars Office

Request

GET /api/financial_aid/laon_notices/{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+effective_date.

This API will typically be used to get a set of records via filtering (e.g. effective_date=>2021-03-01&school_id=DM)

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/loan_notices/6064b5c01a2da7e586f99848

Sample Return

{
    "cache_date": "2021-05-04T13:14:52Z",
    "effective_date": "2020-08-18T04:00:00Z",
    "id": "608c6470d4896c922bd1c11b",
    "is_graduated": false,
    "netid": "f00000w",
    "notices": [
        {
            "amount": 21124,
            "date_term_fund_amount": "AUG 18 2020  Fall Term 2020  Federal Unsub. Direct Loan   $21,124.00",
            "fund": "Federal Unsub. Direct Loan"
        }
    ],
    "pidm": 15538,
    "school_id": "DM"
}