Dartmouth API Developer Portal

People-Names API

Returns information about names of people: past and present, legal and chosen. It returns one record for each unique [netid + first_name + middle_name + last_name + name_type (e.g. Legal Name, Chosen Name, null)]. Most netids will be associated with multiple name records.

Rating

Attribute	Value
Highly Available	Yes
Cache Refresh Interval	30 minutes
Filtering	Yes

Required Scopes

Scope	Description
urn:dartmouth:people:read.highlysensitive	This scope is required to access people names. Granting of this scope is approved by the Chief Technology Officer of ITC
urn:dartmouth:people:private	This optional scope is required in order to view names for FERPA protected identities. Granting of this scope is via the Undergraduate Registrars Office

Request

GET /api/people_names

Required Headers

Authorization: Bearer {jwt}

Parameters

Parameter Name	Type	Description	Valid values	Required

(standard filter parameters)

Notes on usage

Names are returned as a collection; may return an empty collection if filter parameters don't match any names.

Returns

Status Code	Description
200	Successful request

Sample Request

https://api.dartmouth.edu/api/people_names?netid=f000xxx

Sample Return

[
    {
        "last_name": "Doe",
        "netid": "f000xxx",
        "name_type": null,
        "cache_date": "2019-05-31T14:32:44Z",
        "middle_name": "J",
        "source": {
            "id": "2489487JohnDoeDI",
            "name": "sis"
        },
        "name": "John J. Doe",
        "is_active": false,
        "first_name": "Ethan",
        "update_date": "2013-12-13T00:06:17Z",
        "id": "5cf13b0c129f9a463c507dcc"
    },
    {
        "last_name": "Doe",
        "netid": "f000xxx",
        "name_type": "Legal Name",
        "cache_date": "2019-05-31T14:32:44Z",
        "middle_name": "J",
        "source": {
            "id": "2489487JohnDoeD",
            "name": "sis"
        },
        "name": "John J. Doe",
        "is_active": true,
        "first_name": "John",
        "update_date": "2013-12-13T00:06:17Z",
        "id": "5cf13b12129f9a463c50af1f"
    }
]