CreateOrderExtProperty

Назначение	Создание расширенного свойства для заказов
PluggetSystemType	RKRef

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

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

Параметр	Тип	Обязательный	Описание	Значение по умолчанию
taskType	string	да	Тип задачи
sync			Синхронный вызов метода (либо синхронный, либо асинхронный)
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": "CreateOrderExtProperty",
        "objectId": 199990246,
        "agentGuid": "d564619a-50c3-3d87-0816-de67ed9c8e18"
    }
}

Параметр	Тип	Описание
responseCommon	object	Информация по задаче
taskGuid	guid	Уникальный код этой задачи используется при получении задачи через очередь
taskType	string	Тип задачи
objectId	int	Код ресторана в системе лицензирования
taskResponse	object
isOk	bool	Расширенное свойство успешно создано или нет
extProperty	object	Расширенное свойство
name	string	Наименование расширенного свойства
code	string	Код (Системное имя) расширенного свойства
status	string	Статус в RKeeper
error	object	Контейнер ошибок, см Описание ошибок

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

{

"taskType": "CreateOrderExtProperty",

"params": {
  "sync": {
  "objectId": {{ObjectId}},
"timeout": 120
},
  "name": "Тестовое расширенное свойство для заказа",
  "code": "testO"
}
}

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

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

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

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

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

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