Partager via

RouteRequestRouteMatrixSync200Response interface

  • Référence
Paquet:
@azure-rest/maps-route

L’API Post Route Matrix Sync est une requête HTTP POST qui permet le calcul d’une matrice de résumés d’itinéraires pour un ensemble d’itinéraires définis par les emplacements d’origine et de destination à l’aide d’une seule requête synchrone (synchronisation). Pour effectuer une requête asynchrone (asynchrone), consultez matrice de post-routage. Pour chaque origine donnée, le service calcule le coût du routage de cette origine vers chaque destination donnée. L’ensemble d’origines et l’ensemble de destinations peuvent être considérés comme les en-têtes de colonne et de ligne d’une table et chaque cellule du tableau contient les coûts de routage de l’origine vers la destination de cette cellule. Par exemple, supposons qu’une entreprise de livraison alimentaire a 20 chauffeurs et qu’elle doit trouver le chauffeur le plus proche pour récupérer la livraison du restaurant. Pour résoudre ce cas d’usage, ils peuvent appeler l’API Matrix Route.

Pour chaque itinéraire, les temps de trajet et les distances sont retournés. Vous pouvez utiliser les coûts calculés pour déterminer les itinéraires détaillés à calculer à l’aide de l’API Route Directions.

La taille maximale d’une matrice pour la requête asynchrone est 700 et pour la demande de synchronisation, elle est 100 (le nombre d’origines multiplié par le nombre de destinations).

Envoyer une demande de matrice de routage synchrone

Si votre scénario nécessite des requêtes synchrones et que la taille maximale de la matrice est inférieure ou égale à 100, vous souhaiterez peut-être effectuer une requête synchrone. La taille maximale d’une matrice pour cette API est 100 (le nombre d’origines multiplié par le nombre de destinations). Avec cette contrainte à l’esprit, les exemples de dimensions de matrice possibles sont : 10x10, 6x8, 9x8 (il n’est pas nécessaire d’être carré).

POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}

Envoyer une demande de matrice de routage asynchrone

L’API asynchrone convient au traitement de gros volumes de demandes de routage relativement complexes. Lorsque vous effectuez une requête à l’aide d’une requête asynchrone, par défaut, le service retourne un code de réponse 202 le long d’une URL de redirection dans le champ Emplacement de l’en-tête de réponse. Cette URL doit être vérifiée régulièrement jusqu’à ce que les données de réponse ou les informations d’erreur soient disponibles. Si waitForResults paramètre dans la requête a la valeur true, l’utilisateur obtient une réponse 200 si la requête est terminée sous 120 secondes.

La taille maximale d’une matrice pour cette API est 700 (le nombre d’origines multiplié par le nombre de destinations). Avec cette contrainte à l’esprit, des exemples de dimensions de matrice possibles sont : 50x10, 10x10, 28x25. 10x70 (il n’a pas besoin d’être carré).

Les réponses asynchrones sont stockées pendant 24 heures. L’URL de redirection retourne une réponse 404 si elle est utilisée après la période d’expiration.

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}

Voici une séquence classique d’opérations asynchrones :

  1. Le client envoie une requête POST de matrice de routage à Azure Maps

  2. Le serveur répond avec l’une des options suivantes :

    HTTP 202 Accepted : la demande de matrice de routage a été acceptée.

    HTTP Error : une erreur s’est produite lors du traitement de votre demande de matrice de routage. Il peut s’agir d’une demande incorrecte 400 ou d’un autre code d’état d’erreur.

  3. Si la demande Matrix Route a été acceptée avec succès, l’en-tête Location dans la réponse contient l’URL pour télécharger les résultats de la demande. Cet URI d’état se présente comme suit :

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Le client émet une requête GET sur l’URL de téléchargement obtenue à l’étape 3 pour télécharger les résultats

Télécharger les résultats de synchronisation

Lorsque vous effectuez une requête POST pour l’API Route Matrix Sync, le service retourne le code de réponse 200 pour une requête réussie et un tableau de réponses. Le corps de la réponse contiendra les données et il n’y aura aucune possibilité de récupérer les résultats ultérieurement.

Télécharger les résultats asynchrones

Lorsqu’une demande émet une réponse 202 Accepted, la demande est traitée à l’aide de notre pipeline asynchrone. Vous recevrez une URL pour vérifier la progression de votre demande asynchrone dans l’en-tête d’emplacement de la réponse. Cet URI d’état se présente comme suit :

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

L’URL fournie par l’en-tête d’emplacement retourne les réponses suivantes lorsqu’une demande de GET est émise.

HTTP 202 Accepted : la demande de matrice a été acceptée, mais elle est toujours traitée. Réessayez dans un certain temps.

HTTP 200 OK - Requête de matrice traitée avec succès. Le corps de la réponse contient tous les résultats.

Extends
HttpResponse

Propriétés

body
status

Propriétés héritées

headers

En-têtes de réponse HTTP.
request

Demande qui a généré cette réponse.

Détails de la propriété

body 

body: RouteMatrixResultOutput

Valeur de propriété

RouteMatrixResultOutput

status 

status: "200"

Valeur de propriété

"200"

Détails de la propriété héritée

headers

En-têtes de réponse HTTP.

headers: RawHttpHeaders

Valeur de propriété

RawHttpHeaders

héritée de HttpResponse.headers

request

Demande qui a généré cette réponse.

request: PipelineRequest

Valeur de propriété

PipelineRequest

héritée de HttpResponse.request