El evento es la parte principal de esta API de ingesta de datos. En este elemento es donde se va a enviar a la plataforma la información del evento generado por cada uno de los dispositivos en tiempo real.
-
Method: POST
-
URL: {baseUrl}/v1/events
-
Body:
{ "actionId": "CLI_235", "beaconId": "cff92179-dc0a-47da-bd9e-5e9c5b14d251", "beaconTypeId": 1, "timestamp": "2021-03-15T13:34:00.000Z", "lon": -3.45368, "lat": 40.36586, "vehicleTypeId": 1, "hdop": 1, "deviceTypeId": 1, "deviceUseTypeId": 1, "speed": 120 }
* = Campo requerido
-
actionId * (texto): Identificador único del evento
-
beaconId * (texto): identificador único de la baliza (por ejemplo, la MAC)
-
beaconTypeId * (número entero): identificador del tipo de baliza. Posibles valores en /beaconTypes
-
timestamp * (fecha UTC): fecha y hora en formato UTC del momento en el que el evento se ha generado. Es necesario que sea de un máximo de 30 segundos de antiguedad con respecto a la hora UTC. La fecha debe finalizar con el caracter 'Z' que marca que está en UTC
-
lon * (número decimal): longitud de coordenadas de tipo WGS 84 donde se ha generado el evento
-
lat * (número decimal): latitud de coordenadas de tipo WGS 84 donde se ha generado el evento
-
vehicleTypeId* (número entero): identificador del tipo de vehículo. Posibles valores en /vehicleTypes
-
hdop * (número entero): valor DOP para determinar la calidad de la información del GPS. Más información aquí
-
deviceTypeId * (número entero): identificador del tipo de dispositivo desde el que se envía la información. Posibles valores en /deviceTypes
-
deviceUseTypeId * (número entero): identificador del tipo de uso del dispositivo que envía la información. Posibles valores en /deviceUseTypes
-
speed * (número decimal): velocidad en kilómetros por hora a la que se encuentra el elemento en el momento que envía el evento
Requisitos
Con objeto de mantener la calidad de los mensajes se aplicarán los siguientes requisitos al contenido de los mensajes:
-
La posición geográfica debe estar contenida en el territorio español
-
La posición proporcionada por el GPS no debe tener un error mayor a 5 metros
-
Dada la criticidad de esta información, se requerirá que los eventos se generen desde el momento en que los trabajadores entren en la zona de riesgo, y se dejen de enviar cuando salgan de la misma
-
Se requiere una antigüedad máxima de 15 segundos con respecto a la hora UTC
-
Se estima una frecuencia de refresco de 15 segundos para carreteras con velocidad máxima de 120 km/h y de 20 segundos para carreteras de velocidad máxima de menos o igual a 90 km/h desde el momento de entrada, y durante toda la estancia dentro de la zona de riesgo de la carretera