Traffic - Get Traffic Flow Segment

Referência

Service:: Maps

API Version:: 1.0

Utilize para obter informações sobre as velocidades e os tempos de deslocação do troço de estrada especificado.

A Traffic Flow Segment API é um pedido HTTP GET que fornece informações sobre as velocidades e os tempos de viagem do fragmento de estrada mais próximo das coordenadas fornecidas. Foi concebido para funcionar em conjunto com a camada Flow do Serviço de Composição para suportar visualizações de dados de fluxo clicáveis. Com a Traffic Flow Segment API, o lado do cliente pode ligar qualquer local no mapa com dados de fluxo na estrada mais próxima e apresentá-lo ao utilizador.

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 do URI

Name	Em	Necessário	Tipo	Description
format	path	True	ResponseFormat	Formato pretendido da resposta. O valor pode ser json ou xml.
api-version	query	True	string	Número da versão da API Azure Maps.
query	query	True	number[]	Coordenadas do ponto perto do segmento de estrada. Este parâmetro é uma lista de quatro coordenadas, que contém dois pares de coordenadas (lat, longo, lat, longo) e calculados com EPSG4326 projeção. Quando este ponto final é chamado diretamente, as coordenadas são transmitidas como uma única cadeia que contém quatro coordenadas, separadas por vírgulas.
style	query	True	TrafficFlowSegmentStyle	O estilo a ser utilizado para compor o mosaico. Os valores válidos são absolutos, o que devolve cores que refletem a velocidade absoluta medida, relativamente à qual devolve a velocidade relativa ao fluxo livre, Relativo-atraso, que apresenta velocidades relativas apenas onde são diferentes das velocidades de fluxo livre
zoom	query	True	integer int32	Nível de zoom para o mosaico pretendido. O valor do zoom tem de estar no intervalo: 0-22 (inclusive). Consulte Níveis de Zoom e Grelha de Mosaicos para obter detalhes.
openLr	query		boolean	Valor booleano sobre se a resposta deve incluir código OpenLR
thickness	query		integer int32	O valor da largura da linha que representa o tráfego. Este valor é um multiplicador e os valores aceites variam entre 1 e 20. O valor predefinido é 10.
unit	query		SpeedUnit	Unidade de velocidade em KMPH ou MPH

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
x-ms-client-id		string	Especifica a conta que se destina à utilização em conjunto com o modelo de segurança Microsoft Entra ID. Representa um ID exclusivo para a conta Azure Maps e pode ser obtido a partir da API de Conta do plano de gestão Azure Maps. Para utilizar Microsoft Entra ID segurança no Azure Maps consulte os seguintes artigos para obter orientações.

Respostas

Name	Tipo	Description
200 OK	TrafficFlowSegmentData	OK
Other Status Codes	ErrorResponse	Ocorreu um erro inesperado.

Segurança

AADToken

Estes são os fluxos Microsoft Entra OAuth 2.0. Quando emparelhado com o controlo de acesso baseado em funções do Azure, pode ser utilizado para controlar o acesso às APIs REST Azure Maps. Os controlos de acesso baseados em funções do Azure são utilizados para designar o acesso a uma ou mais Azure Maps conta de recursos ou sub-recursos. Qualquer utilizador, grupo ou principal de serviço pode ter acesso através de uma função incorporada ou de uma função personalizada composta por uma ou mais permissões para Azure Maps APIs REST.

Para implementar cenários, recomendamos que veja os conceitos de autenticação. Em resumo, esta definição de segurança fornece uma solução para modelar aplicações através de objetos com capacidade de controlo de acesso em APIs e âmbitos específicos.

Notas

Esta definição de segurança requer a utilização do x-ms-client-id cabeçalho para indicar a que recurso Azure Maps a aplicação está a pedir acesso. Isto pode ser adquirido a partir da API de gestão do Maps .

O Authorization URL é específico da instância da cloud pública do Azure. As clouds soberanas têm URLs de Autorização exclusivos e configurações de Microsoft Entra ID. * O controlo de acesso baseado em funções do Azure está configurado a partir do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * A utilização do SDK Web Azure Maps permite a configuração baseada na configuração de uma aplicação para vários casos de utilização.

Para obter mais informações sobre plataforma de identidades da Microsoft, consulte plataforma de identidades da Microsoft descrição geral.

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

Scopes

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

subscription-key

Esta é uma chave partilhada que é aprovisionada quando Cria uma conta Azure Maps no portal do Azure ou com o PowerShell, a CLI, os SDKs do Azure ou a API REST.

Com esta chave, qualquer aplicação pode aceder a toda a API REST. Por outras palavras, esta chave pode ser utilizada como uma chave mestra na conta na qual são emitidas.

Para aplicações expostas publicamente, a nossa recomendação é utilizar a abordagem de aplicações cliente confidenciais para aceder Azure Maps APIs REST para que a sua chave possa ser armazenada de forma segura.

Type: apiKey
In: query

SAS Token

Este é um token de assinatura de acesso partilhado criado a partir da operação Listar SAS no recurso Azure Maps através do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com este token, qualquer aplicação está autorizada a aceder com controlos de acesso baseados em funções do Azure e controlo detalhado para a expiração, taxa e regiões de utilização para o token específico. Por outras palavras, o Token de SAS pode ser utilizado para permitir que as aplicações controlem o acesso de uma forma mais segura do que a chave partilhada.

Para aplicações expostas publicamente, a nossa recomendação é configurar uma lista específica de origens permitidas no recurso da conta de Mapa para limitar o abuso de composição e renovar regularmente o Token de SAS.

Type: apiKey
In: header

Exemplos

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"
  }
}

Definições

Name	Description
Coordinates	Inclui as coordenadas que descrevem a forma do segmento. As coordenadas são movidas da estrada consoante o nível de zoom para suportar a visualização de alta qualidade em todas as escalas.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta a erros
FlowSegmentData	Propriedade Dados do Segmento de Fluxo
LatLongPair	Uma localização representada como uma latitude e longitude.
ResponseFormat	Formato pretendido da resposta. O valor pode ser json ou xml.
SpeedUnit	Unidade de velocidade em KMPH ou MPH
TrafficFlowSegmentData	Este objeto é devolvido de uma chamada bem-sucedida do Segmento de Fluxo de Tráfego
TrafficFlowSegmentStyle	O estilo a ser utilizado para compor o mosaico. Os valores válidos são absolutos, o que devolve cores que refletem a velocidade absoluta medida, relativamente à qual devolve a velocidade relativa ao fluxo livre, Relativo-atraso, que apresenta velocidades relativas apenas onde são diferentes das velocidades de fluxo livre

Coordinates

Inclui as coordenadas que descrevem a forma do segmento. As coordenadas são movidas da estrada consoante o nível de zoom para suportar a visualização de alta qualidade em todas as escalas.

Name	Tipo	Description
coordinate	LatLongPair[]	Matriz de coordenadas

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informações adicionais.

ErrorDetail

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta a erros

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

FlowSegmentData

Propriedade Dados do Segmento de Fluxo

Name	Tipo	Description
@version	string	Isto indica a versão de software que gerou a resposta.
confidence	number	A confiança é uma medida da qualidade do tempo e velocidade de viagem fornecidos. Um valor de 1 significa total confiança, que a resposta contém os dados de maior qualidade. Os valores mais baixos indicam o grau em que a resposta pode variar em função das condições reais na estrada. Qualquer valor superior a 0,6 significa que as informações foram baseadas na entrada da sonda em tempo real. Um valor de 0,5 significa que a velocidade comunicada se baseia em informações históricas. Um valor entre 0,5 e 0,6 tem uma média calculada ponderada entre velocidades históricas e dinâmicas.
coordinates	Coordinates	Inclui as coordenadas que descrevem a forma do segmento. As coordenadas são movidas da estrada consoante o nível de zoom para suportar a visualização de alta qualidade em todas as escalas.
currentSpeed	integer	A velocidade média atual no ponto selecionado, nas unidades pedidas. Isto é calculado a partir do currentTravelTime e do comprimento do segmento selecionado.
currentTravelTime	integer	Tempo de deslocação atual em segundos, através deste segmento de tráfego, com base em medições em tempo real fundidas entre as localizações definidas na direção especificada.
frc	string	Classe de Estrada Funcional. Isto indica o tipo de estrada: 0: Auto-estrada, auto-estrada ou outra estrada principal. 1: Estrada principal, menos importante que uma auto-estrada. 2: Outra estrada principal. 3: Estrada secundária. 4: Estrada de ligação local. 5: Estrada local de alta importância. 6: Estrada local.
freeFlowSpeed	integer	A velocidade de fluxo livre esperada em condições ideais, expressa nas unidades pedidas. Isto está relacionado com o freeFlowTravelTime.
freeFlowTravelTime	integer	O tempo de deslocação em segundos, através deste segmento de tráfego, o que seria de esperar em condições de fluxo livre ideais.
openlr	string	Código OpenLR para segmento. Veja OpenLR para obter mais informações sobre a utilização de códigos Open LR.

LatLongPair

Uma localização representada como uma latitude e longitude.

Name	Tipo	Description
latitude	number	Propriedade Latitude
longitude	number	Propriedade Longitude

ResponseFormat

Formato pretendido da resposta. O valor pode ser json ou xml.

Name	Tipo	Description
json	string	Formato JavaScript Object Notation Data Interchange
xml	string	O Idioma de Marcação Extensível

SpeedUnit

Unidade de velocidade em KMPH ou MPH

Name	Tipo	Description
KMPH	string	Quilómetros por Hora
MPH	string	Milhas por Hora

TrafficFlowSegmentData

Este objeto é devolvido de uma chamada bem-sucedida do Segmento de Fluxo de Tráfego

Name	Tipo	Description
flowSegmentData	FlowSegmentData	Propriedade Dados do Segmento de Fluxo

TrafficFlowSegmentStyle

O estilo a ser utilizado para compor o mosaico. Os valores válidos são absolutos, o que devolve cores que refletem a velocidade absoluta medida, relativamente à qual devolve a velocidade relativa ao fluxo livre, Relativo-atraso, que apresenta velocidades relativas apenas onde são diferentes das velocidades de fluxo livre

Name	Tipo	Description
absolute	string
relative	string
relative-delay	string