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 os tempos de viagem do trecho de estrada especificado.

A API Traffic Flow Segment é uma solicitação http GET 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 junto com a camada Flow do serviço Renderizar para dar 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á-lo 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 de URI

Nome	Em	Obrigató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 de versão da API do Azure Mapas.
query	query	True	number[]	Coordenadas do ponto próximo ao segmento rodoviário. Esse parâmetro é uma lista de quatro coordenadas, contendo dois pares de coordenadas (lat, long, lat, long) e calculados 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. Valores válidos são absolutos, o que retorna cores que refletem a velocidade absoluta medida, relativa que retorna a velocidade relativa ao fluxo livre, atraso relativo que exibe velocidades relativas somente em que são diferentes das velocidades de fluxo livre
zoom	query	True	integer (int32)	Nível de zoom para o bloco desejado. O valor de zoom deve estar no intervalo: 0 a 22 (inclusive). Consulte níveis de zoom e de grade de blocos para obter detalhes.
openLr	query		boolean	Booliano sobre se a resposta deve incluir código OpenLR
thickness	query		integer (int32) minimum: 1 maximum: 20	O valor da largura da linha que representa o tráfego. Esse valor é um multiplicador e os valores aceitos variam de 1 a 20. O valor predefinido é 10.
unit	query		SpeedUnit	Unidade de velocidade em KMPH ou MPH

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-client-id		string	Especifica qual conta destina-se ao uso em conjunto com o modelo de segurança da ID do Microsoft Entra. Ele representa uma ID exclusiva para a conta do Azure Mapas e pode ser recuperado da API de Conta do plano de gerenciamento do Azure Mapas. Para usar a segurança da ID do Microsoft Entra no Azure Mapas, consulte os artigos de a seguir para obter diretrizes.

Respostas

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

Segurança

AADToken

Estas são as Fluxos de do Microsoft Entra OAuth 2.0. Quando emparelhado com acesso baseado em função do Azure controle, ele pode ser usado para controlar o acesso às APIs REST do Azure Mapas. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais sub-recursos ou conta de recurso do Azure Mapas. 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 Mapas.

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

Anotações

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

O Authorization URL é específico para a instância de nuvem pública do Azure. 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 do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST. * O uso do SDK da Web do Azure Mapas 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
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

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

subscription-key

Essa é uma chave compartilhada provisionada quando você Criar uma conta do Azure Mapas no portal do Azure ou usando o PowerShell, a CLI, os SDKs do Azure ou a API REST.

Com essa chave, qualquer aplicativo pode acessar toda a API REST. Em outras palavras, essa chave pode ser usada como uma chave mestra na conta em que elas são emitidas.

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

Tipo: apiKey
Em: query

SAS Token

Esse é um token de assinatura de acesso compartilhado criado a partir da operação LISTA SAS no recurso do Azure Mapas por meio do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.

Com esse token, qualquer aplicativo está autorizado a acessar com controles de acesso baseados em função do Azure e controle refinado para expiração, taxa e região(s) 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 protegida 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 de mapa de para limitar o abuso de renderização e renovar regularmente o Token SAS.

Tipo: apiKey
Em: header

Exemplos

Request traffic flow segment information

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 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

Nome	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 dar suporte à visualização de alta qualidade em cada escala.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
FlowSegmentData	Propriedade Dados do Segmento de Fluxo
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	Esse objeto é retornado de uma chamada bem-sucedida do Segmento de Fluxo de Tráfego
TrafficFlowSegmentStyle	O estilo a ser usado para renderizar o bloco. Valores válidos são absolutos, o que retorna cores que refletem a velocidade absoluta medida, relativa que retorna a velocidade relativa ao fluxo livre, atraso relativo que exibe velocidades relativas somente em que são diferentes das velocidades de fluxo livre

Coordinates

Objeto

Inclui as coordenadas que descrevem a forma do segmento. As coordenadas são deslocadas da estrada dependendo do nível de zoom para dar suporte à visualização de alta qualidade em cada escala.

Nome	Tipo	Description
coordinate	LatLongPair[]	Matriz de coordenadas

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

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

ErrorDetail

Objeto

O detalhe do erro.

Nome	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

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

FlowSegmentData

Objeto

Propriedade Dados do Segmento de Fluxo

Nome	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 fornecidos. Um valor de 1 significa confiança total, que a resposta contém os dados de mais alta qualidade. Valores mais baixos indicam o grau em que a resposta pode variar das condições reais na estrada. Qualquer valor maior que 0,6 significa que as informações foram baseadas na entrada de investigação 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 dinâmicas.
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 dar suporte à visualização de alta qualidade em cada escala.
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, neste segmento de tráfego, com base em medidas em tempo real fundidas entre os locais definidos na direção especificada.
frc	string	Classe de estrada funcional. Isso indica o tipo de estrada: 0: Auto-estrada, rodovia ou outra estrada principal. 1: Estrada principal, menos importante que uma auto-estrada. 2: Outra estrada principal. 3: Estrada secundária. 4: Estrada de conexão local. 5: Estrada local de alta importância. 6: Estrada local.
freeFlowSpeed	integer (int32)	A velocidade de fluxo livre esperada em condições ideais, expressa nas unidades solicitadas. Isso está relacionado ao freeFlowTravelTime.
freeFlowTravelTime	integer (int32)	O tempo de viagem em segundos, em todo esse 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

Objeto

Um local representado como latitude e longitude.

Nome	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

Objeto

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

Nome	Tipo	Description
flowSegmentData	FlowSegmentData	Propriedade Dados do Segmento de Fluxo

TrafficFlowSegmentStyle

Enumeração

O estilo a ser usado para renderizar o bloco. Valores válidos são absolutos, o que retorna cores que refletem a velocidade absoluta medida, relativa que retorna a velocidade relativa ao fluxo livre, atraso relativo que exibe velocidades relativas somente em que são diferentes das velocidades de fluxo livre

Valor	Description
absolute
relative
relative-delay

Compartilhar via

Traffic - Get Traffic Flow Segment

Parâmetros de URI

Cabeçalho da solicitação

Respostas

Segurança

AADToken

Anotações

Escopos

subscription-key

SAS Token

Exemplos

Request traffic flow segment information

Solicitação de exemplo

Resposta de exemplo

Definições

Coordinates

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FlowSegmentData

LatLongPair

ResponseFormat

SpeedUnit

TrafficFlowSegmentData

TrafficFlowSegmentStyle

Recursos adicionais