CreateDishCategory

Назначение	Создание категории блюд
PluggetSystemType	RKRef

Формат запроса

{
  "taskType": "CreateDishCategory",
  "params": {
    "sync": {
      "objectId": number,
       "timeout": number
    },
    "guid": "guid",
    "name": "string",
    "menuGroupId": number
   }
}

Параметр	Тип	Обязательный	Описание	Значение по умолчанию
taskType	string	да	Тип задачи
sync			Синхронный вызов метода (либо синхронный, либо асинхронный)
objectId	int	да	Код ресторана в системе лицензирования
timeout	int	-	Время ожидания ответа в секундах	120 секунд
guid	guid	да	Guid новой категории
name	string	да	Наименование категории
menuGroupId	number	нет	Идентификатор группы (категории) меню в которую будет добавлена новая категория (categories.id из GetMenu/GetMenuByParams) Если не указан, категория создается в корне дерева категорий

Формат ответа

{
    "taskResponse": {
        "isOk": true,
        "category": {
            "name": "string",
            "id": number,
            "status": "string"
        }
    },
    "responseCommon": {
        "taskGuid": "58cc115d-86ca-41ec-aea4-140aa7095bad",
        "taskType": "CreateDishCategory",
        "objectId": 199990246,
        "agentGuid": "d564619a-50c3-3d87-0816-de67ed9c8e18"
    }
}

Параметр	Тип	Описание
responseCommon	object	Информация по задаче
taskGuid	guid	Уникальный код этой задачи используется при получении задачи через очередь
taskType	string	Тип задачи
objectId	int	Код ресторана в системе лицензирования
taskResponse	object
isOk	bool	Блюдо создан или нет
category	object	Созданная категория
name	string	Наименование категории.
id	number	Идентификатор категории.
status	string	Статус в RKeeper
error	object	Контейнер ошибок, см Описание ошибок

Пример запроса

{
  "taskType": "CreateDishCategory",
  "params": {
  "sync": {
  "objectId": {{ObjectId}},
"timeout": 120
},
  "guid": "6de2415e-9492-4d86-81b3-6713ba3b2225",
  "name": "Тест кат"
}
}

Пример успешного ответа

{
  "taskResponse": {
  "isOk": true,
  "category": {
  "name": "Тест кат",
  "id": 1000139,
  "status": "Active"
}
},
  "responseCommon": {
  "taskGuid": "51a32873-9c91-471d-a567-42079e6992be",
  "taskType": "CreateDishCategory",
  "objectId": 199990246,
  "agentGuid": "d564619a-50c3-3d87-0816-de67ed9c8e18"
}
}

Пример ответа с ошибкой

{
  "taskResponse": {
  "isOk": false,
  "error": "Категория с Guid = {6DE2415E-9492-4D86-81B3-6713BA3B2235} уже существует",
  "category": {
  "name": "Тест кат in",
  "id": 1000138,
  "status": "Active"
}
},
  "responseCommon": {
  "taskGuid": "c59892a3-1733-4d14-9212-08656c19f51f",
  "taskType": "CreateDishCategory",
  "objectId": 199990246,
  "agentGuid": "d564619a-50c3-3d87-0816-de67ed9c8e18"
}
}

Пример ответа с ошибкой (Запрет в админке)

{
  "responseCommon": {
  "taskGuid": "49d436b5-b687-4241-bd1e-252c0165de92",
  "taskType": "CreateDishCategory",
  "objectId": 199990246
},
  "error": {
  "wsError": {
  "code": "Request is restricted",
  "desc": "Запрос CreateDishCategory не разрешен настройками ресторана"
}
}
}