- Documentation
- Sandbox
Get menus
Name | Information | ||||
---|---|---|---|---|---|
filter_year |
|
||||
filter_month |
|
Status Code | Description |
---|---|
200 |
|
Search recipes
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
page | integer | false | Sets the page to return for multi-paged result sets. | |
items_per_page | integer | false | Sets the number of recipes per page for multi-paged result sets. Default: 15. | |
sort_fields | string | true | Determines the ordering of the results. Example: 'kcal_int desc, created_date desc'. | |
return_facets | string | false | Determines if facets are included in the result set ('true') or not ('false'). Default: false. Unless either 'facet_fields' or 'facet_ranges' are specified, a default set of facets is returned. | |
facet_sort | choice | false | {"index":0,"count":1} | Determines the ordering of the facet field constraints: 'count' to sort by count (highest first) or 'index' to sort alphabetically. Default: 'index'. |
facet_limit | integer | true | Indicates the maximum number of constraint counts that should be returned for the facet fields. Default: all facets. | |
facet_min_count | integer | true | Indicates the minimum counts for facet fields that should be included in the response. Default: 0. | |
facet_fields | string | true | Specifies a non-default list of facet fields that should be included in the response. Example: 'kitchen_multi_str, difficulty_str'. | |
facet_ranges | string | true | Specifies a non-default list of ranged facet fields that should be included in the response. Example: 'kcal_int, protein_int'. | |
full_text | string | true | Specifies the Solr query for the title, subtitle, ingredients and preparations text fields. | |
ingredient_text | string | true | Specifies the Solr query for the ingredient text fields. | |
mainingredient_text | string | true | Specifies the Solr query for the mainingredient text fields. | |
created_date | string | true | Specifies the Solr query for the recipe creation date. | |
updated_date | string | true | Specifies the Solr query for the recipe update date. | |
kcal_int | string | true | Specifies the Solr query for the recipe number of kilocalories. | |
fat_int | string | true | Specifies the Solr query for the recipe fat amount in grams. | |
saturated_fat_int | string | true | Specifies the Solr query for the recipe saturated fat amount in grams. | |
carbs_int | string | true | Specifies the Solr query for the recipe carbohydrate amount in grams. | |
protein_int | string | true | Specifies the Solr query for the recipe protein amount in grams. | |
fibers_int | string | true | Specifies the Solr query for the recipe fibers amount in grams. | |
salt_int | string | true | Specifies the Solr query for the recipe salt amount in milligram. | |
persons_int | string | true | Specifies the Solr query for the recipe serving size. | |
total_time_int | string | true | Specifies the Solr query for the recipe preparation time. | |
preparation_time_int | string | true | Specifies the Solr query for the recipe preparation time in minutes. | |
rating_average_int | string | true | Specifies the Solr query for the recipe average rating from 1 to 10 (or 0 for no rating). | |
view_count_int | string | true | Specifies the Solr query for the recipe total view count. | |
status_id | string | true | Specifies the Solr query for the recipe activation status. | |
status_str | string | true | Specifies the Solr query for the recipe activation status. | |
difficulty_id | string | true | Specifies the Solr query for the recipe difficulty. | |
difficulty_str | string | true | Specifies the Solr query for the recipe difficulty. | |
difficulty_multi_id | string | true | Specifies the Solr query for the recipe difficulties. | |
difficulty_multi_str | string | true | Specifies the Solr query for the recipe difficulties. | |
course_multi_id | string | true | Specifies the Solr query for the recipe menu courses. | |
course_multi_str | string | true | Specifies the Solr query for the recipe menu courses. | |
kitchen_multi_id | string | true | Specifies the Solr query for the recipe kitchen types. | |
kitchen_multi_str | string | true | Specifies the Solr query for the recipe kitchen types. | |
mainingredient_multi_id | string | true | Specifies the Solr query for the recipe mainingredient types. | |
mainingredient_multi_str | string | true | Specifies the Solr query for the recipe mainingredient types. | |
magazine_multi_id | string | true | Specifies the Solr query for the recipe published magazines. | |
magazine_multi_str | string | true | Specifies the Solr query for the recipe published magazines. | |
tag_multi_id | string | true | Specifies the Solr query for the recipe tags. | |
tag_multi_str | string | true | Specifies the Solr query for the recipe tags. | |
ingredient_multi_id | string | true | Specifies the Solr query for the recipe ingredients. | |
ingredient_multi_str | string | true | Specifies the Solr query for the recipe ingredients. | |
wine_multi_id | string | true | Specifies the Solr query for the recipe wine advices. | |
wine_multi_str | string | true | Specifies the Solr query for the recipe wine advices. | |
not_ids_str | string | true | Specifies the Solr query to exclude recipes with the given id's | |
ids_str | string | true | Specifies the Solr query to include recipes with the given id's | |
query | string | true | Specifies the Solr query to execute |
Status Code | Description |
---|---|
200 |
|
403 |
|
422 |
|
Search recipes log
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
page | integer | false | Sets the page to return for multi-paged result sets. | |
items_per_page | integer | false | Sets the number of recipes per page for multi-paged result sets. Default: 15. | |
sort_fields | string | true | Determines the ordering of the results. Example: 'kcal_int desc, created_date desc'. | |
return_facets | string | false | Determines if facets are included in the result set ('true') or not ('false'). Default: false. Unless either 'facet_fields' or 'facet_ranges' are specified, a default set of facets is returned. | |
facet_sort | choice | false | {"index":0,"count":1} | Determines the ordering of the facet field constraints: 'count' to sort by count (highest first) or 'index' to sort alphabetically. Default: 'index'. |
facet_limit | integer | true | Indicates the maximum number of constraint counts that should be returned for the facet fields. Default: all facets. | |
facet_min_count | integer | true | Indicates the minimum counts for facet fields that should be included in the response. Default: 0. | |
facet_fields | string | true | Specifies a non-default list of facet fields that should be included in the response. Example: 'kitchen_multi_str, difficulty_str'. | |
facet_ranges | string | true | Specifies a non-default list of ranged facet fields that should be included in the response. Example: 'kcal_int, protein_int'. | |
full_text | string | true | Specifies the Solr query for the title, subtitle, ingredients and preparations text fields. | |
ingredient_text | string | true | Specifies the Solr query for the ingredient text fields. | |
mainingredient_text | string | true | Specifies the Solr query for the mainingredient text fields. | |
created_date | string | true | Specifies the Solr query for the recipe creation date. | |
updated_date | string | true | Specifies the Solr query for the recipe update date. | |
kcal_int | string | true | Specifies the Solr query for the recipe number of kilocalories. | |
fat_int | string | true | Specifies the Solr query for the recipe fat amount in grams. | |
saturated_fat_int | string | true | Specifies the Solr query for the recipe saturated fat amount in grams. | |
carbs_int | string | true | Specifies the Solr query for the recipe carbohydrate amount in grams. | |
protein_int | string | true | Specifies the Solr query for the recipe protein amount in grams. | |
fibers_int | string | true | Specifies the Solr query for the recipe fibers amount in grams. | |
salt_int | string | true | Specifies the Solr query for the recipe salt amount in milligram. | |
persons_int | string | true | Specifies the Solr query for the recipe serving size. | |
total_time_int | string | true | Specifies the Solr query for the recipe preparation time. | |
preparation_time_int | string | true | Specifies the Solr query for the recipe preparation time in minutes. | |
rating_average_int | string | true | Specifies the Solr query for the recipe average rating from 1 to 10 (or 0 for no rating). | |
view_count_int | string | true | Specifies the Solr query for the recipe total view count. | |
status_id | string | true | Specifies the Solr query for the recipe activation status. | |
status_str | string | true | Specifies the Solr query for the recipe activation status. | |
difficulty_id | string | true | Specifies the Solr query for the recipe difficulty. | |
difficulty_str | string | true | Specifies the Solr query for the recipe difficulty. | |
difficulty_multi_id | string | true | Specifies the Solr query for the recipe difficulties. | |
difficulty_multi_str | string | true | Specifies the Solr query for the recipe difficulties. | |
course_multi_id | string | true | Specifies the Solr query for the recipe menu courses. | |
course_multi_str | string | true | Specifies the Solr query for the recipe menu courses. | |
kitchen_multi_id | string | true | Specifies the Solr query for the recipe kitchen types. | |
kitchen_multi_str | string | true | Specifies the Solr query for the recipe kitchen types. | |
mainingredient_multi_id | string | true | Specifies the Solr query for the recipe mainingredient types. | |
mainingredient_multi_str | string | true | Specifies the Solr query for the recipe mainingredient types. | |
magazine_multi_id | string | true | Specifies the Solr query for the recipe published magazines. | |
magazine_multi_str | string | true | Specifies the Solr query for the recipe published magazines. | |
tag_multi_id | string | true | Specifies the Solr query for the recipe tags. | |
tag_multi_str | string | true | Specifies the Solr query for the recipe tags. | |
ingredient_multi_id | string | true | Specifies the Solr query for the recipe ingredients. | |
ingredient_multi_str | string | true | Specifies the Solr query for the recipe ingredients. | |
wine_multi_id | string | true | Specifies the Solr query for the recipe wine advices. | |
wine_multi_str | string | true | Specifies the Solr query for the recipe wine advices. | |
not_ids_str | string | true | Specifies the Solr query to exclude recipes with the given id's | |
ids_str | string | true | Specifies the Solr query to include recipes with the given id's | |
query | string | true | Specifies the Solr query to execute |
Status Code | Description |
---|---|
200 |
|
403 |
|
422 |
|
Search recipes using a raw SOLR query
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
page | integer | false | Sets the page to return for multi-paged result sets. | |
items_per_page | integer | false | Sets the number of recipes per page for multi-paged result sets. Default: 15. | |
sort_fields | string | true | Determines the ordering of the results. Example: 'kcal_int desc, created_date desc'. | |
return_facets | string | false | Determines if facets are included in the result set ('true') or not ('false'). Default: false. Unless either 'facet_fields' or 'facet_ranges' are specified, a default set of facets is returned. | |
facet_sort | choice | false | {"index":0,"count":1} | Determines the ordering of the facet field constraints: 'count' to sort by count (highest first) or 'index' to sort alphabetically. Default: 'index'. |
facet_limit | integer | true | Indicates the maximum number of constraint counts that should be returned for the facet fields. Default: all facets. | |
facet_min_count | integer | true | Indicates the minimum counts for facet fields that should be included in the response. Default: 0. | |
facet_fields | string | true | Specifies a non-default list of facet fields that should be included in the response. Example: 'kitchen_multi_str, difficulty_str'. | |
facet_ranges | string | true | Specifies a non-default list of ranged facet fields that should be included in the response. Example: 'kcal_int, protein_int'. | |
query | string | true | Specifies the Solr query to execute | |
full_text | string | true | Appends a full text search to the end of the specified query |
Status Code | Description |
---|---|
200 |
|
403 |
|
422 |
|
Register a rating for a recipe
Name | Requirement | Type | Description |
---|---|---|---|
id | integer |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
rating | integer | true |
Parameter | Type | Versions | Description |
---|---|---|---|
id | integer | * | |
recipe_id | integer | * | |
channel | object (Channel) | * | |
channel[id] | integer | * | |
channel[name] | string | * | |
rating | integer | * | |
timestamp | DateTime | * |
Status Code | Description |
---|---|
200 |
|
403 |
|
404 |
|
422 |
|
Suggest related recipes.
Name | Requirement | Type | Description |
---|---|---|---|
id |
Name | Information | ||||||
---|---|---|---|---|---|---|---|
max |
|
||||||
full_information |
|
Status Code | Description |
---|---|
200 |
|
403 |
|
Register a view for a recipe
Name | Requirement | Type | Description |
---|---|---|---|
id | integer |
Parameter | Type | Versions | Description |
---|---|---|---|
recipe_id | integer | * | |
channel | object (Channel) | * | |
channel[id] | integer | * | |
channel[name] | string | * | |
views | integer | * |
Status Code | Description |
---|---|
200 |
|
403 |
|
404 |
|
422 |
|
Suggest recipes based on personal preferences
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
user_id | integer | true | Sets the userid for the current channel | |
channel_id | integer | true | Sets the current channel | |
page | integer | false | Sets the page to return for multi-paged result sets. | |
items_per_page | integer | false | Sets the number of recipes per page for multi-paged result sets. Default: 15. | |
sort_fields | string | true | Determines the ordering of the results. Example: 'kcal_int desc, created_date desc'. | |
return_facets | string | false | Determines if facets are included in the result set ('true') or not ('false'). Default: false. Unless either 'facet_fields' or 'facet_ranges' are specified, a default set of facets is returned. | |
facet_sort | choice | false | {"index":0,"count":1} | Determines the ordering of the facet field constraints: 'count' to sort by count (highest first) or 'index' to sort alphabetically. Default: 'index'. |
facet_limit | integer | true | Indicates the maximum number of constraint counts that should be returned for the facet fields. Default: all facets. | |
facet_min_count | integer | true | Indicates the minimum counts for facet fields that should be included in the response. Default: 0. | |
facet_fields | string | true | Specifies a non-default list of facet fields that should be included in the response. Example: 'kitchen_multi_str, difficulty_str'. | |
facet_ranges | string | true | Specifies a non-default list of ranged facet fields that should be included in the response. Example: 'kcal_int, protein_int'. | |
full_text | string | true | Specifies the Solr query for the title, subtitle, ingredients and preparations text fields. | |
ingredient_text | string | true | Specifies the Solr query for the ingredient text fields. | |
mainingredient_text | string | true | Specifies the Solr query for the mainingredient text fields. | |
created_date | string | true | Specifies the Solr query for the recipe creation date. | |
updated_date | string | true | Specifies the Solr query for the recipe update date. | |
kcal_int | string | true | Specifies the Solr query for the recipe number of kilocalories. | |
fat_int | string | true | Specifies the Solr query for the recipe fat amount in grams. | |
saturated_fat_int | string | true | Specifies the Solr query for the recipe saturated fat amount in grams. | |
carbs_int | string | true | Specifies the Solr query for the recipe carbohydrate amount in grams. | |
protein_int | string | true | Specifies the Solr query for the recipe protein amount in grams. | |
fibers_int | string | true | Specifies the Solr query for the recipe fibers amount in grams. | |
salt_int | string | true | Specifies the Solr query for the recipe salt amount in milligram. | |
persons_int | string | true | Specifies the Solr query for the recipe serving size. | |
total_time_int | string | true | Specifies the Solr query for the recipe preparation time. | |
preparation_time_int | string | true | Specifies the Solr query for the recipe preparation time in minutes. | |
rating_average_int | string | true | Specifies the Solr query for the recipe average rating from 1 to 10 (or 0 for no rating). | |
view_count_int | string | true | Specifies the Solr query for the recipe total view count. | |
status_id | string | true | Specifies the Solr query for the recipe activation status. | |
status_str | string | true | Specifies the Solr query for the recipe activation status. | |
difficulty_id | string | true | Specifies the Solr query for the recipe difficulty. | |
difficulty_str | string | true | Specifies the Solr query for the recipe difficulty. | |
difficulty_multi_id | string | true | Specifies the Solr query for the recipe difficulties. | |
difficulty_multi_str | string | true | Specifies the Solr query for the recipe difficulties. | |
course_multi_id | string | true | Specifies the Solr query for the recipe menu courses. | |
course_multi_str | string | true | Specifies the Solr query for the recipe menu courses. | |
kitchen_multi_id | string | true | Specifies the Solr query for the recipe kitchen types. | |
kitchen_multi_str | string | true | Specifies the Solr query for the recipe kitchen types. | |
mainingredient_multi_id | string | true | Specifies the Solr query for the recipe mainingredient types. | |
mainingredient_multi_str | string | true | Specifies the Solr query for the recipe mainingredient types. | |
magazine_multi_id | string | true | Specifies the Solr query for the recipe published magazines. | |
magazine_multi_str | string | true | Specifies the Solr query for the recipe published magazines. | |
tag_multi_id | string | true | Specifies the Solr query for the recipe tags. | |
tag_multi_str | string | true | Specifies the Solr query for the recipe tags. | |
ingredient_multi_id | string | true | Specifies the Solr query for the recipe ingredients. | |
ingredient_multi_str | string | true | Specifies the Solr query for the recipe ingredients. | |
wine_multi_id | string | true | Specifies the Solr query for the recipe wine advices. | |
wine_multi_str | string | true | Specifies the Solr query for the recipe wine advices. | |
not_ids_str | string | true | Specifies the Solr query to exclude recipes with the given id's | |
ids_str | string | true | Specifies the Solr query to include recipes with the given id's |
Status Code | Description |
---|---|
200 |
|
403 |
|
422 |
|
Suggest recipes based on popularity in the last n days.
Name | Information | ||||||
---|---|---|---|---|---|---|---|
max |
|
||||||
days |
|
||||||
filter_tags |
|
Status Code | Description |
---|---|
200 |
|
403 |
|
Documentation auto-generated on Thu, 14 Nov 24 14:18:08 +0000