Bing Maps Optimized Multi-Itinerary API - errorMessage : Request is not completed

Question

Bing Maps Optimized Multi-Itinerary API - errorMessage : Request is not completed

Evans C 20

I have a web app which I'm using to submit the payload as shown below, using an HTTP async POST request:

{
	"agents": [
	   {
		"name":"Care Five",
		"shifts": [
		    {
			"startTime":"2023-07-09T07:00:00",
			"startAddress":"26 Galbraith Rd, Andover, SP11 6AZ",
			"endTime":"2023-07-09T13:00:00",
			"endAddress":"The Commercial Centre, Suite 205, Picket Piece, Andover, SP11 6AZ"
		    }
		 ],
		"capacity":[3]
	   },
	   {
		"name":"Carer 2",
		"shifts": [
		    {
			"startTime":"2023-07-09T07:00:00",
			"startAddress":"17 Sheraton Ave, Basingstoke, RG22 4TS",
			"endTime":"2023-07-09T12:30:00",
			"endAddress":"The Commercial Centre, Suite 205, Picket Piece, Andover, SP11 6AZ"
		    }
		],
		"capacity":[3]
	   }
	],
	"itineraryItems": [
	    {
		"name":"Ameli Service",
		"openingTime":"2023-07-09T07:00:00",
		"closingTime":"2023-07-09T09:00:00",
		"dwellTime":"00:30:00",
		"priority":1,
		"address":"14 Walworth Rd, Andover, SP11 6LU"
	    },
	    {
		"name":"April Spring",
		"openingTime":"2023-07-09T07:00:00",
		"closingTime":"2023-07-09T10:00:00",
		"dwellTime":"00:45:00",
		"priority":1,
		"address":"Walworth Rd, Andover, SP11 6LY"
	    },
	    {
		"name":"Boris Beckham",
		"openingTime":"2023-07-09T07:00:00",
		"closingTime":"2023-07-09T10:45:00",
		"dwellTime":"01:00:00",
		"priority":1,
		"address":"15 High St, ANdover, SP10 1LJ"
	    },
	    {
		"name":"Augustus Summer",
		"openingTime":"2023-07-09T08:00:00",
		"closingTime":"2023-07-09T10:00:00",
		"dwellTime":"01:00:00",
		"priority":1,
		"address":"Station Rd, Overton, RG25 3DU"
	    }
	]
}

After the initial API response returns a status code of 200 OK, I then visit the provided callback URL using an HTTP GET request. The second API response is somewhat confusing me, as I'm getting a status code of 200 OK but there's a "Request is not completed" errorMessage like this:

{"authenticationResultCode":"ValidCredentials","brandLogoUri":"http://dev.virtualearth.net/Branding/logo_powered_by.png","copyright":"Copyright © 2023 Microsoft and its suppliers. All rights reserved. This API cannot be accessed and the content and any results may not be used, reproduced or transmitted in any manner without express written permission from Microsoft Corporation.","resourceSets":[{"estimatedTotal":1,"resources":[{"__type":"RouteProxyAsyncResult:http://schemas.microsoft.com/search/local/ws/rest/v1","callbackInSeconds":1,"callbackUrl":"https://dev.virtualearth.net/REST/V1/Routes/OptimizeItineraryAsyncCallback?key={API_KEY}","errorMessage":"Request is not completed.","isAccepted":true,"isCompleted":false,"requestId":"d21ddc15-94f9-4008-95a8-b5dc658908fd"}]}],"statusCode":200,"statusDescription":"OK","traceId":"d8916f4300804c1cbb8aafb24128aae0|DU00002E69|0.0.0.0"}

I can revisit the callback URL several times, but I still get the same result of "Request is not completed". Where am I going wrong?

0 comments

Answer accepted by question author

0 additional answers

Your answer

Answer 1

rbrundritt 21,711 Volunteer Moderator

That means that your request is still processing and the results aren't yet ready. You need to periodically call that URL to check when it is completed. Once completed, it will have a URL to use to download the results. Note that this API is a batch process and can take several minutes or longer depending on the complexity and length of routes.

In addition to this API, the truck routing and batch geocoding APIs work in a similar way.

Evans C 20 Reputation points

2023-07-13T06:26:00.9+00:00

Thank you for that response. It is very logical to interpret it that way. However, I am getting a callbackInSeconds:1, (i.e. 1 sec) almost all the time. So I created a loop in my code to check if isCompleted:true, if not pause for callbackInSeconds and then retry the callback URL. It results in 1000s of callback requests to the callback API, then the gateway eventually times out after about 3 or so minutes. If I check my Bing Maps account, I currently have the following number of API calls:

Routes-OptimizeItineraryAsyncCallback 12,960

Routes-OptimizeItineraryAsync 196

As you can see there's a disproportionate number of calls to the callback API, which all happen in just a few requests. At that rate I will exhaust my 125k free API calls within days to fulfil just a handful of requests. I would've expected the callbackInSeconds value to be much higher if the API was busy calculating?
rbrundritt 21,711 Reputation points Volunteer Moderator

2023-07-13T17:32:06.2366667+00:00
The Route-OptimizeItineraryAsyncCallback transactions are non-billable and don't count towards your 125K free limit. So no issue there.

That said, it does seem odd that it would keep saying 1 second. I know the time estimates of the async services can be "optimistic" at times and having to call the callback 4 or 5 times while waiting for it to complete is not unusual, but 1 second constantly seems like there might be an issue. I'll reach out to the Bing Maps team and ask if they can look into this. Checking some older code I wrote to use these services I see I also used the callbackInSeconds value.

As a temporary workaround, if you don't mind the response taking a few more seconds to return, you could set a minimum wait time in your code. For example:

long MIM_STATUS_WAIT_TIME_SECONDS = 15000; //15 seconds. private async Task WaitForStatus(AsyncStatus status) { long waitTime = Math.Max(status.CallbackInSeconds, MIM_STATUS_WAIT_TIME_SECONDS); await Task.Delay(TimeSpan.FromSeconds(waitTime )); //Add code to check status again. }
Evans C 20 Reputation points

2023-07-13T20:18:15.46+00:00

Hey rbrundritt, looks like Microsoft may have revoked my API Keys. I have not been able to view my keys since this morning. It's probably because of the deluge of API calls my issue caused? I have not been contacted about any potential abuse of the TOU. Is that something you can look at or point me in the right direction?

Screenshot 2023-07-13 at 21.09.24.png
rbrundritt 21,711 Reputation points Volunteer Moderator

2023-07-13T23:07:41.35+00:00

Are you still seeing this error? This looks more like a service error and not an account TOU issue. The keys should always appear. If you exceeded any TOU limit, you would get an error when making REST API calls.
Evans C 20 Reputation points

2023-07-14T05:42:12.1133333+00:00

That error has gone now, it seems to have been a service issue.

As for my original problem, in the end I had to wait for about 3 minutes for the final response to come. So you were absolutely right in advising that the process can take several minutes. It would be great if the callbackInSeconds could be sorted out as it's nowhere near accurate.

Thank you very much.

Share via

Bing Maps Optimized Multi-Itinerary API - errorMessage : Request is not completed

0 additional answers

Your answer