{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/routing/response/:responseId/status","auth":"required","params":[{"name":"responseId","type":"string","default":"","desc":"ID of the routing response.","required":true,"in":"path","ref":"","_id":"5745513da488e8170054159d"},{"name":"x-api-key","type":"string","default":"","desc":"An API key.","required":true,"in":"header","ref":"","_id":"57a07557cf8f650e00cccdd6"}],"results":{"codes":[{"language":"json","status":"2XX","name":"","code":"{\n\t\"status\": String\n}"},{"status":"4XX","name":"","code":"{\n  \"error\": String,\n\t\"errorCode\": String\n}","language":"json"}]},"settings":"576a36aadd4f320e0060b806","examples":{"codes":[{"code":"{\n\t\"status\": \"InProgress\"\n}","language":"json","name":"response - success"},{"code":"{\n  \"error\": \"Response with ID: [1c2e52d6-9108-48df-8c1e-305633f02810] is not valid\",\n\t\"errorCode\": \"2003\"\n}","language":"json","name":"response - error"}]},"method":"get"},"next":{"description":"","pages":[]},"title":"/routing/response/{responseId}/status","type":"endpoint","slug":"routingresponseresponse_idstatus","excerpt":"Check the current status of the computation","body":"There are 4 enum types representing the current status of the routing response computation.\n1. Submitted\n2. InProgress\n3. Done\n4. Cancelled","updates":[],"order":5,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5745513da488e8170054159c","githubsync":"","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"},"user":"57061c3e21cfed0e00e8c640","__v":1,"editedParams":true,"parentDoc":null,"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-05-25T07:16:13.238Z","project":"5706099c21cfed0e00e8c60b","editedParams2":true}

get/routing/response/{responseId}/status

Check the current status of the computation

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


Documentation

There are 4 enum types representing the current status of the routing response computation. 1. Submitted 2. InProgress 3. Done 4. Cancelled

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