#SmartGoals API - Work In Progress

• HEADERS: Authorization
  • All routes are tagged with an Authorization header. This is the id_token jwt. On the backend we can use this as a session key to authorize the user.

---

• 2. Route: /smartgoals/

• Action: POST request
  • Creates a new SmartGoal object.
  • Required Parameters:
    • title : String
    • priority : String (“LOW”, “MEDIUM”, or “HIGH”) (Required if goal_type is OPEN)
    • goal_type : String (“OPEN”, “SINGLE”, “REPEAT”)
    • due_date : Date (Required if goal_type is SINGLE)
    • repeat : Number (Integer) (Required if goal_type is REPEAT - This is currently how many times the user wants to accomplish the goal per week.)
  • Optional Parameters:
    • notes: String

---

• 3. Route: /smartgoals/goal/update/

• Action: POST request
  • Updates an existing SmartGoal object.
  • Required Parameters:
    • goal_id: String
  • Optional parameters (anything you want to update):
    • title: String
    • notes: String
    • priority: String (“LOW”, “MEDIUM”, or “HIGH”)
    • goal_type: String (“OPEN”, “SINGLE”, “REPEAT”)
    • due_date: Date (Required if goal_type is SINGLE)
    • repeat: Number (Integer) (Required if goal_type is REPEAT)

---

• 4. Route: /smartgoals/byuser/

• Action: POST request
• Returns all SmartGoal objects in the database with user_id matching the given user_id, with variable "complete" set to false
  • Required Parameters:
    • None, User_ID is passed automatically
• Returned values:
  • title: String,
  • notes: String (If Set),
  • user_id: String,
  • priority: String (Will be set if OPEN goal),
  • goal_type: String (OPEN, SINGLE, REPEAT),
  • due_date: Date (Will be set if SINGLE goal),
  • repeat: Number (Will be set if REPEAT goal, # of requested repeats per week),
  • completeDates: Date (Array of Dates, one for each "complete" action. SINGLE goals should only have one. REPEAT goals may have many.)
  • completesThisWeek: Number (A pre-calculated number of complete actions for the current week. Only really applies to REPEAT goals.)
  • complete: Boolean (Yes/No value for if the goal is currently considered complete. Complete goals will not show up on the active list. Repeat goals will reset their complete value to false automatically when a new week starts, and re-appear on the active list)
  • date_created: Date, default: moment().format() (A Moment.js object for the current date, set automatically when created)

---

• 5. Route: /smartgoals/byuser/history/

• Action: POST request
• Returns all SmartGoal objects in the database with user_id matching the given user_id, with variable "complete" set to true.
  • Required Parameters:
    • None, User_ID is passed automatically
• Returned values:
  • title: String,
  • notes: String (If Set),
  • user_id: String,
  • priority: String (Will be set if OPEN goal),
  • goal_type: String (OPEN, SINGLE, REPEAT),
  • due_date: Date (Will be set if SINGLE goal),
  • repeat: Number (Will be set if REPEAT goal, # of requested repeats per week),
  • completeDates: Date (Array of Dates, one for each "complete" action. SINGLE goals should only have one. REPEAT goals may have many.)
  • completesThisWeek: Number (A pre-calculated number of complete actions for the current week. Only really applies to REPEAT goals.)
  • complete: Boolean (Yes/No value for if the goal is currently considered complete. Complete goals will not show up on the active list. Repeat goals will reset their complete value to false automatically when a new week starts, and re-appear on the active list)
  • date_created: Date, default: moment().format() (A Moment.js object for the current date, set automatically when created)

---

• 6. Route: /smartgoals/complete/

• Action: POST request
  • Sets a specific SmartGoal object as complete.
  • Required Parameters:
    • goal_id: String
• Returned Values:
  • Currently none. To be added, we will return points earned, along with any level up or achievement info, to be used on the front end.

---

• 7. Route: /smartgoals/view/

• Action: POST request
  • Returns only a single SmartGoal object, matching the given id.
  • Required Parameters:
    • goal_id: String
• Returned values:
  • title: String,
  • notes: String (If Set),
  • user_id: String,
  • priority: String (Will be set if OPEN goal),
  • goal_type: String (OPEN, SINGLE, REPEAT),
  • due_date: Date (Will be set if SINGLE goal),
  • repeat: Number (Will be set if REPEAT goal, # of requested repeats per week),
  • completeDates: Date (Array of Dates, one for each "complete" action. SINGLE goals should only have one. REPEAT goals may have many.)
  • completesThisWeek: Number (A pre-calculated number of complete actions for the current week. Only really applies to REPEAT goals.)
  • complete: Boolean (Yes/No value for if the goal is currently considered complete. Complete goals will not show up on the active list. Repeat goals will reset their complete value to false automatically when a new week starts, and re-appear on the active list)
  • date_created: Date, default: moment().format() (A Moment.js object for the current date, set automatically when created)

---

• 8. Route: /smartgoals/delete/

• Action: DELETE request
  • Deletes a single SmartGoal object, with the given goal_id
  • Required Parameters:
    • goal_id: String
      • Make goal_id="deleteAll" to delete all user's goals even complete/inactive ones
• Returned values:
  • A message giving a success or error response

---

• 9. Route: /users/

• Action: POST request
• Creates a user if one with user_id does not exists. Also updates the user_token. Returns the user object
  • Parameters Required:
    • user_id : String

---

• 10. Route: /users/updateUser/

• Action: POST request
• Updates a user object with the specified parameters and then returns the updated user object
  • Optional Parameters:
    • updates: Object
      • Updates may contain the following properties:
        • points : Number
        • level : Number
        • pointsToNext : Number