GetStopList

Описание

Назначение	Получить список ограниченных блюд и стоп-листа
Тип запроса	Синхронный / асинхронный
Поддерживаемая версия агента	v1, v2
PluggetSystemType	RKMid

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

{
  "taskType": "GetStopList",
  "params": {
    "async": {
      "objectId": number,
       "timeout": number
    },
    "sync": {
      "objectId": number,
       "timeout": number
    }
  }
}

CODE

Описание параметров

Параметр	Тип	Обязательный	Описание
taskType	string	да	Тип задачи
async			Асинхронный вызов метода (либо синхронный, либо асинхронный)
sync			Синхронный вызов метода (либо синхронный, либо асинхронный)
objectId	int	да	Код ресторана в системе лицензирования
timeout	int	-	Время ожидания ответа от агента в секундах	120 секунд

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

{ 
   "responseCommon":{ 
      "taskGuid":"guid",
      "taskType":"GetStopList",
      "objectId":number
   },
   "error":{ 
      "wsError":{ 
         "code":"string",
         "desc":"string"
      }
   }
}

CODE

Параметр	Тип	Описание
taskGuid	guid	Уникальный код этой задачи используется при получении задачи через очередь
taskType	string enum	Тип задачи
objectId	int	Код ресторана в системе лицензирования
error		Контейнер ошибок, внутри детализация по связанным системам
- wsError		Ошибки, получаемые от сервиса WhiteServer
– code	string	Код ошибки
– extCode	string	Расширенный код ошибки
– desc	string	Описание ошибки

Формат синхронного ответа

Успешный ответ

{
  "taskResponse": {
     "stopList": {
       "dishes": [
         {
           "id": "string",
           "name": "string",
           "type": "string"
         }
       ]
     },
     "limitedList": {
       "dishes": [
         {
           "id": "string",
           "name": "string",
           "type": "string",
           "quantity": decimal
         }
       ]
     },
     "modifierStopList": {
       "dishes": [
         {
           "id": "string",
           "name": "string",
           "type": "string",
           "quantity": decimal
         }
       ]
     }
},
  "responseCommon": {
    "taskGuid": "string",
    "taskType": "GetStopList",
    "objectId": 0
  }
}

CODE

Успешный ответ, но стоп-лист пустой

{
  "taskResponse": {
     "stopList": {
       "dishes": []
     },
     "limitedList": {
       "dishes": []
     },
     "modifierStopList": {
        "dishes": []
     },
  },
  "responseCommon": {
    "taskGuid": "string",
    "taskType": "GetStopList",
    "objectId": 0
  }
}

CODE

Ответ с ошибкой

{
  "responseCommon": {
    "taskGuid": "string",
    "taskType": "GetStopList",
    "objectId": 0
  },
  "error": {
    "wsError": {
      "code": "string",
      "extCode": "string",
      "desc": "string"
    },
    "agentError": {
      "code": 0,
      "desc": "string"
    }
  }
}

Описание параметров

Параметр	Тип параметра	Обязательный	Описание
taskGuid	guid	+	Идентификатор запроса
stoplist
- dishes	array		Массив элементов в стоп-листе
– id	integer		Идентификатор блюда
– name	string		Название блюда
– type	string		Тип товара. Возможные варианты: product, ingredient, category (сейчас всегда product)
limitedList
- dishes	array		Массив элементов ограниченных блюд
– id	integer		Идентификатор блюда
– name	string		Название блюда
– type	string		Тип товара. Возможные варианты: product, ingredient, category (сейчас всегда product)
– quantity	decimal		Количество остатков. Значения в ед.изм. шт. или кг
modifierStopList		-
-dishes	array		Массив модификаторов в стоп-листе
– id	integer		Идентификатор блюда
– name	string		Название блюда
– type	string		Тип товара. ingredient

{
    "taskResponse": {
        "stopList": {
            "dishes": [
                {
                    "id": "1000057",
                    "name": "Шашлык",
                    "type": "product"
                }
            ]
        },
        "limitedList": {
            "dishes": [
                {
                    "id": "1000016",
                    "name": "Борщ",
                    "type": "product",
                    "quantity": 5
                }
            ]
        },
        "modifierStopList": {
            "dishes": [
                {
                    "id": "1000065",
                    "name": "Сметана",
                    "type": "ingredient"
                }
            ]
        }
    },
    "responseCommon": {
        "taskGuid": "0d4b9052-88f5-4a0b-b468-36d703852c9c",
        "taskType": "GetStopList",
        "objectId": 199990246,
        "agentGuid": "d564619a-50c3-3d87-0816-de67ed9c8e18"
    }
}

CODE

Описание

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

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

Формат синхронного ответа

Успешный ответ

Успешный ответ, но стоп-лист пустой

Ответ с ошибкой

Пример ответа