fatsecret Platform API Documentation

Food Sub Categories: Get All

OAuth 2.0 OAuth 1.0 Deprecated Premier Exclusive
Description

This is a utility method, returning the full list of all food sub categories for a food category.

Parameters
URL / Method
NAME TYPE REQUIRED DESCRIPTION
URL (new)
Method
N/A Required "https://platform.fatsecret.com/rest/food-sub-categories/v1"
HTTP "GET"
OR
method String Required "food_sub_categories.get" (included with other parameters)
Additional Parameters
NAME TYPE REQUIRED DESCRIPTION
food_category_id Long Required Unique identifier of the food category entry
region String Optional Results will be filtered by region. E.G.: "FR" returns results from France
language String Optional (Ignored unless region is also specified) Results will be in the specified language. E.G.: "fr" returns results in French
format String Optional The desired response format. Valid response formats are "xml" or "json" (default value is "xml").
Scopes for OAuth2 integration: premier
Response
There are no storable values returned by this call.

Each food_sub_categories element contains information as follows:

NAME TYPE DESCRIPTION
food_sub_category String (Premier Exclusive) Sub category of the food

Example Response

Example 1:

<?xml version="1.0" encoding="utf-8" ?> 
<food_sub_categories 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">
	<food_sub_category>Baked Bean</food_sub_category>
	<food_sub_category>Bean</food_sub_category>
	<food_sub_category>Black Bean</food_sub_category>
</food_sub_categories>

Example 1:

{
  "food_sub_categories": {
    "food_sub_category": [
      "Baked Bean",
      "Bean",
      "Black Bean"
    ]
  }
}
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>'
13 OAuth 2.0 Invalid token: '<details>'
14 OAuth 2.0 Missing scope: '<details>'
101 Parameter Missing required parameter: '<details>'