fatsecret Platform API Documentation
Profile - Saved Meals: Get All Foods In Meal
Description
Returns saved meal items for a specified saved meal.
Why are we introducing this version?
Parameters
URL / Method
NAME | TYPE | REQUIRED | DESCRIPTION |
---|---|---|---|
URL (new) Method |
N/A | Required | "https://platform.fatsecret.com/rest/saved-meals/item/v2" HTTP "GET" |
OR | |||
method | String | Required | "saved_meal_items.get.v2" (included with other parameters) |
Additional Parameters
NAME | TYPE | REQUIRED | DESCRIPTION |
---|---|---|---|
saved_meal_id | Long | Required | Unique saved meal identifier |
format | String | Optional | The desired response format. Valid response formats are "xml" or "json" (default value is "xml"). |
Response
saved_meal_item_id, food_id, serving_id
. Each saved_meal_item
element contains information as follows:
NAME | TYPE | DESCRIPTION |
---|---|---|
saved_meal_item_id | Long | Unique saved meal item identifier |
food_id | Long | Unique food identifier |
saved_meal_item_name | String | New name of the saved meal item |
serving_id | Long | Unique serving identifier |
number_of_units | Decimal | Number of units in this standard serving size. For instance, if the serving description is "2 tablespoons" the number of units is "2", while if the serving size is "1 cup" the number of units is "1". Please note that this is only applicable for when food_type is "Generic" whereas for "Brand" the number of units will always be "1" |
Example Response
Example 1:
<?xml version="1.0" encoding="utf-8" ?>
<saved_meal_items 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">
<saved_meal_item>
<saved_meal_item_id>1111111</saved_meal_item_id>
<food_id>4384</food_id>
<saved_meal_item_name>Plain French Toast</saved_meal_item_name>
<serving_id>16758</serving_id>
<number_of_units>2.000</number_of_units>
</saved_meal_item>
</saved_meal_items>
Example 1:
{
"saved_meal_items": {
"saved_meal_item": [
{
"food_id": "4384",
"number_of_units": "2.000",
"saved_meal_item_id": "1111111",
"saved_meal_item_name": "Plain French Toast",
"serving_id": "16758"
}
]
}
}
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>' |