Описание


НазначениеПолучить стоп лист из ресторана
Тип запросаАсинхронный

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

{
  "taskType": "GetStopList",
  "params": {
    "async": {
      "objectId": 0,
      "timeout": 0
    }
  }
}

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

ПараметрТипОбязательныйОписание
taskType

Тип задачи
async

Асинхронный метод
timeoutint-Время ожидания ответа от агента в секундах, по умолчанию 120 секунд
objectIdint+Код ресторана в системе лицензирования


Формат ответа

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


ПараметрТипОписание
taskGuidguidУникальный код этой задачи используется при получении задачи через очередь
taskTypestring enumТип задачи
objectIdintКод ресторана в системе лицензирования
error
Контейнер ошибок, внутри детализация по связанным системам
- wsError
Ошибки, получаемые от сервиса WhiteServer
– codestringКод ошибки
– extCodestringРасширенный код ошибки
– descstringОписание ошибки

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

Успешный ответ
{
  "taskResponse": {
     "stopList": {
       "dishes": [
         {
           "id": "string",
           "name": "string",
           "type": "string"
         }
       ]
     }
  },
  "responseCommon": {
    "taskGuid": "string",
    "taskType": "GetStopList",
    "objectId": 0
  }
}
Успешный ответ, но стоп-лист пустой
{
  "taskResponse": {
     "stopList": {
       "dishes": []
     }
  },
  "responseCommon": {
    "taskGuid": "string",
    "taskType": "GetStopList",
    "objectId": 0
  }
}
Ответ с ошибкой
{
  "responseCommon": {
    "taskGuid": "string",
    "taskType": "GetStopList",
    "objectId": 0
  },
  "error": {
    "wsError": {
      "code": "string",
      "extCode": "string",
      "desc": "string"
    },
    "agentError": {
      "code": 0,
      "desc": "string"
    }
  }
}

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


ПараметрТип параметраОбязательныйОписание
taskGuiduuid+Идентификатор запроса
stoplist


- dishesarray
массив элементов в стоп-листе .
– idinteger
Идентификатор блюда
– namestring
Название блюда
– typestring
Тип товара. Возможные варианты: product, ingredient, category (сейчас всегда product)
errorstring enum
Контейнер ошибок, внутри детализация по связанным системам
- wsErrorstring enum
Ошибка Whiteserver
– codestring
Код ошибки
– extCodestring
Расширенный код ошибки
– descstring
Описание ошибки
- agentErrorstring enum
Ошибка Агента
– codeint
Код ошибки
– descstring
Описание ошибки

Примеры

Запрос

{
  "taskType": "GetStopList",
  "params": {
    "async": {
      "objectId": 199990106,
      "timeout": 60
    }
  }
}

Синхронный ответ

{
  "responseCommon": {
    "taskGuid": "fa1bdcbf-1e96-425c-9159-eb57d4accb6f",
    "taskType": "GetStopList",
    "objectId": 199990106
  },
  "responseSync": "QueuedSuccess"
}

Асинхронный ответ успешный

{
  "stopList": {
    "dishes": [
      {
        "id": "1000021",
        "name": "Гречневая каша",
        "type": "product"
      },
      {
        "id": "1000019",
        "name": "Чай",
        "type": "product"
      }
    ]
  },
  "responseCommon": {
    "taskGuid": "fe5633c8-ee7d-4ef5-ab98-8ff9e98adbdc",
    "taskType": "GetStopList",
    "objectId": 199990106
  }
}

Асинхронный ответ с ошибкой

{
  "responseCommon": {
    "taskGuid": "fa1bdcbf-1e96-425c-9159-eb57d4accb6f",
    "taskType": "GetStopList",
    "objectId": 199990106
  },
  "error": {
    "agentError": {
      "code": 82,
      "desc": "Нет доступа к основной системе (Rk7)"
    }
  }
}