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/pools/{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 |
| pool_id |
string |
34340 |
the position id as assigned in interfolio |
| pool_name |
string |
Search for position X |
the name of the position search in interfolio |
| attribute_pools |
array |
|
array of EEO attributes, and the data aggregating the results for this position |
Sample Request
https://api.dartmouth.edu/api/faculty_search/pools/{id}
Sample Return
{
"pool_id": "34340",
"pool_name": "Faculty Search in Marketing",
"attribute_pools": [
{
"attribute_type": "disability_status",
"ira_deep_link": "",
"aggregate_data": [
{
"data_source": "Candidate Pool",
"population_counts": [
{
"subpopulation": "Disability No Response",
"count": 9
},
{
"subpopulation": "Does Not Have a Disability",
"count": 137
},
{
"subpopulation": "Has a Disability",
"count": 3
}
]
},
{
"data_source": "Intf Historical Pool",
"population_counts": [
{
"subpopulation": "Disability No Response",
"count": 17
},
{
"subpopulation": "Does Not Have a Disability",
"count": 295
},
{
"subpopulation": "Has a Disability",
"count": 7
}
]
},
{
"data_source": "Long List",
"population_counts": [
{
"subpopulation": "Does Not Have a Disability",
"count": 9
}
]
},
{
"data_source": "NSF Availability Pool",
"population_counts": [
{
"subpopulation": "Disability No Response",
"count": 2774
},
{
"subpopulation": "Has a Disability",
"count": 260
}
]
},
{
"data_source": "Short List",
"population_counts": [
{
"subpopulation": "Does Not Have a Disability",
"count": 9
}
]
}
]
}
],
"cache_date": "2021-10-21T01:00:32Z"
}