Traffic - Get Traffic Flow Segment

Referência

Serviço:: Maps

Versão da API:: 1.0

Use para obter informações sobre as velocidades e tempos de viagem da seção especificada da estrada.

A API Traffic Flow Segment é uma solicitação de GET HTTP que fornece informações sobre as velocidades e os tempos de viagem do fragmento de estrada mais próximo das coordenadas fornecidas. Ele foi projetado para funcionar ao lado da camada Flow do Render Service para oferecer suporte a visualizações de dados de fluxo clicáveis. Com a API Traffic Flow Segment, o lado do cliente pode conectar qualquer lugar no mapa com dados de fluxo na estrada mais próxima e apresentá-los ao usuário.

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

Com parâmetros opcionais:

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 desejado da resposta. O valor pode ser json ou xml.
api-version	query	True	string	Número da versão da API do Azure Maps.
query	query	True	number[]	Coordenadas do ponto próximo ao segmento rodoviário. Este parâmetro é uma lista de quatro coordenadas, contendo dois pares de coordenadas (lat, long, lat, long), e calculado usando EPSG4326 projeção. Quando esse ponto de extremidade é chamado diretamente, as coordenadas são passadas como uma única cadeia de caracteres contendo quatro coordenadas, separadas por vírgulas.
style	query	True	TrafficFlowSegmentStyle	O estilo a ser usado para renderizar o bloco. Os valores válidos são absolutos que retornam cores refletindo a velocidade absoluta medida, relativa que retorna a velocidade relativa ao fluxo livre, atraso relativo que exibe velocidades relativas apenas onde elas são diferentes das velocidades de fluxo livre
zoom	query	True	integer (int32)	Nível de zoom para o bloco desejado. O valor do zoom deve estar no intervalo: 0-22 (inclusive). Consulte Níveis de zoom e de grade de blocos para obter detalhes.
openLr	query		boolean	Boolean sobre se a resposta deve incluir o código OpenLR
thickness	query		integer (int32) minimum: 1 maximum: 20	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 padrão é 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 qual conta deve ser usada em conjunto com o modelo de segurança do Microsoft Entra ID. Ele representa uma ID exclusiva para a conta do Azure Maps e pode ser recuperado da API de Conta do plano de gerenciamento do Azure Maps. Para usar a segurança do Microsoft Entra ID no Azure Maps, consulte os seguintes artigos para obter orientação.

Respostas

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

Segurança

AADToken

Estes são os Microsoft Entra OAuth 2.0 Flows. Quando emparelhado com controle de de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso às APIs REST do Azure Maps. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais contas de recursos ou subrecursos do Azure Maps. Qualquer usuário, grupo ou entidade de serviço pode receber acesso por meio de uma função interna ou uma função personalizada composta por uma ou mais permissões para APIs REST do Azure Maps.

Para implementar cenários, recomendamos a visualização conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos(s) por meio de objetos capazes de controle de acesso em APIs e escopos específicos.

Observações

Essa definição de segurança requer o uso do cabeçalho x-ms-client-id para indicar a qual recurso do Azure Maps o aplicativo está solicitando acesso. Isso pode ser adquirido na API de gerenciamento de do Maps.

O Authorization URL é específico para a instância de nuvem pública do Azure. As nuvens soberanas têm URLs de autorização exclusivas e configurações de ID do Microsoft Entra. * O controle de acesso baseado em função do Azure é configurado a partir do plano de gerenciamento do Azure por meio do portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * O uso do SDK da Web do Azure Maps permite a configuração baseada em configuração de um aplicativo para vários casos de uso.

Para obter mais informações sobre a plataforma de identidade da Microsoft, consulte visão geral da plataforma de identidade da Microsoft.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

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

subscription-key

Esta é uma chave compartilhada que é provisionada quando você Criar uma conta do Azure Maps no portal do Azure ou usando PowerShell, CLI, SDKs do Azure ou API REST.

Com essa chave, qualquer aplicativo pode acessar todas as APIs REST. Em outras palavras, essa chave pode ser usada como uma chave mestra na conta em que eles são emitidos.

Para aplicativos expostos publicamente, nossa recomendação é usar a abordagem de de aplicativos cliente confidenciais para acessar APIs REST do Azure Maps para que sua chave possa ser armazenada com segurança.

Tipo: apiKey
Em: query

SAS Token

Este é um token de assinatura de acesso compartilhado criado a partir da operação Listar SAS no de recursos do Azure Maps por meio do plano de gerenciamento do Azure por meio do portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com esse token, qualquer aplicativo é autorizado a acessar com controles de acesso baseados em função do Azure e controle de grão fino para a expiração, taxa e região(ões) de uso para o token específico. Em outras palavras, o Token SAS pode ser usado para permitir que os aplicativos controlem o acesso de forma mais segura do que a chave compartilhada.

Para aplicativos expostos publicamente, nossa recomendação é configurar uma lista específica de origens permitidas no de recursos da conta do Map para limitar o abuso de renderização e renovar regularmente o Token SAS.

Tipo: apiKey
Em: header

Exemplos

Request traffic flow segment information

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 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 deslocadas da estrada dependendo do nível de zoom para suportar visualização de alta qualidade em todas as escalas.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
FlowSegmentData	Propriedade Flow Segment Data
LatLongPair	Um local representado como latitude e longitude.
ResponseFormat	Formato desejado da resposta. O valor pode ser json ou xml.
SpeedUnit	Unidade de velocidade em KMPH ou MPH
TrafficFlowSegmentData	Este objeto é retornado de uma chamada bem-sucedida do Segmento de Fluxo de Tráfego
TrafficFlowSegmentStyle	O estilo a ser usado para renderizar o bloco. Os valores válidos são absolutos que retornam cores refletindo a velocidade absoluta medida, relativa que retorna a velocidade relativa ao fluxo livre, atraso relativo que exibe velocidades relativas apenas onde elas são diferentes das velocidades de fluxo livre

Coordinates

Object

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

Name	Tipo	Description
coordinate	LatLongPair[]	Matriz de coordenadas

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

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

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
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

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

FlowSegmentData

Object

Propriedade Flow Segment Data

Name	Tipo	Description
@version	string	Isso indica a versão do software que gerou a resposta.
confidence	number	A confiança é uma medida da qualidade do tempo de viagem e da velocidade proporcionados. Um valor de 1 significa confiança total de que a resposta contém dados da mais alta qualidade. Valores mais baixos indicam o grau em que a resposta pode variar das condições reais na estrada. Qualquer valor superior a 0,6 significa que a informação foi baseada na entrada da sonda em tempo real. Um valor de 0,5 significa que a velocidade relatada é baseada em informações históricas. Um valor entre 0,5 e 0,6 tem uma média ponderada calculada entre velocidades históricas e ao vivo.
coordinates	Coordinates	Inclui as coordenadas que descrevem a forma do segmento. As coordenadas são deslocadas da estrada dependendo do nível de zoom para suportar visualização de alta qualidade em todas as escalas.
currentSpeed	integer (int32)	A velocidade média atual no ponto selecionado, nas unidades solicitadas. Isso é calculado a partir do currentTravelTime e do comprimento do segmento selecionado.
currentTravelTime	integer (int32)	Tempo de viagem atual em segundos, através deste segmento de tráfego, com base em medições fundidas em tempo real entre os locais definidos na direção especificada.
frc	string	Classe Funcional de Estrada. Isto indica o tipo de estrada: 0: Autoestrada, autoestrada ou outra estrada principal. 1: Estrada principal, menos importante do que uma autoestrada. 2: Outra estrada principal. 3: Estrada secundária. 4: Estrada de ligação local. 5: Estrada local de grande importância. 6: Estrada local.
freeFlowSpeed	integer (int32)	A velocidade de fluxo livre esperada em condições ideais, expressa nas unidades solicitadas. Isto está relacionado com o freeFlowTravelTime.
freeFlowTravelTime	integer (int32)	O tempo de viagem em segundos, através deste segmento de tráfego, o que seria esperado em condições ideais de fluxo livre.
openlr	string	Código OpenLR para segmento. Consulte OpenLR para obter mais informações sobre o uso de códigos Open LR.

LatLongPair

Object

Um local representado como latitude e longitude.

Name	Tipo	Description
latitude	number (double)	Propriedade Latitude
longitude	number (double)	Propriedade Longitude

ResponseFormat

Enumeração

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

Valor	Description
json	O formato de intercâmbio de dados de notação de objeto JavaScript
xml	A linguagem de marcação extensível

SpeedUnit

Enumeração

Unidade de velocidade em KMPH ou MPH

Valor	Description
KMPH	Quilômetros por hora
MPH	Milhas por hora

TrafficFlowSegmentData

Object

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

Name	Tipo	Description
flowSegmentData	FlowSegmentData	Propriedade Flow Segment Data

TrafficFlowSegmentStyle

Enumeração

O estilo a ser usado para renderizar o bloco. Os valores válidos são absolutos que retornam cores refletindo a velocidade absoluta medida, relativa que retorna a velocidade relativa ao fluxo livre, atraso relativo que exibe velocidades relativas apenas onde elas são diferentes das velocidades de fluxo livre

Valor	Description
absolute
relative
relative-delay

Partilhar via

Traffic - Get Traffic Flow Segment

Parâmetros do URI

Cabeçalho do Pedido

Respostas

Segurança

AADToken

Observações

Âmbitos

subscription-key

SAS Token

Exemplos

Request traffic flow segment information

Pedido de amostra

Resposta da amostra

Definições

Coordinates

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FlowSegmentData

LatLongPair

ResponseFormat

SpeedUnit

TrafficFlowSegmentData

TrafficFlowSegmentStyle