Dartmouth API Developer Portal

Faculty Search API

Returns information about faculty searches used in the FACES application.

Rating

Attribute Value
Highly Available Yes
Cache Refresh Interval Once Daily
Filtering Yes

Required Scopes

This API was specifically designed to support the Faculty Search FACES application and is not of general purpose. Access to this API is highly restricted.

Scope Description
"api:faculty_search:read" This scope allows consumers to query and get faculty search information

Request

GET /api/faculty_search/positions/{id}

Required Headers

Authorization: Bearer {jwt}

Notes on usage

The Faculty Search API is specifically designed to support the FACES application and does not have general applicability.

Returns

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

Top Level Payload Attribute Descriptions

Field Type Sample Data Description
position_id string 34340 the position id as assigned in interfolio
position_name string Search for position X the name of the position search in interfolio
applications array array of all applications to this position

Sample Request

https://api.dartmouth.edu/api/faculty_search/positions/{id}

Sample Return

{
    "position_id": "34340",
    "position_name": "Faculty Search in Xyz",
    "applications": [
        {
            "application_id": 1792978,
            "position_id": "34340",
            "first_name": "John",
            "last_name": "Doe",
            "email": "jdoe@somplace.edu",
            "status": "Short List",
            "disposition": null
        },
        {
            "application_id": 1793314,
            "position_id": "34340",
            "first_name": "Jane",
            "last_name": "Doe",
            "email": "jadoe@someplace.edu",
            "status": "*Hired",
            "disposition": "Hired/Accepted"
        }
    ],
    "cache_date": "2021-10-08T12:00:11Z"
}