fatsecret Platform API Documentation
Recipe Types: Get All
Description
This is a utility method, returning the full list of all supported recipe type names.
Why are we introducing this version?
Updated json array formatting so it is consistent when one object is returned.
Added support for localization for premier clients.
Parameters
URL / Method
| NAME | TYPE | REQUIRED | DESCRIPTION |
|---|---|---|---|
| URL (new) Method |
N/A | Required | "https://platform.fatsecret.com/rest/recipe-types/v2" HTTP "GET" |
| OR | |||
| method | String | Required | "recipe_types.get.v2" (included with other parameters) |
Additional Parameters
| NAME | TYPE | REQUIRED | DESCRIPTION |
|---|---|---|---|
| format | String | Optional | The desired response format. Valid response formats are "xml" or "json" (default value is "xml"). |
Premier Exclusive
| Name | Type | Required | Description |
|---|---|---|---|
| region | String | Optional | Results will be filtered by region. E.G.: "FR" returns results from France. If not specified this will default to "US" (United States). Click here for full documentation on localization. |
| language | String | Optional | (Ignored unless region is also specified) Results will be in the specified language. E.G.: "fr" returns results in French |
Response
The only storable value returned by this call is
recipe_types. Each recipe_types element contains information as follows:
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| recipe_types | String | This option filters by specified recipe types and should be provided as a comma separated string of recipe type names. The values are provided via the api: Recipe Types Get All |
Example Response
Example 1:
<?xml version="1.0" encoding="utf-8" ?>
<recipe_types 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">
<recipe_types>Appetizers</recipe_types>
<recipe_types>Soups</recipe_types>
<recipe_types>Main Dishes</recipe_types>
</recipe_types>Example 1:
{
"recipe_types": {
"recipe_types": [
"Appetizers",
"Soups",
"Main Dishes"
]
}
}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>' |