list
Para obtener los protocolos de retransmisión disponibles para el usuario actual, utilice el método retranslator/list. La respuesta contiene tanto los protocolos estándar como los personalizados permitidos para la cuenta.
Endpoint
svc=retranslator/list¶ms={}
Parámetros
El método no tiene parámetros. Indique un objeto vacío en la solicitud.
Respuesta
Si la solicitud se completa con éxito, la respuesta se devuelve en el siguiente formato:
{
"custom_retranslators": [ /* Protocolos personalizados disponibles para el usuario. */
{
"name": "apad_gps", /* Valor para el campo "protocol" de la configuración. */
"params": {
"fields": [ /* Campos de la configuración. */
{
"key": "server", /* Nombre del campo. */
"type": "name" /* Tipo del campo. */
},
{
"key": "api_key",
"type": "name"
},
{
"key": "password",
"type": "name"
}
],
"name": "APAD GPS", /* Nombre del protocolo que se muestra en la interfaz. */
"public": 1 /* Disponibilidad para todos los usuarios: 1 para sí, 0 para no. */
}
},
...
],
"retranslators": [ /* Protocolos estándar. */
{
"name": "wialon",
"params": {
"fields": [
{
"key": "server",
"type": "name"
},
{
"key": "port",
"type": "uint16",
"default": 20163 /* Valor predeterminado del campo. */
},
{
"key": "attach_sensors",
"type": "bool"
}
]
}
},
...
]
}
Un protocolo personalizado se incluye en la respuesta si está marcado como público, si la cuenta tiene habilitado el servicio correspondiente o si el usuario tiene derechos de administrador. Si no hay ningún protocolo personalizado disponible, la matriz custom_retranslators no está presente en la respuesta. La matriz retranslators siempre se devuelve, y los protocolos que contiene se describen en el método update_config.
La descripción de un protocolo depende del propio protocolo:
- El
typede un campo indica cómo debe completarse. Además dename, se utilizan los tiposbool,int,int16,uint16y otros. - Un campo puede tener la clave
defaultcon el valor que la interfaz ofrece para él. Se utiliza tanto en los protocolos estándar como en los personalizados. - Además de
fields,nameypublic, el objetoparamsde un protocolo personalizado puede contener otras claves con los ajustes de este protocolo, comosending_optionsolocation_conversion.
Si la solicitud falla, se devuelve un código de error.
Códigos de error
| Código de error | Descripción |
|---|---|
| 5 | Error al generar la respuesta. |
| 6 | No hay ningún usuario en la sesión actual. |