|
|
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.
|
|
|
|
|
|
#### Envío de un único evento
|
|
|
|
|
|
- Method: POST
|
|
|
|
|
|
- URL: {baseUrl}/v1/**events**
|
|
|
- URL: {baseUrl}/v1/**event**
|
|
|
|
|
|
- Body:
|
|
|
- Body (elemento en formato JSON):
|
|
|
|
|
|
```json
|
|
|
{
|
... | ... | @@ -19,26 +21,65 @@ El evento es la parte principal de esta API de ingesta de datos. En este element |
|
|
"speed": 120
|
|
|
}
|
|
|
```
|
|
|
|
|
|
#### Envío de múltiples eventos
|
|
|
|
|
|
Este endpoint permite el envío de múltiples eventos al mismo tiempo. Todos ellos deben cumplir con los mismos requisitos que si fueran enviados individualmente.
|
|
|
|
|
|
- Method: POST
|
|
|
|
|
|
- URL: {baseUrl}/v1/**events**
|
|
|
|
|
|
- Body (array de elementos en formato JSON):
|
|
|
|
|
|
**\* = 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 = Vehicle, 2 = Mobile
|
|
|
|
|
|
- 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
|
|
|
|
|
|
- eventTypeId * (número entero): identificador del tipo de evento. Posibles valores en /eventTypes. 1 = VAC en camino, 2 = VAC en intervención, 3 = VAC intervención finalizada
|
|
|
|
|
|
- hdop * (número entero): valor DOP para determinar la calidad de la información del GPS. Más información [aquí](https://en.wikipedia.org/wiki/Dilution_of_precision_(navigation))
|
|
|
|
|
|
- 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
|
|
|
```json
|
|
|
[
|
|
|
{
|
|
|
"actionId": "CLI_235",
|
|
|
"beaconId": "00:1B:44:11:3A:B7",
|
|
|
"beaconTypeId": 1,
|
|
|
"timestamp": "{{$isoTimestamp}}",
|
|
|
"lon": -0.979758,
|
|
|
"lat": 41.694851,
|
|
|
"eventTypeId": 1,
|
|
|
"hdop": 1,
|
|
|
"speed": 120
|
|
|
},
|
|
|
{
|
|
|
"actionId": "CLI_235",
|
|
|
"beaconId": "00:1B:44:11:3A:B8",
|
|
|
"beaconTypeId": 1,
|
|
|
"timestamp": "{{$isoTimestamp}}",
|
|
|
"lon": -0.978548,
|
|
|
"lat": 41.684751,
|
|
|
"eventTypeId": 1,
|
|
|
"hdop": 1,
|
|
|
"speed": 120
|
|
|
}
|
|
|
]
|
|
|
```
|
|
|
|
|
|
#### Descripción de los campos del evento
|
|
|
|
|
|
*** = 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 = Vehicle, 2 = Mobile
|
|
|
|
|
|
- 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
|
|
|
|
|
|
- eventTypeId * (número entero): identificador del tipo de evento. Posibles valores en /eventTypes. 1 = VAC en camino, 2 = VAC en intervención, 3 = VAC intervención finalizada
|
|
|
|
|
|
- hdop * (número entero): valor DOP para determinar la calidad de la información del GPS. Más información [aquí](https://en.wikipedia.org/wiki/Dilution_of_precision_(navigation))
|
|
|
|
|
|
- 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
|
|
|
|
... | ... | |