API calls for VRMS

[drubgrubby]

Dependency

• Cognito client secrets - API client #174
• Epic: Redesign event schema #88

Overview

This is a list of the API calls that are currently being used by VRMS that will need to be reproduced from PD, with the addition of a couple that I have good reason to believe we will need.

Action Items

Make these API calls available:

• Users Create Table: User #15
  GET - Get all users - /api/users/
  GET - Get one user by _id - /api/users/:user_id
  GET - Get one user by email - /api/users/:user_email
  POST - Create new user - /api/users
  PATCH - Update one user by _id - /api/users/:user_id
  DELETE - Delete one user by _id - /api/users/:user_id

• Recurring Events Create Table: recurring_event #14
  GET - Get all recurring events - /api/recurringevents
  GET - Get one recurring event by id - /api/recurringevents/:recurringevent_id
  POST - Create new recurring event - /api/recurringevents
  PATCH - Update one recurring event by id- /api/recurringevents/:recurringevent_id
  DELETE - Delete recurring event by id - /api/recurringevents/:recurringevent_id

• Events
  GET - Get all events - /api/events
  GET - Get one event by id - /api/events/:event_id
  POST - Create new event - /api/events
  PATCH - Update one user by id - /api/events/
  DELETE - Delete one event by id - /api/events/:event_id

• Checkins
  GET - Get all checkins - /api/checkins
  GET - Get all checkins by event - /api/checkins/:event_id
  GET - Get all checkins by project_id - /api/checkins/:project_id (needs a join)
  GET - Get all checking by user_id - /api/checkins/:user_id
  GET - Get one checkin by id - /api/checkins/:checkin_id
  POST - Create new checkin - /api/checkins

• Projects Create Table: project #16
  GET - Get all projects - /api/projects
  GET - Get one project by id - /api/projects/:project_id
  POST - Create new project - /api/projects
  PATCH - Update one project by id - /api/projects
  DELETE - Delete one project by id - /api/projects/:project_id

• Questions
  GET - Get all questions - /api/questions
  GET - One question by id - /api/questions/:question_id
  POST - Create a question - /api/questions
  PATCH - Update a question by id- /api/questions/:question_id
  DELETE - Delete a question by id - /api/questions/:question_id

[ExperimentsInHonesty]

This issue will be reviewed and turned into smaller issues for making the apis for custom items. Some apis are part of the table creation.

[fyliu]

Note that PD is using Django REST Framework, which is able to generate the standard CRUD endpoints based on row ids.

So for the user table, the only custom functionality is getting the user by email /api/users/?email=:user_email.

• It's not a lot of added code (5 lines) to add that.
• I bolded all the lines that require custom code in the main description.