API Reference

Our API can be accessed from our domain at these endpoints.

Events

Our Events are JSON Objects that contain basic information about any upcoming trips. The fields of this object are listed below, along with their types and hyperparameters:

Departure Object:

Destination Object:

Event Routing

Here is a summary of all of our routes for events. Note that all of these events are exclusive to requests with a bearer token.

Requests & Responses:

GET /api/events

(All optional parameters for search)
req =  { title, start, end, departure, destination, notes }

GET /api/events/joined

GET /api/events/:id

req.params = { id }

POST /api/events

req.body = { title, startDate, departure, owner, notes, capacity }

DELETE /api/events/:id

req.params = { id }

PUT /api/events/:id

req.params = { id }

Users

Our Users are JSON Objects that contain information extracted from SSO and the events that the users own/joined. None of these routes (except PUT) can actually be accessed by users, as they are only for administrative purposes. The fields of this object are listed below, along with their types and hyperparameters:

User Routing

GET /api/users/all

GET /api/users

POST /api/users

req.body = { username, jhed, email }

DELETE /api/users/:id

PUT /api/users/

SSO

Our SSO utilizes 4 endpoints, three for authentication with an external server (JHU) and one for token verification.

SSO Routing

Here is a summary of all our routes for SSO and tokenization.

GET /jhu/metadata

GET /jhu/login

RESPONSE CODES DETERMINED BY JHU IT.

GET /jhu/login/callback

RESPONSE CODES DETERMINED BY JHU IT.

GET /verify

req.body = { token }