Dartmouth API Developer Portal

Financial Aid Applicant Portals API

Returns information about financial aid application portals (e.g. Slate, AMCAS) for applicants to all schools.

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 applicant portal info. Granting of this scope is via the Financial Aid Office

Request

GET /api/financial_aid/applicant_portals/{pidm}

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 {pidm} 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 pidm.

Business Logic

The {pidm} attribute is a unique integer string generated when the record is created in Banner.

Returns

Status Code	Description
200	{pidm} requested exists or was not specified
404	{pidm} requested does not exist

Sample Request

https://api.dartmouth.edu/api/financial_aid/applicant_portals/2769157

Sample Return

{
    "dartid": "@02466986",
    "first_name": "Jane",
    "middle_name": "M",
    "last_name": "Doe",
    "name": "Jane M doe",
    "email": "jd2251@columbia.edu",
    "parent_email": null,
    "pidm": "2769157",
    "portals": [
        {
            "type": "Slate",
            "id": "119243978",
            "school_id": "DM",
            "program": "MD",
            "term_code": "202309",
            "activity_date": "2023-02-03T21:12:15Z"
        },
        {
            "type": "AMCAS",
            "id": "14822910",
            "school_id": "DM",
            "program": "MD",
            "term_code": "202309",
            "activity_date": "2023-02-03T21:12:15Z"
        }
    ]
}