Dartmouth API Developer Portal
Academic Course-Crosslists API
Returns information about valid course crosslists. A crosslist object contains one or more courses. This information is used to validate a crosslist when creating crosslisted sections.
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/course/crosslists/{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 crosslists 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.
Business Logic
The {id} attribute is constructed from other attributes using the following format: {group_name}-{term_code_effective}.
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/course/crosslists/00010017-201901
Sample Return
{
"cache_date": "2020-05-01T19:21:53Z",
"courses": [
{
"id": "EARS.032-201803"
},
{
"id": "BIOL.028-200503"
}
],
"group_name": "00010017",
"id": "00010017-201901",
"term_code_effective": "201901"
}