Справочный центр Wialon

Ретрансляторы

В зависимости от указанных флагов формат ответа может различаться.

На этой странице описаны флаги, которые могут быть применены к ретрансляторам, и соответствующие им части результирующего JSON, которыми они управляют. Если указано несколько флагов, их соответствующие части объединяются в единый JSON.

Флаги ретранслятора

Следующие флаги можно применять к ретрансляторам:

Значение в HEX Значение в DEC Описание
0x00000001 1 Базовый флаг
0x00000002 2 Произвольные свойства
0x00000004 4 Информация о биллинге
0x00000040 64 GUID
0x00000100 256 Состояние и конфигурация
0x00000200 512 Объекты ретранслятора
0x3FFFFFFFFFFFFFFF 4611686018427387903 Установить все возможные флаги ретранслятора

Основные свойства

Флаг основных свойств — 0x00000001 (1).

Copied!
{
	"nm":<text>,	/* Название */
	"cls":<uint>,	/* ID суперкласса avl_retranslator (см. ключ classes в ответе token/login) */
	"id":<long>,	/* ID ретранслятора */
	"mu":<uint>,	/* Система измерений:
		0 — СИ,
		1 — американская,
		2 — имперская,
		3 — метрическая с галлонами */
	"uacl":<long>	/* Права доступа пользователя на ретранслятор (64-битное значение) */
}

Произвольные свойства

Флаг произвольных свойств — 0x00000002 (2).

В произвольных свойствах можно хранить любые данные ретранслятора.

Copied!
{
	"prp": {},	/* Произвольные свойства */
	"ftp": {	/* Настройки FTP */
		"hs": <text>,	/* Хост (только если задан) */
		"lg": <text>,	/* Логин (только если задан) */
		"pt": <text>,	/* Путь к директории (только если задан) */
		"ch": <uint>,	/* Валидность настроек FTP: 1 — да, 0 — нет */
		"tp": <uint>,	/* Использовать FTP Wialon Hosting: 1 — да, 0 — нет */
		"fl": <uint>	/* Доступность FTP Wialon Hosting: 1 — да, 0 — нет */
	},
	"ct": <uint>	/* Время создания (Unix-время) */
}

Информация о биллинге

Флаг информации о биллинге — 0x00000004 (4).

Copied!
{
	"crt": <uint>,	/* ID создателя */
	"bact": <uint>	/* ID учетной записи */
}

GUID

Флаг GUID — 0x00000040 (64).

Copied!
{
	"gd": <text>	/* GUID ретранслятора */
}

Состояние и конфигурация

Флаг состояния и конфигурации — 0x00000100 (256).

Copied!
{
   "rtro": <int>,              /* Состояние: 0 — отключен, 1 — включен */
   "rtrst": <uint>,            /* Время, когда ретрансляция останавливается автоматически (Unix-время), 0, если время не задано */
   "rtrc": {                   /* Конфигурация. Набор полей зависит от протокола */
      "protocol": <text>,      /* Протокол */
      "server": <text>,        /* Сервер для ретрансляции */
      "port": <ushort>,        /* Порт (для всех протоколов, кроме NIS, SOAP и RTTI). Возвращается в том типе, в котором был сохранен, поэтому может быть и строкой */
      "auth": <text>,          /* Авторизация (только для NIS, Wialon IPS, TRN и RTTI) */
      "ssl": <int>,            /* Защищенное соединение (только для NIS): 1 — да, 0 — нет */
      "v6type": <int>,         /* Использовать протокол версии 6 (только для Granit Navigator): 1 — да, 0 — нет */
      "attach_sensors": <int>, /* Ретранслировать рассчитанные значения датчиков (только для Wialon Retranslator и Wialon IPS): 1 — да, 0 — нет */
      "scoutOpen": <int>,      /* Использовать вариант протокола Skaut Open (только для Skaut): 1 — да, 0 — нет */
      "notauth": <int>,        /* Отключить авторизацию (только для EGTS): 1 — да, 0 — нет */
      "timeoutauth": <int>,    /* Время в секундах, по истечении которого авторизация повторяется (только для EGTS). Если значение 0, соединение авторизуется один раз */
      "didauth": <int>,        /* Использовать ID устройства для авторизации (только для EGTS): 1 — да, 0 — нет */
      "fuel": <int>,           /* Ретранслировать значения датчиков уровня топлива (только для EGTS): 1 — да, 0 — нет */
      "binauth": <int>,        /* Отправлять код авторизации в двоичном виде (только для TRN): 1 — да, 0 — нет */
      "carrier": <uint>,       /* ID перевозчика (только для RTTI) */
      "login": <text>,         /* Логин (только для SOAP) */
      "password": <text>,      /* Пароль (только для SOAP) */
      "debug": <int>           /* Режим отладки: 1 — да, 0 — нет (только если задан) */
   }
}

Типы протоколов описаны на странице update_config.

Объекты ретранслятора

Флаг объектов ретранслятора — 0x00000200 (512).

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

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