Dartmouth API Developer Portal
Academic plans API
Returns information from declare about declared major and minor plans.
Rating
| Attribute | Value |
|---|---|
| Highly Available | Yes |
| Cache Refresh Interval | 1 hour |
| Filtering | Yes |
Required Scopes
| Scope | Description |
|---|---|
| urn:dartmouth:students:read.sensitive | This scope is required to access plans for students. Granting of this scope is via the Undergraduate Registrars Office |
Request
GET api/academic/plans/{id}
GET api/students/{netid}/plans
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 major and minor plans 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
Data comes from the data in the plans table in the wag_declare schema in Copper.
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/plans/?netid=f0027k4
Sample Return
[
{
"id": "20109",
"type": "Major",
"state": "declared",
"name": "GOVT-GOVT:ECON",
"parent_id": 20111,
"updated": "N",
"dropped": "N",
"department": "GOVT",
"student_netid": "f0027k4",
"faculty_netid": "f003736",
"internal_comment": null,
"student_rationale": "<p>The modified major will best allow me to explore international relations</p>",
"denial_reason": null,
"prerequisites": "<p>MATH 3: Pre-College </p>\r\n<p>MATH 10: Pre-College</p>\r\n<p>ECON 1: 20W </p>",
"culminating_experience": "<p>GOVT 92: Economics Statecraft and International Relations </p>\r\n<p>GOVT 86.27: Ethics of the Family</p>",
"approval_comment": null,
"student_comments": null,
"db_name": "iron",
"updated_at": "2021-01-29T23:07:02Z"
},
{
"id": "20110",
"type": "Major",
"state": "declared",
"name": "ECON-GOVT:ECON",
"parent_id": 20111,
"updated": "N",
"dropped": "N",
"department": "ECON",
"student_netid": "f0027k4",
"faculty_netid": "d22062k",
"internal_comment": null,
"student_rationale": "<p>The modified major will best allow me to explore international relations</p>",
"denial_reason": null,
"prerequisites": "<p>MATH 3: Pre-College </p>\r\n<p>MATH 10: Pre-College</p>\r\n<p>ECON 1: 20W </p>",
"culminating_experience": "<p>GOVT 92: Economics Statecraft and International Relations </p>\r\n<p>GOVT 86.27: Ethics of the Family</p>",
"approval_comment": null,
"student_comments": null,
"db_name": "iron",
"updated_at": "2021-01-29T23:07:02Z"
},
{
"id": "20111",
"type": "Modified",
"state": "declared",
"name": "GOVT:ECON",
"parent_id": null,
"updated": "N",
"dropped": "N",
"department": null,
"student_netid": "f0027k4",
"faculty_netid": null,
"internal_comment": null,
"student_rationale": "<p>The modified major will best allow me to explore international relations</p>",
"denial_reason": null,
"prerequisites": "<p>MATH 3: Pre-College </p>\r\n<p>MATH 10: Pre-College</p>\r\n<p>ECON 1: 20W </p>",
"culminating_experience": "<p>GOVT 92: Economics Statecraft and International Relations </p>\r\n<p>GOVT 86.27: Ethics of the Family</p>",
"approval_comment": null,
"student_comments": null,
"db_name": "iron",
"updated_at": "2021-01-29T23:07:02Z"
},
{
"id": "22191",
"type": "Major",
"state": "declared",
"name": "ASCL-MAJOR",
"parent_id": null,
"updated": "N",
"dropped": "N",
"department": "ASCL",
"student_netid": "f0027k4",
"faculty_netid": "d34486s",
"internal_comment": null,
"student_rationale": null,
"denial_reason": null,
"prerequisites": "<p>All prerequisites have been satisfied</p>",
"culminating_experience": "",
"approval_comment": null,
"student_comments": null,
"db_name": "iron",
"updated_at": "2021-04-23T16:12:20Z"
}
]