get_round_data
Para obtener información detallada sobre las rutinas, utilice el método route/get_round_data:
svc=route/get_round_data
params={
"itemId": <long>,
"col": [<long>]
}
Parámetros
La solicitud debe contener los siguientes parámetros:
| Parámetro | Descripción |
|---|---|
| itemId | ID de la ruta. |
| col | Array de ID de rutinas. |
Respuesta
Si la solicitud se completa con éxito, la respuesta se devuelve en el siguiente formato:
[
{
"id": <long>, // ID de la rutina.
"n": <text>, // Nombre.
"d": <text>, // Descripción.
"tz": <uint>, // Zona horaria.
"u": <long>, // ID de la unidad asignada (si no se especifica, se usa la primera unidad de "cu" que sale del primer punto de control).
"cu": [<long>], // Array de ID de unidades.
"pt": [ // Puntos de control.
{
"n": <text>, // Nombre.
"f": <uint>, // Tipo.
"u": <long>, // ID de la unidad (0 si no es del tipo "punto de control desde unidad").
"y": <double>, // Latitud.
"x": <double>, // Longitud.
"r": <uint> // Radio.
}
],
"sh": { // Horario.
"id": <long>, // ID del horario.
"n": <text>, // Nombre.
"f": <uint>, // Tipo.
"tz": <uint>, // Zona horaria.
"cfg": { // Configuración personalizada. Se pasa desde el objeto de horario sin cambios.
"enabled": <byte>, // Creación automática de rutinas: 1 = habilitada, 0 = deshabilitada.
"name": <text>, // Nombre de la rutina.
"description": <text>, // Descripción.
"roundFlags": <uint>, // Flags de la rutina.
"units": [<long>], // ID de unidades.
"validityPeriod": <uint> // Periodo de validez.
},
"tm": [ // Tiempo de paso por los puntos de control.
{
"at": <uint>, // Hora de llegada.
"ad": <uint>, // Desviación respecto a la hora de llegada.
"dt": <uint>, // Hora de salida.
"dd": <uint> // Desviación respecto a la hora de salida.
}
],
"sch": { // Restricciones 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 de días del mes.
"y": <uint>, // Máscara de meses.
"w": <uint> // Máscara de días de la semana.
}
},
"at": <uint>, // Hora de activación.
"vt": <uint>, // Inicio del periodo de validez.
"vp": <uint>, // Periodo de validez.
"f": <uint>, // Flags de la rutina.
"st": { // Estado de la rutina.
"st": { // Estado general de la rutina.
"pi": <uint>, // Índice del punto de control (4294967295 significa que la rutina no ha comenzado).
"ps": <uint>, // Flags de estado y de eventos.
"ut": <uint> // Hora del último evento.
},
"pts": { // Estado por punto de control individual.
"<text>": {
"st": <uint>, // Flags de eventos.
"tm": <uint> // Hora del último evento.
}
// ... más puntos de control
}
}
}
]
Los tipos de puntos de control se describen en la página update_checkpoints.
Los tipos de horario se describen en la página update_schedule.
Flags de la rutina
| Flag | Descripción |
|---|---|
| 0x0 | Orden de los puntos de control: estricto. |
| 0x2 | Eliminar las rutinas finalizadas de la línea de tiempo. |
| 0x10 | Orden de los puntos de control: se permiten omisiones. |
| 0x20 | Permite ejecutar informes sobre las rutinas. |
| 0x40 | Orden de los puntos de control: arbitrario. |
Flags de estado de la rutina
| Flag | Descripción |
|---|---|
| 0x010000 | Inactiva. |
| 0x020000 | Finalizada. |
| 0x040000 | En espera de llegada. |
| 0x080000 | En espera de salida. |
| 0x200000 | Con retraso. |
| 0x400000 | Adelantada. |
| 0x800000 | Detenida. |
| 0x0100000 | Anulada. |
Flags de eventos
| Flag | Descripción |
|---|---|
| 0x1 | La rutina se inició. |
| 0x2 | La rutina finalizó. |
| 0x4 | La rutina fue anulada. |
| 0x8 | La unidad llegó a un punto de control. |
| 0x10 | La unidad pasó un punto de control. |
| 0x20 | La unidad salió de un punto de control. |
| 0x40 | La unidad llegó con retraso. |
| 0x80 | La unidad llegó antes de tiempo. |
| 0x100 | La unidad pasó un punto de control a tiempo. |
| 0x200 | La llegada fue pospuesta. |