Rutas
Dependiendo de los flags especificados, el formato de respuesta puede variar.
Este capítulo describe los flags que se pueden aplicar a las rutas y las partes correspondientes del JSON resultante que controlan. Si se especifican varios flags, sus respectivas partes se combinan en un solo JSON.
Indique los flags en formato DEC. Para obtener más información, consulte Formato de datos.
Flags de rutas
Los siguientes flags pueden aplicarse a las rutas:
| Valor HEX | Valor DEC | Descripción |
|---|---|---|
| 0x00000001 | 1 | Flag base |
| 0x00000002 | 2 | Propiedades personalizadas |
| 0x00000004 | 4 | Información de facturación |
| 0x00000040 | 64 | GUID |
| 0x00000080 | 128 | Campos administrativos |
| 0x00000100 | 256 | Configuración |
| 0x00000200 | 512 | Puntos de control |
| 0x00000400 | 1204 | Horarios |
| 0x00000800 | 2048 | Rutinas |
| 0x00001000 | 4096 | Estado del monitor de ruta |
| 0x3FFFFFFFFFFFFFFF | 4611686018427387903 | Establecer todos los flags de ruta posibles |
Propiedades básicas
El flag de las propiedades básicas es 0x00000001.
{
"nm": <text>, /* Nombre */
"cls": <uint>, /* ID de superclase: "avl_route" */
"id": <uint>, /* ID de la ruta */
"mu": <uint>, /* Unidades de medida:
0 — SI,
1 — US,
2 — imperial,
3 — métrico con galones */
"uacl": <uint> /* Derechos de acceso del usuario a la ruta */
}
Propiedades personalizadas
El flag de las propiedades personalizadas es 0x00000002.
Puede almacenar cualquier dato de la ruta en las propiedades personalizadas.
{
"prp": {} /* Propiedades personalizadas */
}
Información de facturación
El flag de la información de facturación es 0x00000004.
{
"crt": <uint>, /* ID del creador */
"bact": <uint> /* ID de la cuenta */
}
GUID
El flag del GUID es 0x00000040.
{
"gd": <text> /* GUID de la ruta */
}
Campos administrativos
El flag de los campos administrativos es 0x00000080.
{
"aflds": { /* Campos administrativos */
<text>: { /* Número de secuencia */
"id": <uint>, /* ID */
"n": <text>, /* Nombre */
"v": <text> /* Valor */
},
...
},
"afldsmax": <long>, /* Cantidad máxima de campos administrativos (-1 para ilimitado) */
}
Configuración
El flag de la configuración es 0x00000100.
{
"rcfg":{ /* Configuración */
"color":<long>, /* Color (ARGB) */
"descr":<text>, /* Descripción */
"units":[<long>] /* Matriz de ID de unidades */
}
}
Puntos de control
El flag de los puntos de control es 0x00000200.
{
"rpts":[ /* Puntos de control */
{
"n": <text>, /* Nombre */
"f": <uint>, /* Tipo (ver abajo) */
"u": <long>, /* ID de la unidad, 0 — si el punto de control no es del tipo "punto de control desde una unidad" */
"y": <double>, /* Longitud */
"x": <double>, /* Latitud */
"r": <uint> /* Radio, m */
},
...
]
}
Los puntos de control pueden ser de los siguientes tipos:
- 1 — punto de control desde el mapa o POI;
- 2 — punto de control desde una geocerca;
- 3 — punto de control desde una unidad.
Horarios
El flag de los horarios es 0x00000400.
{
"rs": { /* Lista de horarios */
"<text>": { /* Número de secuencia del horario */
"id": <long>, /* ID del horario */
"n": "<text>", /* Nombre */
"f": <uint>, /* Tipo */
"tz": <uint>, /* Zona horaria */
"cfg": { /* Configuración personalizada (ejemplo) */
"autoName": <byte>, /* Usar un nombre generado automáticamente: 0 — no, 1 — sí */
"enabled": <byte>, /* Crear rutinas para el horario automáticamente: 1 — habilitar, 0 — deshabilitar */
"name": "<text>", /* Nombre de la rutina */
"roundFlags": <uint>, /* Flags de la rutina */
"units": [<long>], /* Matriz de ID de unidades */
"validityPeriod": <uint> /* Período de validez */
},
"tm": [ /* Hora de visita del punto */
{
"at": <uint>, /* Hora de llegada */
"ad": <uint>, /* Desviación de la hora de llegada */
"dt": <uint>, /* Hora de salida */
"dd": <uint> /* Desviación de la hora de salida */
}
],
"sch": { /* Limitación de tiempo */
"f1": <uint>, /* Inicio del intervalo 1 */
"f2": <uint>, /* Inicio del intervalo 2 */
"t1": <uint>, /* Fin del intervalo 1 */
"t2": <uint>, /* Fin del intervalo 2 */
"m": <uint>, /* Máscara para días del mes */
"y": <uint>, /* Máscara de meses */
"w": <uint> /* Máscara para días de la semana */
}
}
}
}
Los tipos de horario se describen en el capítulo update_schedule.
Rutinas
El flag de las rutinas es 0x00000800.
{
"rr": { /* Rutinas */
"<text>": { /* Número de secuencia de la rutina */
"id": <long>, /* ID de la rutina */
"n": "<text>", /* Nombre */
"d": "<text>", /* Descripción */
"sh": "<text>", /* Nombre del horario */
"f": <uint>, /* Flags de la rutina */
"tz": <uint>, /* Zona horaria */
"u": <long>, /* Unidad asignada a esta rutina */
"at": <uint>, /* Hora de activación */
"vt": <uint>, /* Hora desde la cual comienza el período de validez */
"vp": <uint>, /* Período de validez */
"sts": <uint>, /* Flags de estado */
"st": { /* Estado de la rutina */
"st": { /* Estado general de la rutina */
"pi": <uint>, /* Índice del punto de control (4294967295 si la rutina no ha comenzado) */
"ps": <uint>, /* Flags de estado y evento */
"ut": <uint> /* Hora del último evento */
},
"pts": { /* Estado por puntos */
"<text>": { /* ID del punto de control */
"st": <uint>, /* Flags de evento */
"tm": <uint> /* Hora del último evento */
}
}
}
}
}
}
Los valores de los flags de rutina, estado y evento se describen en el capítulo get_round_data.