Dartmouth API Developer Portal

Academic Enrollment Attendances API

Returns information about attendance including student, class date, course section, course, and term. A history of attendances is maintained via term.

The attendance data is considered sensitive because for wellness courses, attendance is equivalent to the grade for the course, and also attendance links a student to a specific place at a specific time (location tracking).

Rating

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

Required Scopes

Scope	Description
api:academic:enrollments:read.sensitive	This scope is required in order to read attendances. Granting of this scope is via the Undergraduate Registrars Office
urn:dartmouth:people:private	This optional scope is required in order to get enrollments for FERPA-protected students. Granting of this scope is via the Undergraduate Registrars Office

Request

GET /api/academic/enrollment/attendances/{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 attendance records 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.

Historical information is available for attendance through queries on term (e.g term.sis_term_code=<202001). To get current attendances only, query is_active=true.

Business Logic

The {id} attribute matches the Mongo ID for this item.

Data comes from the view / table SORSATR in Banner. This links to the SSRMEET table to define the course section. The data is collected into the DART_IPAAS view sis_enrollment_attendances_v.

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/enrollment/attendances/{id}

Sample Returns

api:academic:enrollments:read.sensitive scope

{
    "cache_date": "2020-06-15T04:43:15Z",
    "id": "d98cd545-3fb5-4cbb-bb18-85a65e7ae293",
    "netid": "f002nkd",
    "is_active": false,
    "subject_id": "AAAS",
    "course_number": "010",
    "sis_term_code": "202001",
    "meeting_date": "2020-02-15",
    "expected_hours": 65,
    "actual_hours": 60,
    "absent_hours": 5,
    "comment": "Comment text goes here",
    "has_attended": true,
    "section": {
        "id": "AAAS.010.01-202001-U-10188",
        "crn": "212485",
        "lms_section_id": "AAAS.010.01-WI20",
        "sis_section_id": "AAAS.010.01-WI20"
    },
    "term": {
        "id": "202001-U",
        "lms_term_id": "WI20",
        "sis_ptrm_code": "U",
        "sis_term_code": "202001"
    }
}