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": 0,
      "hdop": 1,
      "deviceTypeId": 3,
      "deviceUseTypeId": 3,
      "speed": 0,
      "eventTypeId": 1,
      "beaconDown": false
  }

  * = 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. 1 = Start, 2 = End, 3 = Intermediate, 4 = Unique

  • 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 15 segundos de antiguedad con respecto a la hora UTC, y además no puede ser futura. 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. 0 = None, 1 = Car, 2 = Motorbike

  • 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. 1 = Baliza, 2 = Chaleco, 3 = Cono

  • deviceUseTypeId * (número entero): identificador del tipo de uso del dispositivo que envía la información. Posibles valores en /deviceUseTypes. 1 = Worker, 2 = Vehicle, 3 = Infrastructure

  • 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

  • evenTypeId * : identificador del tipo de evento. Posibles valores 1 = Encendido, 2 = Activado, 3 = Apagado

  • beaconDown (boolean): permite saber si el cono se encuentra caído físicamente. Posibles valores: true (si está caído), false (si está en pie). Será un campo requerido para conos

Nota: En el caso de que el tipo de dispositivo sea un cono (deviceType = 3), los siguientes campos deberán de tener valores determinados:

• vehicleType = 0 (None)

• deviceUseType = 3 (Infrastructure)

• beaconTypeId = 1 (Start)

• speed < 10

• beaconDown = true/false

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

• Se establece a continuación el orden, cantidad y frecuencia de los mensajes:

  1. Eventos de tipo Encendido, un único mensaje (opcional).
  2. Eventos de tipo Activado, tantos mensajes cómo dure la actividad de la baliza con una frecuencia de 5 minutos entre mensajes.
  3. Eventos de tipo Apagado, un único mensaje.

• En el caso de que el tipo de dispositivo sea un cono conectado (deviceTypeId = 3), la frecuencia de envío de mensaje será como máximo 5 minutos