Dartmouth API Developer Portal

Advancement Donors API

The Advancement Donors API provides Dartmouth Advancement donor information either as a collection of objects related to a donor's netid, or as a single giving summary record as specified by the resource's unique id.

This is a restricted service and is strictly limited to external system integrations. Application to use this service must be approved by the General Accounting office. Usage of this API is monitored and audited by the General Accounting office on a daily basis.

Notes on usage

The primary use case of this API is to retrieve a collection of donor objects for an entity identified by a netid. A donor object can be of type "Public" or "Anonymous" and a given netid can have neither, either or both.

A second, less likely, use case is to retrieve a single donor object identified by a unique ID.

This information is regarded as highly sensitive. All requests to this API require the scope shown below.

Required Scope

urn:dartmouth:advancement.donors:read.sensitive

Sample Request (retrieve for a given netid)

GET /api/advancement/donors?netid=d1234xx

Query Parameters

Body

none

Returns

Sample returned data

// this information is too sensitive for public display; contact xxx@dartmouth.edu for more information

Sample Request (retrieve for a given id)

GET /api/advancement/donors/{id}

URI Parameters

Body

none

Returns

Sample returned data

// this information is too sensitive for public display; contact xxx@dartmouth.edu for more information