Build Zones

• POST https://routecloud.telogis.com/v1/zones.
• Authentication required.
• Request body: zone_request.
• Response body: If wait=1 specified, returns the task result (see below). Otherwise, returns a task_redirect_response.
• Task result: Returns zone[].

The build zones call generates new zones using a collection of markers and jobs. The build request produces the specified number zones where each zone has a balanced number of either Markers, Stops, Time on Site or a Capacity Metric.

Query Parameters

• wait=1 - Optional. Wait until the zones completes before returning the result. See Retrieving API Results.

Status Codes

• 200 - Success.
• 302 - If wait=1 was provided and the zones result is not yet available, a redirect is sent instead of a normal result every 15 seconds to refresh the HTTP timeout. See Retrieving API Results.
• 400 - The input zone_request is invalid. The response is an error_response.
• 401 - Authentication required.
• 429 - Exceeded usage limits.

zone_request

Name	Type	Description
zone_count	integer	The number of zones to create.
variance	variance	The expected variance of a given metric when creating zones.
jobs	job[]	Inherited. The jobs to distribute between the generated zones.
markers	marker[]	Inherited. The markers involved in this build. If defined here, markers can be referenced by id elsewhere; for example, job.location.

{
  "zone_count": 2,
  "variance": {
  	"stop_count_variance": 1
  },
  "markers": [
  ],
  "jobs": [
    { "id": "job0", "time_on_site": "00:10", "location": "-43.549062, 172.642059" },
    { "id": "job1", "time_on_site": "00:10", "location": "-43.544839, 172.628252" },
    { "id": "job2", "time_on_site": "00:15", "location": "-43.551746, 172.610160" },
    { "id": "job3", "time_on_site": "00:18", "location": "-43.522026, 172.630837" },
    { "id": "job4", "time_on_site": "00:15", "location": "-43.511665, 172.598252" }
  ],
}