Команда stop

Команда stop останавливает запущенную модель.

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

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

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

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

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

{
  "Command": {
    "CommandType": "stop",
    "CommandId": "61f0c404-5cb3-11e7-907b-a6006ad3dba0"
  }
}

Поскольку CommandId опциональный параметр, самый минималистичный вариант команды stop выглядит так:

{
  "Command": {
    "CommandType": "stop"
  }
}

Схема ответа

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

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

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

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

{
  "Response": {
    "Command": {
      "CommandType": "stop",
      "CommandId": "61f0c404-5cb3-11e7-907b-a6006ad3dba0"
    },
    "Status": 0,
    "ErrorCode": "NPE001"
  }
}