Dartmouth API Developer Portal

Academic Enrollment Transfers API

Returns information about enrollments transferred from other institutions including parent course, term, school_id, and credits. A history of enrollments is maintained via term.

Rating

Attribute	Value
Highly Available	Yes
Cache Refresh Interval	30 minutes
Filtering	Yes

Required Scopes

Scope	Description
api:academic:enrollments:read	This scope is required in order to read enrollments. Granting of this scope is via the Undergraduate Registrars Office
api:academic:enrollments:read.sensitive	This scope is required in order to read sensitive enrollment attributes (e.g. final_grade). Granting of this scope is via the Undergraduate Registrars Office
urn:dartmouth:people:private	This optional scope is required in order to get enrollments for FERPA-protected students. Granting of this scope is via the Undergraduate Registrars Office

Request

GET /api/academic/enrollment/transfers/{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 enrollment transfers 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.

Historical information is available for enrollments through queries on term (e.g sis_term_code=<202001).

Business Logic

The source for enrollment transfer data is Banner's sfrtrce table.

The {id} attribute is constructed from other attributes using the following format: {subject_id}.{course_number}.{section}-{sis_term_code}-{sfrtrce_surrogate_id}-{netid}.

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/academic/enrollment/transfers/PSYC.050.2-201003-197221-d25193t

Sample Returns

api:academic:enrollments:read scope

{
    "id": "PSYC.050.2-201003-197221-d25193t",
    "netid": "d25193t",
    "school_id": "UG",
    "course_transfer": {
        "id": "PSYC.050.2-201003-Issues_in_Neuropsychology",
        "sis_term_code": "201003"
    },
    "cache_date": "2022-05-18T14:24:31Z"
}

api:academic:enrollments:read and api:academic:enrollments:read.sensitive scopes

The read.sensitive scope exposes final_grade and credit_hours_earned attributes:

{
    "id": "PSYC.050.2-201003-197221-d25193t",
    "netid": "d25193t",
    "school_id": "UG",
    "credit_hours_earned": 1.0,
    "final_grade": "TR",
    "course_transfer": {
        "id": "PSYC.050.2-201003-Issues_in_Neuropsychology",
        "sis_term_code": "201003"
    },
    "cache_date": "2022-05-18T14:24:31Z"
}