Workouts.api

Accessing Workout API from cultiveight.net:

http://cultiveight.net/api/workouts/[endpoints]

Testing in local server:

localhost:3001/[endpoints] in database/index.js, change the host ip to public (line5)

Endpoints:

1. GET ('/')

=> get first 10 workouts information

• params: null,
• body: null
• return data example:

[
  {   //workout 1
      "id": 1,
      "name": "Dumbbell Only Workouts",
      "type": "Strength",
      "likes": 55,
      "duration": "45-60 min",
      "body_group": "chest,  shoulder,  triceps",
      "description": "only requires dumbbells and is perfect for those looking to build lean muscle mass at home or on the go!",
      "equipment": "bodyweight, dumbbells",
      "workout_exercises": [
          {   //exercise 1
              "id": 1,
              "exercise_id": 1,
              "sets": 5,
              "reps": "8-10",
              "exercise": {
                  "id": 1,
                  "name": "Dumbbell Bench Press",
                  "video": "https://youtu.be/dGqI0Z5ul4k"
              }
          },
          {
              //exercise 2
              ...
          },...
      ]
  },
  {
      //workout 2
  },...
]

2. GET ('/oneworkout/:workout_id')

=> get a certain workout by given workout_id

• params: workout_id,
• body: null
• return data example:

  {
    "id": 1,
    "name": "Dumbbell Only Workouts",
    "type": "Strength",
    "likes": 55,
    "duration": "45-60 min",
    "body_group": "chest,  shoulder,  triceps",
    "description": "only requires dumbbells and is perfect for those looking to build lean muscle mass at home or on the go!",
    "equipment": "bodyweight, dumbbells",
    "workout_exercises": [
        {   //exercise 1
            "id": 1,
            "exercise_id": 1,
            "sets": 5,
            "reps": "8-10",
            "exercise": {
                "id": 1,
                "name": "Dumbbell Bench Press",
                "video": "https://youtu.be/dGqI0Z5ul4k"
            }
        },
        {
            //exercise 2
            ...
        },...
    ]
  },

3. GET ('/savedworkouts')

=> get user's saved workouts list

• params: null,
• body example:

  //body is not required in the deployed product, but you can use this for testing.
  user: {
    id:3 //integer
  }
  

• return data example: same as GET('/'), but only get the workouts saved by the users

4. POST ('/savedworkouts')

=> when user save a workout to calendar

• params: null,
• body example:

  //user object is not required in the deployed product, but you can use this for testing.
  {
    user: {
      id:3 //integer
    }
    workout_id: 5 //integer
    time_on_calendar: "2021-12-13 18:30:00" //string
  }
  

5. PUT ('/savedworkouts')

=> when user wants to update time on calendar for a certain saved workout.

• params: null,
• body example:

  // NOTE:savedWorkout_id is the same as the id from GET ('/savedworkouts'), not workout_id
  // user object is not required in the deployed product, but you can use this for testing.
  {
    user: {
      id:3 //integer
    }
    savedWorkout_id: 15 //integer,
    time_on_calendar: "2021-12-13 14:30:00" //string,
  }
  

5. DELETE ('/savedworkouts')

=> when user wants to delete a certain saved workout.

• params: null,
• body example:

  // NOTE:savedWorkout_id is the same as the id from GET ('/savedworkouts'), not workout_id
  // user object is not required in the deployed product, but you can use this for testing.
  {
    user: {
      id:3 //integer
    }
    savedWorkout_id: 15 //integer,
  }