Partager via

Traffic - Get Traffic Flow Segment

  • Référence
Service:
Maps
Version d'API:
1.0

Utilisez pour obtenir des informations sur les vitesses et les temps de trajet de la section de route spécifiée.

L’API Traffic Flow Segment est une requête HTTP GET qui fournit des informations sur les vitesses et les temps de trajet du fragment de route le plus proche des coordonnées données. Il est conçu pour fonctionner en même temps que la couche Flux du service Render pour prendre en charge les visualisations de données de flux cliquables. Avec l’API Traffic Flow Segment , le côté client peut connecter n’importe quel endroit de la carte avec des données de flux sur la route la plus proche et les présenter à l’utilisateur.

GET https://atlas.microsoft.com/traffic/flow/segment/{format}?api-version=1.0&style={style}&zoom={zoom}&query={query}
Avec des paramètres facultatifs: 
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}

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.
query
 query True

number[]

Coordonnées du point proche du segment routier. Ce paramètre est une liste de quatre coordonnées, contenant deux paires de coordonnées (lat, long, lat, long) et calculée à l’aide de EPSG4326 projection. Lorsque ce point de terminaison est appelé directement, les coordonnées sont transmises sous la forme d’une chaîne unique contenant quatre coordonnées, séparées par des virgules.
style
 query True

TrafficFlowSegmentStyle

Style à utiliser pour afficher la vignette. Les valeurs valides sont absolues qui retournent des couleurs reflétant la vitesse absolue mesurée, relatives qui retourne la vitesse par rapport au flux libre, relative-délai qui affiche les vitesses relatives uniquement lorsqu’elles sont différentes des vitesses de flux libre
zoom
 query True

integer

int32

Niveau de zoom de la vignette souhaitée. La valeur de zoom doit être comprise entre 0 et 22 (inclus). Pour plus d’informations, consultez Niveaux de zoom et Grille de mosaïques .
openLr
 query

boolean

Boolean indiquant si la réponse doit inclure du code OpenLR
thickness
 query

integer

int32

Valeur de la largeur de la ligne représentant le trafic. Cette valeur est un multiplicateur et les valeurs acceptées sont comprises entre 1 et 20. La valeur par défaut est 10.
unit
 query

SpeedUnit

Unité de vitesse en KMPH ou MPH

En-tête de la demande

Nom Obligatoire Type Description
x-ms-client-id

string

Spécifie quel compte est destiné à être utilisé conjointement avec le modèle de sécurité de l’ID Microsoft Entra. Il représente un ID unique pour le compte Azure Maps et peut être récupéré à partir de l’API Compte du plan de gestion Azure Maps. Pour utiliser la sécurité des ID Microsoft Entra dans Azure Maps, consultez les articles suivants pour obtenir des conseils.

Réponses

Nom Type Description
200 OK

TrafficFlowSegmentData

Ok
Other Status Codes

ErrorResponse

Une erreur inattendue s’est produite.

Sécurité

AADToken

Il s’agit des flux OAuth Microsoft Entra 2.0 . Lorsqu’il est associé au contrôle d’accès en fonction du rôle Azure , 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 Ou sous-ressources Azure Maps. Tout utilisateur, groupe ou principal de service peut se voir accorder l’accès via un rôle intégré ou un rôle personnalisé composé d’une ou plusieurs autorisations aux API REST Azure Maps.

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

Notes

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

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 du 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 une configuration basée sur la configuration d’une application pour plusieurs cas d’usage.

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 qui est provisionnée lorsque vous créez un compte Azure Maps dans le portail Azure ou à l’aide de PowerShell, de l’interface CLI, des SDK Azure ou de l’API REST.

Avec cette clé, n’importe quelle 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 elle est émise.

Pour les applications exposées publiquement, nous vous recommandons d’utiliser l’approche des applications clientes confidentielles pour 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, l’interface CLI, les SDK Azure 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 de grain 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, notre recommandation est de configurer une liste spécifique d’origines autorisées sur la ressource de compte Map afin de limiter les abus de rendu et de renouveler régulièrement le jeton SAP.

Type: apiKey
Dans: header

Exemples

Request traffic flow segment information

Exemple de requête

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

Exemple de réponse

Code d’état:
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"
  }
}

Définitions

Nom Description
Coordinates

Inclut les coordonnées décrivant la forme du segment. Les coordonnées sont déplacées de la route en fonction du niveau de zoom pour prendre en charge la visualisation de haute qualité à chaque échelle.
ErrorAdditionalInfo

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

Détail de l’erreur.
ErrorResponse

Réponse d’erreur
FlowSegmentData

Propriété Données de segment de flux
LatLongPair

Emplacement représenté sous la forme d’une latitude et d’une longitude.
ResponseFormat

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

Unité de vitesse en KMPH ou MPH
TrafficFlowSegmentData

Cet objet est retourné à partir d’un appel de segment de flux de trafic réussi
TrafficFlowSegmentStyle

Style à utiliser pour afficher la vignette. Les valeurs valides sont absolues qui retournent des couleurs reflétant la vitesse absolue mesurée, relatives qui retourne la vitesse par rapport au flux libre, relative-délai qui affiche les vitesses relatives uniquement lorsqu’elles sont différentes des vitesses de flux libre

Coordinates

Inclut les coordonnées décrivant la forme du segment. Les coordonnées sont déplacées de la route en fonction du niveau de zoom pour prendre en charge la visualisation de haute qualité à chaque échelle.

Nom Type Description
coordinate

LatLongPair[]

Tableau de coordonnées

ErrorAdditionalInfo

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

Nom Type Description
info

object

Informations supplémentaires
type

string

Type d’informations supplémentaires.

ErrorDetail

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

Réponse d’erreur

Nom Type Description
error

ErrorDetail

Objet d’erreur.

FlowSegmentData

Propriété Données de segment de flux

Nom Type Description
@version

string

Cela indique la version du logiciel qui a généré la réponse.
confidence

number

La confiance est une mesure de la qualité du temps de trajet et de la vitesse fournis. La valeur 1 signifie que la réponse contient les données de la plus haute qualité. Des valeurs inférieures indiquent le degré de variation de la réponse par rapport aux conditions réelles sur la route. Toute valeur supérieure à 0,6 signifie que les informations étaient basées sur une entrée de sonde en temps réel. La valeur 0,5 signifie que la vitesse signalée est basée sur les informations historiques. Une valeur comprise entre 0,5 et 0,6 a une moyenne pondérée calculée entre les vitesses historiques et les vitesses actives.
coordinates

Coordinates

Inclut les coordonnées décrivant la forme du segment. Les coordonnées sont déplacées de la route en fonction du niveau de zoom pour prendre en charge la visualisation de haute qualité à chaque échelle.
currentSpeed

integer

Vitesse moyenne actuelle au point sélectionné, dans les unités demandées. Cette valeur est calculée à partir du currentTravelTime et de la longueur du segment sélectionné.
currentTravelTime

integer

Temps de trajet actuel en secondes, sur ce segment de trafic, basé sur des mesures en temps réel fusionnées entre les emplacements définis dans la direction spécifiée.
frc

string

Classe de route fonctionnelle. Cela indique le type de route : 0 : autoroute, autoroute ou autre route principale. 1 : Route principale, moins importante qu’une autoroute. 2 : Autre route principale. 3 : Route secondaire. 4 : Route de liaison locale. 5 : Route locale de grande importance. 6 : Route locale.
freeFlowSpeed

integer

Vitesse de libre flux attendue dans des conditions idéales, exprimée en unités demandées. Cela est lié à freeFlowTravelTime.
freeFlowTravelTime

integer

Le temps de trajet en secondes, sur ce segment de trafic, qui serait attendu dans des conditions de libre circulation idéales.
openlr

string

Code OpenLR pour le segment. Pour plus d’informations sur l’utilisation des codes Open LR, consultez OpenLR .

LatLongPair

Emplacement représenté sous la forme d’une latitude et d’une longitude.

Nom Type Description
latitude

number

Propriété Latitude
longitude

number

Longitude, propriété

ResponseFormat

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

Nom Type Description
json

string

Format d’échange de données de notation d’objet JavaScript
xml

string

Langage de balisage extensible

SpeedUnit

Unité de vitesse en KMPH ou MPH

Nom Type Description
KMPH

string

Kilomètres par heure
MPH

string

Miles par heure

TrafficFlowSegmentData

Cet objet est retourné à partir d’un appel de segment de flux de trafic réussi

Nom Type Description
flowSegmentData

FlowSegmentData

Propriété Données de segment de flux

TrafficFlowSegmentStyle

Style à utiliser pour afficher la vignette. Les valeurs valides sont absolues qui retournent des couleurs reflétant la vitesse absolue mesurée, relatives qui retourne la vitesse par rapport au flux libre, relative-délai qui affiche les vitesses relatives uniquement lorsqu’elles sont différentes des vitesses de flux libre

Nom Type Description
absolute

string

relative

string

relative-delay

string