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

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 }}