Skip to content

Latest commit

 

History

History
204 lines (190 loc) · 4.39 KB

README.md

File metadata and controls

204 lines (190 loc) · 4.39 KB
Raw

Introduction

This is a JSON API for the DND, allowing you to quickly and easily integrate the Dartmouth network into your application.

Usage

It's easy to perform a full-text search on the database:

$ curl dnd.hackdartmouth.org/zd
[
  {
    "uid": "d34023k",
    "name": "Zachary J. Denton",
    "surname": "Denton",
    "firstname": "Zachary",
    "nickname": "zach zd zjd",
    "email": "[email protected]",
    "website": "http://zacharydenton.com",
    "phone": null,
    "hinman": "0973",
    "department": "'15",
    "affiliations": [
      "Student",
      "Alum"
    ],
    "_id": "518448be91c9b9de67004729"
  }
]

You can also query specific fields:

$ curl dnd.hackdartmouth.org?department=philosophy
[
  {
    "uid": "d15580d",
    "name": "Adina L. Roskies",
    "surname": "Roskies",
    "firstname": "Adina",
    "nickname": "adina",
    "email": "[email protected]",
    "website": "www.dartmouth.edu/~adinar/",
    "phone": "603-646-2112",
    "hinman": "HB 6035",
    "department": "Philosophy",
    "affiliations": [
      "Faculty"
    ],
    "_id": "518448bd91c9b9de67000005"
  },
  {
    "uid": "d40053s",
    "name": "Alan Kim",
    "surname": "Kim",
    "firstname": "Alan",
    "nickname": null,
    "email": "[email protected]",
    "website": "http://www.dartmouth.edu/~phil/faculty/kim.html",
    "phone": "63807",
    "hinman": "HB 6035",
    "department": "Philosophy",
    "affiliations": [
      "Faculty"
    ],
    "_id": "518448bd91c9b9de670001be"
  },
  {
    "uid": "d41137j",
    "name": "Alice S. Walden",
    "surname": "Walden",
    "firstname": "Alice",
    "nickname": null,
    "email": "[email protected]",
    "website": null,
    "phone": null,
    "hinman": "HB 6035",
    "department": "Philosophy",
    "affiliations": [
      "Faculty"
    ],
    "_id": "518448bd91c9b9de67000251"
  },
  [...],
  {
    "uid": "f000cw0",
    "name": "Tillmann Vierkant",
    "surname": "Vierkant",
    "firstname": "Tillmann",
    "nickname": null,
    "email": "[email protected]",
    "website": null,
    "phone": null,
    "hinman": "HB 6035",
    "department": "Philosophy",
    "affiliations": [
      "Faculty",
      "Alum"
    ],
    "_id": "518448be91c9b9de670041ec"
  }
]

You can also POST an arbitrary MongoDB query as JSON:

$ curl -X POST -H "Content-Type: application/json" --data '{"uid":{"$regex":"0000"}}' dnd.hackdartmouth.org
[
  {
    "uid": "d30000t",
    "name": "Bo Wei Deng",
    "surname": "Deng",
    "firstname": "Bo Wei",
    "nickname": "bowei deng  boooo",
    "email": "[email protected]",
    "website": null,
    "phone": null,
    "hinman": null,
    "department": "'13",
    "affiliations": [
      "Student",
      "Alum"
    ],
    "_id": "51844ce7732f530700000967"
  },
  {
    "uid": "dz00000",
    "name": "Potluck",
    "surname": "Potluck",
    "firstname": "EMPTY",
    "nickname": null,
    "email": "[email protected]",
    "website": null,
    "phone": null,
    "hinman": "HB 6028",
    "department": "Software Devel",
    "affiliations": [
      "Member"
    ],
    "_id": "51844ce7732f5307000014b9"
  }
]

You can use any Perl-compatible regular expression:

$ curl -X POST -H "Content-Type: application/json" --data '{"phone":{"$regex":"^410"}}' dnd.hackdartmouth.org
[
  {
    "uid": "d36935m",
    "name": "Charlotte A. Snow",
    "surname": "Snow",
    "firstname": "Charlotte",
    "nickname": null,
    "email": "[email protected]",
    "website": null,
    "phone": "4109409167",
    "hinman": "3954",
    "department": "'15",
    "affiliations": [
      "Student",
      "Alum"
    ],
    "_id": "51844ce7732f530700000bdc"
  },
  [...],
  {
    "uid": "d30907f",
    "name": "Paul A. Wagdalt",
    "surname": "Wagdalt",
    "firstname": "Paul",
    "nickname": "pol  wagdalt  waggy   private snoopy wagz wags",
    "email": "[email protected]",
    "website": null,
    "phone": "410-585-4272",
    "hinman": "4331",
    "department": "'13",
    "affiliations": [
      "Student",
      "Alum"
    ],
    "_id": "51844ce7732f5307000034d1"
  }
]

Installation

If you want to run this on your local machine, you'll need Node.js and MongoDB.

$ sudo npm install -g
$ coffee import.coffee
$ node server
$ curl localhost:4000