WorkoutResultOpenServiceImpl

The following resources are part of this group:

/workoutresults/get_gps_results

Mount Point: /../api2/workoutresults/get_gps_results

GET

Retrieves Workout results posted by User through GPS between the specified dates

This service returns the all the posted GPS workout results

Suceess : Status code 200 and GPS workout results

Parameters

name description type default
fromDate Format : MM/dd/YYYY query
toDate Format : MM/dd/YYYY query
timezone Format : GMT Sign Hours : Minutes (e.g. "GMT-8:00") or GMT Sign Hours Minutes (e.g. "GMT-0800") or GMT Sign Hours (e.g. "GMT-8"). query

Response Body

element: resultProgressGPSWorkout
media types: application/xml
application/json

GPS workout results

Error will return HTTP status code 500 with error code and description. List of Error code and error message:

Error Code Error Message
406 Expecting All Query Params
100 Internal Error.

/workoutresults/get_lifefitness_results

Mount Point: /../api2/workoutresults/get_lifefitness_results

GET

Retrieves Lifefitness workout results of User between the specified dates

This service returns all the workouts posted through Lifefitness equipments aggregated by equipment(ex Treadmill,Upright Bike)

Success will return Status code 200 and Lifefitness workout results

Parameters

name description type default
fromDate Format : MM/dd/YYYY query
toDate Format : MM/dd/YYYY query
timezone Format : GMT Sign Hours : Minutes (e.g. "GMT-8:00") or GMT Sign Hours Minutes (e.g. "GMT-0800") or GMT Sign Hours (e.g. "GMT-8"). query

Response Body

element: resultProgressLifefitnessWorkout
media types: application/xml
application/json

Lifefitness workout results

Error will return HTTP status code 500 with error code and description. List of Error code and error message:

Error Code Error Message
406 Expecting All Query Params
100 Internal Error.

/workoutresults/get_manualcardio_results

Mount Point: /../api2/workoutresults/get_manualcardio_results

GET

Retrieves Manual Cardio workout results of User between the specified dates

This service returns all the manual cardio workout results aggregated by workoutname

Status code 200 and Manual Cardio workout results

Parameters

name description type default
fromDate Format : MM/dd/YYYY query
toDate Format : MM/dd/YYYY query
timezone Format : GMT Sign Hours : Minutes (e.g. "GMT-8:00") or GMT Sign Hours Minutes (e.g. "GMT-0800") or GMT Sign Hours (e.g. "GMT-8"). query

Response Body

element: resultProgressManualCardioWorkout
media types: application/xml
application/json

Manual Cardio workout results

Error will return HTTP status code 500 with error code and description. List of Error code and error message:

Error Code Error Message
406 Expecting All Query Params
100 Internal Error.

/workoutresults/get_manualstrength_results

Mount Point: /../api2/workoutresults/get_manualstrength_results

GET

Retrieves Manual Strength workout results of User between the specifieddates

This service returns all the Manual strength workout results aggregated by workoutname

Status code 200 and Manual Strength workout results

Parameters

name description type default
fromDate Format : MM/dd/YYYY query
toDate Format : MM/dd/YYYY query
timezone Format : GMT Sign Hours : Minutes (e.g. "GMT-8:00") or GMT Sign Hours Minutes (e.g. "GMT-0800") or GMT Sign Hours (e.g. "GMT-8"). query

Response Body

element: resultProgressManualStrengthWorkout
media types: application/xml
application/json

Manual Strength workout results

Error will return HTTP status code 500 with error code and description. List of Error code and error message:

Error Code Error Message
406 Expecting All Query Params
100 Internal Error.

/workoutresults/get_results_daily

Mount Point: /../api2/workoutresults/get_results_daily

GET

Retrieves Daily Progress of User between the specified dates

This service returns all the individual workout results aggregated by date.

The fromDate and toDate can be used to get the daily progress information of all days for which the results are available .

The cardio results includes workouts through Lifefitness equipments, GPS workouts and Manual Cardio workouts posted. These workouts can be differentiated as follows:

The Lifefitness workout results have equipmentId and equipmentName ex: 1 Treadmill
Manual Cardio workout results have workoutname(the workoutname the results are posted with)
GPS workout results show the equipmentName as GPS and equipmentID as -1

Status code 200 and Daily Progress Info

Parameters

name description type default
fromDate Format : MM/dd/YYYY query
toDate Format : MM/dd/YYYY query
timezone Format : GMT Sign Hours : Minutes (e.g. "GMT-8:00") or GMT Sign Hours Minutes (e.g. "GMT-0800") or GMT Sign Hours (e.g. "GMT-8"). query

Response Body

element: resultProgressDaily
media types: application/xml
application/json

Daily Progress Information

Error will return HTTP status code 500 with error code and description. List of Error code and error message:

Error Code Error Message
406 Expecting All Query Params
100 Internal Error.

/workoutresults/get_results_workout

Mount Point: /../api2/workoutresults/get_results_workout

GET

Retrieves workout progress of User between the specified dates

This service returns all the workout results aggregated by workout

The workout here signifies either equipmentName for Lifefitness workouts , workoutname for manual workout results and GPS for GPS workout results

These workouts can be differentiated as follows:

The Lifefitness workout results have equipmentId and equipmentName
Manual Cardio workout results have workoutname
GPS workout results show the equipmentName as GPS and equipmentID as -1

Status code 200 and workout results

Parameters

name description type default
fromDate Format : MM/dd/YYYY query
toDate Format : MM/dd/YYYY query
timezone Format : GMT Sign Hours : Minutes (e.g. "GMT-8:00") or GMT Sign Hours Minutes (e.g. "GMT-0800") or GMT Sign Hours (e.g. "GMT-8"). query

Response Body

element: resultProgressWorkout
media types: application/xml
application/json

Workout results

Error will return HTTP status code 500 with error code and description. List of Error code and error message:

Error Code Error Message
406 Expecting All Query Params
100 Internal Error.

/workoutresults/get_summary_results

Mount Point: /../api2/workoutresults/get_summary_results

GET

Read current progress information.

This service provides the progress information like calories,duration,workout span days and weights lifted per Day,Week,Month and Year. The currDate parameter value passed is considered as the current day till which the progress information is seeked.

Successful operation will return HTTP Status code 200 and Progress info.

Parameters

name description type default
currDate The date till which the progress is needed Format : MM/dd/YYYY query
unit Format : "I" for Imperial unit or "M" for Metric unit. query
timezone Format : GMT Sign Hours : Minutes (e.g. "GMT-8:00") or GMT Sign Hours Minutes (e.g. "GMT-0800") or GMT Sign Hours (e.g. "GMT-8"). query

Response Body

element: progressSummary
media types: application/xml
application/json

Summary of current workout progress information.

Error will return HTTP status code 500 with error code and description. List of Error code and error message:

Error Code Error Message
100 Internal Error.
400 Unit should be I or M.
401 Need timezone and unit.
402 Incorrect timezone provided.

/workoutresults/postcardio

Mount Point: /../api2/workoutresults/postcardio

POST

Store Manual Cardio Workout information i.e, Cardio workout posted manually rather than through equipment.

This service saves the Manual Cardio workout information and posts to Facebook if the User has authorized Facebook sharing in his profile with the message specified in facebookShareMsg and the workout information.

Successful operation will return HTTP Status code 200.

Request Body

element: manualCardioWorkoutResult
media types: application/xml
application/json

Format of ManualStrengthWorkout in XML or JSON. All tag element is required.

Response Body

element: (custom)
media types: */*
application/xml
application/json

HTTP Status code 200.

Error will return HTTP status code 500 with error code and description. List of Error code and error message:

Error Code Error Message
100 Internal Error.
502 Need workout name parameter.
503 Date is null or wrong format.
504 Unit should be I or M.
505 Need preferred unit parameter.
508 Need Calories parameter.
509 Need Distance parameter.
510 Need Time parameter.
511 Distance conversion error.
512 Error in posting the workout to Facebook.

/workoutresults/postgps

Mount Point: /../api2/workoutresults/postgps

POST

Saves the GPS workout information.

This service saves the GPS information and posts to Facebook if the User has authorized Facebook sharing in his profile, with the message specified in facebookShareMsg and the workout information.

Successful operation will return HTTP Status code 200.

Request Body

element: GPSWorkoutResult
media types: application/xml
application/json

XML or JSON data for the GPS workout result.

Response Body

element: (custom)
media types: application/xml
application/json

HTTP Status code 200.

Error will return HTTP status code 500 with error code and description. List of Error code and error message:

Error Code Error Message
100 Internal Error.
500 Validation Error.
514 Total distance or total time must be greater than zero.

/workoutresults/poststrength

Mount Point: /../api2/workoutresults/poststrength

POST

Store Manual Strength Workout information.i.e, Strength workout posted manually rather than through equipment.

This service saves the Manual Strength workout information and posts to Facebook if the User has authorized Facebook sharing in his profile with the message specified in facebookShareMsg and the workout information.

Successful operation will return HTTP Status code 200.

Request Body

element: manualStrengthWorkoutResult
media types: application/xml
application/json

Format of ManualStrengthWorkout in XML or JSON. All tag element is required. Maximum tag element for StrengthSet is 5.

Response Body

element: (custom)
media types: */*
application/xml
application/json

HTTP Status code 200.

Error will return HTTP status code 500 with error code and description. List of Error code and error message:

Error Code Error Message
100 Internal Error.
501 Weight conversion error.
502 Need workout name parameter.
503 Date is null or wrong format.
504 Unit should be I or M.
505 Need preferred unit parameter.
506 Need at least 1 Strength Sets.
507 Reached maximum Strength Sets (max. 5).
512 Error in posting the workout to Facebook.
513 The set numbers provided are not sequential.

/workoutresults/submit_user_workout

Mount Point: /../api2/workoutresults/submit_user_workout

POST

Simulates user workout submission from LifeFitness equipments

Successful operation will return HTTP Status code 204.

Request Body

element: userWorkoutInputVo
media types: application/xml
application/json

userWorkoutInput in XML or JSON XML or JSON data.
activityId - range 1-16
calories - acceptable range 1-3000
distance - acceptable range 1-40 miles
dateTime - performed date in YYYY-MM-DDThh:mm:ssTZD format
duration - acceptable range is 60s-36000s
Error will return HTTP status code 500 with error code and description.
List of Error codes and error messages:

Error Code Error Message
100 Internal Error.
522 Missing Mandatory parameters
523 Unacceptable calorie count, valid range is 1-3000
524 Unacceptable duration, valid range is 60s-36000s
525 Unacceptable distance, valid range is is 1-40 miles
526 Unacceptable activityId, valid range is is 1-16
527 Provided activityId is not yet supported.