Create routing configuration
curl --request POST \
--url https://apiweb.mile.app/api/v3/configuration \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"hubId": "<string>",
"useAllVehicle": true,
"multitrip": true,
"autoSpeed": true,
"defaultVisitTime": 123,
"returnToHub": true,
"returnToBase": true,
"defaultSpeed": 123,
"autoMerge": true,
"avoidToll": true,
"returnAfterWorkingTime": true,
"subHubs": [
"<string>"
],
"vehicleSubHubDistanceLimit": 123,
"dynamicVisitTime": [
{
"constraintName": "<string>",
"visitTime": 123
}
],
"useOddEven": true,
"oddEvenTime": [
{
"startTime": "<string>",
"endTime": "<string>"
}
]
}
'import requests
url = "https://apiweb.mile.app/api/v3/configuration"
payload = {
"name": "<string>",
"hubId": "<string>",
"useAllVehicle": True,
"multitrip": True,
"autoSpeed": True,
"defaultVisitTime": 123,
"returnToHub": True,
"returnToBase": True,
"defaultSpeed": 123,
"autoMerge": True,
"avoidToll": True,
"returnAfterWorkingTime": True,
"subHubs": ["<string>"],
"vehicleSubHubDistanceLimit": 123,
"dynamicVisitTime": [
{
"constraintName": "<string>",
"visitTime": 123
}
],
"useOddEven": True,
"oddEvenTime": [
{
"startTime": "<string>",
"endTime": "<string>"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
hubId: '<string>',
useAllVehicle: true,
multitrip: true,
autoSpeed: true,
defaultVisitTime: 123,
returnToHub: true,
returnToBase: true,
defaultSpeed: 123,
autoMerge: true,
avoidToll: true,
returnAfterWorkingTime: true,
subHubs: ['<string>'],
vehicleSubHubDistanceLimit: 123,
dynamicVisitTime: [{constraintName: '<string>', visitTime: 123}],
useOddEven: true,
oddEvenTime: [{startTime: '<string>', endTime: '<string>'}]
})
};
fetch('https://apiweb.mile.app/api/v3/configuration', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://apiweb.mile.app/api/v3/configuration",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'hubId' => '<string>',
'useAllVehicle' => true,
'multitrip' => true,
'autoSpeed' => true,
'defaultVisitTime' => 123,
'returnToHub' => true,
'returnToBase' => true,
'defaultSpeed' => 123,
'autoMerge' => true,
'avoidToll' => true,
'returnAfterWorkingTime' => true,
'subHubs' => [
'<string>'
],
'vehicleSubHubDistanceLimit' => 123,
'dynamicVisitTime' => [
[
'constraintName' => '<string>',
'visitTime' => 123
]
],
'useOddEven' => true,
'oddEvenTime' => [
[
'startTime' => '<string>',
'endTime' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://apiweb.mile.app/api/v3/configuration"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"hubId\": \"<string>\",\n \"useAllVehicle\": true,\n \"multitrip\": true,\n \"autoSpeed\": true,\n \"defaultVisitTime\": 123,\n \"returnToHub\": true,\n \"returnToBase\": true,\n \"defaultSpeed\": 123,\n \"autoMerge\": true,\n \"avoidToll\": true,\n \"returnAfterWorkingTime\": true,\n \"subHubs\": [\n \"<string>\"\n ],\n \"vehicleSubHubDistanceLimit\": 123,\n \"dynamicVisitTime\": [\n {\n \"constraintName\": \"<string>\",\n \"visitTime\": 123\n }\n ],\n \"useOddEven\": true,\n \"oddEvenTime\": [\n {\n \"startTime\": \"<string>\",\n \"endTime\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://apiweb.mile.app/api/v3/configuration")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"hubId\": \"<string>\",\n \"useAllVehicle\": true,\n \"multitrip\": true,\n \"autoSpeed\": true,\n \"defaultVisitTime\": 123,\n \"returnToHub\": true,\n \"returnToBase\": true,\n \"defaultSpeed\": 123,\n \"autoMerge\": true,\n \"avoidToll\": true,\n \"returnAfterWorkingTime\": true,\n \"subHubs\": [\n \"<string>\"\n ],\n \"vehicleSubHubDistanceLimit\": 123,\n \"dynamicVisitTime\": [\n {\n \"constraintName\": \"<string>\",\n \"visitTime\": 123\n }\n ],\n \"useOddEven\": true,\n \"oddEvenTime\": [\n {\n \"startTime\": \"<string>\",\n \"endTime\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://apiweb.mile.app/api/v3/configuration")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"hubId\": \"<string>\",\n \"useAllVehicle\": true,\n \"multitrip\": true,\n \"autoSpeed\": true,\n \"defaultVisitTime\": 123,\n \"returnToHub\": true,\n \"returnToBase\": true,\n \"defaultSpeed\": 123,\n \"autoMerge\": true,\n \"avoidToll\": true,\n \"returnAfterWorkingTime\": true,\n \"subHubs\": [\n \"<string>\"\n ],\n \"vehicleSubHubDistanceLimit\": 123,\n \"dynamicVisitTime\": [\n {\n \"constraintName\": \"<string>\",\n \"visitTime\": 123\n }\n ],\n \"useOddEven\": true,\n \"oddEvenTime\": [\n {\n \"startTime\": \"<string>\",\n \"endTime\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"message": "Success",
"data": {
"_id": "6512a0b1c2d3e4f5a6b7c8d1",
"name": "Default",
"hubId": "64d9932e2beb9037735ff022",
"organizationId": "64d99303be0ad015c461c932",
"isDefault": true,
"returnToHub": true,
"useAllVehicle": false,
"multitrip": false,
"clustering": "normal",
"autoSpeed": false,
"defaultSpeed": 30,
"defaultVisitTime": 10,
"autoSplit": "none",
"autoMerge": false,
"avoidToll": false,
"crossDockingType": "none",
"subHubs": [],
"constraintId": [
"1694662020650253c84b5d2a9"
],
"dynamicVisitTime": [],
"isDeleted": false,
"createdTime": "2023-09-14T03:27:00.000000Z",
"updatedTime": "2023-09-14T03:27:00.000000Z"
}
}{
"status": false,
"message": "Bad request - invalid parameters provided."
}Configuration
Create routing configuration
Creates a routing configuration profile for a hub. The name must be unique within the hub. A new profile is never the default; use PATCH /configurations/hub/{hubId} to make it default.
When autoSpeed is false, defaultSpeed is required and must be at least 5 (km/h).
Requires the add/configuration permission.
POST
/
configuration
Create routing configuration
curl --request POST \
--url https://apiweb.mile.app/api/v3/configuration \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"hubId": "<string>",
"useAllVehicle": true,
"multitrip": true,
"autoSpeed": true,
"defaultVisitTime": 123,
"returnToHub": true,
"returnToBase": true,
"defaultSpeed": 123,
"autoMerge": true,
"avoidToll": true,
"returnAfterWorkingTime": true,
"subHubs": [
"<string>"
],
"vehicleSubHubDistanceLimit": 123,
"dynamicVisitTime": [
{
"constraintName": "<string>",
"visitTime": 123
}
],
"useOddEven": true,
"oddEvenTime": [
{
"startTime": "<string>",
"endTime": "<string>"
}
]
}
'import requests
url = "https://apiweb.mile.app/api/v3/configuration"
payload = {
"name": "<string>",
"hubId": "<string>",
"useAllVehicle": True,
"multitrip": True,
"autoSpeed": True,
"defaultVisitTime": 123,
"returnToHub": True,
"returnToBase": True,
"defaultSpeed": 123,
"autoMerge": True,
"avoidToll": True,
"returnAfterWorkingTime": True,
"subHubs": ["<string>"],
"vehicleSubHubDistanceLimit": 123,
"dynamicVisitTime": [
{
"constraintName": "<string>",
"visitTime": 123
}
],
"useOddEven": True,
"oddEvenTime": [
{
"startTime": "<string>",
"endTime": "<string>"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
hubId: '<string>',
useAllVehicle: true,
multitrip: true,
autoSpeed: true,
defaultVisitTime: 123,
returnToHub: true,
returnToBase: true,
defaultSpeed: 123,
autoMerge: true,
avoidToll: true,
returnAfterWorkingTime: true,
subHubs: ['<string>'],
vehicleSubHubDistanceLimit: 123,
dynamicVisitTime: [{constraintName: '<string>', visitTime: 123}],
useOddEven: true,
oddEvenTime: [{startTime: '<string>', endTime: '<string>'}]
})
};
fetch('https://apiweb.mile.app/api/v3/configuration', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://apiweb.mile.app/api/v3/configuration",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'hubId' => '<string>',
'useAllVehicle' => true,
'multitrip' => true,
'autoSpeed' => true,
'defaultVisitTime' => 123,
'returnToHub' => true,
'returnToBase' => true,
'defaultSpeed' => 123,
'autoMerge' => true,
'avoidToll' => true,
'returnAfterWorkingTime' => true,
'subHubs' => [
'<string>'
],
'vehicleSubHubDistanceLimit' => 123,
'dynamicVisitTime' => [
[
'constraintName' => '<string>',
'visitTime' => 123
]
],
'useOddEven' => true,
'oddEvenTime' => [
[
'startTime' => '<string>',
'endTime' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://apiweb.mile.app/api/v3/configuration"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"hubId\": \"<string>\",\n \"useAllVehicle\": true,\n \"multitrip\": true,\n \"autoSpeed\": true,\n \"defaultVisitTime\": 123,\n \"returnToHub\": true,\n \"returnToBase\": true,\n \"defaultSpeed\": 123,\n \"autoMerge\": true,\n \"avoidToll\": true,\n \"returnAfterWorkingTime\": true,\n \"subHubs\": [\n \"<string>\"\n ],\n \"vehicleSubHubDistanceLimit\": 123,\n \"dynamicVisitTime\": [\n {\n \"constraintName\": \"<string>\",\n \"visitTime\": 123\n }\n ],\n \"useOddEven\": true,\n \"oddEvenTime\": [\n {\n \"startTime\": \"<string>\",\n \"endTime\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://apiweb.mile.app/api/v3/configuration")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"hubId\": \"<string>\",\n \"useAllVehicle\": true,\n \"multitrip\": true,\n \"autoSpeed\": true,\n \"defaultVisitTime\": 123,\n \"returnToHub\": true,\n \"returnToBase\": true,\n \"defaultSpeed\": 123,\n \"autoMerge\": true,\n \"avoidToll\": true,\n \"returnAfterWorkingTime\": true,\n \"subHubs\": [\n \"<string>\"\n ],\n \"vehicleSubHubDistanceLimit\": 123,\n \"dynamicVisitTime\": [\n {\n \"constraintName\": \"<string>\",\n \"visitTime\": 123\n }\n ],\n \"useOddEven\": true,\n \"oddEvenTime\": [\n {\n \"startTime\": \"<string>\",\n \"endTime\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://apiweb.mile.app/api/v3/configuration")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"hubId\": \"<string>\",\n \"useAllVehicle\": true,\n \"multitrip\": true,\n \"autoSpeed\": true,\n \"defaultVisitTime\": 123,\n \"returnToHub\": true,\n \"returnToBase\": true,\n \"defaultSpeed\": 123,\n \"autoMerge\": true,\n \"avoidToll\": true,\n \"returnAfterWorkingTime\": true,\n \"subHubs\": [\n \"<string>\"\n ],\n \"vehicleSubHubDistanceLimit\": 123,\n \"dynamicVisitTime\": [\n {\n \"constraintName\": \"<string>\",\n \"visitTime\": 123\n }\n ],\n \"useOddEven\": true,\n \"oddEvenTime\": [\n {\n \"startTime\": \"<string>\",\n \"endTime\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"message": "Success",
"data": {
"_id": "6512a0b1c2d3e4f5a6b7c8d1",
"name": "Default",
"hubId": "64d9932e2beb9037735ff022",
"organizationId": "64d99303be0ad015c461c932",
"isDefault": true,
"returnToHub": true,
"useAllVehicle": false,
"multitrip": false,
"clustering": "normal",
"autoSpeed": false,
"defaultSpeed": 30,
"defaultVisitTime": 10,
"autoSplit": "none",
"autoMerge": false,
"avoidToll": false,
"crossDockingType": "none",
"subHubs": [],
"constraintId": [
"1694662020650253c84b5d2a9"
],
"dynamicVisitTime": [],
"isDeleted": false,
"createdTime": "2023-09-14T03:27:00.000000Z",
"updatedTime": "2023-09-14T03:27:00.000000Z"
}
}{
"status": false,
"message": "Bad request - invalid parameters provided."
}Authorizations
Use a valid Bearer token to authenticate.
Body
application/json
Profile name, unique within the hub.
Example: Default
Hub the profile belongs to.
Example: 64d9932e2beb9037735ff022
Use every vehicle, even when fewer would do.
Allow a vehicle to make more than one trip in its working time.
How visits are grouped per vehicle.
Example: normal
Available options:
non-overlap, balanced, normal, none Use road-network speeds. When false, defaultSpeed is required.
Minutes spent at a visit that has no visit time.
Example: 10
Vehicles end their route back at the hub. Required unless returnToBase is sent.
Vehicles end their route back at their own start location.
Average speed in km/h when autoSpeed is false. At least 5.
Example: 30
Split a visit across vehicles when it is larger than one vehicle's capacity.
Available options:
none, equal, maximize Merge visits at the same location.
Avoid toll roads.
Allow returning to the hub after the working time ends.
Cross-docking through sub hubs.
Default: none
Available options:
none, all, drop Sub hub ids for cross-docking. Must be in the same country as the main hub.
Maximum distance in meters between a vehicle and a sub hub. At least 1000.
Extra visit time per unit of a capacity type.
Show child attributes
Show child attributes
Respect odd-even plate restrictions.
Up to 2 restricted periods, HH:mm.
Show child attributes
Show child attributes