Назначение | Получить информацию по ресторану |
---|
Тип запроса | Асинхронный/синхронный |
---|
Поддерживаемая версия агента | v2 |
---|
PluggetSystemType | RKMid |
---|
Формат запроса
{
"taskType": "GetRestaurantInfo",
"params": {
"async": {
"objectId": number,
"timeout": number
},
"sync": {
"objectId": number,
"timeout": number
},
}
}
JSON
Параметр | Тип | Обязательный | Описание |
---|
taskType | string | да | Тип задачи |
-async |
|
| Асинхронный вызов метода: либо синхронный, либо асинхронный |
-sync |
|
| Синхронный вызов метода: либо синхронный, либо асинхронный |
--timeout | int | нет | Время ожидания ответа от агента в секундах, по умолчанию — 120 секунд |
--objectId | int | да | Код ресторана в системе лицензирования |
Формат синхронного ответа
{
"responseCommon":{
"taskGuid":"guid",
"taskType":"GetRestaurantInfo",
"objectId": 0
},
"error":{
"wsError":{
"code":"string",
"desc":"string"
}
}
}
JSON
Параметр | Тип | Описание |
---|
-taskGuid | guid | Уникальный код этой задачи. Используется при получении задачи через очередь |
-taskType | string enum | Тип задачи |
-objectId | int | Код ресторана в системе лицензирования |
error |
| Контейнер ошибок, подробнее читайте в статье Описание ошибок |
Формат асинхронного ответа
Успешный ответ
{
"taskResponse": {
"restaurant": {
"guid": "guid",
"name": "string",
"halls": [
{
"guid": "guid",
"name": "string",
"tables":[
"guid": "guid",
"code": 0,
"name": "string",
"seatsCount": 0
]
}
]
}
},
"responseCommon": {
"taskGuid": "string",
"taskType": "GetRestaurantInfo",
"objectId": 0
}
}
JSON
Ответ с ошибкой
{
"responseCommon": {
"taskGuid": "string",
"taskType": "GetRestaurantInfo",
"objectId": 0
},
"error": {
"wsError": {
"code": "string",
"extCode": "string",
"desc": "string"
},
"agentError": {
"code": "string",
"desc": "string"
}
}
}
JSON
Параметр | Тип | Описание |
---|
-restaurant |
| Описание ресторана |
--guid | guid | UUID ресторана |
--name | string | Название ресторана |
--halls |
| Список залов |
---guid | guid | UUID зала |
---name | string | Название зала |
---tables |
| Список столов |
----guid | guid | UUID стола |
----code | int | Код стола |
----name | string | Название стола |
----seatsCount | int | Количество мест за столом |
error | string enum | Контейнер ошибок, подробнее читайте в статье Описание ошибок |