Dartmouth API Developer Portal

Students-Academic Awards API

Returns information about academic awards for students.

Rating

Attribute	Value
Highly Available	Yes
Cache Refresh Interval	24 hours
Filtering	Yes

Required Scopes

Scope	Description
api:academic.awards:read.sensitive	This scope is required to access the main part of the payload. Granting of this scope is via the Undergraduate Registrars Office
api:academic.awards:read.highlysensitive	This optional scope is required in order to access award amounts. Granting of this scope is via the Undergraduate Registrars Office
urn:dartmouth:people:private	This scope is required to access awards for confidential students

Request

GET /api/students/{netid}/awards

Required Headers

Authorization: Bearer {jwt}

Notes on usage

Financial Awards are available in a rolling window from the prior summer term and forward. All awards in that period are available. Award amounts are only available by specifying the api:academic.awards:read.highlysensitive scope.

Returns

Status Code	Description
200	{netid} requested is valid
404	{netid} requested is either not valid or is FERPA-protected (and urn:dartmouth:people:private scope was not specified)

Sample Request

https://api.dartmouth.edu/api/students/f000abc/awards

Sample Return

[
    {
        "netid": "f00abcd",
        "is_confidential": false,
        "school_id": "UG",
        "quarterly_term_code": "202109",
        "quarterly_term_desc": "Fall Term 2021",
        "aid_year_code": "2122",
        "is_current_term": false,
        "fund_code": "U80132",
        "fund_title": "Federal Pell Grant",
        "award_status_code": "ACPT",
        "federal_source_code": "FDRL",
        "federal_type_code": "USCH",
        "detail_code": "G001",
        "federal_fund_id": "PELL",
        "offer_amount": 1083.0,
        "offer_date": "2021-09-29T04:00:00Z",
        "original_offer_amount": 2165.0,
        "accept_amount": 1083.0,
        "accept_date": "2022-04-14T04:00:00Z",
        "paid_amount": 1083.0,
        "paid_date": "2021-09-29T04:00:00Z",
        "cache_date": "2022-08-09T05:45:36Z"
    },
    {
        "netid": "f00abcd",
        "is_confidential": false,
        "school_id": "UG",
        "quarterly_term_code": "202109",
        "quarterly_term_desc": "Fall Term 2021",
        "aid_year_code": "2122",
        "is_current_term": false,
        "fund_code": "U80207",
        "fund_title": "Federal SEOG",
        "award_status_code": "ACPT",
        "federal_source_code": "FDRL",
        "federal_type_code": "USCH",
        "detail_code": "G004",
        "federal_fund_id": "SEOG",
        "offer_amount": 1333.0,
        "offer_date": "2022-06-03T04:00:00Z",
        "original_offer_amount": 1000.0,
        "accept_amount": 1333.0,
        "accept_date": "2022-06-03T04:00:00Z",
        "paid_amount": 1333.0,
        "paid_date": "2022-06-03T04:00:00Z",
        "cache_date": "2022-08-09T05:45:36Z"
    }
]