API: POI Visits

M: Listar visitas a geocercas

HTTP GET:
https://<hostname>/api/visits
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 Fecha en formato HH:MM:SS
end_time Hora de fin Texto si Fecha 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 visitas.
poi_groups Lista de grupos de geocercas Lista de números no Listado de ids de grupos de geocercas en las cuales se quiere ver visitas.
findby Buscar visitas por Texto no (opcional, valores: 'veh', 'driver') Buscar y mostrar visitas 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 visitas a geocercas.
driver_ids Lista de conductores Lista de números no Listado de ids de conductores de los cuales se quiere ver visitas a geocercas.
min_stop_len Tiempo mínimo de visita Numérico no Cantidad mínima de minutos que debe haber durado la visitas a geocerca para ser retornada en la respuesta.
OUTPUT:

Json con los campos:

EJEMPLO CON CURL:
$ curl -u <api_key>:<password>
     -X GET
     https://<hostname>/api/visits?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": 344,
            "driver_id": 6123,
            "poi_id": 520,
            "place": "Parqueo TEC",
            "contact": "Anaité Orozco",
            "start_trip_id": 190502,
            "start_point_id": 1560098,
            "end_trip_id": 192754,
            "end_point_id": 1693265,
            "start_date": "2018-12-04T09:03:47-06:00",
            "end_date": "2019-03-08T14:42:15-06:00",
            "duration": 8141908,
            "start_odometer": 30.58,
            "end_odometer": 30.68
        },
        {
            "vehicle_id": 400,
            "driver_id": null,
            "poi_id": 521,
            "place": "Oficina Startrack",
            "contact": null,
            "start_trip_id": 192130,
            "start_point_id": 1665043,
            "end_trip_id": 192832,
            "end_point_id": 1695310,
            "start_date": "2019-02-18T10:21:44-06:00",
            "end_date": "2019-03-11T11:16:19-06:00",
            "duration": 1817675,
            "start_odometer": 0.02,
            "end_odometer": 0.02
        }
    ]
}

O: POI Visit Data Object

Cada objeto de visita a geocerca 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 visita.
poi_id Id de la geocerca.
contact Contacto en la geocerca.
place Nombre de la geocerca visitada.
start_trip_id Id del viaje en el que inició la visita.
start_trip_point Id del punto en el que inició la visita.
end_trip_id Id del viaje en el que terminó la visita.
end_trip_point Id del punto en el que terminó la visita.
start_date Fecha de inicio de la visita. En formato ISO 8601.
end_date Fecha de fin de la visita. En formato ISO 8601.
duration Duración de la visita en segundos.
start_odometer Odómetro del vehículo con el que se inició la visita. Obtener unidad de medida en la respuesta distance_uom.
end_odometer Odómetro del vehículo con el que se finalizó la visita. Obtener unidad de medida en la respuesta distance_uom.