Dartmouth API Developer Portal

Value Lists - Petition Types API

Returns information about known event type codes that relate to Petitions.

Rating

Required Scopes

Request

GET /api/petition_types/{id}

Required Headers

Authorization: Bearer {jwt}

Parameters

(standard filter parameters as documented in the introduction section of this portal)

Notes on usage

Value lists provide consistent information about objects referenced by multiple applications (e.g. states, countries, genders, student_types). All value list items include an "id" attribute and a "name" attribute. The "id" value is often included in other objects (e.g. the /students API includes a student_type_id attribute); this value can be used as the {id} parameter of the URL (e.g. /student_types/{id}) to get details of the value list item.

When {id} 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.

Business Logic

The code (id) and desc (name) values from the Banner lookup table STVEVEN (Event Type Code Validation) are returned by this endpoint. Only types beginning with Q and R are returned, since these are the petition types.

Returns

Sample Request

https://api.dartmouth.edu/api/petition_types

Sample Return

[
    {
        "id": "Q14",
        "name": "Additional 2-Course Load",
        "is_active": true,
        "cache_date": "2019-07-19T16:10:08Z"
    },
    {
        "id": "Q20",
        "name": "Postpone Summer Term",
        "is_active": true,
        "cache_date": "2019-07-19T16:10:08Z"
    }
]

Sample Request

https://api.dartmouth.edu/api/petition_types/Q20

Sample Return

{
    "id": "Q20",
    "name": "Postpone Summer Term",
    "is_active": true,
    "cache_date": "2019-07-19T16:10:08Z"
}