API: Stops
M: Listar paradas de un vehículo específico
Límite de Tasa de Peticiones
Máximo de 10 peticiones por IP en 5 minutos
HTTP GET:
https://<hostname>/api/vehicle/<id>/stops
URL PARAMETERS:
Nombre | Tipo | Requerido | Descripción | |
---|---|---|---|---|
limit |
Límite de paradas | Numérico | sí | Cantidad de paradas que se quiere obtener en la respuesta. (Entre 1 y 200) |
OUTPUT:
- Lista de Vehicle Stop Data Objects
EJEMPLO EN CURL:
$ curl -u <api_key>:<password>
-X GET
https://<hostname>/api/vehicle/9585/stops?limit=1
RESPUESTA:
{
"success": true,
"data": [
{
"id":"12556",
"duration":"14783",
"start_date":"20160903151494",
"placename":"Dollar Country",
"poi_id":"15398"
}
]
}
O: Vehicle Stop Data Object
Cada objeto de parada tiene estos campos:
campo | read-only | |
---|---|---|
id |
sí | Id de parada |
duration |
sí | Duración de parada en segundos |
start_date |
sí | Fecha de inicio de la parada en formato "YYYYMMDDHHMMSS" |
placename |
sí | Lugar de la parada |
poi_id |
sí | Id de la geocerca |
M: Listar paradas
HTTP GET:
https://<hostname>/api/stops
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 | si | Hora en formato HH:MM:SS |
end_time |
Hora de fin | Texto | si | Hora en formato HH:MM:SS |
pois |
Lista de geocercas | Lista de números | no | Listado de ids de geocercas en las cuales se quiere ver paradas. |
findby |
Buscar paradas por | Texto | no | (valores: veh , driver ) Buscar y mostrar paradas por vehículos (veh) o conductores (driver). |
vehicle_ids |
Lista de vehículos | Lista de números | no | Listado de ids de vehículos de los cuales se quiere ver paradas. |
driver_ids |
Lista de conductores | Lista de números | no | Listado de ids de conductores de los cuales se quiere ver paradas. |
min_stop_len |
Tiempo mínimo de parada | Numérico | no | Cantidad mínima de minutos que debe haber durado la parada para ser retornada en la respuesta. |
stop_type |
Tipo de parada | Texto | no | (valores: ignOff , idle , tripend ) Tipo de paradas que se desean filtrar. Paradas con motor apagado(ignOff), paradas con motor encendido(idle) y paradas de fin de viaje(tripend) |
OUTPUT:
Json con los campos:
success
:boolean
distance_uom
:string
Unidades de medida de distancia.data
:json
Contiene una lista de Stop Data Objects
EJEMPLO CON CURL:
$ curl -u <api_key>:<password>
-X GET
https://<hostname>/api/stops?start_date=2017-01-01&end_date=2017-03-02&start_time=00:00&end_time=23:59
RESPUESTA:
{
"success": true,
"distance_uom": "km",
"data": [
{
"vehicle_id": 213,
"driver_id": 5122,
"event": "engine off",
"place": "Ruta 1, Zona 4, Ciudad de Guatemala, Guatemala",
"lat": "14.622829",
"lon": "-90.51352",
"start_date": "2019-03-12T07:46:55-06:00",
"end_date": "2019-03-12T07:46:55-06:00",
"duration": 25409299,
"idle_time": 41,
"off_time": 25409258,
"odometer": 3700.7,
"start_trip_id": 182484,
"start_trip_point": 1116097,
"poi_id": null,
"end_trip_id": 192678,
"end_trip_point": 1695288
},
{
"vehicle_id": 214,
"driver_id": null,
"event": "stopped",
"place": "Ruta 3, Zona 4, Ciudad de Guatemala, Guatemala",
"lat": "14.621780999",
"lon": "-90.514743",
"start_date": "2019-03-12T07:46:55-06:00",
"end_date": "2019-03-12T07:46:55-06:00",
"duration": 7961294,
"idle_time": 314,
"off_time": 7960980,
"odometer": 5139.1,
"start_trip_id": 190428,
"start_trip_point": 1541783,
"poi_id": null,
"end_trip_id": 192536,
"end_trip_point": 1682188
}
]
}
O: Stop Data Object
Cada objeto de parada tiene estos campos:
Campo | Descripción |
---|---|
vehicle_id |
Id del vehículo. |
driver_id |
Id del conductor asignado al vehículo cuando se realizó la parada. |
event |
Nombre del evento en el que inició la parada. |
place |
Lugar donde ocurrió la parada. |
lat |
Latitud donde ocurrió la parada. |
lon |
Longitud donde ocurrió la parada. |
start_date |
Fecha de inicio de la parada. En formato ISO 8601. |
end_date |
Fecha de fin de la parada. En formato ISO 8601. |
duration |
Duración de la parada en segundos. |
idle_time |
Tiempo parado con motor encendido en segundos. |
off_time |
Tiempo parado con motor apagado en segundos. |
odometer |
Odómetro del vehículo durante la parada. Obtener unidad de medida en la respuesta, en el campo distance_uom . |
start_trip_id |
Id del viaje en el que inició la parada. |
start_trip_point |
Id del punto en el que inició la parada. |
poi_id |
Id de la geocerca. Puede ser null . |
end_trip_id |
Id del viaje en el que terminó la parada. |
end_trip_point |
Id del punto en el que terminó la parada. |