Skip to content
This repository has been archived by the owner on Mar 11, 2019. It is now read-only.

Event Endpoint API Reference

zachlefevre edited this page Mar 3, 2017 · 8 revisions

Event

Method Endpoint Verb Description
createEvent /event/:eventuid POST Creates a new event.
getEventByID /event/:eventuid GET Gets a specific event.
deleteEvent /event/:eventuid DELETE Deletes an event.
getAllEvents /event/ GET Gets all events

More Info

createEvent

Creates a new event.

  • Endpoint: /event/
  • Verb: POST
  • Request:
{
  "category" : ENUM/STRING,
  "contact" : STRING,
  "creator" : USER-UID,
  "datetime" : DATE-TIME STRING,
  "description" : STRING,
  "location" : STRING,
  "title" : STRING
}
  • Response: Status 201
{
  "eventuid": EVENT-UID
}

getEventByID

Database Schema Reference

Gets a specific event

  • Endpoint:/event/:eventuid
  • Verb: GET
  • Request:
{
  "eventuid" : EVENT-UID
}
  • Response: Status 200
{
  "event": EVENT
}

deleteEvent

Deletes an event.

  • Endpoint: /event/:eventuid
  • Verb: DELETE
  • Request:
{
  "eventuid": EVENT-UID
}
  • Response: status 200

getAllEvents

Gets all events.

  • Endpoint: /event/
  • Verb: GET
  • Request: NULL
  • Response: Status 200
{
  "eventuid1": EVENT,
  "eventuid2": EVENT,
  ...
}