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

update_units

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

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

Copied!

svc=retranslator/update_units&params={
    "itemId": <long>,
    "units": [{
        "i": <long>,
        "a": <text>,
        "st": <uint>
    }],
    "callMode": <text>
}

Параметры

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

Параметр	Описание
`itemId`*	ID ретранслятора.
`units`*	Массив объектов для ретрансляции.
`i`*	ID объекта.
`a`*	Идентификатор (псевдоним) объекта, под которым он ретранслируется на принимающий сервер. Может отличаться от ID объекта.
`st`	Время (Unix-время), когда объект автоматически удаляется из ретранслятора. Если значение равно 0 или параметр не указан, объект не удаляется автоматически.
`callMode`	Режим запроса: `add` — добавляет указанные объекты и обновляет настройки тех, которые уже добавлены в ретранслятор; `remove` — удаляет указанные объекты из ретранслятора; не указан — добавляет указанные объекты и удаляет из ретранслятора все остальные.

Ответ

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

Copied!

{
    "rtru":[
        {
            "i":<long>,   /* ID объекта. */
            "a":<text>,   /* Идентификатор (псевдоним) объекта, под которым он ретранслируется на принимающий сервер. Может отличаться от ID объекта. */
            "st":<uint>   /* Время (Unix-время), когда объект автоматически удаляется из ретранслятора. 0, если время не задано. */
        }
    ]
}

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

Коды ошибок

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

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