Dartmouth API Developer Portal

Academic Hold Types API

Returns information about hold types.

Rating

Attribute	Value
Highly Available	Yes
Cache Refresh Interval	4 hours
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/hold_types/{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 hold types are 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 {id} and {short_description} attributes are sourced from the Banner stvhldd table - stvhldd_code and stvhldd_desc.

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/hold_types/LT

Sample Return

{
    "cache_date": "2020-06-26T06:05:09Z",
    "category": "academic",
    "guid": "51b42139-2699-4533-b89f-4ebe1e22fa10",
    "id": "LT",
    "long_description": "Students who are missing loan exit interviews for institutional load or are delinquent in paying back loans are unable to order a transcript.",
    "resolution": "Complete an institutional loan exit interview or make a loan payment via: <a href=\"https://heartland.ecsi.net/\" target=\"_blank\">heartland.ecsi.net. </a>",
    "resolution_url": "http://www.dartmouth.edu/~control/faq/student-loans.html",
    "short_description": "Loan Tran Hold"
}