Saltar a contenido

API: Fuel Consumption

M: Listar lecturas de consumo de combustible

Límite de Tasa de Peticiones

Máximo de 20 peticiones por IP en 5 minutos

HTTP GET:
https://<hostname>/api/fuel-consumption
URL PARAMETERS:
Nombre Tipo Requerido Descripción
date Fecha Texto sí Fecha en formato YYYY-MM-DD
start_time Hora de inicio Texto sí Hora en formato HH:MM:SS
end_time Hora de fin Texto sí Hora en formato HH:MM:SS
fuel_cost Costo de combustible Número no Costo por unidad de combustible. 0 por defecto.
vehicle_ids Lista de vehículos Lista de números no Listado de ids de vehículos separados por coma. Todos por defecto.
OUTPUT:

Json con los campos:

EJEMPLO CON CURL:
$ curl -u <api_key>:<password>
     -X GET
     https://<hostname>/api/fuel-consumption?date=2019-03-01&start_time=00:00&end_time=23:59&fuel_cost=7.7
RESPUESTA:
{
    "success": true,
    "timezone": "America/Guatemala",
    "distance_uom": "km",
    "fuel_consumption_uom": "gal",
    "currency_symbol": "Q",
    "summary": [
        {
            "vehicle_id": 364,
            "cost_by_distance": 3872.6,
            "cost_by_time": 5757.5,
            "efficiency": 0,
            "fuel_consumed": 7795.5,
            "fuel_expense": 60025.35,
            "ignition_on_hours": 10.4,
            "distance": 15.5,
            "sensor_type": "volume"
        },
    ],
    "data": [
        {
            "vehicle_id": 364,
            "sensor_id": 57,
            "sensor_type": "volume",
            "event": "respuesta a comando de rastreo",
            "place": "Fábrica B",
            "lat": "14.622536",
            "lon": "-90.514066",
            "consumption": 9450,
            "datetime_iso": "2019-04-01T05:43:37-06:00"
        },
        {
            "vehicle_id": 364,
            "sensor_id": 57,
            "sensor_type": "volume",
            "event": " 14 km/h",
            "place": "Cuadra del Tec",
            "lat": "14.622281",
            "lon": "-90.513863",
            "consumption": 9795,
            "datetime_iso": "2019-04-01T15:20:06-06:00"
        },
    ]
}

O: Fuel Consumption Summary Object

Cada objeto de resumen de consumo de combustible tiene estos campos:

Campo Tipo Descripción
vehicle_id Número Id del vehículo.
cost_by_distance Número Costo promedio por unidad de distancia.
cost_by_time Número Costo promedio por unidad de tiempo.
efficiency Número Distancia entre combustible consumido.
fuel_consumed Número Combustible consumido.
fuel_expense Número Gasto de combusitble.
ignition_on_hours Número Tiempo de motor encendido en horas.
distance Número Distancia recorrida.
sensor_type "consumption" o "volume" Tipo del sensor que mandó la lectura.

O: Fuel Consumption Data Object

Cada objeto de lectura de consumo de combustible tiene estos campos:

Campo Tipo Descripción
vehicle_id Número Id del vehículo.
sensor_id Número Id del sensor que mandó la lectura.
sensor_type "consumption" o "volume" Tipo del sensor que mandó la lectura.
event Texto Nombre del evento cuando se hizo la lectura.
place Texto Lugar en que se hizo la lectura.
lat Texto Latitud.
lon Texto Longitud.
consumption Número Valor de la lectura de consumo de combustible.
datetime_iso Fecha y hora en formato ISO Fecha y hora.