Traffic - Get Traffic Incident Detail

Référence

Service:: Maps

Version d'API:: 1.0

Permet d’obtenir des informations sur les incidents de trafic à l’intérieur d’une zone englobante donnée.

L’API Traffic Incident Detail est une requête HTTP GET qui fournit des informations sur les incidents de trafic à l’intérieur d’une zone englobante donnée, en fonction de l’ID de modèle de trafic actuel. L’ID du modèle de trafic est disponible pour accorder la synchronisation des données entre les appels et les API. L’ID du modèle de trafic est une valeur clé pour déterminer la devise des incidents de trafic. Il est mis à jour toutes les minutes et est valide pendant deux minutes avant qu’il expire. Il est utilisé dans le rendu des vignettes d’incident . Il peut être obtenu à partir de l’API Viewport.

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

Avec des paramètres facultatifs:

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}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
format	path	True	ResponseFormat	Format souhaité de la réponse. La valeur peut être json ou xml.
api-version	query	True	string	Numéro de version de l’API Azure Maps.
boundingbox	query	True	number[]	La `boundingbox` est représentée par deux paires valeur décrivant ses angles (première paire pour le coin inférieur gauche et la seconde pour le coin supérieur droit). Les paires peuvent être spécifiées à l’aide de l’une des paires `projection`spécifiées ci-dessous (par exemple, minY,minX, maxY,maxX) ou par deux paires de longitude latitude (par exemple, minLat,minLon,maxLat,maxLon). REMARQUE : Si des paires latitude/longitude sont utilisées, le paramètre `projection` doit être défini sur « EPSG4326 ».
boundingZoom	query	True	integer (int32) minimum: 0 maximum: 22	Niveau de zoom pour la vignette souhaitée. 0 à 22 pour les mosaïques raster, 0 à 22 pour les vignettes vectorielles
style	query	True	IncidentDetailStyle	Style qui sera utilisé pour afficher la vignette dans Traffic Vignette Incident API. Cela aura un effet sur les coordonnées des incidents de trafic dans la réponse.
trafficmodelid	query	True	string	Numéro référençant le modèle de trafic. Cette opération peut être obtenue à partir de l’API viewport. Il est mis à jour toutes les minutes et est valide pendant deux minutes avant qu’il expire. Si l’ID de modèle de trafic incorrect est spécifié, celui qui est correct est retourné par l’interface. Une valeur de -1 appelle toujours le modèle de trafic le plus récent
expandCluster	query		boolean	Boolean pour indiquer s’il faut répertorier tous les incidents de trafic dans un cluster séparément
geometries	query		IncidentGeometryType	Type de géométrie vectorielle ajoutée aux incidents (retourné dans l’élément de la réponse).
language	query		string	code ISO 639-1 pour le langage de sortie. Les langues prises en charge sont 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. Pour plus d’informations, consultez langues prises en charge. Lorsque le code de langue non valide est fourni, la réponse est retournée en anglais. Lorsque la cause ou la description de l’incident n’a pas de traduction, la description en anglais est retournée.
originalPosition	query		boolean	Boolean sur le fait de retourner la position d’origine de l’incident () ainsi que celle qui est passée au début du tube de trafic ()
projection	query		ProjectionStandard	Projection utilisée pour spécifier les coordonnées dans la demande et la réponse. EPSG900913 (par défaut) ou EPSG4326

En-tête de la demande

Nom	Obligatoire	Type	Description
x-ms-client-id		string	Spécifie le compte destiné à l’utilisation conjointement avec le modèle de sécurité Microsoft Entra ID. Il représente un ID unique pour le compte Azure Maps et peut être récupéré à partir de l’API compte de plan de gestion Azure Maps. Pour utiliser la sécurité microsoft Entra ID dans Azure Maps, consultez les articles suivants pour obtenir des conseils.

Réponses

Nom	Type	Description
200 OK	TrafficIncidentDetail	D’ACCORD
Other Status Codes	ErrorResponse	Une erreur inattendue s’est produite.

Sécurité

AADToken

Il s’agit des flux Microsoft Entra OAuth 2.0. Lorsqu’il est associé à 'accès en fonction du rôle Azure contrôle, il peut être utilisé pour contrôler l’accès aux API REST Azure Maps. Les contrôles d’accès en fonction du rôle Azure sont utilisés pour désigner l’accès à un ou plusieurs comptes de ressources Azure Maps ou sous-ressources. Tout utilisateur, groupe ou principal de service peut avoir accès via un rôle intégré ou un rôle personnalisé composé d’une ou plusieurs autorisations pour les API REST Azure Maps.

Pour implémenter des scénarios, nous vous recommandons d’afficher concepts d’authentification. En résumé, cette définition de sécurité fournit une solution pour la modélisation des applications via des objets capables de contrôler l’accès sur des API et des étendues spécifiques.

Remarques

Cette définition de sécurité nécessite l’utilisation de l’en-tête x-ms-client-id pour indiquer la ressource Azure Maps à laquelle l’application demande l’accès. Vous pouvez l’acquérir à partir de l’API de gestion Maps.

La Authorization URL est spécifique à l’instance de cloud public Azure. Les clouds souverains ont des URL d’autorisation uniques et des configurations d’ID Microsoft Entra. * Le contrôle d’accès en fonction du rôle Azure est configuré à partir de l'plan de gestion Azure via le portail Azure, PowerShell, l’interface CLI, les SDK Azure ou les API REST. * L’utilisation du kit de développement logiciel (SDK) web Azure Maps permet la configuration basée sur la configuration d’une application pour plusieurs cas d’usage.

Pour plus d’informations sur la plateforme d’identités Microsoft, consultez vue d’ensemble de la plateforme d’identités Microsoft.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

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

subscription-key

Il s’agit d’une clé partagée provisionnée lorsque vous créer un compte Azure Maps dans le portail Azure ou à l’aide de PowerShell, CLI, sdk Azure ou API REST.

Avec cette clé, toute application peut accéder à toutes les API REST. En d’autres termes, cette clé peut être utilisée comme clé principale dans le compte dans lequel elles sont émises.

Pour les applications exposées publiquement, nous vous recommandons d’utiliser les applications clientes confidentielles approche permettant d’accéder aux API REST Azure Maps afin que votre clé puisse être stockée en toute sécurité.

Type: apiKey
Dans: query

SAS Token

Il s’agit d’un jeton de signature d’accès partagé créé à partir de l’opération List SAS sur la ressource Azure Maps via le plan de gestion Azure via le portail Azure, PowerShell, CLI, azure SDK ou LES API REST.

Avec ce jeton, toute application est autorisée à accéder avec des contrôles d’accès en fonction du rôle Azure et un contrôle précis à l’expiration, au taux et aux régions d’utilisation pour le jeton particulier. En d’autres termes, le jeton SAP peut être utilisé pour permettre aux applications de contrôler l’accès de manière plus sécurisée que la clé partagée.

Pour les applications exposées publiquement, nous vous recommandons de configurer une liste spécifique d’origines autorisées sur la ressource de compte mapper pour limiter l’abus de rendu et renouveler régulièrement le jeton SAP.

Type: apiKey
Dans: header

Exemples

Request information about a traffic incident

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 200

{
  "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
      }
    ]
  }
}

Définitions

Nom	Description
DelayMagnitude	Ampleur du délai associé à l’incident. Ces valeurs correspondent aux couleurs d’incident dans les vignettes de trafic
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
IconCategory	Catégorie d’icône associée à cet incident. Les valeurs sont des nombres dans la plage 0-13, avec les significations suivantes :- 0 : Inconnu, 1 : Accident, 2 : Brouillard, 3 : Conditions dangereuses, 4 : Pluie, 5 : Glace, 6 : Jam, 7 : Lane fermée, 8 : Chemin fermé, 9 : Travaux routiers, 10 : Vent, 11 : Inondations, 12 : Détour, 13 : Cluster Fermé, 9 : Travaux routiers, 10 : Vent, 11 : Inondations, 12 : Détour, 13 : Cluster
IncidentDetailStyle	Style qui sera utilisé pour afficher la vignette dans Traffic Vignette Incident API. Cela aura un effet sur les coordonnées des incidents de trafic dans la réponse.
IncidentGeometryType	Type de géométrie vectorielle ajoutée aux incidents (retourné dans l’élément de la réponse).
Point	Représentation générique d’un point avec des coordonnées (x, y) dans le plan cartésien.
ProjectionStandard	Projection utilisée pour spécifier les coordonnées dans la demande et la réponse. EPSG900913 (par défaut) ou EPSG4326
ResponseFormat	Format souhaité de la réponse. La valeur peut être json ou xml.
Tm	Élément de réponse principal
TrafficIncidentDetail	Cet objet est retourné à partir d’un appel détaillé de l’incident de trafic réussi
TrafficIncidentPointOfInterest

DelayMagnitude

Énumération

Ampleur du délai associé à l’incident. Ces valeurs correspondent aux couleurs d’incident dans les vignettes de trafic

Valeur	Description
0	Inconnu
1	Mineur
2	Modéré
3	Majeur
4	Indéfini (utilisé pour les fermetures de routes et autres retards indéfinis)

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Object

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

IconCategory

Énumération

Catégorie d’icône associée à cet incident. Les valeurs sont des nombres dans la plage 0-13, avec les significations suivantes :- 0 : Inconnu, 1 : Accident, 2 : Brouillard, 3 : Conditions dangereuses, 4 : Pluie, 5 : Glace, 6 : Jam, 7 : Lane fermée, 8 : Chemin fermé, 9 : Travaux routiers, 10 : Vent, 11 : Inondations, 12 : Détour, 13 : Cluster Fermé, 9 : Travaux routiers, 10 : Vent, 11 : Inondations, 12 : Détour, 13 : Cluster

Valeur	Description
0	Inconnu
1	Accident
10	Vent
11	Inondation
12	Détour
13	Cluster : retourné si un cluster contient des incidents avec différentes catégories d’icônes.
14	Véhicule décomposé
2	Brouillard
3	Conditions dangereuses
4	Pluie
5	Verglas
6	Confiture
7	Voie fermée
8	Route fermée
9	Travaux routiers

IncidentDetailStyle

Énumération

Style qui sera utilisé pour afficher la vignette dans Traffic Vignette Incident API. Cela aura un effet sur les coordonnées des incidents de trafic dans la réponse.

Valeur	Description
night	Style nocturne.
s1	Crée des lignes de trafic avec des chevrons colorés indiquant la gravité.
s2	Crée des lignes simples avec un certain degré de lumière.
s3	Crée des lignes simples avec un certain degré de lumière, différente du style s2.

IncidentGeometryType

Énumération

Type de géométrie vectorielle ajoutée aux incidents (retourné dans l’élément de la réponse).

Valeur	Description
original	Place des incidents précisément sur la route.
shifted	Déplace légèrement l’incident (selon le niveau de zoom) pour indiquer des voies routières spécifiques.

Point

Object

Représentation générique d’un point avec des coordonnées (x, y) dans le plan cartésien.

Nom	Type	Description
x	number	coordonnée x
y	number	coordonnée y

ProjectionStandard

Énumération

Projection utilisée pour spécifier les coordonnées dans la demande et la réponse. EPSG900913 (par défaut) ou EPSG4326

Valeur	Description
EPSG4326	EPSG4326
EPSG900913	EPSG900913

ResponseFormat

Énumération

Format souhaité de la réponse. La valeur peut être json ou xml.

Valeur	Description
json	le format d’échange de données JavaScript Object Notation
xml	le langage de balisage extensible

Tm

Object

Élément de réponse principal

Nom	Type	Description
@id	string	ID du modèle de trafic pour cet incident
poi	TrafficIncidentPointOfInterest[]	Un incident de trafic unique ou un cluster d’incidents de trafic

TrafficIncidentDetail

Object

Cet objet est retourné à partir d’un appel détaillé de l’incident de trafic réussi

Nom	Type	Description
tm	Tm	Élément de réponse principal

TrafficIncidentPointOfInterest

Object

Nom	Type	Description
c	string	Cause de l’incident, le cas échéant, dans la langue demandée
cbl	Point	Coordonnée inférieure gauche du cluster dans la projection de la requête
cs	integer (int32)	Taille du cluster : nombre d’incidents dans le cluster
ctr	Point	Coordonnée supérieure droite du cluster dans la projection de la requête
d	string	Description de l’incident dans la langue demandée
dl	integer (int32)	Retard causé par l’incident en secondes (sauf dans les fermetures routières)
ed	string (date-time)	Date de fin estimée de l’incident, le cas échéant. La date est décrite au format ISO8601.
f	string	À partir de : nom de l’intersection ou de l’emplacement où le trafic en raison de l’incident démarre
ic	IconCategory (int32)	Catégorie d’icône associée à cet incident. Les valeurs sont des nombres dans la plage 0-13, avec les significations suivantes :- 0 : Inconnu, 1 : Accident, 2 : Brouillard, 3 : Conditions dangereuses, 4 : Pluie, 5 : Glace, 6 : Jam, 7 : Lane fermée, 8 : Chemin fermé, 9 : Travaux routiers, 10 : Vent, 11 : Inondations, 12 : Détour, 13 : Cluster Fermé, 9 : Travaux routiers, 10 : Vent, 11 : Inondations, 12 : Détour, 13 : Cluster
id	string	ID de l’incident de trafic
l	integer (int32)	Longueur de l’incident en mètres
p	Point	Point où une icône du cluster ou de l’incident brut doit être dessinée, exprimée dans la projection demandée. Cela est affecté par le style de circulation, le niveau de zoom et le type de route
r	string	Numéro de route affecté par l’incident. Plusieurs numéros de route seront délimités par des barres obliques
sd	string (date-time)	Date de début de l’incident, le cas échéant. La date est décrite au format ISO8601.
t	string	Pour : le nom de l’intersection ou de l’emplacement où le trafic en raison de l’incident se termine
ty	DelayMagnitude (int32)	Ampleur du délai associé à l’incident. Ces valeurs correspondent aux couleurs d’incident dans les vignettes de trafic

Partager via

Traffic - Get Traffic Incident Detail

Paramètres URI

En-tête de la demande

Réponses

Sécurité

AADToken

Remarques

Étendues

subscription-key

SAS Token

Exemples

Request information about a traffic incident

Exemple de requête

Exemple de réponse

Définitions

DelayMagnitude

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

IconCategory

IncidentDetailStyle

IncidentGeometryType

Point

ProjectionStandard

ResponseFormat

Tm

TrafficIncidentDetail

TrafficIncidentPointOfInterest

Ressources supplémentaires