Saltar a contenido

API: Distance

M: Listar distancia recorrida por día

Límite de Tasa de Peticiones

Máximo de 20 peticiones por IP en 5 minutos

HTTP GET:
https://<hostname>/api/distance
URL PARAMETERS:
Nombre Tipo Requerido Descripción
date Fecha Texto Fecha en formato YYYY-MM-DD
start_time Hora de inicio Texto Hora en formato HH:MM:SS
end_time Hora de fin Texto Hora en formato HH:MM:SS
vehicle_ids Lista de vehículos Lista de números no Listado de ids de vehículos separados por coma. Todos por defecto.
days_of_week Días de la semana Lista de números 0 a 6 no Listado de días de la semana separados por coma. Todos por defecto. 0 es domingo y 6 es sábado.
OUTPUT:

Json con los campos:

  • success: boolean
  • timezone: string identificador TZ
  • distance_units: "km" o "mi"
  • data: lista de Distance Data Object
EJEMPLO CON CURL:
$ curl -u <api_key>:<password>
     -X GET
     https://<hostname>/api/distance?date=2019-06-01&start_time=00:00&end_time=23:59&vehicle_ids=199,240&days_of_week=0,1,2,3,4,5,6
RESPUESTA:
{
    "success": true,
    "timezone": "America/Guatemala",
    "distance_units": "mi",
    "data": [
        {
            "vehicle_id": 199,
            "tracking_type": "gps",
            "distance": 1920.84
        },
        {
            "vehicle_id": 240,
            "tracking_type": "gps",
            "distance": 24.47
        },
    ]
}

O: Distance Data Object

Cada objeto de distancia recorrida por día tiene estos campos:

Campo Tipo Descripción
vehicle_id Número Id del vehículo.
tracking_type "gps" o "cell-based" Tipo de rastreo para la distancia calculada.
distance Número Valor de la distancia recorrida.