{"_id":"57453e85e33ef10e00e1a9e9","__v":2,"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"},"parentDoc":null,"project":"5706099c21cfed0e00e8c60b","editedParams2":true,"user":"57061c3e21cfed0e00e8c640","githubsync":"","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"},"editedParams":true,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-05-25T05:56:21.361Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"name":"response - success","code":"{\n  \"id\": \"86d9cf4f-dfb8-45ac-b481-1a3516c38d58\",\n  \"problem\": {\n    \"drivers\": [\n      {\n        \"id\": \"D1\",\n        \"maxCapacity\": {\n          \"data\": {\n            \"Volume\": 1000000.0\n          }\n        },\n        \"startTime\": {\n          \"epoch\": 1455356400\n        },\n        \"endTime\": {\n          \"epoch\": 1455375540\n        },\n        \"skillLevel\": 0,\n        \"vehicleFeatures\": [],\n        \"maxWaitTime\": {\n          \"seconds\": 0\n        }\n      }\n    ],\n    \"jobs\": [\n      {\n        \"id\": \"j1\",\n        \"tasks\": [\n          {\n            \"id\": \"t1\",\n            \"jobId\": \"j1\",\n            \"taskType\": \"DepotDelivery\",\n            \"location\": {\n              \"labels\": [\n                \"15823\"\n              ],\n              \"x\": 126.9,\n              \"y\": 37.3\n            },\n            \"capacity\": {\n              \"data\": {\n                \"Volume\": 62400.0\n              }\n            },\n            \"taskDuration\": {\n              \"seconds\": 300\n            },\n            \"timeWindow\": {\n              \"start\": {\n                \"epoch\": 1455357600\n              },\n              \"end\": {\n                \"epoch\": 1455368400\n              }\n            },\n            \"difficulty\": 0\n          }\n        ],\n        \"partialOrder\": []\n      }\n    ],\n    \"hardConstraints\": [\n      {\n        \"type\": \"TimeWindowConstraint\",\n        \"weight\": 1.0\n      }\n    ],\n    \"softConstraints\": [\n      {\n        \"type\": \"CapacityConstraint\",\n        \"weight\": 100.0\n      }\n    ],\n    \"config\": {\n      \"gis\": {\n        \"type\": \"SimpleGIS\",\n        \"drivingFactor\": 1.26,\n        \"averageSpeed\": 40.0\n      },\n      \"depot\": {\n        \"id\": \"depot1\",\n        \"location\": {\n          \"labels\": [],\n          \"x\": 127.1,\n          \"y\": 37.3\n        }\n      },\n      \"returnToDepot\": true\n    }\n  },\n  \"config\": {\n    \"processors\": []\n  },\n  \"createdAt\": \"20160525 15:00:00\"\n}\n\n","language":"json"},{"name":"response - error","language":"json","code":"{\n  \"error\": \"Request with ID: [86d9cf4f-dfb8-45ac-b481-1a3516c38d58] is not valid\", \n  \"errorCode\": \"2004\"\n}"}]},"method":"get","results":{"codes":[{"name":"","status":"2XX","language":"json","code":"{\n  \"id\": String,\n  \"problem\": Object[RoutingProblem],\n  \"config\": Object[RoutingConfig],\n  \"createdAt\": String\n}"},{"status":"4XX","language":"json","code":"{\n  \"error\": String,\n  \"errorCode\": String\n}","name":""}]},"settings":"576a36aadd4f320e0060b806","auth":"required","params":[{"_id":"57453fd977539d0e008d8f88","ref":"","in":"path","required":true,"desc":"ID of the routing response.","default":"Request","type":"string","name":"requestId"},{"_id":"57a0758f0c933e0e00249bc6","ref":"","in":"header","required":true,"desc":"An API key.","default":"","type":"string","name":"x-api-key"}],"url":"/routing/request/:requestId"},"isReference":false,"order":1,"body":"","excerpt":"Retrieve the specific routing request by request id","slug":"get-the-routing-request","type":"endpoint","title":"/routing/request/{requestId}"}

get/routing/request/{requestId}

Retrieve the specific routing request by request id

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

requestId:
required
stringRequest
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 }}