Wialon para desarrolladores Manual de usuario Documentación de API retranslator update_config

update_config

Para actualizar la configuración del repetidor, utilice el método retranslator/update_config.

La configuración se reemplaza por completo, no se actualiza campo por campo. Indique en la solicitud todos los campos que necesita: los campos que no se indican se pierden. La única excepción es el campo debug, que se conserva de la configuración anterior.

Endpoint

Copied!

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

Parámetros

La solicitud puede contener los siguientes parámetros. Los parámetros obligatorios están marcados con un asterisco (*).

Parámetro	Descripción
`itemId`*	ID del repetidor.
`config`*	Configuración del repetidor.
`protocol`*	Nombre del protocolo (véase Protocolos).
`server`	Servidor para la retransmisión. Es obligatorio para todos los protocolos enumerados en la sección Protocolos.
`port`	Puerto. Es obligatorio para los protocolos `wialon`, `wialon_ips`, `granit3`, `skaut`, `cyber_glx`, `vt300`, `egts`, `trn` y `nvg`.
`auth`	Datos de autorización. Para el protocolo Nis, indique el inicio de sesión y la contraseña separados por dos puntos (`login:password`). Es obligatorio para los protocolos `nis` y `rtti`.
`ssl`	Conexión segura: `1` para sí, `0` para no. Es obligatorio para el protocolo `nis`.
`v6type`	Usar la versión 6 del protocolo: `1` para sí, `0` para no.
`attach_sensors`	Retransmitir los valores calculados de los sensores: `1` para sí, `0` para no.
`scoutOpen`	Usar la variante Skaut Open del protocolo: `1` para sí, `0` para no.
`notauth`	Deshabilitar la autorización: `1` para sí, `0` para no.
`timeoutauth`	Tiempo en segundos tras el cual se repite la autorización. Si el valor es `0`, la conexión se autoriza una sola vez.
`didauth`	Usar el ID del dispositivo para la autorización: `1` para sí, `0` para no.
`fuel`	Retransmitir los valores de los sensores del nivel de combustible: `1` para sí, `0` para no.
`binauth`	Enviar el código de autorización en formato binario: `1` para sí, `0` para no.
`carrier`	ID del transportista.
`login`	Inicio de sesión. Es obligatorio para el protocolo `soap`.
`password`	Contraseña. Es obligatorio para el protocolo `soap`.
`debug`	Usar el modo de depuración: `1` para sí, `0` para no. Si el parámetro no se indica, su valor se toma de la configuración anterior.

El conjunto de campos dentro de config depende del protocolo. Los campos protocol y server son obligatorios para todos los protocolos enumerados en la sección Protocolos, y el resto se enumeran en la misma sección. Si falta un campo obligatorio, la solicitud devuelve el error 4.

Protocolos

Los campos obligatorios están marcados con un asterisco (*). Los valores de port entre paréntesis son los que sugiere la interfaz; la API no los aplica automáticamente.

Valor	Protocolo	Campos además de `protocol` y `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`

No todos los protocolos enumerados anteriormente están disponibles en cada cuenta, y una cuenta también puede tener protocolos de retransmisión personalizados con sus propios conjuntos de campos. Si el protocolo indicado no está disponible, la solicitud devuelve el error 4. Para obtener los protocolos disponibles para el usuario junto con sus campos, utilice el método list.

Respuesta

Si la solicitud se completa con éxito, la configuración actual del repetidor se devuelve en el siguiente formato:

Copied!

{
    "rtrc":{
        "protocol":<text>,  /* Protocolo. */
        "server":<text>,    /* Servidor para la retransmisión. */
        "port":<ushort>     /* Puerto. */
    }
}

El conjunto de campos devueltos depende del protocolo, igual que en la solicitud. Para obtener más información, consulte la página de formato de datos Repetidores.

Si la solicitud falla, se devuelve un código de error.

Códigos de error

Código de error	Descripción
4	Error al analizar los parámetros de entrada, el protocolo indicado no es compatible o error al guardar la configuración.
6	Error al generar la respuesta.
7	El elemento indicado no es un repetidor o el usuario no tiene el derecho de acceso para modificar los ajustes del repetidor, incluidos su inicio y detención (bit ACL `0x100000`, véase Tokens).

Si nota un error en el texto, por favor resáltelo y presione Ctrl+Intro.