get_routes_history
Para obtener el historial de rutas, use el método order/get_routes_history.
Para utilizar el método, necesita el derecho de acceso Solicitar informes y mensajes al recurso.
Endpoint
svc=order/get_routes_history¶ms={
"itemId":<long>,
"ivalType":<int>,
"ivalFrom":<uint>,
"ivalTo":<uint>,
"name":"<text>",
"unitId":<long>,
"routeId":<long>
}
Parámetros
Los parámetros obligatorios están marcados con un asterisco (*).
| Parámetro | Valor predeterminado | Descripción |
|---|---|---|
itemId* |
ID del recurso. | |
ivalType |
1 |
Método de selección del intervalo. Los valores son los mismos que los del parámetro ivalType de events/load, pero se usan ivalFrom e ivalTo en lugar de timeFrom y timeTo. |
ivalFrom |
0 |
Depende de ivalType: inicio del intervalo (hora UNIX) o cantidad de rutas que se deben cargar. |
ivalTo |
UINT_MAX |
Fin del intervalo (hora UNIX). |
name |
Máscaras de nombre de las rutas, separadas por comas. Se devuelve una ruta si su nombre coincide con al menos una máscara. Use * para cualquier cantidad de caracteres, ? para exactamente un carácter y ! al principio de una máscara para invertirla. Por ejemplo, "Vil*,Berl*" devuelve las rutas cuyo nombre empieza por Vil o Berl, "*kr" devuelve las rutas cuyo nombre termina en kr y "!Vil*" devuelve las rutas cuyo nombre no empieza por Vil. |
|
unitId |
ID de la unidad. | |
routeId |
ID único de la ruta (la propiedad uid de la ruta). |
Respuesta
Si la solicitud se ejecuta correctamente, se devuelve el siguiente resultado:
{
"routes":[
{...},
{...},
...
],
"count":<uint>, /* cantidad de rutas filtradas (tamaño de "routes") */
"total":<uint> /* cantidad total de rutas del periodo solicitado */
}
Si la solicitud no se ejecuta correctamente, se devuelve un código de error.
Códigos de error
| Código de error | Descripción |
|---|---|
| 4 | Parámetros de entrada incorrectos. |
| 6 | No se pudo cargar el historial, por ejemplo, porque el valor de ivalType no es válido. |
| 7 | El recurso no existe o el usuario no tiene el derecho de acceso Solicitar informes y mensajes a él. |