greenheart / fcc-rest-api-project Goto Github PK

{userId}&{exercise}&{duration}[&date]

Input:

• Exercise type (30-40 char string)
• Duration (minutes)
• Date (year-month-day) string
• If no date passed, the date is today

Response

• 200 OK

response (json)

• username
• userId (???)
• number of exercises/workouts/trainings/activities completed

• fromDate sets the earliest date of log entries returned.
  • Default: Date.bigBang() (Unix big bang?)
  • Date-string Ex: (2016-12-11)
• toDate sets the max date of log entries returned.
  • Default: Date.today()
  • Date-string Ex: (2016-12-11)
• entries sets max number of entries returned
  • Integer

Response

• { status: 'OK' || '{Error message}', exercises: [Array of exercise-objects] }

Error messages

• 2016-jan-second --> 'toDate/fromDate is not a date string with the format (year-month-day)'

Post body:

• username (string, unique)

Create unique id.

Response

• If username is not already taken:
  • return {username, userId}
• else
  • return { status: 400, message: 'username already taken'}

We could add more details later if we want:

• Description
• Real name