1 Описание

НазначениеПолучение информации о подключенных к агенту системах и проверка их доступности (опционально).
Тип запросаАсинхронный

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

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

<?xml version="1.0" encoding="utf-8"?>
<RQ cmd="get_connected_systems" callback="https://ya.ru">
   <PARAM name="object_id" val="int" />
   <PARAM name="CheckConnections" val="boolean"/>
</RQ>

Описание параметров


ПараметрТипОбязательныйОписаниеЗначение по умолчанию
object_idint+Код ресторана в системе лицензирования

CheckConnectionsbool-true/false - Проверить доступ к системе?


2.2 Формат ответа - успех

<?xml version="1.0" encoding="utf-8"?>
<RP taskguid="guid">
<ConnectedSystems>
	<Rk7 IsUsed="boolean" ConnectedType="enum"/>
	<Sh4 IsUsed="boolean" ConnectedType="enum"/>
	<Sh5 IsUsed="boolean" ConnectedType="enum"/>
	<Crm IsUsed="boolean" ConnectedType="enum"/>
	<Sql IsUsed="boolean" ConnectedType="enum"/>
  </ConnectedSystems>
</RP>

Описание параметров

ПараметрТипОписание
taskguidguidGuid запрашиваемой задачи
Rk7boolИнфо о подключении к rk7
Sh4boolИнфо о подключении к sh4
Sh5boolИнфо о подключении к sh5
CrmboolИнфо о подключении к crm
SqlboolИнфо о подключении к msSql
IsUsedboolНастроено ли подключение к системе
ConnectedTypeenumПризнак наличия доступа к системе: Connected - система доступна; Unavalible - система не доступна; NotChecked - проверка доступа не осуществлялась (во входящих параметрах поле check_connections = false;

3 Примеры вызовов

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

<?xml version="1.0" encoding="utf-8"?>
<RQ cmd="get_connected_systems" callback="https://ya.ru">
   <PARAM name="object_id" val="123456" />
   <PARAM name="CheckConnections" val="true"/>
</RQ>

3.2 Пример ответа - успех

<?xml version="1.0" encoding="UTF-8"?>
<RP taskguid="38aa6f3c-ad1a-43b6-a0e7-8b1746e3a49f" code="0" version="1.11.0">
  <ConnectedSystems>
	<Rk7 IsUsed="false" ConnectedType="NotChecked"/>
	<Sh4 IsUsed="true" ConnectedType="NotChecked"/>
	<Sh5 IsUsed="false" ConnectedType="NotChecked"/>
	<Crm IsUsed="false" ConnectedType="NotChecked"/>
	<Sql IsUsed="true" ConnectedType="NotChecked"/>
  </ConnectedSystems>
</RP>

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

<?xml version="1.0" encoding="utf-8"?>
<RP taskguid="1df51a8a-a524-42f8-a043-848cca6bc129" code="0" version="1.11.0">
  <ERROR code="99" text="Ошибка парсинга xml"/>
</RP>

V2 GetConnectedSystems

https://ws-dev.ucs.ru/wsserverlp/swagger/index.html

Примеры вызовов

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

{
  "asyncWithObjectId": {
    "objectId": 1199991111,
    "callbackUrl": "https://ucs.ru",
    "timeout": 0
  },
  "checkConnections": true,
  "extGuid": "bcfa7008-19f4-4846-b9d5-3a1f8e5c3fd6"
}

Пример синхронный ответ - ошибка лицензии

{
    "responseCommon": {
        "taskGuid": "0219d2b3-0fcd-4fa7-bbd6-90d3464e010e",
        "cmdTypeV2": "GetConnectedSystems",
        "objectId": 1199991111
    },
    "responseErrorV2": {
        "code": "License",
        "extCode": "WsAgent"
    }
}

Пример синхронный ответ - успех

{
    "responseCommon": {
        "taskGuid": "5fe20475-6b2f-4fa4-ad86-fa8cbc2c2756",
        "cmdTypeV2": "GetConnectedSystems",
        "objectId": 199991111
    },
    "responseSync": "AsyncQueued"
}

Пример асинхронный ответ - успех

{  
   "ResponseCommon":{  
      "TaskGuid":"5fe20475-6b2f-4fa4-ad86-fa8cbc2c2756",
      "CmdTypeV2":"GetConnectedSystems",
      "ObjectId":199991111
   },
   "ResponseAsync":{  
      "ConnectedSystems":{  
         "Rk7":{  
            "@IsUsed":"true",
            "@ConnectedType":"Connected"
         },
         "Sh4":{  
            "@IsUsed":"false",
            "@ConnectedType":"NotChecked"
         },
         "Sh5":{  
            "@IsUsed":"true",
            "@ConnectedType":"Connected"
         },
         "Crm":{  
            "@IsUsed":"true",
            "@ConnectedType":"Connected"
         },
         "Sql":{  
            "@IsUsed":"false",
            "@ConnectedType":"NotChecked"
         }
      }
   }
}