fatsecret Platform API Documentation
Profile - Saved Meals: Edit Meal By Id
Description
Records a change to a user's saved meal.
Parameters
URL / Method
NAME | TYPE | REQUIRED | DESCRIPTION |
---|---|---|---|
URL (new) Method |
N/A | Required | "https://platform.fatsecret.com/rest/saved-meals/v1" HTTP "PUT" |
OR | |||
method | String | Required | "saved_meal.edit" (included with other parameters) |
Additional Parameters
NAME | TYPE | REQUIRED | DESCRIPTION |
---|---|---|---|
saved_meal_id | Long | Required | Unique saved meal identifier |
saved_meal_name | String | Optional | New name of the saved meal |
saved_meal_description | String | Optional | New description of the saved meal |
meals | String | Optional | Comma separated list of meals the saved meal is suitable for |
format | String | Optional | The desired response format. Valid response formats are "xml" or "json" (default value is "xml"). |
Response
Each success
element contains information as follows:
NAME | TYPE | DESCRIPTION |
---|---|---|
success | Int | Whether the call succeeded or not. If successful equals 1 |
Example Response
Example 1:
<?xml version="1.0" encoding="utf-8"?>
<success xmlns="http://platform.fatsecret.com/api/1.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://platform.fatsecret.com/api/1.0/ http://platform.fatsecret.com/api/1.0/fatsecret.xsd">1</success>
Example 1:
{
"success": {
"value": "1"
}
}
Error Codes
CODE | TYPE | DESCRIPTION |
---|---|---|
2 | OAuth 1.0 | Missing required oauth parameter: '<details>' |
3 | OAuth 1.0 | Unsupported oauth parameter: '<details>' |
4 | OAuth 1.0 | Invalid signature method: '<details>' |
5 | OAuth 1.0 | Invalid consumer key: '<details>' |
6 | OAuth 1.0 | Invalid/expired timestamp: '<details>' |
7 | OAuth 1.0 | Invalid/used nonce: '<details>' |
8 | OAuth 1.0 | Invalid signature: '<details>' |
9 | OAuth 1.0 | Invalid access token: '<details>' |
101 | Parameter | Missing required parameter: '<details>' |
106 | Parameter | Invalid ID: '<details>' |
108 | Parameter | Invalid Type: '<details>' |