UserOpenServiceImpl
The following resources are part of this group:
/user
Mount Point: /../api2/user
GET
Retrieves the user account details based on the User access token passed.
Response Body
| element: | LFUser |
| media types: | application/xml application/json |
User account details
Error will return HTTP status code 500 with error code and
description. List of Error code and error message:
| Error Code | Error Message |
|---|---|
| 200 | User not found. |
POST
Updates the user details based on the user access token provided.
Similar to the LFConnect website ,Updating profile excludes updating of email and nickname. If the input includes these fields to be updated, it will be ignored.
Valid values to be provided
| Param | Valid Value |
|---|---|
| Weight | kg Min: 34 Max: 181 |
| Weight | lbs Min: 75 Max: 400 |
| Height | cm Min: 60 Max: 310 |
| Height | inches Min: 23.64 Max: 122.04 |
| Gender | m/M f/F |
| Age * | Min: 10 Max: 99 |
| preferredUnit | I: Imperial M: Metric |
Request Body
| element: | LFUser |
| media types: | application/xml application/json |
User details to update.
Response Body
| element: | LFUser |
| media types: | application/xml application/json |
Updated user account details.
Error will return HTTP status code 500 with error code and
description. List of Error code and error message:
| Error Code | Error Message |
|---|---|
| 205 | User cannot be updated. |
| 206 | User cannot be updated. Missing parameter/s: [List of lacking parameters] |
| 219 | Weight is not within allowable range. |
| 220 | Height is not within allowable range. |
/user/getphoto
Mount Point: /../api2/user/getphoto
GET
Returns the Profile photo of the LFConnect User related to the Access Token passed.
Response Body
| element: | (custom) |
| media types: | image/* |
File of the profile image.
Error will return HTTP status code 500 with error code and
description. List of Error code and error message:
| Error Code | Error Message |
|---|---|
| 208 | User photo cannot be retrieved. |
/user/savephoto
Mount Point: /../api2/user/savephoto
POST
Saves the photo as the new profile photo of the user related to the Access Token passed.
Request Body
| element: | (custom) |
| media types: | image/* |
The new profile photo File to set.
Response Body
| element: | (custom) |
| media types: | */* application/xml application/json |
Response 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 |
|---|---|
| 209 | User photo cannot be saved. |