Dartmouth API Developer Portal
Academic Sections API
Returns information about sections include parent course(s), lms (i.e. Canvas) id/name, and sis (i.e. Banner) id/name.
There are two types of sections: single-course and multi-course (i.e. crosslisted).
Single-course sections have:
- sis_section.id identical to lms_section.id
- sis_section.name identical to name
- crosslist is null
Multi-course sections have:
- sis_section.id is concatentation of crosslisted lms_section.ids, formatted as "x-{lms_ids}-x"
- sis_section.name is concatenation of crosslisted lms_section.names
- crosslist contains crosslist.id and crosslisted section ids
Single-course sections (only) are loaded into Canvas; multi-course sections exist in Banner (only) and take the place of their single-course member 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/sections/{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 sections 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 sections through queries on term (e.g term.sis_term_code=<202001). To get current (in terms of availabilty for course registration and data feeds) sections only, query is_active=true. To get sections that are currently in session, query is_in_session=true.
Business Logic
The {id} attribute is constructed from other attributes using the following format: {subject_id}.{course_number}.{section_number}-{term.id}-{crn}.
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/sections/AAAS.010.01-202001-U-10188
Sample Return: single-course section
- sis_section.id identical to lms_section.id
- sis_section.name identical to name
- crosslist is null
{
"cache_date": "2020-06-18T14:54:05Z",
"course_id": "AAAS.010-201409",
"course_assessment": {
"is_active": null,
"is_enabled": false,
"start_date": "2020-02-26T05:00:00Z",
"end_date": "2020-04-02T04:00:00Z"
},
"course_number": "010",
"crn": "10188",
"crosslist": null,
"end_date": "2020-03-13T04:00:00Z",
"enroll_limit": 12,
"id": "AAAS.010.01-202001-U-10188",
"instructors": [
{
"is_primary": true,
"netid": "f002nkd"
}
],
"is_active": false,
"is_credit_nocredit": false,
"is_gradeable": true,
"is_in_session": false,
"learning_objectives": null,
"lms_section": {
"id": "AAAS.010.01-WI20",
"name": "Intro African Amer Studies (WI20)",
"subaccount_id": "A+S.C.ACAD.AAAS.AAAS"
},
"maximum_credits": 1,
"name": "Intro African Amer Studies",
"priorities": [
{
"is_overlaps": true,
"item_number": 6,
"major_id": "AAAS",
"school_year": "Junior",
"set_number": 14656,
"type": "Modifieds"
},
{
"is_overlaps": true,
"item_number": 5,
"major_id": "AAAS",
"school_year": "Junior",
"set_number": 14656,
"type": "Minors"
},
{
"is_overlaps": true,
"item_number": 4,
"major_id": "AAAS",
"school_year": "Junior",
"set_number": 14656,
"type": "Majors"
},
{
"is_overlaps": true,
"item_number": 3,
"major_id": "AAAS",
"school_year": "Senior",
"set_number": 14656,
"type": "Modifieds"
},
{
"is_overlaps": true,
"item_number": 2,
"major_id": "AAAS",
"school_year": "Senior",
"set_number": 14656,
"type": "Minors"
},
{
"is_overlaps": true,
"item_number": 1,
"major_id": "AAAS",
"school_year": "Senior",
"set_number": 14656,
"type": "Majors"
}
],
"required_materials": null,
"schedule": {
"sessions": [
{
"class_days": [
{
"id": "M"
},
{
"id": "W"
},
{
"id": "F"
}
],
"end_date": "2020-03-13T04:00:00Z",
"is_x_session": false,
"local_begin_time": "12:50:00",
"local_end_time": "13:55:00",
"location": {
"building": {
"code": "THORTN",
"name": "Thornton Hall"
},
"room": "104"
},
"start_date": "2020-01-06T05:00:00Z"
},
{
"class_days": [
{
"id": "T"
}
],
"end_date": "2020-03-13T04:00:00Z",
"is_x_session": true,
"local_begin_time": "13:20:00",
"local_end_time": "14:10:00",
"location": {
"building": {
"code": "THORTN",
"name": "Thornton Hall"
},
"room": "104"
},
"start_date": "2020-01-06T05:00:00Z"
}
],
"type_id": "12"
},
"section_attributes": [],
"section_number": "01",
"sis_section": {
"id": "AAAS.010.01-WI20",
"name": "Intro African Amer Studies",
"short_name": "Winter 2020 AAAS 010 01"
},
"start_date": "2020-01-06T05:00:00Z",
"status_id": "A",
"subject_id": "AAAS",
"term": {
"id": "202001-U",
"lms_term_id": "WI20",
"sis_ptrm_code": "U",
"sis_term_code": "202001"
},
"type_id": "L"
}
Sample Return: multi-course (i.e. crosslisted) section
- sis_section.id is concatentation of crosslisted lms_section.ids, formatted as "x-{lms_ids}-x"
- sis_section.name is concatenation of crosslisted lms_section.names
- crosslist contains crosslist.id and crosslisted section ids
{
"cache_date": "2020-06-18T14:54:05Z",
"course_id": "AAAS.014-201406",
"course_assessment": {
"is_active": null,
"is_enabled": false,
"start_date": "2020-02-26T05:00:00Z",
"end_date": "2020-04-02T04:00:00Z"
},
"course_number": "014",
"crn": "10745",
"crosslist": {
"id": "D6-202001",
"sections": [
{
"id": "AAAS.014.01-202001-U-10745"
},
{
"id": "HIST.05.01.01-202001-U-10743"
}
]
},
"end_date": "2020-03-13T04:00:00Z",
"enroll_limit": 999,
"id": "AAAS.014.01-202001-U-10745",
"instructors": [
{
"is_primary": true,
"netid": "d28853h"
}
],
"is_active": false,
"is_credit_nocredit": false,
"is_gradeable": true,
"is_in_session": false,
"learning_objectives": null,
"lms_section": {
"id": "AAAS.014.01-WI20",
"name": "PreColonial African History (WI20)",
"subaccount_id": "A+S.C.ACAD.AAAS.AAAS"
},
"maximum_credits": 1,
"name": "PreColonial African History",
"priorities": [],
"required_materials": null,
"schedule": {
"sessions": [
{
"class_days": [
{
"id": "W"
}
],
"end_date": "2020-03-13T04:00:00Z",
"is_x_session": false,
"local_begin_time": "16:35:00",
"local_end_time": "17:25:00",
"location": {
"building": {
"code": "CARSON",
"name": "Carson"
},
"room": "060"
},
"start_date": "2020-01-06T05:00:00Z"
},
{
"class_days": [
{
"id": "T"
},
{
"id": "R"
}
],
"end_date": "2020-03-13T04:00:00Z",
"is_x_session": false,
"local_begin_time": "14:25:00",
"local_end_time": "16:15:00",
"location": {
"building": {
"code": "CARSON",
"name": "Carson"
},
"room": "060"
},
"start_date": "2020-01-06T05:00:00Z"
}
],
"type_id": "2A"
},
"section_attributes": [],
"section_number": "01",
"sis_section": {
"id": "x-AAAS.014.01-HIST.05.01.01-WI20-x",
"name": "PreColonial African History PreColonial African History",
"short_name": "Winter 2020 AAAS 014 01"
},
"start_date": "2020-01-06T05:00:00Z",
"status_id": "A",
"subject_id": "AAAS",
"term": {
"id": "202001-U",
"lms_term_id": "WI20",
"sis_ptrm_code": "U",
"sis_term_code": "202001"
},
"type_id": "L"
}