Skip to main content

GET /logistics/vrp/1.1.0/status

OpenAPI Specification

2GIS Navigation API (6.0.0)

Algorithms

Task status and solution

Get the status of the task and the solution if it is available

query Parameters
task_id
required
string

Task ID

key
required
string

Developer API key

Responses

Response Schema: application/json
task_id
required
string
status
required
string (PublicTaskStatus)
Enum: "Run" "Partial" "Fail" "Done" "Not Found"

Task status:

  • Run - the task is processing,
  • Partial - the route was built, but some points were excluded,
  • Fail - an error occurred while building the route,
  • Done - the route was successfully built,
  • Not Found - the task was not found,

PublicResultUrls (object) or null
integer or null

Queue time for reachability matrix calculation (in seconds)

integer or null

Reachability matrix calculation duration (in seconds)

integer or null

Traveling salesman task calculation duration (in seconds)

integer or null

Queue time for traveling salesman task calculation (in seconds)

Response samples

Content type
application/json
{
  • "task_id": "string",
  • "status": "Run",
  • "urls": {
    • "url_vrp_solution": "string",
    • "url_excluded": "string"
    },
  • "dm_queue": 0,
  • "dm": 0,
  • "vrp": 0,
  • "vrp_queue": 0
}