Dartmouth API Developer Portal
Value Lists - Faculty Ranks API
Returns information about known student types.
Rating
Attribute | Value |
---|---|
Highly Available | Yes |
Cache Refresh Interval | Daily |
Filtering | Yes |
Required Scopes
None: value list APIs require only authentication to Dartmouth's login API as documented in the introduction section of this portal.
Request
GET /api/faculty_ranks/{faculty_rank_code}
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
Use this API to get a unique list of faculty rank codes as expressed in the Employees API faculty_data
section of the payload.
To find a particular rank use a call like /api/faculty_ranks/{faculty_rank_code}
When {faculty_rank_code} is excluded from the URL, the entire value list is returned as a collection. This can be useful when an application needs to provide a complete list of valid selections. 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.
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/faculty_ranks/10
Sample Return
{
"faculty_rank_code": "10",
"faculty_rank_description": "Professor",
"is_active": true,
"cache_date": "2021-08-11T20:23:10Z"
}