REST API - lkw657/CITS3200_Team_K GitHub Wiki

REST API

Table of Contents

  1. /mail
  2. /db
    1. User Related
    2. Form Related
    3. Question Set Related
  3. /

/mail

POST /mail/verifyFormAccess

Verifies if link is valid and adds form to user.
Requires:

  • mailID
  • secret
  • userID

/db

User Related

GET /db/users

Lists all users in the database.
Requires:

  • IT Permissions (Cookie)

PUT /db/updateUser

Updates a user in the database.
Requires:

  • _id
  • fname (first name)
  • lname (last name)
  • number (student/staff number)
  • IT Permissions (Cookie)

PUT /db/removeUser

Removes a user in the database.
Requires:

  • _id
  • IT Permissions (Cookie)

Form Related

POST /db/newSubmission

Create a new submission.
Requires:

  • qset_id
  • answers
  • submitter
  • school

GET /db/form/

Lists all forms.
Requires:

  • Nothing at the moment

GET /db/form/:id

Lists form with matching id.
Requires:

  • Nothing at the moment

Question Set Related

POST /db/questionSet/

Adds a question set.
Requires:

  • questionList

GET /db/questionSet/

Gets all question sets.
Requires:

  • Nothing at the moment

GET /db/questionSet/latest

Gets question set with latest version.
Requires:

  • Nothing at the moment

GET /db/questionSet/:id

Gets question set with matching id.
Requires:

  • _id

/

GET /

Get's homepage

Account Related

POST /register

Registers a new user.
Requires:

  • fname (first name)
  • lname (last name)
  • number (student/staff number)
  • password

POST /authenticate

Authenticates a login request.
Requires:

  • number (student/staff number)
  • password
⚠️ **GitHub.com Fallback** ⚠️