CreateDishExtProperty
| Назначение | Создание расширенного свойства для блюд (меню) |
|---|---|
| PluggetSystemType | RKRef |
Формат запроса
{
"taskType": "CreateDishExtProperty",
"params": {
"sync": {
"objectId": number,
"timeout": number
},
"name": "string",
"code": "string"
}
}
| Параметр | Тип | Обязательный | Описание | Значение по умолчанию |
|---|---|---|---|---|
| taskType | string | да | Тип задачи | |
| sync | Синхронный вызов метода (либо синхронный, либо асинхронный) | |||
| int | да | Код ресторана в системе лицензирования | |
| int | - | Время ожидания ответа в секундах | 120 секунд |
| name | string | да | Наименование расширенного свойства | |
| code | string | да | Код (Системное имя) расширенного свойства |
Формат ответа
{
"taskResponse": {
"isOk": true,
"extProperty": {
"name": "string",
"code": "string",
"status": "string"
}
},
"responseCommon": {
"taskGuid": "58cc115d-86ca-41ec-aea4-140aa7095bad",
"taskType": "CreateDishExtProperty",
"objectId": 199990246,
"agentGuid": "d564619a-50c3-3d87-0816-de67ed9c8e18"
}
}
| Параметр | Тип | Описание |
|---|---|---|
| responseCommon | object | Информация по задаче |
| guid | Уникальный код этой задачи используется при получении задачи через очередь |
| string | Тип задачи |
| int | Код ресторана в системе лицензирования |
| taskResponse | object | |
| bool | Стол создан или нет |
| object | Расширенное свойство |
| string | Наименование расширенного свойства |
| string | Код (Системное имя) расширенного свойства |
| error | object | Контейнер ошибок, см Описание ошибок |
Пример запроса
{
"taskType": "CreateDishExtProperty",
"params": {
"sync": {
"objectId": {{ObjectId}},
"timeout": 120
},
"name": "Тестовое расширенное свойство для блюд",
"code": "test1"
}
}
Пример успешного ответа
{
"taskResponse": {
"isOk": true,
"extProperty": {
"name": "Тестовое расширенное свойство для блюд",
"code": "test1",
"status": "Active"
}
},
"responseCommon": {
"taskGuid": "321ccba0-f988-44f4-9215-76f3e1654b02",
"taskType": "CreateDishExtProperty",
"objectId": 199990246,
"agentGuid": "d564619a-50c3-3d87-0816-de67ed9c8e18"
}
}
Пример ответа с ошибкой
{
"taskResponse": {
"isOk": false,
"error": "Расширенное свойство с кодом = test1 уже существует",
"extProperty": {
"name": "Тестовое расширенное свойство для блюд",
"code": "test1",
"status": "Active"
}
},
"responseCommon": {
"taskGuid": "9f13a753-74a1-4d1c-bf51-175252336f59",
"taskType": "CreateDishExtProperty",
"objectId": 199990246,
"agentGuid": "d564619a-50c3-3d87-0816-de67ed9c8e18"
}
}
Пример ответа с ошибкой при запрете в админке
{
"responseCommon": {
"taskGuid": "d436d102-a96e-4a73-a5d4-3ed6863e6a1c",
"taskType": "CreateDishExtProperty",
"objectId": 199990246
},
"error": {
"wsError": {
"code": "Request is restricted",
"desc": "Запрос CreateDishExtProperty не разрешен настройками ресторана"
}
}
}