PushDishSettings
Назначение | Запрос на редактирование параметров блюда |
---|---|
Тип запроса | Асинхронный/синхронный |
Поддерживаемая версия агента | v1 |
PluggetSystemType | RKRef |
Формат запроса
{
"taskType": "PushDishSettings",
"params": {
"async": {
"objectId": number,
"timeout": number
},
"sync": {
"objectId": number,
"timeout": number
},
"identity": number,
"extProperties": [
{
"name": "string",
"value": "string"
}
]
}
}
JSON
Параметр | Тип | Обязательный | Описание | Значение по умолчанию |
---|---|---|---|---|
taskType | string | да | Тип задачи | |
-async | Асинхронный вызов метода: либо синхронный, либо асинхронный | |||
-sync | Синхронный вызов метода: либо синхронный, либо асинхронный | |||
--objectId | int | да | Код ресторана в системе лицензирования | |
--timeout | int | нет | Время ожидания ответа в секундах | 120 секунд |
-identity | int | да | Идентификатор блюда | |
-extProperties | да | Набор дополнительных свойств для элемента меню в r_keeper | ||
--name | string | да | Имя свойства | |
--value | string | да | Значение свойства |
Расширенное свойство блюда | Описание |
---|---|
PhotoForDelivery | Ссылка на картинку блюда, расширенное свойство блюда |
DescriptionForDelivery | Описание продукта |
DefaultModifierForDelivery | Модификаторы по умолчанию. Указываются идентификаторы модификаторов, которых может быть более одного, разделитель — точка с запятой |
NameForDelivery | Название блюда для доставки |
Формат синхронного ответа
{
"responseCommon":{
"taskGuid":"guid",
"taskType":"PushDishSettings",
"objectId":number
},
"error":{
"wsError":{
"code":"string",
"desc":"string"
}
}
}
JSON
Параметр | Тип | Описание |
---|---|---|
-taskGuid | guid | Уникальный код этой задачи. Используется при получении задачи через очередь |
-taskType | string | Тип задачи |
-objectId | int | Код ресторана в системе лицензирования |
error | Контейнер ошибок, подробнее читайте в статье Описание ошибок |
Формат асинхронного ответа
Успешный ответ
{
"responseCommon": {
"taskGuid": "string",
"taskType": "PushDishSettings",
"objectId": 0
}
}
JSON
Ответ с ошибкой
{
"responseCommon": {
"taskGuid": "string",
"taskType": "PushDishSettings",
"objectId": 0
},
"error": {
"wsError": {
"code": "string",
"desc": "string"
},
"agentError": {
"code": string,
"desc": "string"
}
}
}
JSON
Параметр | Тип параметра | Обязательный | Описание |
---|---|---|---|
taskGuid | guid | да | Идентификатор запроса |
-taskType | string | Тип задачи | |
-objectId | int | Код ресторана в системе лицензирования | |
error | Контейнер ошибок, подробнее читайте в статье Описание ошибок |
Пример запроса
{
"taskType": "PushDishSettings",
"params": {
"async": {
"objectId": 199990000,
"timeout": 20
},
"identity": 1122,
"extProperties": [
{
"name": "NameForDelivery",
"value": "Блюдище"
}
]
}
}
JSON