CreateDishExtProperty

Назначение	Создание расширенного свойства для блюд (меню)
PluggetSystemType	RKRef

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

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

Запрос

{
  "taskType": "CreateDishExtProperty",
  "params": {
    "sync": {
      "objectId": number,
       "timeout": number
    },
    "name": "string",
    "code": "string"
  }
}

CODE

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

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

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

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

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

CODE

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

{
    "taskResponse": {
        "isOk": false,
        "error": "Расширенное свойство с кодом = test1 уже существует",
        "extProperty": {
            "name": "string",
            "code": "string",
            "status": "string"
        }
    },
    "responseCommon": {
        "taskGuid": "9f13a753-74a1-4d1c-bf51-175252336f59",
        "taskType": "CreateDishExtProperty",
        "objectId": 199990246,
        "agentGuid": "d564619a-50c3-3d87-0816-de67ed9c8e18"
    }
}

CODE

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

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

{
  "responseCommon": {
    "taskGuid": "string",
    "taskType": "CreateDishExtProperty",
    "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

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

table

object

Расширенное свойство

- name

string

Наименование расширенного свойства

- code

string

Код (Системное имя) расширенного свойства

error

object

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

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

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

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

{
  "taskType": "CreateDishExtProperty",
  "params": {
      "sync": {
        "objectId": 199990246,
         "timeout": 120
      },
      "name": "Тестовое расширенное свойство для блюд",
      "code": "test1"
  }
}

{
    "taskResponse": {
        "isOk": true,
        "extProperty": {
            "name": "Тестовое расширенное свойство для блюд",
            "code": "test1",
            "status": "Active"
        }
    },
    "responseCommon": {
        "taskGuid": "321ccba0-f988-44f4-9215-76f3e1654b02",
        "taskType": "CreateDishExtProperty",
        "objectId": 199990246,
        "agentGuid": "d564619a-50c3-3d87-0816-de67ed9c8e18"
    }
}

{
    "taskResponse": {
        "isOk": false,
        "error": "Расширенное свойство с кодом = test1 уже существует",
        "extProperty": {
            "name": "Тестовое расширенное свойство для блюд",
            "code": "test1",
            "status": "Active"
        }
    },
    "responseCommon": {
        "taskGuid": "9f13a753-74a1-4d1c-bf51-175252336f59",
        "taskType": "CreateDishExtProperty",
        "objectId": 199990246,
        "agentGuid": "d564619a-50c3-3d87-0816-de67ed9c8e18"
    }
}

{
    "responseCommon": {
        "taskGuid": "d436d102-a96e-4a73-a5d4-3ed6863e6a1c",
        "taskType": "CreateDishExtProperty",
        "objectId": 199990246
    },
    "error": {
        "wsError": {
            "code": "Request is restricted",
            "desc": "Запрос CreateDishExtProperty не разрешен настройками ресторана"
        }
    }
}