Traffic - Get Traffic Incident Viewport

Referência

Service:: Maps

API Version:: 1.0

Utilize para obter informações legais e técnicas para um viewport.

A Traffic Incident Viewport API é um pedido HTTP GET que devolve informações legais e técnicas para o viewport descrito no pedido. Deve ser chamado por aplicações cliente sempre que o viewport for alterado (por exemplo, através de zoom, panning, ir para uma localização ou apresentar uma rota). O pedido deve conter a caixa delimitadora e o nível de zoom do viewport cujas informações são necessárias. A devolução conterá informações da versão do mapa, bem como o ID do Modelo de Tráfego atual e os IDs de direitos de autor. O ID do Modelo de Tráfego devolvido pela Descrição do Viewport é utilizado por outras APIs para obter as últimas informações de tráfego para processamento adicional.

GET https://atlas.microsoft.com/traffic/incident/viewport/{format}?api-version=1.0&boundingbox={boundingbox}&boundingzoom={boundingzoom}&overviewbox={overviewbox}&overviewzoom={overviewzoom}

With optional parameters:

GET https://atlas.microsoft.com/traffic/incident/viewport/{format}?api-version=1.0&boundingbox={boundingbox}&boundingzoom={boundingzoom}&overviewbox={overviewbox}&overviewzoom={overviewzoom}&copyright={copyright}

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.
boundingbox	query	True	number[]	Caixa delimitadora do viewport do mapa na projeção EPSG900913 . O `boundingbox` é representado por dois pares de valores que descrevem os cantos (primeiro par para o canto inferior esquerdo e o segundo para o canto superior direito). Quando este ponto final é chamado diretamente, todos os valores devem ser separados por vírgulas (por exemplo, minY,minX,maxY,maxX). O tamanho máximo da caixa delimitadora que pode ser transmitida depende do nível de zoom pedido. A largura e a altura não podem exceder os 4092 pixels quando compostos no nível de zoom especificado. NOTA: as caixas delimitadoras que atravessam o meridiano de 180° necessitam de tratamento especial. Para estas caixas, o valor maxX oriental será negativo e, portanto, inferior ao valor minX a oeste do meridiano de 180°. Para resolver este problema, o valor 40075016.6855874 deve ser adicionado ao valor maxX verdadeiro antes de ser transmitido no pedido.
boundingzoom	query	True	integer int32	Nível de zoom do viewport do mapa. Utilizado para determinar se a vista pode ser ampliada.
overviewbox	query	True	number[]	Caixa delimitadora do mapa de descrição geral na projeção EPSG900913 . Utilizado no caso de a caixa de descrição geral/mini mapa ter dados de direitos de autor diferentes dos do mapa principal. Se não existir um mini mapa, as mesmas coordenadas que `boundingBox` são utilizadas. Quando este ponto final é chamado diretamente, as coordenadas são transmitidas como uma única cadeia que contém quatro coordenadas, separadas por vírgulas.
overviewzoom	query	True	integer int32	Nível de zoom do mapa de descrição geral. Se não existir um mini mapa, utilize o mesmo nível de zoom que boundingZoom.
copyright	query		boolean	Determina as informações de direitos de autor a devolver. Quando verdadeiro, o texto de direitos de autor é devolvido; quando falso apenas é devolvido o índice de direitos de autor.

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 veja os seguintes artigos para obter orientações.

Respostas

Name	Tipo	Description
200 OK	TrafficIncidentViewport	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 Azure Maps recurso a que a aplicação está a pedir acesso. Isto pode ser adquirido na API de gestão de Mapas .

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 List SAS no recurso de 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 incident information for the selected viewport

Sample Request

HTTP

GET https://atlas.microsoft.com/traffic/incident/viewport/json?api-version=1.0&boundingbox=-939584.4813015489,-23954526.723651607,14675583.153020501,25043442.895825107&boundingzoom=2&overviewbox=-939584.4813018347,-23954526.723651607,14675583.153020501,25043442.89582291&overviewzoom=2&copyright=True

Sample Response

Status code:: 200

{
  "viewpResp": {
    "trafficState": {
      "@trafficAge": 18895,
      "@trafficModelId": "1504808593298"
    },
    "copyrightIds": "&copy; 2017 GeoSmart^&copy; 2017 TomTom^&copy; 2017 Whereis",
    "@version": "1.0.51-mascoma",
    "@maps": "europe,taiwan,latam,northamerica,israel,middleeast,iraq,guam,australia,newzealand,india,africa,world,southeastasia"
  }
}

Definições

Name	Description
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta a erros
ResponseFormat	Formato pretendido da resposta. O valor pode ser json ou xml.
TrafficIncidentViewport	Este objeto é devolvido a partir de uma chamada Viewport de Incidentes de Tráfego bem-sucedida
TrafficState	Informações do Estado do Tráfego
ViewpResp	Objeto De Resposta do Viewport

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ção adicional.

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.

ResponseFormat

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

Name	Tipo	Description
json	string	O Formato de Intercâmbio de Dados de Notação de Objetos JavaScript
xml	string	O Idioma de Marcação Extensível

TrafficIncidentViewport

Este objeto é devolvido a partir de uma chamada Viewport de Incidentes de Tráfego bem-sucedida

Name	Tipo	Description
viewpResp	ViewpResp	Objeto De Resposta do Viewport

TrafficState

Informações do Estado do Tráfego

Name	Tipo	Description
@trafficAge	integer	O tempo decorrido (em segundos) da criação do ID do Modelo de Tráfego.
@trafficModelId	string	O ID exclusivo denominado ID do Modelo de Tráfego é utilizado em chamadas para serviços de Incidentes de Tráfego. Permite obter informações de atualizações de tráfego específicas. O ID do Modelo de Tráfego é atualizado a cada minuto e é válido durante dois minutos antes de exceder o limite de tempo.

ViewpResp

Objeto De Resposta do Viewport

Name	Tipo	Description
@maps	string	Indica os nomes internos do fornecedor de dados para os dados de mapa utilizados no viewport. Para utilizar com consultas de suporte.
@version	string	Indica a versão de software utilizada para gerar as informações. Para utilizar com consultas de suporte.
copyrightIds	string	Quando o valor do parâmetro de direitos de autor é verdadeiro, este contém o texto completo das informações de direitos de autor que têm de ser apresentadas com os mosaicos no viewport
trafficState	TrafficState	Informações do Estado do Tráfego