ExecuteRk7Query

Ответ с ошибкой

Назначение	Выполнить произвольный XML запрос на кассе
Тип запроса	асинхронный/синхронный
Поддерживаемая версия агента	v1, v2
PluggetSystemType	RKMid

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

{
  "taskType": "ExecuteRk7Query",
  "params": {
    "async": {
      "objectId": number,
       "timeout": number
    },
    "sync": {
      "objectId": number,
       "timeout": number
    },
    "base64": "string"
  }
}

JSON

Параметр	Тип	Обязательный	Описание
taskType	string	да	Тип задачи, для данного метода — значение ExecuteRk7Query
-async			Асинхронный вызов метода: либо синхронный, либо асинхронный
-sync			Синхронный вызов метода: либо синхронный, либо асинхронный
--timeout	int	нет	Время ожидания ответа от агента в секундах, по умолчанию 120 секунд
--objectId	int	да	Код ресторана в системе лицензирования
-base64	string	да	Текст запроса в xml — это вся нода RK7Query, которую необходимо перевести в кодировку base64. Для тестов это можно сделать любым онлайн-сервисом. В административной панели White Server текст запроса будет отображаться в обоих вариантах — оригинал и закодированный в base64. Пример запроса: Xml оригинал текст: `<?xml version="1.0" encoding="UTF-8"?> <RK7Query> <RK7CMD CMD="GetSystemInfo"/> </RK7Query>` JSON Xml в кодировке base64: `PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4NCjxSSzdRdWVyeT4NCiAgCQk8Uks3Q01EIENNRD0iR2V0U3lzdGVtSW5mbyIvPg0KPC9SSzdRdWVyeT4NCg==` CODE

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

{ 
   "responseCommon":{ 
      "taskGuid":"guid",
      "taskType":"ExecuteRk7Query",
      "objectId": 0
   },
   "error":{ 
      "wsError":{ 
         "code":"string",
         "desc":"string"
      }
   }
}

JSON

Параметр	Тип	Описание
-taskGuid	guid	Уникальный код этой задачи, используется при получении задачи через очередь
-taskType	string enum	Тип задачи
-objectId	int	Код ресторана в системе лицензирования
error		Контейнер ошибок, подробнее читайте в статье Описание ошибок

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

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

{
  "taskResponse": {
     "base64": {
     }
  },
  "responseCommon": {
    "taskGuid": "string",
    "taskType": "ExecuteRk7Query",
    "objectId": 0
  },
  "error": {
    "wsError": {
      "code": "string",
      "extCode": "string",
      "desc": "string"
    },
    "agentError": {
      "code": 0,
      "text": "string"
    }
  }
}

JSON

Ответ с ошибкой:

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

JSON

Параметр

Тип параметра

Обязательный

Описание

-base64

string

да

В административной панели White Server текст запроса будет отображаться в обоих вариантах: в оригинале и закодированный в base64.

Пример ответа:

Xml оригинал текст:

<?xml version="1.0" encoding="UTF-8"?>
  <RK7QueryResult ServerVersion="7.6.2.203" XmlVersion="244" NetName="5826_MIDSERV" Status="Ok" CMD="GetSystemInfo" ErrorText="" DateTime="2019-10-01T15:14:28" WorkTime="0" Processed="1">
  <SystemInfo SystemTime="3779104468231" ReqSysVer="2" NetName="5826_MIDSERV" ProcessID="3052" CashServerVersion="7.6.2.203" ShiftDate="20190930" RestCode="199995826">
    <BusinessPeriod id="0" code="0" />
    <CashGroup id="15007" code="15007" name="5826_MIDSERV" />
    <Restaurant id="1" code="5826" name="Ресторан "Стенд"" />
  </SystemInfo>
</RK7QueryResult>

XML

Xml в кодировке base64:

YXVyYW50IGlkPSIxIiBjb2RlPSI1ODI2IiBuYW1lPSLvv73vv73vv73vv73vv73vv73vv73vv70gJnF1b3Q777+977+977+977+977+9JnF1b3Q7IiAvPg0KICAgIDwvU3lzdGVtSW5mbz4NCjwvUks3UXVlcnlSZXN1bHQ+

CODE

error string enum Контейнер ошибок, подробнее читайте в статье Описание ошибок