{"_id":"57a070d819a5850e0096a9f8","user":"570614bde2df830e00d52774","version":{"_id":"5706099c21cfed0e00e8c60e","hasDoc":true,"project":"5706099c21cfed0e00e8c60b","__v":6,"hasReference":true,"createdAt":"2016-04-07T07:17:48.808Z","releaseDate":"2016-04-07T07:17:48.808Z","categories":["5706099c21cfed0e00e8c60f","573548f4afab4417007239cf","57354970fc5f1e0e001a463c","573549791f16241700c89fc9","57441052583f470e000a7947","57a068f90c933e0e00249bae"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.17","version":"1.0.17"},"category":{"_id":"573548f4afab4417007239cf","__v":0,"project":"5706099c21cfed0e00e8c60b","version":"5706099c21cfed0e00e8c60e","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-05-13T03:24:36.341Z","from_sync":false,"order":9999,"slug":"api","title":"Routing API"},"__v":1,"project":"5706099c21cfed0e00e8c60b","githubsync":"","parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-08-02T10:07:20.750Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"name":"request - body","code":"{\n  \"algorithmNames\": [\"ALNSAlgorithm\"],\n\t\"stopCriteria\": {\n  \t\"numIterations\": 150,\n    \"improvementLimit\": 10,\n    \"improvementRate\": 0.05\n  },\n  \"callbackUrl\": \"my.url.com\",\n  \"numWorkers\": 1,\n  \"timeOut\": 10\n}","language":"json"},{"code":"{\n  \"responseId\":\"6ece8490-acc3-4a4b-9de0-e1f23a4e344d\"\n}","language":"json","name":"response - success"},{"code":"{\n  \"error\": \"Request with ID: [7520e724-fd68-6471-b080-a32645947fe4] is not valid\",\n  \"errorCode\": \"4001\"","language":"json","name":"response - error"}]},"method":"post","results":{"codes":[{"status":"2XX","language":"json","code":"{\n\t\"responseId\": String\n}","name":""},{"status":"4XX","language":"json","code":"{\n  \"error\" String,\n  \"errorCode\": String\n}","name":""}]},"settings":"576a36aadd4f320e0060b806","auth":"required","params":[{"_id":"57454bc011628d0e009a76fb","ref":"","in":"path","required":true,"desc":"ID of the routing response.","default":"","type":"string","name":"requestId"},{"_id":"57454c296aa4860e00c2e19e","ref":"","in":"body","required":false,"desc":"Parameter values for determining termination. Can specify number of iterations, improvement rate and limit. Refer to \"Problems and Solutions\" section for more information.","default":"","type":"object","name":"stopCriteria"},{"_id":"57454c296aa4860e00c2e19d","ref":"","in":"body","required":false,"desc":"The URL to receive the result of computation.","default":"","type":"string","name":"callbackUrl"},{"_id":"57a0686b1435850e00dfbc0d","ref":"","in":"body","required":false,"desc":"List of the name of algorithm to use for computation. ALNS algorithm and genetic algorithm are currently available.","default":"[\"ALNSAlgorithm\", \"GeneticAlgorithm\"]","type":"array_string","name":"algorithmNames"},{"_id":"57a0686b1435850e00dfbc0c","ref":"","in":"body","required":false,"desc":"The number of independent, parallel computations.","default":"1","type":"int","name":"numWorkers"},{"_id":"57a0686b1435850e00dfbc0b","ref":"","in":"body","required":false,"desc":"Timeout in minutes for computation.","default":"10","type":"int","name":"timeOut"},{"_id":"57a076f8cf8f650e00cccdd8","ref":"","in":"header","required":true,"desc":"An API key.","default":"","type":"string","name":"x-api-key"}],"url":"/routing/request/:requestId/response"},"isReference":false,"order":3,"body":"","excerpt":"Start computing a routing solution for the specific routing request","slug":"routingrequestrequestidresponse","type":"endpoint","title":"/routing/request/{requestId}/response"}

post/routing/request/{requestId}/response

Start computing a routing solution for the specific routing request

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

requestId:
required
string
ID of the routing response.

Body Params

stopCriteria:
object
Parameter values for determining termination. Can specify number of iterations, improvement rate and limit. Refer to "Problems and Solutions" section for more information.
callbackUrl:
string
The URL to receive the result of computation.
algorithmNames:
array of strings["ALNSAlgorithm", "GeneticAlgorithm"]
List of the name of algorithm to use for computation. ALNS algorithm and genetic algorithm are currently available.
numWorkers:
integer1
The number of independent, parallel computations.
timeOut:
integer10
Timeout in minutes for computation.

Headers

x-api-key:
required
string
An API key.

Examples


Result Format


User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}