Evento - dgt30-esp/Caso-de-uso-17 GitHub Wiki

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/event

  • Body:

    {
  "actionId": "CLI_100",
  "beaconId": "cff92179-dc0a-47da-bd9e-5e9c5b14d251",
  "beaconTypeId": "1",
  "timestamp": "{{$timestamp}}",
  "lon": -3.767109,
  "lat": 41.954368,
  "eventTypeId": "2",
  "hdop": "5" 
}

* = 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 = App, 2 = Baliza

  • 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. 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

  • evenTypeId * : identificador del tipo de evento. Posibles valores 2 = Dentro de zona de riesgo, 3 = Salida de zona de riesgo

  • hdop * (número entero): valor DOP para determinar la calidad de la información del GPS. Más información aquí

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
  • Se establece a continuación el orden, cantidad y frecuencia de los mensajes:
    1. Eventos de tipo Dentro de zona de riesgo, tantos mensajes como el usuario esté dentro de la zona de riesgo, un mensaje cada 15 segundos .
    2. Eventos de tipo Salida de zona de riesgo, un único mensaje.
  • La posición proporcionada por el GPS no debe tener un error mayor a 5 metros
  • Se aceptaran eventos con una antigüedad máxima de 15 segundos con respecto a la hora UTC, y que no sea un dato a futuro. En caso de no cumplirse, se recibirá un: HTTP Status: 400 Bad Request Error code: 10