UpdateMenu
Описание
| Назначение | Запрос на ручное обновление меню |
| Тип запроса | Асинхронный |
Формат запроса
{
"taskType": "UpdateMenu",
"params": {
"async": {
"objectId": 0,
"timeout": 0
}
}
}Описание параметров
Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| taskType | Тип задачи | ||
| async | Асинхронный метод | ||
| timeout | int | - | Время ожидания ответа от агента в секундах, по умолчанию 120 секунд |
| objectId | int | + | Код ресторана в системе лицензирования |
Формат ответа
{
"responseCommon":{
"taskGuid":"guid",
"taskType":"UpdateMenu",
"objectId":"int"
},
"error":{
"wsError":{
"code":"string",
"extCode":"string",
"desc":"string"
}
}
}Параметр | Тип | Описание |
|---|---|---|
| taskGuid | guid | Уникальный код этой задачи используется при получении задачи через очередь |
| taskType | string enum | Тип задачи |
| objectId | int | Код ресторана в системе лицензирования |
| error | Контейнер ошибок, внутри детализация по связанным системам | |
| - wsError | Ошибки, получаемые от сервиса WhiteServer | |
| – code | string | Код ошибки |
| – extCode | string | Расширенный код ошибки |
| – desc | string | Описание ошибки |
Формат асинхронного ответа
Успешный ответ
{
"taskResponse": {
"status": "string"
},
"responseCommon": {
"taskGuid": "string",
"taskType": "UpdateMenu",
"objectId": 0
}
}Ответ с ошибкой
{
"responseCommon": {
"taskGuid": "string",
"taskType": "UpdateMenu",
"objectId": 0
},
"error": {
"wsError": {
"code": "string",
"extCode": "string",
"desc": "string"
},
"agentError": {
"code": "string",
"desc": "string"
}
}
}Описание параметров
Параметр | Тип параметра | Обязательный | Описание |
|---|---|---|---|
| taskGuid | uuid | + | Идентификатор запроса |
| status | string | Может быть только значение Updated, иначе вернется ошибка | |
| error | string enum | Контейнер ошибок, внутри детализация по связанным системам | |
| - wsError | string enum | Ошибка Whiteserver | |
| – code | string | Код ошибки | |
| – extCode | string | Расширенный код ошибки | |
| – desc | string | Описание ошибки | |
| - agentError | string enum | Ошибка Агента | |
| – code | string | Код ошибки | |
| – desc | string | Описание ошибки |
Примеры
Запрос
{
"taskType": "UpdateMenu",
"params": {
"async": {
"objectId": 199990106,
"timeout": 60
}
}
}Синхронный ответ
{
"responseCommon": {
"taskGuid": "fa1bdcbf-1e96-425c-9159-eb57d4accb6f",
"taskType": "UpdateMenu",
"objectId": 199990106
},
"responseSync": "QueuedSuccess"
}Асинхронный ответ успешный
{
"taskResponse": {
"status": "updated"
},
"responseCommon": {
"taskGuid": "fe5633c8-ee7d-4ef5-ab98-8ff9e98adbdc",
"taskType": "UpdateMenu",
"objectId": 199990106
}
}Асинхронный ответ с ошибкой
{
"responseCommon": {
"taskGuid": "fa1bdcbf-1e96-425c-9159-eb57d4accb6f",
"taskType": "UpdateMenu",
"objectId": 199990106
},
"error": {
"agentError": {
"code": 82,
"desc": "Нет доступа к основной системе (Rk7)"
}
}
}