fatsecret Platform API Documentation
Profile - Saved Meals: Create Meal
Description
Records a saved meal for the user according to the parameters specified. The result of the call is the new unique identifier of the newly created saved meal.
Parameters
URL / Method
| NAME | TYPE | REQUIRED | DESCRIPTION |
|---|---|---|---|
| URL (new) Method |
N/A | Required | "https://platform.fatsecret.com/rest/saved-meals/v1" HTTP "POST" |
| OR | |||
| method | String | Required | "saved_meal.create" (included with other parameters) |
Additional Parameters
| NAME | TYPE | REQUIRED | DESCRIPTION |
|---|---|---|---|
| saved_meal_name | String | Required | 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
saved_meal_id. Each saved_meal_id element contains information as follows:
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| saved_meal_id | Long | Unique saved meal identifier |
Example Response
Example 1:
<?xml version="1.0" encoding="utf-8"?>
<saved_meal_id 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">1111111</saved_meal_id>
Example 1:
{
"saved_meal_id": {
"value": "1111111"
}
}
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>' |
| 108 | Parameter | Invalid Type: '<details>' |