CreateHall

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

ФОРМАТ ЗАПРОСА

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

Запрос

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

CODE

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

ФОРМАТ ОТВЕТА

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

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

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

CODE

Ответ с ошибкой при создании зала

{
    "taskResponse": {
        "isOk": false,
        "error": "Зал с Guid = {guid} уже существует",
        "hall": {
            "name": "string",
            "id": "string",
            "status": "string"
        }    
    },
    "responseCommon": {
        "taskGuid": "075874bb-0e07-42f8-9aa1-51e49318afa0",
        "taskType": "CreateHall",
        "objectId": 199990246,
        "agentGuid": "d564619a-50c3-3d87-0816-de67ed9c8e18"
    }
}

CODE

Ответ с ошибкой. Ошибка агента или сервера

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

CODE

Параметр

Тип

Описание

responseCommon

object

Информация по задаче

taskGuid

guid

Уникальный код этой задачи используется при получении задачи через очередь

taskType

string

Тип задачи

objectId

int

Код ресторана в системе лицензирования

taskResponse

object

isOk

bool

Стол создан или нет

hall

object

Созданный зал

- name

string

Наименование зала.

- id

number

Идентификатор зала.

- status

string

Статус зала в r_keeper

error

object

Контейнер ошибок, см Описание ошибок

wsError		Ошибка от сервера
agentError		Ошибка от агента

ПРИМЕРЫ СТРУКТУРЫ ЗАПРОСОВ

Примеры структуры запросов

{
  "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 не разрешен настройками ресторана"
        }
    }
}