{"_id":"57454fad77539d0e008d8fa8","user":"57061c3e21cfed0e00e8c640","editedParams":true,"githubsync":"","project":"5706099c21cfed0e00e8c60b","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"},"editedParams2":true,"parentDoc":null,"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"},"__v":1,"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-05-25T07:09:33.058Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"{\n  \"id\": \"088bd450-3299-4775-9b30-c0ecd12f5b4e\",\n  \"requestId\": \"86d9cf4f-dfb8-45ac-b481-1a3516c38d58\",\n  \"status\": \"Done\",\n  \"solution\": {\n    \"routes\": [\n      {\n        \"driver\": {\n          \"id\": \"d1\",\n          \"maxCapacity\": {\n            \"data\": {\n              \"Volume\": 1000000.0\n            }\n          },\n          \"startLocation\": {\n            \"labels\": [],\n            \"x\": 128.1,\n            \"y\": 37.1\n          },\n          \"endLocation\": {\n            \"labels\": [],\n            \"x\": 128.1,\n            \"y\": 37.1\n          },\n          \"startTime\": {\n            \"epoch\": 1455340000\n          },\n          \"endTime\": {\n            \"epoch\": 1455370000\n          },\n          \"skillLevel\": 0,\n          \"vehicleFeatures\": []\n        },\n        \"jobs\": [\n          {\n            \"id\": \"j1\",\n            \"tasks\": [\n              {\n                \"id\": \"t1\",\n                \"jobId\": \"j1\",\n                \"taskType\": \"DepotDelivery\",\n                \"location\": {\n                  \"labels\": [],\n                  \"x\": 126.9,\n                  \"y\": 37.3\n                },\n                \"capacity\": {\n                  \"data\": {\n                    \"Volume\": 100.0\n                  }\n                },\n                \"taskDuration\": {\n                  \"seconds\": 300\n                },\n                \"timeWindow\": {\n                  \"start\": {\n                    \"epoch\": 1455354000\n                  },\n                  \"end\": {\n                    \"epoch\": 1455364800\n                  }\n                },\n                \"difficulty\": 0\n              }\n            ],\n            \"partialOrder\": []\n          }\n        ],\n        \"tasks\": [\n          {\n            \"id\": \"t1\",\n            \"jobId\": \"j1\",\n            \"taskType\": \"DepotDelivery\",\n            \"location\": {\n              \"labels\": [],\n              \"x\": 126.9,\n              \"y\": 37.3\n            },\n            \"capacity\": {\n              \"data\": {\n                \"Volume\": 100.0\n              }\n            },\n            \"taskDuration\": {\n              \"seconds\": 300\n            },\n            \"timeWindow\": {\n              \"start\": {\n                \"epoch\": 1455354000\n              },\n              \"end\": {\n                \"epoch\": 1455364800\n              }\n            },\n            \"difficulty\": 0\n          }\n        ],\n        \"depot\": {\n          \"id\": \"depot1\",\n          \"location\": {\n            \"labels\": [],\n            \"x\": 127.1,\n            \"y\": 37.3\n          }\n        }\n      }\n    ]\n  },\n  \"createdAt\": \"20160525 15:17:39\",\n  \"config\": {\n    \"algorithmNames\": [\"ALNSAlgorithm\"],\n    \"stopCriteria\": {\n      \"numIterations\": 5,\n      \"improvementRate\": 0.05,\n      \"improvementLimit\": 20\n    },\n    \"numWorkers\": 1,\n    \"timeOut\": 10\n  }\n}","language":"json","name":"response - success"},{"code":"{\n  \"error\": \"Request with ID: [9876a8ec-c832-45fb-8793-383f9ea7c13d] is not valid\",\n  \"errorCode\": \"2004\"\n}","language":"json","name":"response - error"}]},"method":"get","results":{"codes":[{"status":"2XX","language":"json","code":"{\n\t\"id\": String,\n  \"requestId\": String,\n  \"status\": String,\n  \"solution\": Object[RoutingResponse],\n  \"createdAt\": String,\n  \"config\": Object[RoutingResponseConfig]\n}","name":""},{"code":"{\n  \"error\": String,\n  \"errorCode\": String\n}","name":"","status":"4XX","language":"json"}]},"settings":"576a36aadd4f320e0060b806","auth":"required","params":[{"_id":"57454fad77539d0e008d8fa9","ref":"","in":"path","required":true,"desc":"ID of the routing response.","default":"","type":"string","name":"responseId"},{"_id":"57a07568cf8f650e00cccdd7","ref":"","in":"header","required":true,"desc":"An API key.","default":"","type":"string","name":"x-api-key"}],"url":"/routing/response/:responseId"},"isReference":false,"order":4,"body":"","excerpt":"Retrieve the specific routing response by response id","slug":"routingresponseresponse_id","type":"endpoint","title":"/routing/response/{responseId}"}

get/routing/response/{responseId}

Retrieve the specific routing response by response id

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

responseId:
required
string
ID of the routing response.

Headers

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

Examples


Result Format


User Information

Try It Out

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