Dartmouth API Developer Portal

Organizations

The organizations API returns informations about different types of organizational resources.

Each organization sub type is a subresource of the high level organizations resource.

Currently the organization sub-types are:

hrs

Organizations Human Resources API

Notes on usage

Returns information about organizations within the Dartmouth HRS system. The API delivers a flattened hierarchy structure showing parentage within a row. A future enhancement (upon requirement request) will be to return a hierarchical rather than flattened structure.

Organization Hierarachy

Organization Hierarachy is arranged top to bottom as follows:

Division School or Sub-Division Academic Division Department Unit Sub Unit

The org_type attribute of each organization is an indicator of where the organization falls in this hierarchy. The hierarchy may not be a uniform hierarchy. For example Units can be parented directly by Division with no intervening Sub Division or Department. For these types of orgs the upper level values fill down to the lower intervening levels. If you intend to use HRS org hierarchies, you should consult with HRS data stewards on correct interpretation of the hierarchy information.

In all cases the name and long_name attributes of each organization is guaranteed to always contain the lowest level organization name so that you can always look in this one place for an organizations name regardless of where it falls in the hierarchy.

Required Scopes

None: the human_resources/organizations API requires only authentication to Dartmouth's login API as documented in the introduction section of this portal.

Request

GET /human_resources/organizations/{id}

Required Headers

Authorization: Bearer {jwt}

Parameters

Searching is allowed on any of the resource attributes in the query parameters. For example:

GET /human_resources/organizations?name=security&org_type=department*

Returns

Status Code	Description
200	The URI parameter {id} passed in is a valid organization
404	The URI parameter {id} passed in is NOT a valid organization

Attributes Definitions

Attribute	Type	Description
id	string	the unique identifier for this organization
org_type	string	indicates this organizations level in the org hierarchy
name	string	the short name of the organization
long_name	string	the long name of the organization
division	string	the divisional parent of this organization
school	string	for orgs that are part of a school, this indicates which school, if this org is part of a sub_division the school is null
sub_division	string	for orgs that are part of a sub_division this indicates the sub_division, if this org is part of a school the sub_division is null
academic_division	string	the academic division parent of this organization
sub_division_or_school	string	the sub division or school of the org, fills in the non null value from sub_division or school
department	string	the department of the org
unit	string	the unit of the org
subunit	string	the subunit of the org
org_parent_id	string	the identifier for the parent of the organization
start_date	string	ISO8601 date formatted string indicating the start date when this org became active
end_date	string	ISO8601 date formatted string indicating the end date when this org became inactive

Sample Search Request

https://api.dartmouth.edu/api/human_resources/organizations?name=*security*&org_type=department*

Sample Collection Return

[
    {
        "org_type": "Department",
        "name": "Computing Security",
        "long_name": "Computing Security",
        "division": "Provosts Office",
        "school": null,
        "sub_division": "Info, Tech & Consulting",
        "academic_division": "Info, Tech & Consulting",
        "sub_division_or_school": "Info, Tech & Consulting",
        "department": "Computing Security",
        "unit": "Computing Security",
        "subunit": "Computing Security",
        "org_parent_id": "5bbe5ff0129f9a5a9614928a",
        "start_date": "2006-01-01T05:00:00Z",
        "end_date": null,
        "id": "5bbb9be6fffdae17d0262948"
    }
]

Sample Resource Request

https://api.dartmouth.edu/api/human_resources/organizations/5bbb9be6fffdae17d0262995

Sample Resource Return

{
    "org_type": "Department",
    "name": "Computer Store",
    "long_name": "Computer Store",
    "division": "Provosts Office",
    "school": null,
    "sub_division": "Info, Tech & Consulting",
    "academic_division": "Info, Tech & Consulting",
    "sub_division_or_school": "Info, Tech & Consulting",
    "department": "Computer Store",
    "unit": "Computer Store",
    "subunit": "Computer Store",
    "org_parent_id": "5bbe5ff0129f9a5a9614928a",
    "start_date": "1951-01-01T05:00:00Z",
    "end_date": null,
    "id": "5bbb9be6fffdae17d0262995"
}