Dartmouth API Developer Portal

Academic Graduate Appointments API

Returns information about graduate appointments including term, type, stipend and hours. A history of appointments is maintained via term.

Rating

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

Required Scopes

Scope	Description
api:academic:appointments:read	This scope is required in order to read graduate appointments. Granting of this scope is via the Undergraduate Registrars Office
urn:dartmouth:people:private	This optional scope is required in order to get appointments for FERPA-protected students. Granting of this scope is via the Undergraduate Registrars Office

Request

GET api/academic/appointments/{id}
GET api/students/{netid}/appointments

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 appointments 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 appointments through queries on term (e.g term.sis_term_code=<202001). To get current appointments only, query is_active=true.

Business Logic

The {id} attribute is constructed from other attributes using the following format: {term}-{netid}-{type}-{subtype}. Type is 'A' for assistantship (other codes exist but are not currently used). Subtypes are defined in STVGTYP - Assistantship types.

The data is stored in the Banner table SATURN.SGRASSI and the comments table SATURN.SGRACMT

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/appointments/202001-f002nkd-A-ERA

Sample Returns

api:academic:appointments:read scope

{
    "cache_date": "2020-06-15T04:43:15Z",
    "id": "202001-f002nkd-A-ERA",
    "is_active": false,
    "term": {
        "id": "202001-G",
        "lms_term_id": "WI20",
        "sis_ptrm_code": "U",
        "sis_term_code": "202001"
    },
    "student_netid": "f0027k4",
    "category": "A",
    "assignment_type_code": "ETA",
    "assignment_type_desc": "Graduate Teaching Assistant",
    "term_code_effective": "202001",
    "stipend": 1000,
    "stipend_notes": "",
    "hours": 20,
    "hours_notes": "",
    "advisor_netid": "f000000",
    "level": "GR",
    "college": "GR",
    "major": "CHEM",
    "department": "CHEM",
    "degree": "PHD",
    "program": "GRCHEMPHD",
    "start_date": "2 July 2024",
    "end_date": "5 Sept 2024",
    "catalog_term_code": null,
    "funding_source": null,
    "fte": null,
    "min_course_load": null,
    "max_course_load": null,
    "section": {
        "id": "AAAS.010.01-202001-U-10188",
        "lms_section_id": "AAAS.010.01-WI20",
        "sis_section_id": "AAAS.010.01-WI20"
    }
}