Wialon для разработчиков Руководство пользователя Документация API retranslator update_config

update_config

Для обновления конфигурации ретранслятора используйте метод retranslator/update_config.

Конфигурация заменяется целиком, а не обновляется по отдельным полям. Указывайте в запросе все необходимые поля: неуказанные поля теряются. Единственное исключение — поле debug, значение которого сохраняется из предыдущей конфигурации.

Конечная точка

Copied!

svc=retranslator/update_config&params={
    "itemId": <long>,
    "config": {
        "protocol": <text>,
        "server": <text>,
        "port": <ushort>
    }
}

Параметры

Запрос может содержать следующие параметры. Обязательные параметры отмечены звездочкой (*).

Параметр	Описание
`itemId`*	ID ретранслятора.
`config`*	Конфигурация ретранслятора.
`protocol`*	Название протокола (см. Протоколы).
`server`	Сервер для ретрансляции. Обязателен для всех протоколов, перечисленных в разделе Протоколы.
`port`	Порт. Обязателен для протоколов `wialon`, `wialon_ips`, `granit3`, `skaut`, `cyber_glx`, `vt300`, `egts`, `trn` и `nvg`.
`auth`	Данные авторизации. Для протокола Nis укажите логин и пароль через двоеточие (`login:password`). Обязателен для протоколов `nis` и `rtti`.
`ssl`	Защищенное соединение: `1` — да, `0` — нет. Обязателен для протокола `nis`.
`v6type`	Использовать протокол версии 6: `1` — да, `0` — нет.
`attach_sensors`	Ретранслировать рассчитанные значения датчиков: `1` — да, `0` — нет.
`scoutOpen`	Использовать вариант протокола Skaut Open: `1` — да, `0` — нет.
`notauth`	Отключить авторизацию: `1` — да, `0` — нет.
`timeoutauth`	Время в секундах, по истечении которого авторизация повторяется. Если значение `0`, соединение авторизуется один раз.
`didauth`	Использовать ID устройства для авторизации: `1` — да, `0` — нет.
`fuel`	Ретранслировать значения датчиков уровня топлива: `1` — да, `0` — нет.
`binauth`	Отправлять код авторизации в двоичном виде: `1` — да, `0` — нет.
`carrier`	ID перевозчика.
`login`	Логин. Обязателен для протокола `soap`.
`password`	Пароль. Обязателен для протокола `soap`.
`debug`	Использовать режим отладки: `1` — да, `0` — нет. Если параметр не указан, его значение берется из предыдущей конфигурации.

Набор полей внутри config зависит от протокола. Поля protocol и server обязательны для всех протоколов, перечисленных в разделе Протоколы, остальные перечислены в том же разделе. Если обязательное поле не указано, запрос возвращает ошибку 4.

Протоколы

Обязательные поля отмечены звездочкой (*). Значения port в скобках — это значения, которые предлагает интерфейс; API не применяет их автоматически.

Значение	Протокол	Поля, кроме `protocol` и `server`
`wialon`	Wialon Retranslator	`port`* (20163), `attach_sensors`
`wialon_ips`	Wialon IPS	`port`* (20332), `auth`, `attach_sensors`
`nis`	Nis	`auth`, `ssl`
`granit3`	Granit Navigator	`port`* (20121), `v6type`
`skaut`	Skaut	`port`* (20117), `scoutOpen`
`cyber_glx`	Cyber GLX	`port`* (20185)
`vt300`	VT300	`port`* (20180)
`egts`	EGTS	`port`* (20629), `notauth`, `timeoutauth`, `didauth`, `fuel`
`soap`	SOAP	`login`, `password`
`trn`	TRN	`port`* (4880), `auth`, `binauth`
`nvg`	NVG	`port`* (8416)
`rtti`	RTTI	`auth`*, `carrier`

Не все перечисленные выше протоколы доступны в каждой учетной записи, а в учетной записи также могут быть пользовательские протоколы ретрансляции со своими наборами полей. Если указанный протокол недоступен, запрос возвращает ошибку 4. Чтобы получить доступные пользователю протоколы вместе с их полями, используйте метод list.

Ответ

В случае успешного выполнения запроса возвращается текущая конфигурация ретранслятора в следующем формате:

Copied!

{
    "rtrc":{
        "protocol":<text>,  /* Протокол. */
        "server":<text>,    /* Сервер для ретрансляции. */
        "port":<ushort>     /* Порт. */
    }
}

Набор возвращаемых полей зависит от протокола, как и в запросе. Подробнее см. на странице формата данных Ретрансляторы.

В противном случае возвращается код ошибки.

Коды ошибок

Код ошибки	Описание
4	Не удалось разобрать входные параметры, указанный протокол не поддерживается или не удалось сохранить конфигурацию.
6	Не удалось сгенерировать ответ.
7	Указанный элемент не является ретранслятором или у пользователя нет права доступа на редактирование настроек ретранслятора, включая его запуск и остановку (бит ACL `0x100000`, см. Токены).

Если вы заметили ошибку в тексте, пожалуйста, выделите её и нажмите Ctrl+Enter.