Traffic - Get Traffic Flow Segment

Referencia

Servicio:: Maps

Versión de la API:: 1.0

Utilice para obtener información sobre las velocidades y los tiempos de viaje de la sección especificada de carretera.

La API de Traffic Flow Segment es una solicitud HTTP GET que proporciona información sobre las velocidades y los tiempos de desplazamiento del fragmento de carretera más cercano a las coordenadas dadas. Está diseñado para funcionar junto con la capa de flujo del servicio de representación de para admitir visualizaciones de datos de flujo en las que se pueden hacer clic. Con la API de Traffic Flow Segment, el lado cliente puede conectar cualquier lugar del mapa con datos de flujo en la carretera más cercana y presentarlo al usuario.

GET https://atlas.microsoft.com/traffic/flow/segment/{format}?api-version=1.0&style={style}&zoom={zoom}&query={query}

Con parámetros opcionales:

GET https://atlas.microsoft.com/traffic/flow/segment/{format}?api-version=1.0&style={style}&zoom={zoom}&query={query}&unit={unit}&thickness={thickness}&openLr={openLr}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
format	path	True	ResponseFormat	Formato deseado de la respuesta. El valor puede ser json o xml.
api-version	query	True	string	Número de versión de la API de Azure Maps.
query	query	True	number[]	Coordenadas del punto cerca del segmento de carretera. Este parámetro es una lista de cuatro coordenadas, que contiene dos pares de coordenadas (lat, long, lat, long) y calculados mediante EPSG4326 proyección. Cuando se llama directamente a este punto de conexión, las coordenadas se pasan como una sola cadena que contiene cuatro coordenadas, separadas por comas.
style	query	True	TrafficFlowSegmentStyle	Estilo que se va a usar para representar el icono. Los valores válidos son absolutos, que devuelven colores que reflejan la velocidad absoluta medida, relativa a la velocidad relativa al flujo libre, retraso relativo, que muestra velocidades relativas solo donde son diferentes de las velocidades de flujo libre.
zoom	query	True	integer (int32)	Nivel de zoom del icono deseado. El valor de zoom debe estar en el intervalo: 0-22 (incluido). Consulte niveles de zoom y de cuadrícula de mosaico para obtener más información.
openLr	query		boolean	Boolean sobre si la respuesta debe incluir código OpenLR
thickness	query		integer (int32) minimum: 1 maximum: 20	Valor del ancho de la línea que representa el tráfico. Este valor es un multiplicador y los valores aceptados oscilan entre 1 y 20. El valor predeterminado es 10.
unit	query		SpeedUnit	Unidad de velocidad en KMPH o MPH

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
x-ms-client-id		string	Especifica qué cuenta está pensada para su uso junto con el modelo de seguridad de Id. de Microsoft Entra. Representa un identificador único para la cuenta de Azure Maps y se puede recuperar de la API de cuenta del plano de administración de Azure Maps. Para usar la seguridad del identificador de Entra de Microsoft en Azure Maps, consulte los siguientes artículos de para obtener instrucciones.

Respuestas

Nombre	Tipo	Description
200 OK	TrafficFlowSegmentData	De acuerdo
Other Status Codes	ErrorResponse	Se ha producido un error inesperado.

Seguridad

AADToken

Estos son los flujos de Microsoft Entra OAuth 2.0. Cuando se empareja con acceso basado en rol de Azure control, se puede usar para controlar el acceso a las API REST de Azure Maps. Los controles de acceso basados en roles de Azure se usan para designar el acceso a una o varias cuentas de recursos o subrecursos de Azure Maps. Se puede conceder acceso a cualquier usuario, grupo o entidad de servicio a través de un rol integrado o de un rol personalizado compuesto por uno o varios permisos para las API REST de Azure Maps.

Para implementar escenarios, se recomienda ver conceptos de autenticación. En resumen, esta definición de seguridad proporciona una solución para modelar aplicaciones a través de objetos capaces de controlar el acceso en determinadas API y ámbitos.

Notas

Esta definición de seguridad requiere el uso del encabezado x-ms-client-id para indicar a qué recurso de Azure Maps solicita acceso la aplicación. Esto se puede adquirir desde la API de administración de de Maps.

El Authorization URL es específico de la instancia de nube pública de Azure. Las nubes soberanas tienen direcciones URL de autorización únicas y configuraciones de id. de Microsoft Entra. * El control de acceso basado en rol de Azure se configura desde el plano de administración de Azure a través de Azure Portal, PowerShell, la CLI, los SDK de Azure o las API REST. * El uso de sdk web de Azure Maps permite la configuración basada en la configuración de una aplicación para varios casos de uso.

Para obtener más información sobre la plataforma de identidad de Microsoft, consulte introducción a la plataforma de identidad de Microsoft.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Se trata de una clave compartida que se aprovisiona al Creación de una cuenta de Azure Maps en Azure Portal o mediante PowerShell, la CLI, los SDK de Azure o la API REST.

Con esta clave, cualquier aplicación puede acceder a todas las API REST. En otras palabras, esta clave se puede usar como clave maestra en la cuenta en la que se emiten.

Para las aplicaciones expuestas públicamente, nuestra recomendación es usar las aplicaciones cliente confidenciales enfoque acceder a las API REST de Azure Maps para que la clave se pueda almacenar de forma segura.

Tipo: apiKey
En: query

SAS Token

Se crea un token de firma de acceso compartido a partir de la operación List SAS en el recurso de Azure Maps a través del plano de administración de Azure a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST.

Con este token, cualquier aplicación tiene autorización para acceder a los controles de acceso basados en rol de Azure y el control específico a la expiración, la tasa y las regiones de uso para el token determinado. Es decir, el token de SAS se puede usar para permitir que las aplicaciones controle el acceso de forma más segura que la clave compartida.

En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es configurar una lista específica de orígenes permitidos en el recurso de cuenta de mapa de limitar el abuso de representación y renovar periódicamente el token de SAS.

Tipo: apiKey
En: header

Ejemplos

Request traffic flow segment information

Solicitud de ejemplo

HTTP

GET https://atlas.microsoft.com/traffic/flow/segment/json?api-version=1.0&style=absolute&zoom=10&query=52.41072,4.84239

Respuesta de muestra

status code:: 200

{
  "flowSegmentData": {
    "frc": "FRC3",
    "currentSpeed": 79,
    "freeFlowSpeed": 79,
    "currentTravelTime": 33,
    "freeFlowTravelTime": 33,
    "confidence": 0.5,
    "coordinates": {
      "coordinate": [
        {
          "latitude": 52.404648,
          "longitude": 4.8442388
        },
        {
          "latitude": 52.408447,
          "longitude": 4.8357286
        }
      ]
    },
    "openlr": null,
    "@version": "1.0.53-mascoma"
  }
}

Definiciones

Nombre	Description
Coordinates	Incluye las coordenadas que describen la forma del segmento. Las coordenadas se desplazan desde la carretera en función del nivel de zoom para admitir la visualización de alta calidad en cada escala.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
FlowSegmentData	Flow Segment Data (propiedad)
LatLongPair	Ubicación representada como latitud y longitud.
ResponseFormat	Formato deseado de la respuesta. El valor puede ser json o xml.
SpeedUnit	Unidad de velocidad en KMPH o MPH
TrafficFlowSegmentData	Este objeto se devuelve de una llamada correcta de Segmento de flujo de tráfico.
TrafficFlowSegmentStyle	Estilo que se va a usar para representar el icono. Los valores válidos son absolutos, que devuelven colores que reflejan la velocidad absoluta medida, relativa a la velocidad relativa al flujo libre, retraso relativo, que muestra velocidades relativas solo donde son diferentes de las velocidades de flujo libre.

Coordinates

Object

Incluye las coordenadas que describen la forma del segmento. Las coordenadas se desplazan desde la carretera en función del nivel de zoom para admitir la visualización de alta calidad en cada escala.

Nombre	Tipo	Description
coordinate	LatLongPair[]	Matriz de coordenadas

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

FlowSegmentData

Object

Flow Segment Data (propiedad)

Nombre	Tipo	Description
@version	string	Esto indica la versión de software que generó la respuesta.
confidence	number	La confianza es una medida de la calidad del tiempo de viaje y la velocidad proporcionados. Un valor de 1 significa plena confianza, que la respuesta contiene los datos de mayor calidad. Los valores inferiores indican el grado en que la respuesta puede variar de las condiciones reales de la carretera. Cualquier valor mayor que 0,6 significa que la información se basa en la entrada del sondeo en tiempo real. Un valor de 0,5 significa que la velocidad notificada se basa en la información histórica. Un valor entre 0,5 y 0,6 tiene un promedio ponderado calculado entre velocidades históricas y activas.
coordinates	Coordinates	Incluye las coordenadas que describen la forma del segmento. Las coordenadas se desplazan desde la carretera en función del nivel de zoom para admitir la visualización de alta calidad en cada escala.
currentSpeed	integer (int32)	Velocidad media actual en el punto seleccionado, en las unidades solicitadas. Esto se calcula a partir de currentAdvisorTime y la longitud del segmento seleccionado.
currentTravelTime	integer (int32)	Tiempo de desplazamiento actual en segundos, en este segmento de tráfico, basado en medidas fusionadas en tiempo real entre las ubicaciones definidas en la dirección especificada.
frc	string	Clase de carretera funcional. Esto indica el tipo de carretera: 0: Autopista, autopista, autopista u otra carretera principal. 1: Carretera principal, menos importante que una autopista. 2: Otro camino importante. 3: Carretera secundaria. 4: Carretera de conexión local. 5: Carretera local de gran importancia. 6: Carretera local.
freeFlowSpeed	integer (int32)	Velocidad de flujo libre esperada en condiciones ideales, expresadas en las unidades solicitadas. Esto está relacionado con freeFlowAdvisorTime.
freeFlowTravelTime	integer (int32)	El tiempo de desplazamiento en segundos, en este segmento de tráfico, que se esperaría en condiciones ideales de flujo libre.
openlr	string	Código OpenLR para el segmento. Consulte openLR para obtener más información sobre el uso de códigos LR abiertos.

LatLongPair

Object

Ubicación representada como latitud y longitud.

Nombre	Tipo	Description
latitude	number (double)	Latitude (propiedad)
longitude	number (double)	Longitud (propiedad)

ResponseFormat

Enumeración

Formato deseado de la respuesta. El valor puede ser json o xml.

Valor	Description
json	el formato de intercambio de datos de notación de objetos JavaScript
xml	el lenguaje de marcado extensible

SpeedUnit

Enumeración

Unidad de velocidad en KMPH o MPH

Valor	Description
KMPH	Kilómetros por hora
MPH	Millas por hora

TrafficFlowSegmentData

Object

Este objeto se devuelve de una llamada correcta de Segmento de flujo de tráfico.

Nombre	Tipo	Description
flowSegmentData	FlowSegmentData	Flow Segment Data (propiedad)

TrafficFlowSegmentStyle

Enumeración

Estilo que se va a usar para representar el icono. Los valores válidos son absolutos, que devuelven colores que reflejan la velocidad absoluta medida, relativa a la velocidad relativa al flujo libre, retraso relativo, que muestra velocidades relativas solo donde son diferentes de las velocidades de flujo libre.

Valor	Description
absolute
relative
relative-delay

Compartir a través de

Traffic - Get Traffic Flow Segment

Parámetros de identificador URI

Encabezado de la solicitud

Respuestas

Seguridad

AADToken

Notas

Ámbitos

subscription-key

SAS Token

Ejemplos

Request traffic flow segment information

Solicitud de ejemplo

Respuesta de muestra

Definiciones

Coordinates

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FlowSegmentData

LatLongPair

ResponseFormat

SpeedUnit

TrafficFlowSegmentData

TrafficFlowSegmentStyle