Traffic - Get Traffic Incident Viewport

Referência

Serviço:: Maps

Versão da API:: 1.0

Use para obter informações técnicas e legais para um visor.

A Traffic Incident Viewport API é uma solicitação HTTP GET que retorna informações legais e técnicas para o visor descrito na solicitação. Ele deve ser chamado por aplicativos cliente sempre que o visor for alterado (por exemplo, por meio de zoom, movimento panorâmico, ir para um local ou exibir uma rota). A solicitação deve conter a caixa delimitadora e o nível de zoom do visor cujas informações são necessárias. O retorno conterá informações de versão do mapa, bem como a ID atual do Modelo de Tráfego e as IDs de direitos autorais. A ID do Modelo de Tráfego retornada pela Descrição do Visor é usada por outras APIs para recuperar 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}

Com parâmetros opcionais:

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 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 de Mapas Azure.
boundingbox	query	True	number[]	Caixa delimitadora do visor de mapa em EPSG900913 projeção. O `boundingbox` é representado por dois pares de valores que descrevem seus cantos (primeiro par para canto inferior esquerdo e segundo para superior direito). Quando esse ponto de extremidade é 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 passada depende do nível de zoom solicitado. A largura e a altura não podem exceder 4.092 pixels quando renderizadas no nível de zoom especificado. OBSERVAÇÃO: as caixas delimitadoras que cruzam o meridiano de 180° exigem tratamento especial. Para essas caixas, o valor maxX oriental será negativo e, portanto, menor que o valor minX a oeste do meridiano de 180°. Para resolver isso, o valor 40075016.6855874 deve ser adicionado ao valor maxX verdadeiro antes de ser passado na solicitação.
boundingzoom	query	True	integer int32	Nível de zoom do visor do mapa. Usado para determinar se a exibição pode ser ampliada.
overviewbox	query	True	number[]	Caixa delimitadora do mapa de visão geral em EPSG900913 projeção. Usado caso a caixa de visão geral/mini map tenha dados de direitos autorais diferentes do mapa principal. Se não houver minipapa, as mesmas coordenadas usadas `boundingBox` . 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.
overviewzoom	query	True	integer int32	Nível de zoom do mapa de visão geral. Se não houver minipapa, use o mesmo nível de zoom que boundingZoom.
copyright	query		boolean	Determina quais informações de direitos autorais devem ser retornadas. Quando true, o texto de direitos autorais é retornado; quando false, somente o índice de direitos autorais é retornado.

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 de 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 de ID do Microsoft Entra no Azure Mapas, consulte os artigos a seguir para obter diretrizes .

Respostas

Nome	Tipo	Description
200 OK	TrafficIncidentViewport	OK
Other Status Codes	ErrorResponse	Erro inesperado.

Segurança

AADToken

Estes são os Fluxos do Microsoft Entra OAuth 2.0 . Quando emparelhado com o controle de acesso baseado em função do Azure , 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 contas de recursos ou sub-recursos 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 acessar o controle em APIs e escopos específicos.

Observações

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

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 no 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ê cria uma conta do Azure Mapas no portal do Azure ou usa 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 a abordagem de aplicativos cliente confidenciais 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 Listar 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 a expiração, a taxa e as regiõ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 maneira mais segura do que a chave compartilhada.

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

Tipo: apiKey
Em: header

Exemplos

Request traffic incident information for the selected viewport

Solicitação de exemplo

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

Resposta de exemplo

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

Nome	Description
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	Os detalhes do erro.
ErrorResponse	Resposta de erro
ResponseFormat	Formato desejado da resposta. O valor pode ser json ou xml.
TrafficIncidentViewport	Esse objeto é retornado de uma chamada bem-sucedida do Visor de Incidentes de Tráfego
TrafficState	Informações de estado de tráfego
ViewpResp	Objeto Viewport Response

ErrorAdditionalInfo

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

Os detalhes 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

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

ResponseFormat

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

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

TrafficIncidentViewport

Esse objeto é retornado de uma chamada bem-sucedida do Visor de Incidentes de Tráfego

Nome	Tipo	Description
viewpResp	ViewpResp	Objeto Viewport Response

TrafficState

Informações de estado de tráfego

Nome	Tipo	Description
@trafficAge	integer	O tempo decorrido (em segundos) da criação da ID do Modelo de Tráfego.
@trafficModelId	string	A ID exclusiva chamada ID do Modelo de Tráfego é usada em chamadas para serviços de Incidentes de Tráfego. Ele permite obter informações de atualizações de tráfego específicas. A ID do Modelo de Tráfego é atualizada a cada minuto e é válida por dois minutos antes de atingir o tempo limite.

ViewpResp

Objeto Viewport Response

Nome	Tipo	Description
@maps	string	Indica os nomes internos do provedor de dados para os dados de mapa usados no visor. Para uso com consultas de suporte.
@version	string	Indica a versão do software usada para gerar as informações. Para uso com consultas de suporte.
copyrightIds	string	Quando o valor do parâmetro de direitos autorais é true, ele contém o texto completo das informações de direitos autorais que devem ser exibidas com os blocos no visor
trafficState	TrafficState	Informações de estado de tráfego

Compartilhar via