Dartmouth API Developer Portal

Students-Academic Terms API

Returns information about academic terms for students.

Rating

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

Required Scopes

Scope	Description
urn:dartmouth:students:read.sensitive	This scope is required to access academic terms for students. Granting of this scope is via the Undergraduate Registrars Office
urn:dartmouth:people:private	This optional scope is required in order to access academic terms for FERPA protected identities. Granting of this scope is via the Undergraduate Registrars Office

Request

GET /api/students/{netid}/terms

Required Headers

Authorization: Bearer {jwt}

Parameters

Parameter Name	Type	Description	Valid values	Required

(none)

Notes on usage

Academic terms are modeled as a subresource of students. Currently it is only possible to get terms for a particular person. Searching for holders of certain terms is not available.

The terms are returned as a collection. When the person does not have terms associated with their account a status of 200 is returned with an empty array in the payload.

See the documentation under Academic Terms for more information about how terms are constructed from Banner.

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/terms

Sample Return

[
    {
        "netid": "f000abc",
        "term_id": "201801-U",
        "school_id": "UG",
        "is_active": false,
        "start_date": "2018-01-03T05:00:00Z",
        "end_date": "2018-03-13T04:00:00Z",
        "lms_term": {
            "id": "WI18",
            "name": "Winter Term 2018 (A&S)",
            "is_course_send_enabled": false,
            "is_enroll_send_enabled": false
        },
        "quarterly_term": {
            "id": "201801",
            "name": "Winter Term 2018",
            "start_date": "2017-12-16T05:00:00Z",
            "end_date": "2018-03-15T04:00:00Z",
            "current_term_offset": -6
        },
        "term_description": {
            "id": "U",
            "name": "Undergraduate full term"
        },
        "id": "5d72b52ddeaaa38d5c98b5cf"
    },
    {
        "netid": "f000abc",
        "term_id": "201901-U",
        "school_id": "UG",
        "is_active": false,
        "start_date": "2019-01-03T05:00:00Z",
        "end_date": "2019-03-13T04:00:00Z",
        "lms_term": {
            "id": "WI19",
            "name": "Winter Term 2019 (A&S)",
            "is_course_send_enabled": false,
            "is_enroll_send_enabled": false
        },
        "quarterly_term": {
            "id": "201901",
            "name": "Winter Term 2019",
            "start_date": "2018-12-16T05:00:00Z",
            "end_date": "2019-03-15T04:00:00Z",
            "current_term_offset": -2
        },
        "term_description": {
            "id": "U",
            "name": "Undergraduate full term"
        },
        "id": "5d72b5a6deaaa38d5c9bb429"
    }
]