Dartmouth API Developer Portal

Nextgen API

Returns information about student employees at Dartmouth College specifically for Nextgen.

Rating

Required Scopes

Request

GET /api/nextgen/student_bio/{netid}

Required Headers

Authorization: Bearer {jwt}

Notes on usage

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

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

Returns

Top Level Payload Attribute Descriptions

Awards Array Attribute Descriptions

Notes on using Awards

The awards collection contains all awards for the student. The is_current_term attribute will indicate awards in the current term and updates with the academic calendar.

More detail gives them the most flexibilty in calculating correct amounts or responding to new requirements.

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

Dartmouth allows cumulative award amounts up to the current term in the current aid year to be utilized for WS. The special field award_amount_available_current_term is calculated for Nextgen's use to indicate how much award is available to the student in the current term. It is the cumulative award amount through the current term minus paid amounts through the prior term.

Neither Leave Term or MDWORK should be part of FWS.

Fund Codes currently in play for Work Study Eligibility

Citizenship Hiring Validation Field for Hiring Student Employees

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/student_bio/d59951y

Sample Return

{
  "name": "Roy K Rogers",
  "netid": "f009xxx",
  "first_name": "Roy",
  "middle_name": "K",
  "last_name": "Rogers",
  "legal_first_name": "Roy",
  "legal_last_name": "Rogers",
  "email_address": "Roy.K.Rogers.22@Dartmouth.edu",
  "is_fws_eligible_program": false,
  "is_international": true,
  "is_visa_f1_type": true,
  "is_visa_j1_type": false,
  "visa_start_date": null,
  "visa_end_date": null,
  "i_9_status": "No",
  "i_9_end_date": null,
  "awards": [
    {
      "aid_year": "2021",
      "is_current_term": false,
      "is_fws_eligible_award": false,
      "term_code_token": "202009",
      "term_desc": "Fall Term 2020",
      "award_type_code": "U10010",
      "award_type_desc": "Federal Work-Study Elig.",
      "accepted_amount": 838.0,
      "award_amount_available_current_term": 833.00
    },
    {
      "aid_year": "2122",
      "is_current_term": true,
      "is_fws_eligible_award": false,
      "term_code_token": "202203",
      "term_desc": "Spring Term 2022",
      "award_type_code": "UDSSL",
      "award_type_desc": "Federal Sub. Direct Loan",
      "accepted_amount": 0.0,
      "award_amount_available_current_term": 957.00

    }
  ],
  "is_active_student": true,
  "is_enrolled": true,
  "hiring_status": 2,
  "cache_date": "2022-06-07T19:09:58Z"
}