Dartmouth API Developer Portal

Academic Holds API

Returns information about academic holds.

Rating

Attribute	Value
Highly Available	Yes
Cache Refresh Interval	24 hours
Filtering	Yes

Required Scopes

Scope	Description
urn:dartmouth:students:read.sensitive	This scope is required in order to view student information. Granting of this scope is via the Undergraduate Registrars Office

Request

GET /api/academic/holds/{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 holds 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.

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/holds/5c61c079d60ee25e1b9dc1cd

Sample Return

{
    "amount_owed": 290.37,
    "cache_date": "2020-06-26T12:47:07Z",
    "created_by": "OPS$SMALL_DL",
    "end_date": "2099-12-31T04:00:00Z",
    "guid": "aa6c0db6-1f1f-483c-a810-f135c48f9137",
    "hold_type_id": "BT",
    "id": "5c61c079d60ee25e1b9dc1cd",
    "reason": "BD-MAY 2001",
    "start_date": "2003-07-14T04:00:00Z",
    "student_netid": "d85578r"
}