get_hw_cmds

La función get_hw_cmds se usa para obtener la lista de comandos disponibles para la unidad o tipo de dispositivo o para obtener plantillas de comandos.

Copied!
svc=core/get_hw_cmds&params={"deviceTypeId":<long>,
			     "unitId":<long>,
			     "template":<bool>
			     "lang":"<text>"}

Parámetros

NombreDescripción

deviceTypeId

ID del tipo de dispositivo.

unitId

ID de unidad.

template

Marca. Si está establecida en 1 (on), el resultado devuelto es JSON con datos de plantilla del comando. Este parámetro no es obligatorio.

lang

Marca. Convierte los valores de los parámetros "title" y "label". Este parámetro no es obligatorio.

Puede establecer solo un parámetro o ambos parámetros. La búsqueda comienza con el ID del tipo de dispositivo y, en caso de un error, continúa con el ID de la unidad. Si es necesario omitir el parámetro, establézcalo en 0.

Resultado devuelto

El resultado devuelto contiene la lista de comandos disponibles si template:0 o no hay parámetro:

Copied!
{
	"<text>":[	/* tipo de conexión: GSM, TCP, UDP, VRT */
		"<text>",	/* tipo de comando */
		...
	],
	...
}

Si la marca template se establece en 1, se devuelve la plantilla del comando. Esto puede ser un conjunto de campos personalizado. A continuación, se ofrece un ejemplo de JSON:

Copied!
{
  "<cmd_template_name>": {   /* nombre */
    "icon": "<text>",          /* icono */
    "props": [               /* propiedades */
      {
        "label":"<text>",      /* nombre de campo */
        "type":"<text>",       /* tipo */
        "validate":"<text>",   /* regla de validación */
        "value": [           /* matriz de valores clave */
          {
            "n":"<text>",      /* clave */
            "v":"<text>"       /* valor */
          },
          ...
        ],
        "default":"<text>",    /* valor por defecto (por ejemplo, puerto de dirección IP) */
        "title":"<text>",      /* título */
        "maxlength":<uint>   /* largo máximo */
      },
      ...      
    ]
  },
  ...  
}

Los códigos de errores posibles son:

CódigoDescripción
6

Error al obtener el usuario actual.

4

Uno de los siguientes errores:

  • parámetros de entrada incorrectos;
  • error al obtener el dispositivo por ID;
  • error al obtener el plan de facturación para el dispositivo.
Descargar archivo PDF
Descargar archivo Word

Ver también