Skip to content
Paul Dilyard edited this page Mar 29, 2015 · 6 revisions

*Add a new event

POST /events
Auth -> admin, staff
{
  "name": String,
  "start": Date,
  "end": Date,
  "group": String,
  "notify": Boolean
}

HTTP/1.1 200 OK
{
  "_id": String,
  "name": String,
  "start": Date,
  "end": Date,
  "group": String,
  "notify": Boolean
}

Get an event by ID

GET /events/:id

HTTP/1.1 200 OK
{
  "_id": String,
  "name": String,
  "start": Date,
  "end": Date,
  "group": String,
  "notify": Boolean
}

Get a list of events

GET /events

HTTP/1.1 200 OK
{
  "events": [{
    "_id": String,
    "name": String,
    "start": Date,
    "end": Date,
    "group": String,
    "notify": Boolean
  }]
}

*Update an event

PUT /events/:id
Auth -> admin, staff
{
  "name": String,
  "start": Date,
  "end": Date,
  "group": String,
  "notify": Boolean
}

HTTP/1.1 200 OK
{
    "_id": String,
    "name": String,
    "start": Date,
    "end": Date,
    "group": String,
    "notify": Boolean
}

*Partially update an event

PATCH /events/:id
Auth -> admin, staff
{ // all fields optional
  "name": String,
  "start": Date,
  "end": Date,
  "group": String,
  "notify": Boolean
}

HTTP/1.1 200 OK
{
  "_id": String,
  "name": String,
  "start": Date,
  "end": Date,
  "group": String,
  "notify": Boolean
}

*Delete an event

DELETE /events/:id
Auth -> admin, staff

HTTP/1.1 200 OK
{
  "_id": String
}

Clone this wiki locally