Planning Profiles
GET all available Planning Profiles¶
curl https://{root_url}/bucket-planning/v2/planning-profiles/ \
-H 'apikey: {YOUR_API_KEY}'
{
"count": 3,
"next": null,
"previous": null,
"results": [
{
"name": "bike-amsterdam",
"description": "Bike network profile for Amsterdam depot area",
"config": {
"matrix_params": {
"dist_cost": 0.001,
"time_cost": 0.010277777777777778,
"stem_in_correction": 1.75,
"client_settings": {
"HOST": "tm.plotwise.com",
"PORT": 4242,
"TIMEOUT": 10000,
"EXTENDED_TIMEOUT": 60000,
"SEARCH_RANGE": 1000
}
},
"optimization_settings": "coolblue-all-2022-november"
}
},
{
"name": "bike-brussels",
"description": "Bike network profile for Brussels depot area",
"config": {
"matrix_params": {
"dist_cost": 0.001,
"time_cost": 0.010277777777777778,
"stem_in_correction": 1.0,
"client_settings": {
"HOST": "tm.plotwise.com",
"PORT": 4242,
"TIMEOUT": 10000,
"EXTENDED_TIMEOUT": 60000,
"SEARCH_RANGE": 1000
}
},
"optimization_settings": "coolblue-all-2022-november"
}
}
},
{
"name": "truck-netherlands",
"description": "Truck network profile for the whole Netherlands area",
"config": {
"matrix_params": {
"dist_cost": 0.001,
"time_cost": 0.010277777777777778,
"stem_in_correction": 1.0,
"client_settings": {
"HOST": "tm.plotwise.com",
"PORT": 4242,
"TIMEOUT": 10000,
"EXTENDED_TIMEOUT": 60000,
"SEARCH_RANGE": 1000
}
},
"optimization_settings": "coolblue-all-2022-november"
}
}
}
]
}
POST Planning Profiles¶
curl -X POST https://{root_url}/bucket-planning/v2/planning-profiles/ \
-H 'Content-Type: application/json' \
-H 'apikey: {YOUR_API_KEY}' \
-d '{
"name": "bike-amsterdam",
"description": "Bike network profile for Amsterdam depot area",
"config": {
"matrix_params": {
"dist_cost": 0.001,
"time_cost": 0.010277777777777778,
"stem_in_correction": 1.0,
"client_settings": {
"HOST": "tm.plotwise.com",
"PORT": 4242,
"TIMEOUT": 10000,
"EXTENDED_TIMEOUT": 60000,
"SEARCH_RANGE": 1000
}
},
"optimization_settings": "coolblue-all-2022-november"
}
}'
{
"name": "bike-amsterdam",
"description": "Bike network profile for Amsterdam depot area",
"config": {
"matrix_params": {
"dist_cost": 0.001,
"time_cost": 0.010277777777777778,
"stem_in_correction": 1.0,
"client_settings": {
"HOST": "tm.plotwise.com",
"PORT": 4242,
"TIMEOUT": 10000,
"EXTENDED_TIMEOUT": 60000,
"SEARCH_RANGE": 1000
}
},
"optimization_settings": "coolblue-all-2022-november"
}
}
UPDATE Planning Profiles¶
WARNING
Each field should have a value (udpated or existing one) or otherwise will be reset to null implicitly.
curl -X PUT https://{root_url}/bucket-planning/v2/planning-profiles/bike-amsterdam/ \
-H 'Content-Type: application/json' \
-H 'apikey: {YOUR_API_KEY}' \
-d '{
"name": "bike-amsterdam",
"description": "Bike network profile for Amsterdam depot area",
"config": {
"matrix_params": {
"dist_cost": 0.0015,
"time_cost": 0.010277777777777778,
"stem_in_correction": 1.5,
"client_settings": {
"HOST": "tm.plotwise.com",
"PORT": 4242,
"TIMEOUT": 10000,
"EXTENDED_TIMEOUT": 60000,
"SEARCH_RANGE": 1000
}
},
"optimization_settings": "coolblue-all-2022-november"
}
}'
{
"name": "bike-amsterdam",
"description": "Bike network profile for Amsterdam depot area",
"config": {
"matrix_params": {
"dist_cost": 0.0015,
"time_cost": 0.010277777777777778,
"stem_in_correction": 1.5,
"client_settings": {
"HOST": "tm.plotwise.com",
"PORT": 4242,
"TIMEOUT": 10000,
"EXTENDED_TIMEOUT": 60000,
"SEARCH_RANGE": 1000
}
},
"optimization_settings": "coolblue-all-2022-november"
}
}