{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://www.apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/places:tomtom-routing/get-routing-version-number-calculate-reachable-range-origin":{"get":{"operationId":"places_tomtom_routing_get_routing_version_number_calculate_reachable_range_origin","summary":"Reachable Range","description":"GET /routing/{versionNumber}/calculateReachableRange/{origin}/{contentType}","tags":["places"],"parameters":[{"name":"versionNumber","in":"query","required":true,"description":"Service version number. The current value is 1.","schema":{"type":"integer","enum":[1],"description":"Service version number. The current value is 1."}},{"name":"origin","in":"query","required":true,"description":"Point from which the range calculation should start.","schema":{"type":"string","description":"Point from which the range calculation should start."},"example":"52.50931,13.42936"},{"name":"contentType","in":"query","required":true,"description":"The content type of the response structure. If the content type is jsonp, a callback method can be specified in the query parameters.","schema":{"type":"string","enum":["xml","json","jsonp"],"default":"xml","description":"The content type of the response structure. If the content type is jsonp, a callback method can be specified in the query parameters."}},{"name":"fuelBudgetInLiters","in":"query","required":false,"description":"Fuel budget in liters. Determines the maximum vehicle range using the specified Combustion Consumption Model.","schema":{"type":"number","description":"Fuel budget in liters. Determines the maximum vehicle range using the specified Combustion Consumption Model."}},{"name":"energyBudgetInkWh","in":"query","required":false,"description":"Electric energy budget in kilowatt hours (kWh). Determines the maximum vehicle range using the specified Electric Consumption Model.","schema":{"type":"number","description":"Electric energy budget in kilowatt hours (kWh). Determines the maximum vehicle range using the specified Electric Consumption Model."},"example":43},{"name":"timeBudgetInSec","in":"query","required":false,"description":"Time budget in seconds. Determines the maximum vehicle range using the specified driving time. The consumption parameters in the request…","schema":{"type":"number","description":"Time budget in seconds. Determines the maximum vehicle range using the specified driving time. The consumption parameters in the request…"}},{"name":"callback","in":"query","required":false,"description":"Specifies the jsonp callback method.","schema":{"type":"string","default":"callback","description":"Specifies the jsonp callback method."}},{"name":"report","in":"query","required":false,"description":"Specifies which data should be reported for diagnosis purposes.","schema":{"type":"string","enum":["effectiveSettings"],"description":"Specifies which data should be reported for diagnosis purposes."}},{"name":"departAt","in":"query","required":false,"description":"The date and time of departure from the origin point. Departure times apart from now must be specified as a dateTime.","schema":{"type":"string","default":"now","description":"The date and time of departure from the origin point. Departure times apart from now must be specified as a dateTime."}},{"name":"arriveAt","in":"query","required":false,"description":"The date and time of arrival at the destination point. It must be specified as a dateTime.","schema":{"type":"string","description":"The date and time of arrival at the destination point. It must be specified as a dateTime."}},{"name":"routeType","in":"query","required":false,"description":"The type of route requested.","schema":{"type":"string","enum":["fastest","shortest","eco","thrilling"],"default":"fastest","description":"The type of route requested."}},{"name":"traffic","in":"query","required":false,"description":"Determines whether current traffic is used in route calculations. Note that information on historic road speeds is always used.","schema":{"type":"boolean","default":true,"description":"Determines whether current traffic is used in route calculations. Note that information on historic road speeds is always used."}},{"name":"avoid","in":"query","required":false,"description":"Specifies whether the routing engine should try to avoid specific types of road segment when calculating the route. Can be specified…","schema":{"type":"string","description":"Specifies whether the routing engine should try to avoid specific types of road segment when calculating the route. Can be specified…"},"example":"unpavedRoads"},{"name":"travelMode","in":"query","required":false,"description":"The mode of travel for the requested route.","schema":{"type":"string","enum":["car","truck","taxi","bus","van","motorcycle","bicycle","pedestrian"],"default":"car","description":"The mode of travel for the requested route."}},{"name":"hilliness","in":"query","required":false,"description":"Degree of hilliness for calculating a thrilling route.","schema":{"type":"string","enum":["low","normal","high"],"default":"normal","description":"Degree of hilliness for calculating a thrilling route."}},{"name":"windingness","in":"query","required":false,"description":"Amount that a thrilling route should wind.","schema":{"type":"string","enum":["low","normal","high"],"default":"normal","description":"Amount that a thrilling route should wind."}},{"name":"vehicleMaxSpeed","in":"query","required":false,"description":"Maximum speed of the vehicle in km/hour.","schema":{"type":"integer","default":0,"description":"Maximum speed of the vehicle in km/hour."}},{"name":"vehicleWeight","in":"query","required":false,"description":"Weight of the vehicle in kilograms.","schema":{"type":"integer","default":0,"description":"Weight of the vehicle in kilograms."}},{"name":"vehicleAxleWeight","in":"query","required":false,"description":"Weight per axle of the vehicle in kg.","schema":{"type":"integer","default":0,"description":"Weight per axle of the vehicle in kg."}},{"name":"vehicleLength","in":"query","required":false,"description":"Length of the vehicle in meters.","schema":{"type":"number","default":0,"description":"Length of the vehicle in meters."}},{"name":"vehicleWidth","in":"query","required":false,"description":"Width of the vehicle in meters.","schema":{"type":"number","default":0,"description":"Width of the vehicle in meters."}},{"name":"vehicleHeight","in":"query","required":false,"description":"Height of the vehicle in meters.","schema":{"type":"number","default":0,"description":"Height of the vehicle in meters."}},{"name":"vehicleCommercial","in":"query","required":false,"description":"Indicates that the vehicle is used for commercial purposes. This means it may not be allowed on certain roads.","schema":{"type":"boolean","default":false,"description":"Indicates that the vehicle is used for commercial purposes. This means it may not be allowed on certain roads."}},{"name":"vehicleLoadType","in":"query","required":false,"description":"Indicates what kinds of hazardous materials the vehicle is carrying (if any). This means it may not be allowed on certain roads. Use these…","schema":{"type":"string","description":"Indicates what kinds of hazardous materials the vehicle is carrying (if any). This means it may not be allowed on certain roads. Use these…"}},{"name":"constantSpeedConsumptionInLitersPerHundredkm","in":"query","required":false,"description":"Specifies the speed-dependent component of consumption. Provided as an unordered list of speed/consumption-rate pairs.","schema":{"type":"string","description":"Specifies the speed-dependent component of consumption. Provided as an unordered list of speed/consumption-rate pairs."}},{"name":"currentFuelInLiters","in":"query","required":false,"description":"Specifies the current supply of fuel in liters.","schema":{"type":"number","description":"Specifies the current supply of fuel in liters."}},{"name":"auxiliaryPowerInLitersPerHour","in":"query","required":false,"description":"Specifies the amount of fuel consumed for sustaining auxiliary systems of the vehicle, in liters per hour.","schema":{"type":"number","description":"Specifies the amount of fuel consumed for sustaining auxiliary systems of the vehicle, in liters per hour."}},{"name":"fuelEnergyDensityInMJoulesPerLiter","in":"query","required":false,"description":"Specifies the amount of chemical energy stored in one liter of fuel in megajoules (MJ).","schema":{"type":"number","description":"Specifies the amount of chemical energy stored in one liter of fuel in megajoules (MJ)."}},{"name":"accelerationEfficiency","in":"query","required":false,"description":"Specifies the efficiency of converting chemical energy stored in fuel to kinetic energy when the vehicle accelerates (i.e.…","schema":{"type":"number","description":"Specifies the efficiency of converting chemical energy stored in fuel to kinetic energy when the vehicle accelerates (i.e.…"}},{"name":"decelerationEfficiency","in":"query","required":false,"description":"Specifies the efficiency of converting kinetic energy to saved (not consumed) fuel when the vehicle decelerates (i.e.…","schema":{"type":"number","description":"Specifies the efficiency of converting kinetic energy to saved (not consumed) fuel when the vehicle decelerates (i.e.…"}},{"name":"uphillEfficiency","in":"query","required":false,"description":"Specifies the efficiency of converting chemical energy stored in fuel to potential energy when the vehicle gains elevation (i.e.…","schema":{"type":"number","description":"Specifies the efficiency of converting chemical energy stored in fuel to potential energy when the vehicle gains elevation (i.e.…"}},{"name":"downhillEfficiency","in":"query","required":false,"description":"Specifies the efficiency of converting potential energy to saved (not consumed) fuel when the vehicle loses elevation (i.e.…","schema":{"type":"number","description":"Specifies the efficiency of converting potential energy to saved (not consumed) fuel when the vehicle loses elevation (i.e.…"}},{"name":"vehicleEngineType","in":"query","required":false,"description":"Engine type of the vehicle.","schema":{"type":"string","enum":["combustion","electric"],"default":"combustion","description":"Engine type of the vehicle."},"example":"electric"},{"name":"constantSpeedConsumptionInkWhPerHundredkm","in":"query","required":false,"description":"Specifies the speed-dependent component of consumption. Provided as an unordered list of speed/consumption-rate pairs.","schema":{"type":"string","description":"Specifies the speed-dependent component of consumption. Provided as an unordered list of speed/consumption-rate pairs."},"example":"50,8.2:130,21.3"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/places:tomtom-routing/post-routing-version-number-calculate-reachable-range-origin":{"post":{"operationId":"places_tomtom_routing_post_routing_version_number_calculate_reachable_range_origin","summary":"Reachable Range","description":"POST /routing/{versionNumber}/calculateReachableRange/{origin}/{contentType}","tags":["places"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["versionNumber","origin","contentType"],"properties":{"versionNumber":{"type":"integer","enum":[1],"description":"Service version number. The current value is 1."},"origin":{"type":"string","description":"Point from which the range calculation should start."},"contentType":{"type":"string","enum":["xml","json","jsonp"],"default":"xml","description":"The content type of the response structure. If the content type is jsonp, a callback method can be specified in the query parameters."},"fuelBudgetInLiters":{"type":"number","description":"Fuel budget in liters. Determines the maximum vehicle range using the specified Combustion Consumption Model."},"energyBudgetInkWh":{"type":"number","description":"Electric energy budget in kilowatt hours (kWh). Determines the maximum vehicle range using the specified Electric Consumption Model."},"timeBudgetInSec":{"type":"number","description":"Time budget in seconds. Determines the maximum vehicle range using the specified driving time. The consumption parameters in the request…"},"callback":{"type":"string","default":"callback","description":"Specifies the jsonp callback method."},"report":{"type":"string","enum":["effectiveSettings"],"description":"Specifies which data should be reported for diagnosis purposes."},"departAt":{"type":"string","default":"now","description":"The date and time of departure from the origin point. Departure times apart from now must be specified as a dateTime."},"arriveAt":{"type":"string","description":"The date and time of arrival at the destination point. It must be specified as a dateTime."},"routeType":{"type":"string","enum":["fastest","shortest","eco","thrilling"],"default":"fastest","description":"The type of route requested."},"traffic":{"type":"boolean","default":true,"description":"Determines whether current traffic is used in route calculations. Note that information on historic road speeds is always used."},"avoid":{"type":"string","description":"Specifies whether the routing engine should try to avoid specific types of road segment when calculating the route. Can be specified…"},"travelMode":{"type":"string","enum":["car","truck","taxi","bus","van","motorcycle","bicycle","pedestrian"],"default":"car","description":"The mode of travel for the requested route."},"hilliness":{"type":"string","enum":["low","normal","high"],"default":"normal","description":"Degree of hilliness for calculating a thrilling route."},"windingness":{"type":"string","enum":["low","normal","high"],"default":"normal","description":"Amount that a thrilling route should wind."},"vehicleMaxSpeed":{"type":"integer","default":0,"description":"Maximum speed of the vehicle in km/hour."},"vehicleWeight":{"type":"integer","default":0,"description":"Weight of the vehicle in kilograms."},"vehicleAxleWeight":{"type":"integer","default":0,"description":"Weight per axle of the vehicle in kg."},"vehicleLength":{"type":"number","default":0,"description":"Length of the vehicle in meters."},"vehicleWidth":{"type":"number","default":0,"description":"Width of the vehicle in meters."},"vehicleHeight":{"type":"number","default":0,"description":"Height of the vehicle in meters."},"vehicleCommercial":{"type":"boolean","default":false,"description":"Indicates that the vehicle is used for commercial purposes. This means it may not be allowed on certain roads."},"vehicleLoadType":{"type":"string","description":"Indicates what kinds of hazardous materials the vehicle is carrying (if any). This means it may not be allowed on certain roads. Use these…"},"constantSpeedConsumptionInLitersPerHundredkm":{"type":"string","description":"Specifies the speed-dependent component of consumption. Provided as an unordered list of speed/consumption-rate pairs."},"currentFuelInLiters":{"type":"number","description":"Specifies the current supply of fuel in liters."},"auxiliaryPowerInLitersPerHour":{"type":"number","description":"Specifies the amount of fuel consumed for sustaining auxiliary systems of the vehicle, in liters per hour."},"fuelEnergyDensityInMJoulesPerLiter":{"type":"number","description":"Specifies the amount of chemical energy stored in one liter of fuel in megajoules (MJ)."},"accelerationEfficiency":{"type":"number","description":"Specifies the efficiency of converting chemical energy stored in fuel to kinetic energy when the vehicle accelerates (i.e.…"},"decelerationEfficiency":{"type":"number","description":"Specifies the efficiency of converting kinetic energy to saved (not consumed) fuel when the vehicle decelerates (i.e.…"},"uphillEfficiency":{"type":"number","description":"Specifies the efficiency of converting chemical energy stored in fuel to potential energy when the vehicle gains elevation (i.e.…"},"downhillEfficiency":{"type":"number","description":"Specifies the efficiency of converting potential energy to saved (not consumed) fuel when the vehicle loses elevation (i.e.…"},"vehicleEngineType":{"type":"string","enum":["combustion","electric"],"default":"combustion","description":"Engine type of the vehicle."},"constantSpeedConsumptionInkWhPerHundredkm":{"type":"string","description":"Specifies the speed-dependent component of consumption. Provided as an unordered list of speed/consumption-rate pairs."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/places:tomtom-routing/get-routing-version-number-calculate-route-locations-content":{"get":{"operationId":"places_tomtom_routing_get_routing_version_number_calculate_route_locations_content","summary":"Calculate Route","description":"GET /routing/{versionNumber}/calculateRoute/{locations}/{contentType}","tags":["places"],"parameters":[{"name":"versionNumber","in":"query","required":true,"description":"Service version number. The current value is 1.","schema":{"type":"integer","enum":[1],"description":"Service version number. The current value is 1."}},{"name":"locations","in":"query","required":true,"description":"Locations through which the calculated route must pass.","schema":{"type":"string","description":"Locations through which the calculated route must pass."},"example":"52.50931,13.42936:52.50274,13.43872"},{"name":"contentType","in":"query","required":true,"description":"The content type of the response structure. If the content type is jsonp, a callback method can be specified in the query parameters.","schema":{"type":"string","enum":["xml","json","jsonp"],"default":"xml","description":"The content type of the response structure. If the content type is jsonp, a callback method can be specified in the query parameters."}},{"name":"maxAlternatives","in":"query","required":false,"description":"Number of alternative routes to be calculated.","schema":{"type":"integer","default":0,"description":"Number of alternative routes to be calculated."}},{"name":"alternativeType","in":"query","required":false,"description":"Determines whether the alternative routes to be calculated should be better with respect to the planning criteria provided than the…","schema":{"type":"string","enum":["anyRoute","betterRoute"],"default":"anyRoute","description":"Determines whether the alternative routes to be calculated should be better with respect to the planning criteria provided than the…"}},{"name":"minDeviationDistance","in":"query","required":false,"description":"All alternative routes will follow the reference route for the specified minimum number of meters starting from the origin point.","schema":{"type":"integer","default":0,"description":"All alternative routes will follow the reference route for the specified minimum number of meters starting from the origin point."}},{"name":"minDeviationTime","in":"query","required":false,"description":"All alternative routes will follow the reference route for the specified minimum number of seconds starting from the origin point.","schema":{"type":"integer","default":0,"description":"All alternative routes will follow the reference route for the specified minimum number of seconds starting from the origin point."}},{"name":"instructionsType","in":"query","required":false,"description":"If specified, guidance instructions will be returned (if available).","schema":{"type":"string","enum":["coded","text","tagged"],"description":"If specified, guidance instructions will be returned (if available)."}},{"name":"language","in":"query","required":false,"description":"The language parameter determines the language of the guidance messages.","schema":{"type":"string","default":"en-GB","description":"The language parameter determines the language of the guidance messages."}},{"name":"computeBestOrder","in":"query","required":false,"description":"Re-order the route waypoints to reduce the route length.","schema":{"type":"boolean","default":false,"description":"Re-order the route waypoints to reduce the route length."}},{"name":"routeRepresentation","in":"query","required":false,"description":"Specifies the representation of the set of routes provided as a response.","schema":{"type":"string","enum":["polyline","none"],"default":"polyline","description":"Specifies the representation of the set of routes provided as a response."}},{"name":"computeTravelTimeFor","in":"query","required":false,"description":"Specifies whether to return additional travel times using different types of traffic information (none, historic, live) as well as the…","schema":{"type":"string","enum":["none","all"],"default":"none","description":"Specifies whether to return additional travel times using different types of traffic information (none, historic, live) as well as the…"}},{"name":"vehicleHeading","in":"query","required":false,"description":"The directional heading of the vehicle in degrees. Entered in degrees, measured clockwise from north (so north is 0, east is 90, etc.).","schema":{"type":"integer","description":"The directional heading of the vehicle in degrees. Entered in degrees, measured clockwise from north (so north is 0, east is 90, etc.)."}},{"name":"sectionType","in":"query","required":false,"description":"Specifies which section types are explicitly reported in the route response. Can be specified multiple times. - carTrain, ferry, tunnel or…","schema":{"type":"string","default":"travelMode","description":"Specifies which section types are explicitly reported in the route response. Can be specified multiple times. - carTrain, ferry, tunnel or…"}},{"name":"callback","in":"query","required":false,"description":"Specifies the jsonp callback method.","schema":{"type":"string","default":"callback","description":"Specifies the jsonp callback method."}},{"name":"report","in":"query","required":false,"description":"Specifies which data should be reported for diagnosis purposes.","schema":{"type":"string","enum":["effectiveSettings"],"description":"Specifies which data should be reported for diagnosis purposes."}},{"name":"departAt","in":"query","required":false,"description":"The date and time of departure from the origin point. Departure times apart from now must be specified as a dateTime.","schema":{"type":"string","default":"now","description":"The date and time of departure from the origin point. Departure times apart from now must be specified as a dateTime."}},{"name":"arriveAt","in":"query","required":false,"description":"The date and time of arrival at the destination point. It must be specified as a dateTime.","schema":{"type":"string","description":"The date and time of arrival at the destination point. It must be specified as a dateTime."}},{"name":"routeType","in":"query","required":false,"description":"The type of route requested.","schema":{"type":"string","enum":["fastest","shortest","eco","thrilling"],"default":"fastest","description":"The type of route requested."}},{"name":"traffic","in":"query","required":false,"description":"Determines whether current traffic is used in route calculations. Note that information on historic road speeds is always used.","schema":{"type":"boolean","default":true,"description":"Determines whether current traffic is used in route calculations. Note that information on historic road speeds is always used."}},{"name":"avoid","in":"query","required":false,"description":"Specifies whether the routing engine should try to avoid specific types of road segment when calculating the route. Can be specified…","schema":{"type":"string","description":"Specifies whether the routing engine should try to avoid specific types of road segment when calculating the route. Can be specified…"},"example":"unpavedRoads"},{"name":"travelMode","in":"query","required":false,"description":"The mode of travel for the requested route.","schema":{"type":"string","enum":["car","truck","taxi","bus","van","motorcycle","bicycle","pedestrian"],"default":"car","description":"The mode of travel for the requested route."}},{"name":"hilliness","in":"query","required":false,"description":"Degree of hilliness for calculating a thrilling route.","schema":{"type":"string","enum":["low","normal","high"],"default":"normal","description":"Degree of hilliness for calculating a thrilling route."}},{"name":"windingness","in":"query","required":false,"description":"Amount that a thrilling route should wind.","schema":{"type":"string","enum":["low","normal","high"],"default":"normal","description":"Amount that a thrilling route should wind."}},{"name":"vehicleMaxSpeed","in":"query","required":false,"description":"Maximum speed of the vehicle in km/hour.","schema":{"type":"integer","default":0,"description":"Maximum speed of the vehicle in km/hour."}},{"name":"vehicleWeight","in":"query","required":false,"description":"Weight of the vehicle in kilograms.","schema":{"type":"integer","default":0,"description":"Weight of the vehicle in kilograms."}},{"name":"vehicleAxleWeight","in":"query","required":false,"description":"Weight per axle of the vehicle in kg.","schema":{"type":"integer","default":0,"description":"Weight per axle of the vehicle in kg."}},{"name":"vehicleLength","in":"query","required":false,"description":"Length of the vehicle in meters.","schema":{"type":"number","default":0,"description":"Length of the vehicle in meters."}},{"name":"vehicleWidth","in":"query","required":false,"description":"Width of the vehicle in meters.","schema":{"type":"number","default":0,"description":"Width of the vehicle in meters."}},{"name":"vehicleHeight","in":"query","required":false,"description":"Height of the vehicle in meters.","schema":{"type":"number","default":0,"description":"Height of the vehicle in meters."}},{"name":"vehicleCommercial","in":"query","required":false,"description":"Indicates that the vehicle is used for commercial purposes. This means it may not be allowed on certain roads.","schema":{"type":"boolean","default":false,"description":"Indicates that the vehicle is used for commercial purposes. This means it may not be allowed on certain roads."}},{"name":"vehicleLoadType","in":"query","required":false,"description":"Indicates what kinds of hazardous materials the vehicle is carrying (if any). This means it may not be allowed on certain roads. Use these…","schema":{"type":"string","description":"Indicates what kinds of hazardous materials the vehicle is carrying (if any). This means it may not be allowed on certain roads. Use these…"}},{"name":"vehicleEngineType","in":"query","required":false,"description":"Engine type of the vehicle.","schema":{"type":"string","enum":["combustion","electric"],"default":"combustion","description":"Engine type of the vehicle."}},{"name":"constantSpeedConsumptionInLitersPerHundredkm","in":"query","required":false,"description":"Specifies the speed-dependent component of consumption. Provided as an unordered list of speed/consumption-rate pairs.","schema":{"type":"string","description":"Specifies the speed-dependent component of consumption. Provided as an unordered list of speed/consumption-rate pairs."}},{"name":"currentFuelInLiters","in":"query","required":false,"description":"Specifies the current supply of fuel in liters.","schema":{"type":"number","description":"Specifies the current supply of fuel in liters."}},{"name":"auxiliaryPowerInLitersPerHour","in":"query","required":false,"description":"Specifies the amount of fuel consumed for sustaining auxiliary systems of the vehicle, in liters per hour.","schema":{"type":"number","description":"Specifies the amount of fuel consumed for sustaining auxiliary systems of the vehicle, in liters per hour."}},{"name":"fuelEnergyDensityInMJoulesPerLiter","in":"query","required":false,"description":"Specifies the amount of chemical energy stored in one liter of fuel in megajoules (MJ).","schema":{"type":"number","description":"Specifies the amount of chemical energy stored in one liter of fuel in megajoules (MJ)."}},{"name":"accelerationEfficiency","in":"query","required":false,"description":"Specifies the efficiency of converting chemical energy stored in fuel to kinetic energy when the vehicle accelerates (i.e.…","schema":{"type":"number","description":"Specifies the efficiency of converting chemical energy stored in fuel to kinetic energy when the vehicle accelerates (i.e.…"}},{"name":"decelerationEfficiency","in":"query","required":false,"description":"Specifies the efficiency of converting kinetic energy to saved (not consumed) fuel when the vehicle decelerates (i.e.…","schema":{"type":"number","description":"Specifies the efficiency of converting kinetic energy to saved (not consumed) fuel when the vehicle decelerates (i.e.…"}},{"name":"uphillEfficiency","in":"query","required":false,"description":"Specifies the efficiency of converting chemical energy stored in fuel to potential energy when the vehicle gains elevation (i.e.…","schema":{"type":"number","description":"Specifies the efficiency of converting chemical energy stored in fuel to potential energy when the vehicle gains elevation (i.e.…"}},{"name":"downhillEfficiency","in":"query","required":false,"description":"Specifies the efficiency of converting potential energy to saved (not consumed) fuel when the vehicle loses elevation (i.e.…","schema":{"type":"number","description":"Specifies the efficiency of converting potential energy to saved (not consumed) fuel when the vehicle loses elevation (i.e.…"}},{"name":"constantSpeedConsumptionInkWhPerHundredkm","in":"query","required":false,"description":"Specifies the speed-dependent component of consumption. Provided as an unordered list of speed/consumption-rate pairs.","schema":{"type":"string","description":"Specifies the speed-dependent component of consumption. Provided as an unordered list of speed/consumption-rate pairs."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/places:tomtom-routing/post-routing-version-number-calculate-route-locations-conten":{"post":{"operationId":"places_tomtom_routing_post_routing_version_number_calculate_route_locations_conten","summary":"Calculate Route","description":"POST /routing/{versionNumber}/calculateRoute/{locations}/{contentType}","tags":["places"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["versionNumber","locations","contentType"],"properties":{"versionNumber":{"type":"integer","enum":[1],"description":"Service version number. The current value is 1."},"locations":{"type":"string","description":"Locations through which the calculated route must pass."},"contentType":{"type":"string","enum":["xml","json","jsonp"],"default":"xml","description":"The content type of the response structure. If the content type is jsonp, a callback method can be specified in the query parameters."},"maxAlternatives":{"type":"integer","default":0,"description":"Number of alternative routes to be calculated."},"alternativeType":{"type":"string","enum":["anyRoute","betterRoute"],"default":"anyRoute","description":"Determines whether the alternative routes to be calculated should be better with respect to the planning criteria provided than the…"},"minDeviationDistance":{"type":"integer","default":0,"description":"All alternative routes will follow the reference route for the specified minimum number of meters starting from the origin point."},"minDeviationTime":{"type":"integer","default":0,"description":"All alternative routes will follow the reference route for the specified minimum number of seconds starting from the origin point."},"instructionsType":{"type":"string","enum":["coded","text","tagged"],"description":"If specified, guidance instructions will be returned (if available)."},"language":{"type":"string","default":"en-GB","description":"The language parameter determines the language of the guidance messages."},"computeBestOrder":{"type":"boolean","default":false,"description":"Re-order the route waypoints to reduce the route length."},"routeRepresentation":{"type":"string","enum":["polyline","none"],"default":"polyline","description":"Specifies the representation of the set of routes provided as a response."},"computeTravelTimeFor":{"type":"string","enum":["none","all"],"default":"none","description":"Specifies whether to return additional travel times using different types of traffic information (none, historic, live) as well as the…"},"vehicleHeading":{"type":"integer","description":"The directional heading of the vehicle in degrees. Entered in degrees, measured clockwise from north (so north is 0, east is 90, etc.)."},"sectionType":{"type":"string","default":"travelMode","description":"Specifies which section types are explicitly reported in the route response. Can be specified multiple times. - carTrain, ferry, tunnel or…"},"callback":{"type":"string","default":"callback","description":"Specifies the jsonp callback method."},"report":{"type":"string","enum":["effectiveSettings"],"description":"Specifies which data should be reported for diagnosis purposes."},"departAt":{"type":"string","default":"now","description":"The date and time of departure from the origin point. Departure times apart from now must be specified as a dateTime."},"arriveAt":{"type":"string","description":"The date and time of arrival at the destination point. It must be specified as a dateTime."},"routeType":{"type":"string","enum":["fastest","shortest","eco","thrilling"],"default":"fastest","description":"The type of route requested."},"traffic":{"type":"boolean","default":true,"description":"Determines whether current traffic is used in route calculations. Note that information on historic road speeds is always used."},"avoid":{"type":"string","description":"Specifies whether the routing engine should try to avoid specific types of road segment when calculating the route. Can be specified…"},"travelMode":{"type":"string","enum":["car","truck","taxi","bus","van","motorcycle","bicycle","pedestrian"],"default":"car","description":"The mode of travel for the requested route."},"hilliness":{"type":"string","enum":["low","normal","high"],"default":"normal","description":"Degree of hilliness for calculating a thrilling route."},"windingness":{"type":"string","enum":["low","normal","high"],"default":"normal","description":"Amount that a thrilling route should wind."},"vehicleMaxSpeed":{"type":"integer","default":0,"description":"Maximum speed of the vehicle in km/hour."},"vehicleWeight":{"type":"integer","default":0,"description":"Weight of the vehicle in kilograms."},"vehicleAxleWeight":{"type":"integer","default":0,"description":"Weight per axle of the vehicle in kg."},"vehicleLength":{"type":"number","default":0,"description":"Length of the vehicle in meters."},"vehicleWidth":{"type":"number","default":0,"description":"Width of the vehicle in meters."},"vehicleHeight":{"type":"number","default":0,"description":"Height of the vehicle in meters."},"vehicleCommercial":{"type":"boolean","default":false,"description":"Indicates that the vehicle is used for commercial purposes. This means it may not be allowed on certain roads."},"vehicleLoadType":{"type":"string","description":"Indicates what kinds of hazardous materials the vehicle is carrying (if any). This means it may not be allowed on certain roads. Use these…"},"vehicleEngineType":{"type":"string","enum":["combustion","electric"],"default":"combustion","description":"Engine type of the vehicle."},"constantSpeedConsumptionInLitersPerHundredkm":{"type":"string","description":"Specifies the speed-dependent component of consumption. Provided as an unordered list of speed/consumption-rate pairs."},"currentFuelInLiters":{"type":"number","description":"Specifies the current supply of fuel in liters."},"auxiliaryPowerInLitersPerHour":{"type":"number","description":"Specifies the amount of fuel consumed for sustaining auxiliary systems of the vehicle, in liters per hour."},"fuelEnergyDensityInMJoulesPerLiter":{"type":"number","description":"Specifies the amount of chemical energy stored in one liter of fuel in megajoules (MJ)."},"accelerationEfficiency":{"type":"number","description":"Specifies the efficiency of converting chemical energy stored in fuel to kinetic energy when the vehicle accelerates (i.e.…"},"decelerationEfficiency":{"type":"number","description":"Specifies the efficiency of converting kinetic energy to saved (not consumed) fuel when the vehicle decelerates (i.e.…"},"uphillEfficiency":{"type":"number","description":"Specifies the efficiency of converting chemical energy stored in fuel to potential energy when the vehicle gains elevation (i.e.…"},"downhillEfficiency":{"type":"number","description":"Specifies the efficiency of converting potential energy to saved (not consumed) fuel when the vehicle loses elevation (i.e.…"},"constantSpeedConsumptionInkWhPerHundredkm":{"type":"string","description":"Specifies the speed-dependent component of consumption. Provided as an unordered list of speed/consumption-rate pairs."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}