НазначениеСоздание зала в ресторане
PluggetSystemTypeRKRef

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

{
  "taskType": "CreateHall",
  "params": {
    "sync": {
      "objectId": number,
       "timeout": number
    },
    "guid": "guid",
    "name": "string"
  }
}

ПараметрТипОбязательныйОписаниеЗначение по умолчанию
taskTypestringдаТип задачи
sync

Синхронный вызов метода (либо синхронный, либо асинхронный)
  • objectId
intдаКод ресторана в системе лицензирования
  • timeout
int-Время ожидания ответа в секундах120 секунд
guidguidдаGuid нового зала
namestringдаНаименование зала

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

{
    "taskResponse": {
        "isOk": true,
        "hall": {
            "name": "string",
            "id": number,
            "status": "string"
        }
    },
    "responseCommon": {
        "taskGuid": "58cc115d-86ca-41ec-aea4-140aa7095bad",
        "taskType": "CreateTable",
        "objectId": 199990246,
        "agentGuid": "d564619a-50c3-3d87-0816-de67ed9c8e18"
    }
}

ПараметрТипОписание
responseCommonobjectИнформация по задаче
  • taskGuid
guidУникальный код этой задачи используется при получении задачи через очередь
  • taskType
stringТип задачи
  • objectId
intКод ресторана в системе лицензирования
taskResponseobject
  • isOk
boolСтол создан или нет 
  • hall
objectСозданный зал
    • name
stringНаименование зала. 
    • id
numberИдентификатор зала. 
    • status
stringСтатус зала в RKeeper
errorobjectКонтейнер ошибок, см Описание ошибок

Пример запроса

{
  "taskType": "CreateHall",
  "params": {
      "sync": {
        "objectId": {{ObjectId}},
         "timeout": 120
      },
      "guid": "6de2415e-9492-4d86-81b3-6713ba4b2221",
      "name": "Зал тест"  
  }
}

Пример успешного ответа

{
    "taskResponse": {
        "isOk": true,
        "hall": {
            "name": "Зал тест",
            "id": 1000125,
            "status": "Active"
        }
    },
    "responseCommon": {
        "taskGuid": "36946a1c-05a9-4977-b30c-63964ee4834c",
        "taskType": "CreateHall",
        "objectId": 199990246,
        "agentGuid": "d564619a-50c3-3d87-0816-de67ed9c8e18"
    }
}

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

{
    "taskResponse": {
        "isOk": false,
        "error": "Зал с Guid = {6DE2415E-9492-4D86-81B3-6713BA4B2221} уже существует",
        "hall": {
            "name": "Зал тест",
            "id": 1000125,
            "status": "Active"
        }
    },
    "responseCommon": {
        "taskGuid": "075874bb-0e07-42f8-9aa1-51e49318afa0",
        "taskType": "CreateHall",
        "objectId": 199990246,
        "agentGuid": "d564619a-50c3-3d87-0816-de67ed9c8e18"
    }
}

Или

{
    "responseCommon": {
        "taskGuid": "2c34931e-730b-48b4-a2d0-ec8a370fd1d1",
        "taskType": "CreateHall",
        "objectId": 199990246
    },
    "error": {
        "wsError": {
            "code": "Request is restricted",
            "desc": "Запрос CreateHall не разрешен настройками ресторана"
        }
    }
}