Поиск элементов Сборника рецептур
Рекомендуем использовать метод совместно с GET /recipes/element/{$id}/products/. Это позволит предоставить пользователю дополнительную информацию при выборе блюда, свойства которого нужно загрузить.
Для поиска элементов Сборника рецептур по названию используется метод GET /recipes/search/.
Обратите внимание!
В запросе может использоваться постраничная навигация.
Параметры запроса GET
| Параметр | Обязательно | Описание |
|---|---|---|
| token | Да | Текущий токен. |
| name | Название элемента. | |
| national_cuisine | ID национальной кухни (можно указать несколько ID через запятую). Получить список национальных кухонь можно с использованием метода GET /nationalcuisine/elements/ | |
| keywords | ID ключевого слова, связанного с продуктом, который входит в состав блюда (можно указать несколько ID через запятую). Получить список ключевых слов можно с использованием метода GET /products/keywords/elements/ | |
| Постраничная навигация | ||
| page | Номер запрашиваемой страницы | |
| limit | Количество элементов на странице. По умолчанию — 15, максимальное количество элементов 45. | |
Пример запроса GET
GET /api/1.0/recipes/search/?token=3fca2c2f88d821fd1592b842713d1093&name=винегрет&free=&health_food=&school_food=&lenten=&national_cuisine=&pc= HTTP/1.1
Host: foodcost.pro
Параметры ответа
| Свойства | Описание | Значения | |
|---|---|---|---|
| status | Статус ответа на запрос | success/error | |
| pagenavigation | Постраничная навигация | ||
| num_page | порядковый номер текущей страницы |
|
|
| count_page | общее количество страниц |
|
|
| rows | общее количество элементов в списке |
|
|
| limit | количество элементов на странице |
|
|
| row | Массив с результатами поиска | ||
| fc_id | уникальный идентификатор элемента | ||
| name | название элемента | ||
| description | описание элемента | ||
| w_general | масса общая готового блюда, выход (г) | ||
| w_main | масса основного продукта в готовом блюде (г) | ||
| w_garnish | масса гарнира в граммах в готовом блюде (г) | ||
| w_sauce | масса соуса/дополнительного продукта в готовом блюде (г) | ||
| token | Новый токен | ||
Правило записи выхода блюд
Если в процессе приготовления продукты перемешиваются, то выход указывается одним числом: Винегрет с маслом 150 г, где 150 — weight_general — общая масса готового блюда.
Если ингредиенты в блюде располагаются отдельно, тогда выход каждого необходимо писать раздельно: Борщ Малороссийский с говядиной 15/250/10, где 15 — weight_main — масса основного продукта (говядина), 250 — weight_garnish — масса гарнира (борщ), 10 — weight_sauce — масса соуса или других продуктов (сметана).
Пример ответа в формате JSON
Обратите внимание!
При выводе результатов используется постраничная навигация.
{
"status": "success",
"pagenavigation": {
"num_page": 1,
"count_page": 1,
"rows": 2,
"limit": 15
},
"rows": [
{
"fc_id": "125677",
"name": "Винегрет с маслом, заготовка",
"description": "Заготовка овощного винегрета с растительным маслом"
},
{
"fc_id": "445196",
"name": "Винегрет с маслом",
"description": "Овощной винегрет с растительным маслом"
}
],
"token": 3fca2c2f88d821fd1592b842713d1093
}
Обратите внимание!
Для доступа к Справочнику продуктов потребуется токен. Не забудьте перезаписать записать новый токен!
Коды ошибок
| Код | Текст ошибки | Причины |
|---|---|---|
| 3 | Request method does not supported | Используется неправильный метод запроса |
| 1000 | Неверный token. Обратитесь в техническую поддержку. | Токен указан неверно. Для решения проблемы следует обратиться в техническую поддержку. |
