Dartmouth API Developer Portal

Nextgen API

Returns information about students class schedule at Dartmouth College specifically for Nextgen.

Rating

Attribute	Value
Highly Available	Yes
Cache Refresh Interval	Hourly
Filtering	Yes

Required Scopes

Scope	Description
api:nextgen:class_schedules:read	This scope is required in order to view the class_schedule of student

Request

GET /api/nextgen/class_schedules/{netid}

Required Headers

Authorization: Bearer {jwt}

Parameters

Parameter Name	Type	Description	Valid values	Required

(none)

Notes on usage

The scope associated with this resource allows the calling individual/application access to "confidential" employees when requested. The calling individual/application must adhere to Dartmouth's policies on data privacy when using this data.

The class_schedule API is designed to return information about current active students.

The class_schedule API is availble for filtering and paged result sets consistent with the syntax specified in the introduction section covering filtering and paging.

Returns

Status Code	Description
200	The URI parameter {netid} passed in is a valid student
404	The URI parameter {netid} passed in is NOT a valid employee

Top Level Payload Attribute Descriptions

Field	Type	Sample Data	Description	Required Scope
netid	string	f0027k4	dartmouth person identifier	api:nextgen:class_schedules:read
first_name	string	Velma	first name of the student	api:nextgen:class_schedules:read
last_name	string	Test	last name of the student	api:nextgen:class_schedules:read
enrollments	array		a collection of enrollments of the student	api:nextgen:class_schedules:read

Enrollments Array Attribute Descriptions

Field	Type	Sample Data	Description	Required Scope
term	string	202003	the dartmouth term code	api:nextgen:class_schedules:read
class_start_date	date string	2020-03-30T04:00:00Z	start date of a class at dartmouth	api:nextgen:class_schedules:read
class_end_date	date string	2020-06-09T04:00:00Z	end date of a class at dartmouth	api:nextgen:class_schedules:read
subject_name	string	GOVT	subject name at dartmouth	api:nextgen:class_schedules:read
course_number	string	40.15	the dartmouth course number	api:nextgen:class_schedules:read
course_title	string	Commodities,Globaliztn,Devl	the title of the of the course	api:nextgen:class_schedules:read
class_start_time	date string	2020-03-30T04:00:00Z	the start time of the class	api:nextgen:class_schedules:read
class_end_time	date string	2020-06-09T04:00:00Z	the end time of the class	api:nextgen:class_schedules:read
day_sunday	bolean	true	true if class is scheduled on sunday	api:nextgen:class_schedules:read
day_monday	boolean	false	true if class is scheduled on monday	api:nextgen:class_schedules:read
day_tuesday	boolean	false	true if class is scheduled on tuesday	api:nextgen:class_schedules:read
day_wednesday	boolean	true	true if class is scheduled on wednesday	api:nextgen:class_schedules:read
day_thursday	boolean	true	true if class is scheduled on thursday	api:nextgen:class_schedules:read
day_friday	boolean	false	true if class is scheduled on friday	api:nextgen:class_schedules:read
day_saturday	boolean	true	true if class is scheduled on saturday	api:nextgen:class_schedules:read

Notes on using Enrollments

The enrollments collection contains all enrollments for the student. The term attribute will indicate enrollments for a specific term. It does not include the enrollments for Labs and "X" Courses.

Enrollments are coded with a term_code that correlates to the quarterly_term.id attributes available in the Academic Terms API.

Getting the Academic Terms:

This query gets the current term (note: we are using the UG term calendar for all WS in Nextgen).

https://api.dartmouth.edu/api/academic/terms?school_id=UG&quarterly_term.current_term_offset=0

Sample Request

https://api.dartmouth.edu/api/nextgen/class_schedules/d59951y

Sample Return

{
  "last_name": "Rogers",
  "first_name": "Roy",
  "netid": "f0000xx",
  "enrollments": [
    {
      "term": "202003",
      "class_start_date": "2020-03-30T04:00:00Z",
      "class_end_date": "2020-06-09T04:00:00Z",
      "subject_name": "GOVT",
      "course_number": "40.15",
      "course_title": "Commodities,Globaliztn,Devl",
      "class_start_time": "11:30:00",
      "class_end_time": "2020-06-09T04:00:00Z",
      "day_sunday": false,
      "day_monday": true,
      "day_tuesday": false,
      "day_wednesday": true,
      "day_thurdsday": false,
      "day_friday": true,
      "day_saturday": false
    },
    {
      "term": "202003",
      "class_start_date": "2020-03-30T04:00:00Z",
      "class_end_date": "2020-06-09T04:00:00Z",
      "subject_name": "GOVT",
      "course_number": "40.15",
      "course_title": "Commodities,Globaliztn,Devl",
      "class_start_time": "12:15:00",
      "class_end_time": "2020-06-09T04:00:00Z",
      "day_sunday": false,
      "day_monday": false,
      "day_tuesday": true,
      "day_wednesday": false,
      "day_thurdsday": false,
      "day_friday": false,
      "day_saturday": false
    }
     ],
  "cache_date": "2022-07-10T03:40:46Z"
}