ServerAPI.md

Events

GET /api/events

• returns array of all events

GET /api/events/filter/:filter/:userId

• returns array of all events for a user filtered on these options:
  • 'unhidden'
  • 'hidden'
  • 'created'
  • 'joined'
  • 'pending'
• if filter is invalid, will default to get all events

GET /api/events/:id

• given param event id, returns array with single event

GET /api/events/:id/guests

• given param event id, returns array of user objects who are guests

POST /api/events/:id/guests

• given param event id, creates new guest and returns that guest user object
• request body should be guest object with properties
  • user_id (int)
  • status (string)
    • 'pending'
    • 'accepted'
    • 'declined'

PUT /api/events/:eventId/guests/:userId

• given param event id and user id, updates guest status
• returns guest object with properties user_id, event_id, and status
• request body should be object with property status

DELETE /api/events/:eventId/guests/:userId

• given param event id and user id, deletes guest if exists
• returns user object of guest deleted

POST /api/events

• creates new event and returns that event object
• request body should be event object with properties
  • title (string)
  • description (string)
  • created_by (int): id in user table
  • location (string)
  • time (dateTime optional)
  • duration (int optional): seconds
  • max_guests (int optional)
  • privacy (bool)
  • group_visibility (int): id in group table

PUT /api/events/:id

• request body should be event object with properties above to update
• given an event id, updates event and returns that event object

DELETE /api/events/:id

• given an event id, deletes event if exists and returns that deleted event object

GET /api/events/hide/:user_id

• given a user_id, returns array with hidden event ids

POST /api/events/:id/hide

• request body should have property user_id
• given param event id, creates a record in hidden_events for a user
• returns object with user_id and event_id

DELETE /api/events/:id/hide/:user_id

• given param event id and user id, deletes the record in hidden_events for a user
• returns object with status 'deleted' if successful

Users

GET /api/users/:id

• given a user id, returns array with single user

POST /api/users

• request body should be user object with properties
  • name (string)
  • email (string)
  • image (string)
  • facebook_id (string)
• creates new user and returns that user object