Traffic - Get Traffic Flow Segment

Referencia

Service:: Maps

API Version:: 1.0

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

La Traffic Flow Segment API 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 especificadas. Está diseñado para funcionar junto con la capa de flujo del servicio renderizado para admitir visualizaciones de datos de flujo en las que se puede hacer clic. Con la Traffic Flow Segment API, 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}

With optional parameters:

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 para el icono deseado. El valor de zoom debe estar en el intervalo: 0-22 (ambos incluidos). Consulte Niveles de zoom y 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	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 Microsoft Entra ID. 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 Microsoft Entra ID seguridad en Azure Maps consulte los siguientes artículos para obtener instrucciones.

Respuestas

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

Seguridad

AADToken

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

Para implementar escenarios, se recomienda ver los conceptos de autenticación. En resumen, esta definición de seguridad proporciona una solución para el modelado de 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 x-ms-client-id encabezado para indicar a qué recurso Azure Maps la aplicación solicita acceso. Esto se puede adquirir desde la API de administración de Maps .

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 Microsoft Entra ID. * 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, CLI, SDK de Azure o API REST. * El uso del 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 Plataforma de identidad de Microsoft, consulte Plataforma de identidad de Microsoft información general.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

subscription-key

Se trata de una clave compartida que se aprovisiona al Create una cuenta de Azure Maps en el 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.

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

Type: apiKey
In: query

SAS Token

Se trata de un token de firma de acceso compartido que se crea 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 está autorizada para acceder a los controles de acceso basado en roles de Azure y al control específico de 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 controlen 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 la cuenta de mapa para limitar la representación de abusos y renovar periódicamente el token de SAS.

Type: apiKey
In: header

Ejemplos

Request traffic flow segment information

Sample Request

HTTP

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

Sample Response

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 según el 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	Propiedad De datos de segmento de flujo
LatLongPair	Una 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 al 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

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

Nombre	Tipo	Description
coordinate	LatLongPair[]	Matriz de coordenadas

ErrorAdditionalInfo

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

Detalle del error.

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

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

FlowSegmentData

Propiedad De datos de segmento de flujo

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 de la velocidad y el tiempo de viaje 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 basaba en la entrada de 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 de vida.
coordinates	Coordinates	Incluye las coordenadas que describen la forma del segmento. Las coordenadas se desplazan desde la carretera según el nivel de zoom para admitir la visualización de alta calidad en cada escala.
currentSpeed	integer	Velocidad media actual en el punto seleccionado, en las unidades solicitadas. Esto se calcula a partir de currentOnlineTime y la longitud del segmento seleccionado.
currentTravelTime	integer	Tiempo de desplazamiento actual en segundos, en este segmento de tráfico, basado en mediciones 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: Otra carretera importante. 3: Carretera secundaria. 4: Carretera de conexión local. 5: Carretera local de gran importancia. 6: Carretera local.
freeFlowSpeed	integer	Velocidad de flujo libre esperada en condiciones ideales, expresadas en las unidades solicitadas. Esto está relacionado con freeFlow TravelTime.
freeFlowTravelTime	integer	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 segmento. Consulte OpenLR para obtener más información sobre el uso de códigos Open LR.

LatLongPair

Una ubicación representada como latitud y longitud.

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

ResponseFormat

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

Nombre	Tipo	Description
json	string	Formato de intercambio de datos de notación de objetos JavaScript
xml	string	Lenguaje de marcado extensible

SpeedUnit

Unidad de velocidad en KMPH o MPH

Nombre	Tipo	Description
KMPH	string	Kilómetros por hora
MPH	string	Millas por hora

TrafficFlowSegmentData

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

Nombre	Tipo	Description
flowSegmentData	FlowSegmentData	Propiedad De datos de segmento de flujo

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.

Nombre	Tipo	Description
absolute	string
relative	string
relative-delay	string

Share via