Dartmouth API Developer Portal

Academic Departmental Appointments API

Returns information about departmental appointments for faculty.

Rating

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

Required Scopes

None: only requires authentication to Dartmouth's login API as documented in the introduction section of this portal.

Request

GET api/academic/departmental/appointments/{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 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.

When searching for a particular appointment type for a particular faculty member, query by netid={netid}&type_id={appointment_type_id}.

Business Logic

The {id} attribute is constructed from other attributes using the following format: {netid}-{department_id}-{type_id}.

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/departmental/appointments/d29748s-NAS-DOF

Sample Return

{
    "cache_date": "2020-05-01T19:14:00Z",
    "department_id": "NAS",
    "id": "d29748s-NAS-DOF",
    "is_home_department": true,
    "netid": "d29748s",
    "term_code_effective": "201606",
    "type_id": "DOF"
}