Saltar a contenido

API: Vehicle Status Report

M: Listar historial de estado de vehículos y usuarios

HTTP GET:
https://<hostname>/api/vehicle-status-report
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
vehicle_status_ids Lista de estados de vehiculo Lista de números no Listado de ids de estado para filtrar el historial
vehicle_ids Lista de vehiculos Lista de números no Listado de ids de los vehículos de los que se quiere el historial
driver_ids Lista de usuarios Lista de números no Listado de ids de los usuarios de los que se quiere el historial

OUTPUT:

Json con los campos:

EJEMPLO CON CURL:
$ curl -u <api_key>:<password>
     -X GET
     https://<hostname>/api/vehicle-status-report?start_date=2021-01-01&end_date=2021-01-15&start_time=00:00&end_time=23:59&vehicle_ids=2731,5121&driver_ids=1340,2138,1021&vehicle_status_ids=1,2,3
RESPUESTA:
{
    "distanceUnit": "km",
    "timezone": "America/Guatemala",
    "data": [
        {
            "start_datetime_iso": "2025-12-01T00:00:00-06:00",
            "end_datetime_iso": "2025-12-01T07:48:27-06:00",
            "vehicle_status_id": 5,
            "start_address": "Ciudad de guatemala (POI)",
            "end_address": "Ciudad de guatemala (POI)",
            "distance_driven": 0,
            "odometer": 4122,
            "duration_seconds": 28133,
            "driver": null,
            "tracking_numbers": null,
            "vehicle": {
                "id": 939,
                "description": "Suministros y Más, S.A.",
                "remote_id": null
            }
        },
        {
            "start_datetime_iso": "2025-12-01T00:00:00-06:00",
            "end_datetime_iso": "2025-12-01T07:48:27-06:00",
            "vehicle_status_id": 5,
            "start_address": "Ciudad de guatemala (POI)",
            "end_address": "Ciudad de guatemala (POI)",
            "distance_driven": 0,
            "odometer": 4125.6,
            "duration_seconds": 28107,
            "driver": null,
            "tracking_numbers": null,
            "vehicle": {
                "id": 939,
                "description": "Suministros y Más, S.A.",
                "remote_id": null
            }
        }
    ]
}

O: Vehicle And User Status Record Data Object

Cada elemento tiene estos campos:

Campo Descripción
start_datetime_iso Fecha y hora a la que el usuario cambió al estado en formato Unix time.
end_datetime_iso Fecha y hora a la que el usuario cambió a otro estado en formato Unix time.
vehicle_status_id Id del estado
start_address Ubicación del usuario cuando cambió al estado.
end_address Ubicación del usuario cuando cambió a otro estado.
distance_driven Distancia recorrida.
odometer Distancia total recorrida.
duration_seconds Tiempo en segundos.
driver Datos del conductor.
tracking_numbers Numero de seguimiento.
vehicle Información del vehiculo, como el id, descripción y el id remoto.