get_report_tables
Para obtener la lista de tablas que se pueden incluir en los informes, utilice el método report/get_report_tables.
Endpoint
svc=report/get_report_tables¶ms={}
Parámetros
La solicitud no requiere ningún parámetro.
Resultado devuelto
Si la solicitud se completa correctamente, se devuelve una respuesta con el siguiente formato:
[
{
"id":<uint>, /* ID de la tabla */
"n":"<text>", /* nombre de sistema de la tabla */
"l":"<text>", /* nombre predeterminado de la tabla */
"t":"<text>", /* tipo de la tabla */
"ct":"<text>", /* tipo de plantilla en la que se puede utilizar esta tabla */
"pt":"<text>", /* parámetros de texto */
"gt":"<text>", /* ajustes avanzados de agrupación */
"col":[ /* matriz de columnas */
{
"n":"<text>", /* nombre de sistema de la columna */
"l":"<text>", /* nombre predeterminado de la columna */
"sl":"<text>", /* lista de encabezados de columnas (si es una tabla de estadísticas) */
"t":"<text>", /* tipo de la columna */
"f":<uint> /* flags de la columna (vea más abajo) */
"calc_type":<uint> /* valor de agrupación (si está establecido) */
"available_calc_types":<uint> /* valores de agrupación disponibles para la columna (si corresponde) */
}
]
}
]
Los tipos de plantillas de informes se describen en la sección Tipos de plantillas. Los flags de las tablas se describen en la página exec_report.
Nombres y tipos de tablas
Cada tabla se registra por separado para cada tipo de plantilla, por lo que su valor n es único. La misma tabla tiene un nombre diferente en cada tipo de plantilla. Por ejemplo, la tabla Viajes es unit_trips en una plantilla avl_unit y unit_group_trips en una plantilla avl_unit_group. Utilice el valor n para indicar las tablas en la solicitud report/update_report.
Las tablas que tienen el mismo valor t se calculan de la misma manera. Para encontrar la tabla equivalente en otro tipo de plantilla, busque una tabla con el mismo valor t y el valor ct requerido.
No todas las tablas están disponibles para todos los tipos de plantillas. Por ejemplo, las tablas Gráfica (Regular), Movimiento de combustible, Imágenes, Seguimiento de mensajes y Vídeo están disponibles para las plantillas avl_unit, pero no tienen equivalente para avl_unit_group.
El contenido de la tabla unit_location (Últimos datos de la unidad) depende del tipo de plantilla. La tabla existe tanto para avl_unit como para avl_unit_group, pero en una plantilla avl_unit todas sus columnas son columnas de estadísticas con el flag 0x02. En este caso, la tabla no tiene filas y solo agrega un bloque a las estadísticas del informe. Como tabla regular, Últimos datos de la unidad está disponible únicamente para las plantillas avl_unit_group.
La lista devuelta también depende de la cuenta. Las tablas se filtran según los servicios disponibles para el usuario actual, por lo que distintos usuarios pueden recibir listas de tablas diferentes.
Flags de columnas
El parámetro f de una columna puede tener los siguientes valores:
| Flag HEX | Flag DEC | Descripción |
|---|---|---|
| 0x01 | 1 | Mostrar como columna de tabla. |
| 0x02 | 2 | Mostrar como columna de estadísticas. |
| 0x04 | 4 | Mostrar como selector global. |
| 0x08 | 8 | Mostrar como columna con datos de posición. |
| 0x10 | 16 | Mostrar como eje de gráfica. |
| 0x20 | 32 | Ocultar la columna en la tabla del informe. Se utiliza junto con 0x10 para las columnas de sensores de las gráficas. |
| 0x40 | 64 | Mostrar como gráfica personalizada. |
| 0x100 | 256 | Mostrar como marcador en la gráfica. |
| 0x200 | 512 | Mostrar como región de fondo en la gráfica. |
El valor de f es una máscara de bits, por lo que una columna puede tener varios flags a la vez. Por ejemplo, 0x01 + 0x02 = 0x03 significa que la columna se muestra tanto como columna de tabla como columna de estadísticas.
Las columnas con los flags 0x100 y 0x200 pertenecen a las tablas que proporcionan los datos para la gráfica (por ejemplo, unit_events o unit_stays), no a la tabla de la gráfica en sí. Estas columnas definen lo que se visualiza en la gráfica. Para obtener más información, consulte las secciones Marcadores y Fondo.
Valores del parámetro «pt»
El parámetro pt enumera los parámetros de texto y las opciones disponibles para la tabla. Puede tener los siguientes valores:
| Valor | Descripción |
|---|---|
| geozones | Geocercas/Unidades. |
| unfinished_ival | Intervalo no finalizado. |
| duration | Duración. |
| mileage | Kilometraje. |
| base_eh_sensor | Sensor de horas de motor. |
| engine_hours | Horas de motor. |
| speed | Velocidad. |
| trips | Viajes. |
| stops | Paradas. |
| parkings | Estacionamientos. |
| sensors | Sensores. |
| sensor_name | Máscara del sensor. |
| driver | Conductor. |
| trailer | Remolque. |
| fillings | Llenados. |
| thefts | Descargas de combustible. |
| duration_format | Formato de duración. |
| geozones_ex | Geocercas/unidades extendidas. |
| username | Máscara de nombre de usuario. |
| route_points | Puntos de ruta. |
| event_mask | Máscara de evento. |
| rides | Rutinas. Se aplica para las tablas Unidad y Rutinas. |
| fields_config | Tipo de campo. Se aplica para las tablas Campos personalizados. |
| units | Unidades. Se aplica para la tabla Manoeuvres. |
| interval | Intervalo de seguimiento en minutos. Se aplica para la tabla Unidad → Seguimiento del sensor. |
| group_zones_pass | La opción Considerar grupo como total está disponible. Se aplica para la tabla Grupo de unidades → Geocercas sin visitar. |
| routes | Se aplica para las tablas de tipo Ruta. |
| last_location | La opción Considerar el intervalo del informe está disponible. Se aplica para la tabla Últimos datos de la unidad. |
| hide_total | La casilla Total está oculta para esa tabla. |
| groupitem | La opción El grupo mismo está disponible. Se aplica para las tablas Grupo de unidades → Historial y Campos personalizados. |
| noschedule | La opción Limitaciones de tiempo no está disponible. Se aplica para las tablas Resumen y Últimos datos de la unidad. |
| hide_driver_split | La casilla Obtener intervalos está oculta en el filtro de conductores. |
| account_tree | Árbol de cuentas. |
| custom_fields_mask | Máscara de campos personalizados. |
| drv_activity | Actividad del conductor. |
| movement_chronology | Cronología del movimiento. |
| sensor_val | Valor del sensor. |
| timeout_sensor | Tiempo de espera del sensor. |
| custom_sensor_name | Nombre del sensor personalizado. |
| filter_notifications | Guardar solo los mensajes que tienen un texto de notificación. |
Códigos de error
| Código de error | Descripción |
|---|---|
| 6 | Error no definido. |