Skip to content

Latest commit

 

History

History
33 lines (29 loc) · 1.43 KB

endpoints.md

File metadata and controls

33 lines (29 loc) · 1.43 KB

WIP list of active endpoints

/

  • return Welcome message / check if the app is active

  • /api/user (Auth.js)

    • GET /: Gets lots of info on "current" user (based on user passed in request)
    • POST /register: Create new user
    • POST /login: Login user
    • POST /update: Update user (WIP)
    • POST /project-manager: Make a user a project manager of a project
    • POST /data-collector: Make a user a data collector of a project
    • POST /analyst: Make a user an analyst of a project
    • DELETE /delete: Delete a user based on ID
  • /api/projects (projects.js)

    • POST /create: Create a project
    • DELETE /delete: Delete a project
    • POST /assign: Assign a user (WIP)
    • POST /unassign: Unassign a user (WIP)
  • /api/forms (forms.js)

    • POST /publish: Finalise a form
    • POST /new-draft: Update the draft on ODK central for a form
    • POST /new: Create a new form on ODK central;
  • /api/meta-data (metaData.js)

    • POST /: Get lots of info on "current" user (based on user passed in request)
  • /api/admin (makeAdmin.js)

    • POST /: Make a user an admin

Questions / possible streamlining for later

  • can GET from api/user be merged with POST from /api/meta-data? (If we only keep one, I think it makes sense long-term to keep the GET api/user, as it is a bit more intuitive than the separate meta-data endpoint.)
  • How does admin or project lead get info on a different user?
  • Maybe unify some of the language (e.g. 'new' vs 'create').