API: Trips
M: Listar viajes
Límite de Tasa de Peticiones
Máximo de 10 peticiones por IP en 5 minutos
HTTP GET:
https://<hostname>/api/trips
URL PARAMETERS:
Nombre | Tipo | Requerido | Descripción | |
---|---|---|---|---|
start_date |
Fecha de inicio | Texto | si | Fecha en formato YYYY-MM-DD |
end_date |
Fecha de fin | Texto | si | Fecha en formato YYYY-MM-DD |
start_time |
Hora de inicio | Texto | no | Hora en formato HH:MM:SS |
end_time |
Hora de fin | Texto | no | Hora en formato HH:MM:SS |
vehicle_ids |
Lista de vehículos | Lista de números | no | Listado de ids de vehículos de los cuales se quiere obtener los viajes. |
driver_ids |
Lista de conductores | Lista de números | no | Listado de ids de conductores de los cuales se quiere obtener los viajes. |
min_distance |
Distancia mínima de viaje | Numérico | no | Distancia mínima que debe tener el viaje para ser incluido en la respuesta. |
OUTPUT:
Json con los campos:
success
:boolean
distance_uom
:string
Unidades de medida de distancia.trips
:json
Contiene una lista de Trip Data Objects
EJEMPLO CON CURL:
$ curl -u <api_key>:<password>
-X GET
https://<hostname>/api/trips?start_date=2021-01-01&end_date=2021-01-15&min_distance=1000
RESPUESTA:
{
"success": true,
"trips": [
{
"vehicleId": 587,
"driverId": null,
"tripId": 241099,
"startDate": 1614578400,
"startPlace": "Centro de abastecimiento",
"endDate": 1614664487,
"endPlace": "Hospital zona 15",
"distance": 110.4,
"duration": 86070,
"movingTime": 1478,
"stoppedTime": 84592,
"routeId": 152355
},
{
"vehicleId": 593,
"driverId": 479,
"tripId": 241127,
"startDate": 1614578491,
"startPlace": "Oficinas centrales zona 9",
"endDate": 1614622108,
"endPlace": "8a Avenida, Mixco, 010576, Guatemala, Guatemala",
"distance": 0.1,
"duration": 43275,
"movingTime": 96,
"stoppedTime": 43179,
"routeId": null
}
]
}
O: Trip Data Object
Cada objeto de viaje tiene estos campos:
Campo | Descripción |
---|---|
vehicleId |
Id del vehículo. |
driverId |
Id del conductor asignado al vehículo cuando se hizo el viaje. |
tripId |
Id del viaje. |
startDate |
Fecha y hora de inicio del viaje en formato Unix time. |
startPlace |
Lugar de inicio del viaje. |
endDate |
Fecha y hora de fin del viaje en formato Unix time. |
endPlace |
Lugar de fin del viaje. |
distance |
Distancia recorrida. Obtener unidad de medida en la respuesta, en el campo distance_uom . |
duration |
Duración del viaje en segundos. |
movingTime |
Tiempo en movimiento durante el viaje en segundos. |
stoppedTime |
Tiempo parado durante el viaje en segundos. |
routeId |
Id de la ruta. |