Traffic - Get Traffic Incident Detail

Utilize para obter informações sobre incidentes de tráfego dentro de uma determinada caixa delimitadora.

A Traffic Incident Detail API é um pedido HTTP GET que fornece informações sobre incidentes de tráfego dentro de uma determinada caixa delimitadora, com base no ID atual do Modelo de Tráfego. O ID do Modelo de Tráfego está disponível para conceder a sincronização de dados entre chamadas e API. O ID do Modelo de Tráfego é um valor chave para determinar a moeda dos incidentes de tráfego. É atualizado a cada minuto e é válido durante dois minutos antes de exceder o limite de tempo. É utilizado na composição de mosaicos de incidentes. Pode ser obtido a partir da API Viewport .

GET https://atlas.microsoft.com/traffic/incident/detail/{format}?api-version=1.0&style={style}&boundingbox={boundingbox}&boundingZoom={boundingZoom}&trafficmodelid={trafficmodelid}
GET https://atlas.microsoft.com/traffic/incident/detail/{format}?api-version=1.0&style={style}&boundingbox={boundingbox}&boundingZoom={boundingZoom}&trafficmodelid={trafficmodelid}&language={language}&projection={projection}&geometries={geometries}&expandCluster={expandCluster}&originalPosition={originalPosition}

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[]

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). Os pares podem ser especificados utilizando qualquer um dos projection's especificados abaixo (por exemplo, minY,minX,maxY,maxX) ou por dois pares latitude-longitude (por exemplo, minLat,minLon,maxLat,maxLon).

NOTA: se forem utilizados pares de latitude/longitude, o projection parâmetro tem de ser definido como "EPSG4326".

boundingZoom
query True

integer

int32

Nível de zoom para o mosaico pretendido. 0 a 22 para mosaicos raster, 0 a 22 para mosaicos de vetor

style
query True

IncidentDetailStyle

O estilo que será utilizado para compor o mosaico na API de Mosaico de Incidentes de Tráfego. Isto terá um efeito nas coordenadas dos incidentes de tráfego na resposta.

trafficmodelid
query True

string

Número que referencia o modelo de tráfego. Isto pode ser obtido a partir da API Viewport . É atualizado a cada minuto e é válido durante dois minutos antes de exceder o limite de tempo. Se for especificado o ID do Modelo de Tráfego errado, o ID correto será devolvido pela interface. Um valor de -1 invocará sempre o modelo de tráfego mais recente

expandCluster
query

boolean

Booleano para indicar se deve listar todos os incidentes de tráfego num cluster separadamente

geometries
query

IncidentGeometryType

O tipo de geometria de vetor adicionada aos incidentes (devolvido no elemento da resposta).

language
query

string

Código ISO 639-1 para o idioma de saída. Os idiomas suportados são ar, ca, cs, da, de, el, en, en-GB, en-US, es, et, fi, fr, he, hu, id, in*, it, lt, lv, nb, nl, no, pl, pt, ro, ru, sk, sv, th, tr, zh.

Consulte idiomas suportados para obter detalhes. Quando é fornecida uma resposta de código de idioma inválido em inglês. Quando a causa ou descrição do incidente não tem tradução, é devolvida a descrição em inglês.

originalPosition
query

boolean

Booleano sobre se deve devolver a posição original do incidente (), bem como o que mudou para o início do tubo de tráfego ()

projection
query

ProjectionStandard

A projeção utilizada para especificar as coordenadas no pedido e na resposta. EPSG900913 (predefinição) ou EPSG4326

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

TrafficIncidentDetail

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.

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 Create 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 information about a traffic incident

Sample Request

GET https://atlas.microsoft.com/traffic/incident/detail/json?api-version=1.0&style=s3&boundingbox=6841263.950712,511972.674418,6886056.049288,582676.925582&boundingZoom=11&trafficmodelid=1335294634919

Sample Response

{
  "tm": {
    "@id": "1521671948910",
    "poi": [
      {
        "id": "europe_HD_NL_TTR116377227776064",
        "p": {
          "x": 538636.9,
          "y": 6842004.5
        },
        "ic": 9,
        "ty": 1,
        "cs": 0,
        "d": "roadworks",
        "c": "new roadworks layout",
        "f": "Amstelveen/Vinkeveen - N201 (N196)",
        "t": "Uithoorn-Centrum (N196)",
        "l": 220,
        "dl": 14,
        "r": "N196"
      },
      {
        "id": "europe_CLUSTER_11_-34959639",
        "p": {
          "x": 528668.6,
          "y": 6848897.9
        },
        "ic": 8,
        "ty": 0,
        "cbl": {
          "x": 528622.5,
          "y": 6848661.2
        },
        "ctr": {
          "x": 528714.7,
          "y": 6849134.6
        },
        "cs": 2,
        "l": 190
      },
      {
        "id": "europe_CLUSTER_11_-1540737434",
        "p": {
          "x": 518277,
          "y": 6852206.8
        },
        "ic": 9,
        "ty": 1,
        "cbl": {
          "x": 517421.3,
          "y": 6851776.4
        },
        "ctr": {
          "x": 519132.8,
          "y": 6852637.2
        },
        "cs": 2,
        "l": 1620
      },
      {
        "id": "europe_CLUSTER_11_-26712906",
        "p": {
          "x": 529902.2,
          "y": 6855622.4
        },
        "ic": 8,
        "ty": 0,
        "cbl": {
          "x": 529524.6,
          "y": 6855377.2
        },
        "ctr": {
          "x": 530279.9,
          "y": 6855867.7
        },
        "cs": 4,
        "l": 660
      },
      {
        "id": "europe_HD_NL_TTR116367997504816",
        "p": {
          "x": 568216,
          "y": 6851287.6
        },
        "ic": 9,
        "ty": 1,
        "cs": 0,
        "d": "roadworks",
        "c": "new roadworks layout",
        "f": "Ankeveen (N236)",
        "t": "Weesp (N236)",
        "l": 2760,
        "dl": 73,
        "r": "N236"
      },
      {
        "id": "europe_HD_NL_TTR116367997261488",
        "p": {
          "x": 561973.7,
          "y": 6854259.4
        },
        "ic": 9,
        "ty": 3,
        "cs": 0,
        "d": "roadworks",
        "c": "new roadworks layout",
        "f": "Weesp (N236)",
        "t": "Ankeveen (N236)",
        "l": 2650,
        "r": "N236"
      },
      {
        "id": "europe_HD_NL_TTR116331064819392",
        "p": {
          "x": 571268.5,
          "y": 6858435.4
        },
        "ic": 8,
        "ty": 4,
        "cs": 0,
        "d": "closed",
        "f": "IJsselmeerweg",
        "t": "A6",
        "l": 370
      },
      {
        "id": "europe_CLUSTER_11_-1442937814",
        "p": {
          "x": 563934,
          "y": 6859271.3
        },
        "ic": 9,
        "ty": 1,
        "cbl": {
          "x": 563726.1,
          "y": 6859250.4
        },
        "ctr": {
          "x": 564141.9,
          "y": 6859292.2
        },
        "cs": 2,
        "l": 460
      },
      {
        "id": "europe_CLUSTER_11_258400781",
        "p": {
          "x": 558055.6,
          "y": 6861147.1
        },
        "ic": 13,
        "ty": 1,
        "cbl": {
          "x": 557493.3,
          "y": 6860514.8
        },
        "ctr": {
          "x": 558618,
          "y": 6861779.4
        },
        "cs": 3,
        "l": 1030
      },
      {
        "id": "europe_HD_NL_TTR116100227865681",
        "p": {
          "x": 542665,
          "y": 6861959.7
        },
        "ic": 8,
        "ty": 4,
        "cs": 0,
        "d": "closed",
        "f": "Strawinskylaan",
        "t": "Matthijs Vermeulenpad",
        "l": 110
      },
      {
        "id": "europe_CLUSTER_11_1438243625",
        "p": {
          "x": 545058.7,
          "y": 6864571.6
        },
        "ic": 8,
        "ty": 0,
        "cbl": {
          "x": 543779.5,
          "y": 6864070.7
        },
        "ctr": {
          "x": 546337.8,
          "y": 6865072.6
        },
        "cs": 5,
        "l": 1590
      },
      {
        "id": "europe_HD_NL_TTR116081762316976",
        "p": {
          "x": 547507.8,
          "y": 6866259.3
        },
        "ic": 8,
        "ty": 4,
        "cs": 0,
        "d": "closed",
        "f": "Alexanderplein (s113)",
        "t": "Stadhouderskade",
        "l": 390,
        "r": "S100"
      },
      {
        "id": "europe_CLUSTER_11_691732516",
        "p": {
          "x": 541448.7,
          "y": 6867162.1
        },
        "ic": 8,
        "ty": 0,
        "cbl": {
          "x": 541160.1,
          "y": 6866710.7
        },
        "ctr": {
          "x": 541737.2,
          "y": 6867613.5
        },
        "cs": 4,
        "l": 430
      },
      {
        "id": "europe_CLUSTER_11_1582351486",
        "p": {
          "x": 534709.6,
          "y": 6865174.7
        },
        "ic": 8,
        "ty": 0,
        "cbl": {
          "x": 534562.2,
          "y": 6865025.3
        },
        "ctr": {
          "x": 534856.9,
          "y": 6865324.2
        },
        "cs": 2,
        "l": 380
      },
      {
        "id": "europe_CLUSTER_11_-2070222267",
        "p": {
          "x": 536813.1,
          "y": 6868188.3
        },
        "ic": 8,
        "ty": 0,
        "cbl": {
          "x": 536191.1,
          "y": 6867699.7
        },
        "ctr": {
          "x": 537435.1,
          "y": 6868677
        },
        "cs": 7,
        "l": 1380
      },
      {
        "id": "europe_CLUSTER_11_-496866890",
        "p": {
          "x": 516025.5,
          "y": 6871606.3
        },
        "ic": 8,
        "ty": 0,
        "cbl": {
          "x": 514115.1,
          "y": 6870216.9
        },
        "ctr": {
          "x": 517935.9,
          "y": 6872995.7
        },
        "cs": 7,
        "l": 1510
      },
      {
        "id": "europe_HD_NL_TTR115675492352160",
        "p": {
          "x": 517835.3,
          "y": 6883216.3
        },
        "ic": 8,
        "ty": 4,
        "cs": 0,
        "d": "closed",
        "f": "Amsterdamseweg",
        "t": "A22",
        "l": 710
      },
      {
        "id": "europe_CLUSTER_11_834920993",
        "p": {
          "x": 543803.8,
          "y": 6875659.8
        },
        "ic": 8,
        "ty": 0,
        "cbl": {
          "x": 543474.7,
          "y": 6875602.7
        },
        "ctr": {
          "x": 544133,
          "y": 6875716.9
        },
        "cs": 2,
        "l": 760
      }
    ]
  }
}

Definições

Name Description
DelayMagnitude

A magnitude do atraso associado ao incidente. Estes valores correspondem às cores dos incidentes nos mosaicos de tráfego

ErrorAdditionalInfo

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

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta a erros

IconCategory

A categoria de ícones associada a este incidente. Os valores são números no intervalo 0-13, com os seguintes significados -- 0: Desconhecido, 1: Acidente, 2: Nevoeiro, 3: Condições Perigosas, 4: Chuva, 5: Gelo, 6: Jam, 7: Pista Fechada, 8: Estrada Fechada, 9: Obras rodoviárias, 10: Vento, 11: Inundação, 12: Desvio, 13: Cluster

IncidentDetailStyle

O estilo que será utilizado para compor o mosaico na API de Mosaico de Incidentes de Tráfego. Isto terá efeito nas coordenadas dos incidentes de tráfego na resposta.

IncidentGeometryType

O tipo de geometria de vetor adicionado aos incidentes (devolvido no elemento da resposta).

Point

Representação genérica de um ponto com coordenadas (x, y) no plano cartesiano.

ProjectionStandard

A projeção utilizada para especificar as coordenadas no pedido e na resposta. EPSG900913 (predefinição) ou EPSG4326

ResponseFormat

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

Tm

Elemento de resposta principal

TrafficIncidentDetail

Este objeto é devolvido de uma chamada Detalhes do incidente de tráfego efetuada com êxito

TrafficIncidentPointOfInterest

DelayMagnitude

A magnitude do atraso associado ao incidente. Estes valores correspondem às cores dos incidentes nos mosaicos de tráfego

Name Tipo Description
0

Integer

Desconhecido

1

Integer

Menor

2

Integer

Moderado

3

Integer

Maior

4

Integer

Indefinido (utilizado para encerramentos de estradas e outros atrasos indefinidos)

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.

IconCategory

A categoria de ícones associada a este incidente. Os valores são números no intervalo 0-13, com os seguintes significados -- 0: Desconhecido, 1: Acidente, 2: Nevoeiro, 3: Condições Perigosas, 4: Chuva, 5: Gelo, 6: Jam, 7: Pista Fechada, 8: Estrada Fechada, 9: Obras rodoviárias, 10: Vento, 11: Inundação, 12: Desvio, 13: Cluster

Name Tipo Description
0

Integer

Desconhecido

1

Integer

Acidente

10

Integer

Vento

11

Integer

Inundações

12

Integer

Desvio

13

Integer

Cluster: devolvido se um cluster contiver incidentes com diferentes categorias de ícones.

14

Integer

Veículo Avariado

2

Integer

Nevoeiro

3

Integer

Condições Perigosas

4

Integer

Chuva

5

Integer

Ferreira

6

Integer

Jam

7

Integer

Pista Fechada

8

Integer

Estrada Fechada

9

Integer

Obras Rodoviárias

IncidentDetailStyle

O estilo que será utilizado para compor o mosaico na API de Mosaico de Incidentes de Tráfego. Isto terá efeito nas coordenadas dos incidentes de tráfego na resposta.

Name Tipo Description
night

string

Estilo noturno.

s1

string

Cria linhas de tráfego com divisas coloridas que indicam gravidade.

s2

string

Cria linhas simples com um certo grau de brilho.

s3

string

Cria linhas simples com um certo grau de brilho, diferentes do estilo s2.

IncidentGeometryType

O tipo de geometria de vetor adicionado aos incidentes (devolvido no elemento da resposta).

Name Tipo Description
original

string

Places incidentes precisamente na estrada.

shifted

string

Move ligeiramente o incidente (dependendo do nível de zoom) para indicar faixas de rodagem específicas.

Point

Representação genérica de um ponto com coordenadas (x, y) no plano cartesiano.

Name Tipo Description
x

number

coordenada x

y

number

coordenada y

ProjectionStandard

A projeção utilizada para especificar as coordenadas no pedido e na resposta. EPSG900913 (predefinição) ou EPSG4326

Name Tipo Description
EPSG4326

string

EPSG4326

EPSG900913

string

EPSG900913

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

Tm

Elemento de resposta principal

Name Tipo Description
@id

string

ID do modelo de tráfego para este incidente

poi

TrafficIncidentPointOfInterest[]

Um único incidente de tráfego ou um cluster de incidentes de tráfego

TrafficIncidentDetail

Este objeto é devolvido de uma chamada Detalhes do incidente de tráfego efetuada com êxito

Name Tipo Description
tm

Tm

Elemento de resposta principal

TrafficIncidentPointOfInterest

Name Tipo Description
c

string

Causa do incidente, quando disponível, no idioma pedido

cbl

Point

Coordenada inferior esquerda do cluster na projeção do pedido

cs

integer

Tamanho do cluster: o número de incidentes no cluster

ctr

Point

Coordenada superior direita do cluster na projeção do pedido

d

string

Descrição do incidente no idioma pedido

dl

integer

Atraso causado pelo incidente em segundos (exceto nos encerramentos de estradas)

ed

string

Data de fim estimada do incidente, se disponível. A data é descrita no formato ISO8601.

f

string

De: o nome da interseção ou localização onde o tráfego devido ao incidente é iniciado

ic

IconCategory

A categoria de ícones associada a este incidente. Os valores são números no intervalo 0-13, com os seguintes significados -- 0: Desconhecido, 1: Acidente, 2: Nevoeiro, 3: Condições Perigosas, 4: Chuva, 5: Gelo, 6: Jam, 7: Pista Fechada, 8: Estrada Fechada, 9: Obras rodoviárias, 10: Vento, 11: Inundação, 12: Desvio, 13: Cluster

id

string

ID do incidente de tráfego

l

integer

Duração do incidente em metros

p

Point

O ponto em que um ícone do cluster ou incidente não processado deve ser desenhado, expresso na projeção pedida. Isto é afetado pelo estilo de tráfego, nível de zoom e tipo de estrada

r

string

Os números de estrada afetados pelo incidente. Vários números de estrada serão delimitados por barras

sd

string

Data de início do incidente, se disponível. A data é descrita no formato ISO8601.

t

string

Para: o nome da interseção ou localização onde termina o tráfego devido ao incidente

ty

DelayMagnitude

A magnitude do atraso associado ao incidente. Estes valores correspondem às cores dos incidentes nos mosaicos de tráfego