Команда unsubscribe

Команда unsubscribe предназначена для отписки от определенного индикатора. После выполнения команды, данные по этому индикатору перестают поступать.

Схема запроса

Поля запроса команды unsubscribe

ПолеТип поляНазначение
CommandJSONКорневой элемент, содержащий собственно текст запроса
CommandTypestringТип команды. В случае команды unsubscribe, нужно указать значение unsubscribe
CommandIdstringИдентификатор команды, для удобства отладки. Используется на усмотрение разработчика программы-агента. Можно указать любой текст, например UUID. Это опциональное поле
ArgsJSONАргументы команды
SubscriptionIdstringИдентификатор подписки, соответствующий нужному индикатору

Пример запроса команды unsubscribe

Пример запроса, содержащий команду unsubscribe:

{
  "Command": {
    "CommandType": "unsubscribe",
    "Args": {
        "SubscriptionId": "afc18bdd-cecd-401b-880b-e1f9ca3bcce7" 
    }
  }
}

Схема ответа

Поля ответа команды unsubscribe

ПолеТип поляНазначение
ResponseJSONКорневой элемент для ответа
CommandJSONПолное повторение команды, пришедшей от клиента, со всеми дочерними полями
StatusintegerСтатус выполнения команды (0 — успешное выполнение, 1 — ошибка)
ErrorCodestringСимволический код ошибки, в соответствии со справочником кодов ошибок Websockets API

Пример ответа команды unsubscribe

Пример ответа, возвращающегося в результате выполнения команды unsubscribe:

{
  "Response": {
    "Command": {
      "CommandType": "unsubscribe",
      "CommandId": "",            
      "Args": {
        "SubscriptionId": "afc18bdd-cecd-401b-880b-e1f9ca3bcce7"
      }
    },
    "Status": 0,
    "ErrorCode": "NPE001"
  }
}