Skip to content

Latest commit

 

History

History
324 lines (243 loc) · 3.94 KB

endpoints.md

File metadata and controls

324 lines (243 loc) · 3.94 KB

/editProfile

Receives: { email: "[email protected]" newEmail: "[email protected]" //optional newName: "Sawyer" //optional }

Sends: { sucess: "true" error: "Email does not exist." //optional }

/profile

Receives: { email: "[email protected]" }

Sends: { sucess: "true" name: "Sawyer" email: "[email protected]" password: "securePass" prefersEmailUpdates: "0" postCount: "3" }

/createAccount

Receives: { email: "[email protected]", name: "Sawyer", email: "[email protected]", password: "securePass", phoneNumber: "2008657700", prefersEmailUpdates: "0" }

Sends: { sucess: "true" error: "Email already exists." //optional }

/deleteAccount

Receives: { email: "[email protected]" }

Sends: { sucess: "true" error: "Email doesn't exist." //optional }

/changePassword

Receives: { email: "[email protected]" password: "oldPassword" newPassword: "newPassword" }

Sends: { sucess: "true" error: "Email doesn't exist." //optional }

/savesummary

Receives:

{

"email": "[email protected]",

"text": "This is the summary text saved by the user",

"name": "CS 307 Notes"

}

Send:

{

success: "true",

error: "error saving to db"

}

/addpicture

Receives: { file: image ->(multipart/form-data) email: "[email protected]" }

Send:

{

success: "true",

error: "success: false"

}

/listnotes

Receives:

{ "email": "[email protected]" }

Send:

[ { "noteID": 12, "name": "1234" }, { "noteID": 13, "name": "2wait Another t" } ]

/createnote

Receives:

{ "email": "[email protected]", "text": "hi this is a testing note " }

Send: {

"noteID": "43"

}

/updatenote

Receives:

{ "noteId": "43", "name:" "?", "noteText": '?' }

Send:

{ "success": "true" error: "success: false" 'name': '' }

/getPicture

Receives:

{ 'email': '' }

Send:

{ "success": "true" error: "success: false" }

/addcollaborators

  • Add collaborators to users
  • The user wants to add a collaborator so they select a note and enter the email address
  • of the collaborator that you want to share the note with
  • We recive the userEmail: the email of the current user, noteID: the note id of the current
  • user that they want to share with collaborator user, colabEmail: the email of the collaborator
  • that will obtain editing abilities

Receives:

{ 'noteID': '', 'userEmail':'', 'colabEmail':'' }

Send:

{ "success": "true" error: "success: false" }

/deleteCollaborators

  • colabEmail: the email of the collaborator

Receives:

{ 'colabEmail':'', 'noteId': '' }

Send:

{ "success": "true" error: "success: false" }

/getsumandnote

  • Click on a note and view its summary and/or user notes(if exists)

Receives: { "email": "", "noteID": "" }

Send: { [ { "summary" : "", "noteText" : "", "name": "" } ] }

/deletenote

  • To delete a whole note with summary and note

Receives: { "email": "", "noteID": "" }

Send: { 'success: true' err }

/addfeedback

  • user can add feedback

Receives: { 'email':'', 'feedback' : '' }

Send: { 'success': 'true' } err

/viewfeedback

  • as a developer would like to view all feedback

Send: [ { "userID": "", "name": "", "feedback": "" } ] err

/getcollaborators

Request: { 'userEmail':'','noteID':'' } Send: [ { 'colabEmail':'', 'name':'' } ] err

/emailReminder

This endpoint will send an email to the email passed in using the mailer. The email will contain a reminder message. Request: { "email": "", "dateString": 'YYYY/MM/DD HH:mm:ss', "message": "" }

Send:
{
    success: true
} 
err