RouteRequestRouteMatrixSync408Response interface

Pakket:

@azure-rest/maps-route

De Post Route Matrix Sync-API is een HTTP-POST-aanvraag waarmee een matrix met routesamenvattingen kan worden berekend voor een set routes die zijn gedefinieerd door oorsprongs- en doellocaties met behulp van één synchrone aanvraag (synchronisatie). Zie Post Route Matrixom een asynchrone (asynchrone) aanvraag te maken. Voor elke opgegeven oorsprong berekent de service de kosten van routering van die oorsprong naar elke opgegeven bestemming. De reeks oorsprongen en de set bestemmingen kunnen worden beschouwd als de kolom- en rijkoppen van een tabel en elke cel in de tabel bevat de kosten voor routering van de oorsprong naar de bestemming voor die cel. Stel dat een foodleveringsbedrijf 20 chauffeurs heeft en dat ze de dichtstbijzijnde chauffeur moeten vinden om de levering van het restaurant op te halen. Om deze use-case op te lossen, kunnen ze matrixroute-API aanroepen.

Voor elke route worden de reistijden en afstanden geretourneerd. U kunt de berekende kosten gebruiken om te bepalen welke gedetailleerde routes u wilt berekenen met behulp van de ROUTEBESCHRIJVING-API.

De maximale grootte van een matrix voor asynchrone aanvraag is 700 en voor de synchronisatieaanvraag is het 100 (het aantal oorsprongen vermenigvuldigd met het aantal bestemmingen).

Synchrone routematrixaanvraag verzenden

Als voor uw scenario synchrone aanvragen zijn vereist en de maximale grootte van de matrix kleiner is dan of gelijk is aan 100, kunt u een synchrone aanvraag indienen. De maximale grootte van een matrix voor deze API is 100 (het aantal oorsprongen vermenigvuldigd met het aantal bestemmingen). Met deze beperking in gedachten zijn voorbeelden van mogelijke matrixdimensies: 10x10, 6x8, 9x8 (het hoeft niet vierkant te zijn).

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

Asynchrone routematrixaanvraag verzenden

De Asynchrone API is geschikt voor het verwerken van grote volumes van relatief complexe routeringsaanvragen. Wanneer u een aanvraag indient met behulp van een asynchrone aanvraag, retourneert de service standaard een 202-antwoordcode langs een omleidings-URL in het veld Locatie van de antwoordheader. Deze URL moet periodiek worden gecontroleerd totdat de antwoordgegevens of foutgegevens beschikbaar zijn. Als waitForResults parameter in de aanvraag is ingesteld op waar, krijgt de gebruiker een 200-antwoord als de aanvraag binnen 120 seconden is voltooid.

De maximale grootte van een matrix voor deze API is 700 (het aantal oorsprongen vermenigvuldigd met het aantal bestemmingen). Met deze beperking in gedachten zijn voorbeelden van mogelijke matrixdimensies: 50x10, 10x10, 28x25. 10x70 (het hoeft niet vierkant te zijn).

De asynchrone antwoorden worden gedurende 24 uur opgeslagen. De omleidings-URL retourneert een 404-antwoord als deze wordt gebruikt na de verloopperiode.

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

Hier volgt een typische reeks asynchrone bewerkingen:

1. Client verzendt een Route Matrix POST-aanvraag naar Azure Maps

2. De server reageert op een van de volgende manieren:

   HTTP-202 Accepted - Routematrix-aanvraag is geaccepteerd.

   HTTP-Error: er is een fout opgetreden bij het verwerken van uw Route Matrix-aanvraag. Dit kan een ongeldige aanvraag van 400 of een andere foutcode zijn.

3. Als de matrixroute-aanvraag is geaccepteerd, bevat de locatieheader in het antwoord de URL om de resultaten van de aanvraag te downloaden. Deze status-URI ziet er als volgt uit:

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

4. Client geeft een GET-aanvraag uit op de download-URL die is verkregen in stap 3 om de resultaten te downloaden

Synchronisatieresultaten downloaden

Wanneer u een POST-aanvraag voor routematrixsynchronisatie-API maakt, retourneert de service 200-antwoordcode voor een geslaagde aanvraag en een antwoordmatrix. De hoofdtekst van het antwoord bevat de gegevens en er is geen mogelijkheid om de resultaten later op te halen.

Asynchrone resultaten downloaden

Wanneer een aanvraag een 202 Accepted antwoord uitgeeft, wordt de aanvraag verwerkt met behulp van onze asynchrone pijplijn. U krijgt een URL om de voortgang van uw asynchrone aanvraag te controleren in de locatieheader van het antwoord. Deze status-URI ziet er als volgt uit:

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

De URL van de locatieheader retourneert de volgende antwoorden wanneer een GET aanvraag wordt uitgegeven.

HTTP-202 Accepted - Matrix-aanvraag is geaccepteerd, maar wordt nog steeds verwerkt. Probeer het over enige tijd opnieuw.

HTTP-200 OK - Matrixaanvraag is verwerkt. De hoofdtekst van het antwoord bevat alle resultaten.

Uitbreiding

HttpResponse

Eigenschappen

body
status

Overgenomen eigenschappen

headers	De HTTP-antwoordheaders.
request	De aanvraag die dit antwoord heeft gegenereerd.

Eigenschapdetails

body

body: ErrorResponseOutput

Waarde van eigenschap

ErrorResponseOutput

status

status: "408"

Waarde van eigenschap

"408"

Details van overgenomen eigenschap

headers

De HTTP-antwoordheaders.

headers: RawHttpHeaders

Waarde van eigenschap

RawHttpHeaders

overgenomen van HttpResponse.headers

request

De aanvraag die dit antwoord heeft gegenereerd.

request: PipelineRequest

Waarde van eigenschap

PipelineRequest

overgenomen van HttpResponse.request