... | ... | @@ -25,31 +25,6 @@ Este caso de uso tiene un comportamiento similar al que ofrece la interfa de ban |
|
|
|
|
|
En el endpoint se publican las velocidades recomendadas en formato JSON. Aquí se puede ver un ejemplo:
|
|
|
|
|
|
```json
|
|
|
```
|
|
|
|
|
|
A continuación se presenta una descripción de cada uno de los campos del JSON anterior. Dicho JSON, publica la información de una congestión concreta así como las velocidades recomendadas en diferentes puntos:
|
|
|
|
|
|
En el documento se publica una lista de carreteras afectadas en las que existe un atasco, cada una de ellas esta formada por un campo **_properties_** y **_recommendedSpeeds_**. Es decir, cada conjunto de estos dos campos referencia a una carretera diferente con recomendaciones de velocidad diferentes.
|
|
|
|
|
|
- **Properties:** Contiene información relativa a la zona afectada.
|
|
|
- **Lat:** Latitud donde comienza el atasco.
|
|
|
- **Lon:** Longitud donde comienza el atasco.
|
|
|
- **Timestamp(Fecha UTC)**: Fecha y hora en formato UTC del momento en el que se ha actualizado la información. Puede no coinicidir con la fecha y hora actuales
|
|
|
- **Vialidad.**
|
|
|
- **RoadDescription:** Nombre de la carretera o carreteras que se ven afectadas.
|
|
|
- **Direction:** La dirección de la carretera sobre la que se aplica el algoritmo. Puede tener valores 1 (Ascendente) o 0 (Descendente).
|
|
|
- **AffectedLength:** Longitud, en metros, del tramo en el que actualmente hay una retención. Cuanto mayor sea esta distancia mayor será la distancia entre velocidades recomendadas.
|
|
|
- **RoadMaxSpeed:** Velocidad máxima de la vía, en Km/h.
|
|
|
- **RecommendedSpeeds:** Contiene las velocidades recomendadas en los distintos tramos.
|
|
|
- **Speed:** Velocidad recomendada.
|
|
|
- **kmStart:** Punto de inicio de la zona de recomendación. Representa la distancia desde el punto de origen en la que comienza la zona de velocidad recomendada.
|
|
|
- **kmEnd:** Punto de finalización de la zona de recomendación. Representa la distancia desde el punto de origen en la que finaliza la zona de velocidad recomendada.
|
|
|
|
|
|
## Errores
|
|
|
|
|
|
Todas las respuestas HTTP que no sean **200 – OK**, se pueden considerar **inválidas**. Independientemente del mensaje de error, el formato de la respuesta es como el siguiente ejemplo:
|
|
|
|
|
|
```json
|
|
|
[
|
|
|
{
|
... | ... | @@ -133,6 +108,36 @@ Todas las respuestas HTTP que no sean **200 – OK**, se pueden considerar **inv |
|
|
]
|
|
|
```
|
|
|
|
|
|
A continuación se presenta una descripción de cada uno de los campos del JSON anterior. Dicho JSON, publica la información de una congestión concreta así como las velocidades recomendadas en diferentes puntos:
|
|
|
|
|
|
En el documento se publica una lista de carreteras afectadas en las que existe un atasco, cada una de ellas esta formada por un campo **_properties_** y **_recommendedSpeeds_**. Es decir, cada conjunto de estos dos campos referencia a una carretera diferente con recomendaciones de velocidad diferentes.
|
|
|
|
|
|
- **Properties:** Contiene información relativa a la zona afectada.
|
|
|
- **Lat:** Latitud donde comienza el atasco.
|
|
|
- **Lon:** Longitud donde comienza el atasco.
|
|
|
- **Timestamp(Fecha UTC)**: Fecha y hora en formato UTC del momento en el que se ha actualizado la información. Puede no coinicidir con la fecha y hora actuales
|
|
|
- **Vialidad.**
|
|
|
- **RoadDescription:** Nombre de la carretera o carreteras que se ven afectadas.
|
|
|
- **Direction:** La dirección de la carretera sobre la que se aplica el algoritmo. Puede tener valores 1 (Ascendente) o 0 (Descendente).
|
|
|
- **AffectedLength:** Longitud, en metros, del tramo en el que actualmente hay una retención. Cuanto mayor sea esta distancia mayor será la distancia entre velocidades recomendadas.
|
|
|
- **RoadMaxSpeed:** Velocidad máxima de la vía, en Km/h.
|
|
|
- **RecommendedSpeeds:** Contiene las velocidades recomendadas en los distintos tramos.
|
|
|
- **Speed:** Velocidad recomendada.
|
|
|
- **kmStart:** Punto de inicio de la zona de recomendación. Representa la distancia desde el punto de origen en la que comienza la zona de velocidad recomendada.
|
|
|
- **kmEnd:** Punto de finalización de la zona de recomendación. Representa la distancia desde el punto de origen en la que finaliza la zona de velocidad recomendada.
|
|
|
|
|
|
## Errores
|
|
|
|
|
|
Todas las respuestas HTTP que no sean **200 – OK**, se pueden considerar **inválidas**. Independientemente del mensaje de error, el formato de la respuesta es como el siguiente ejemplo:
|
|
|
|
|
|
```json
|
|
|
{
|
|
|
"status": 401,
|
|
|
"code": 1,
|
|
|
"message": "User not found or valid"
|
|
|
}
|
|
|
```
|
|
|
|
|
|
La información relativa a los errores en este caso de uso se puede encontrar aquí. Estos errores tendrán tres categorías principales:
|
|
|
|
|
|
#### Error de Autentificación
|
... | ... | |