Dartmouth API Developer Portal

People Disability and Disability Services API

Returns information about disability types and disability services from Banner for students. May be extended to include HR information about non-students in the future.

Rating

Attribute	Value
Highly Available	Yes
Cache Refresh Interval	6 Hours
Filtering	Yes

Required Scopes

Scope	Description
api:disability_services:write.hipaa	This scope is required in order to write disability services. Granting of this scope is approved by the Undergraduate Registrars Office
api:disability_services:read.hipaa	This scope is required in order to release disability services attributes. Granting of this scope is approved by the Undergraduate Registrars Office
urn:dartmouth:people:private	This optional scope is required in order to read and update records for FERPA protected identities. Granting of this scope is via the Undergraduate Registrars Office

Request

GET /api/disability_services

Required Headers

Authorization: Bearer {jwt}

Parameters

Parameter Name	Type	Description	Valid values	Required

(Standard filter parameters)

Returns

Status Code	Description
200	The URI parameter {netid} passed in is a valid person
404	The URI parameter {netid} passed in is NOT a valid person, or the scope is not supplied

Notes on usage

For students, the disability codes are taken from Banner. For Faculty and Staff, no disability information is currently supplied.

Business Logic

The disability_id is field SGRDISA_DISA_CODE in table SGRDISA in Banner. The disability_service_id is field SGRDSER_SSER_CODE in table SGRDSER in Banner. These are both edited via the Banner form SGADISA - Student Disability Services.

Descriptions for these codes are defined in the lookup tables STVDISA and STVSSER. See the disability types endpoint.

Sample Request

https://api.dartmouth.edu/api/disability_services?netid=f0027k4

Sample Return

[
    {
        "netid": "f0027k4",
        "cache_date": "2019-05-31T14:32:44Z",
        "data_source": "sis",
        "disability_id":"DA",
        "sis_term_code": "202001",
        "disability_services": []
    },
    {
        "netid": "f0027k4",
        "cache_date": "2019-05-31T14:32:44Z",
        "data_source": "sis",
        "disability_id":"DA",
        "sis_term_code": "202003",
        "disability_services": []
    },
    {
        "netid": "f0027k4",
        "cache_date": "2019-05-31T14:32:44Z",
        "data_source": "sis",
        "disability_id":"DB",
        "sis_term_code": "202001",
        "disability_services": [
            {
                "disability_service_id": "CTEC",
                "start": "2020-01-01",
                "end": "2020-03-30"
            },
            {
                "disability_service_id": "SUPA",
                "start": "2020-01-01",
                "end": "2020-03-30"
            }
        ]
    }
]