Dartmouth API Developer Portal

Academic Petitions API

Returns information about student petitions

Rating

Attribute Value
Highly Available Yes
Cache Refresh Interval 1 hour
Filtering Yes

Required Scopes

Scope Description
api:academic:petitions:read This scope is required to access petitions for students. Granting of this scope is via the Undergraduate Registrars Office

Request

GET api/academic/petitions/{id}
GET api/students/{netid}/petitions

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 D-Plan petitions 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 view STUDENT_PETITIONS_V in BAN_DATA_MGR. This in turn reads from the table SATURN.SHREVNT. It includes lookup data from STVEVEN (for event names) and STVORIG (for origin names)

Events count as a Petition if they have an event code starting with Q or R.

See also Banner Form SHATCMT

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/petitions/?netid=f0027k4

Sample Return

[
    {
        "id": "2907841-Q25-24W=L-APPV",
        "netid": "f0027k4",
        "petition_code": "Q25",
        "petition_name": "Reduce Sr Yr Residence Req",
        "origin_code": "UREG",
        "origin_name": "UG - Registrar",
        "school": "UG",
        "decision": "APPV",
        "grade_term": "24W=L",
        "effective_date": "2021-03-02T05:00:00Z",
        "cache_date": "2022-05-07T23:49:22Z"
    },
    {
        "id": "2907841-Q24--FIVEYEAR",
        "netid": "f0027k4",
        "petition_code": "Q24",
        "petition_name": "Five+ Year Enrollment Pattern",
        "origin_code": "UREG",
        "origin_name": "UG - Registrar",
        "school": "UG",
        "decision": "FIVE YEAR",
        "grade_term": null,
        "effective_date": "2021-03-02T05:00:00Z",
        "cache_date": "2022-05-07T23:49:22Z"
    }
]