Drive Time Polygon (Isochrones)
Contents
This API retrieves a polygon of the location coordinates that can be reached from a center point within a specified driving time in minutes. Fastest routing is used in all calculations.
GET /route/DriveTimePolygon
Resource URL
https://pcmiler.alk.com/apis/rest/v1.0/Service.svc/route/DriveTimePolygon
Request Parameters
| Data Element | Description | Data Type | Value/Example |
|---|---|---|---|
| center | Coordinates of the center point represented in lon, lat format. There must be at least two numbers. |
Double | -76.12345,42.12345 |
| minutes | Time limit from center. |
Int | Valid numbers are between 1 and 120 (2 hours). |
| hwyOnly | Indicates whether to use highways only for routing. |
boolean | True False(Default) |
| vehType | Restricts the route to roads that are accessible by the selected vehicle type. |
Enum | 0 - Truck (Default) 1 - LightTruck 2 - Auto 3 - Midsize Truck 4 - School Bus |
| overrideClass | A comma separated list of class overrides. This allows you to select whether a truck with a 48' or shorter trailer should still adhere to routing for larger (53') trucks along the National Network. (U.S. Only) |
Enum | 1 - NationalNetwork (U.S. Only) 2 - FiftyThreeFoot 0 - None (Default) |
| distUnits | Sets whether to use miles or kilometers in distance and speed measurements. |
Enum | 0 - Miles (Default) 1 - Kilometers |
| tollRoads | Indicates whether or not to avoid toll roads when generating a route. |
int | 1 - Always Avoid 2 - Avoid if Possible 3 - Use Default is null. |
| openBorders | Sets whether or not international borders are open to travel. Set to false to minimize the number of international border crossings, unless they are necessary to reach all of the stops on a route. |
boolean | True(Default) False |
| restrOverrides | Indicates whether or not to override truck restrictions pertaining to specific sizes and weights when generating a route. |
boolean | True False(Default) |
| hazMat | Indicates the hazardous material type. Read more about hazmat routing. |
Enum | 0 - None (Default) 1 - General 2 - Caustic 3 - Explosives 4 - Flammable 5 - Inhalants 6 - Radioactive 7 - HarmfulToWater 8 - Tunnel |
| vehDimUnits | Vehicle dimension units |
Enum | 0 - English (Default) 1 - Metric |
| vehHeight |
The height of the truck in feet and inches or meters depending on vehDimUnits.
Valid range is between 5' and 15' in North America, or between 2 and 5 meters in Europe. |
string | Read more about setting vehicle dimensions. |
| vehLength |
The length of a straight truck/van or combined vehicle’s trailer in feet and inches or meters depending on vehDimUnits. You do not need to include the tractor's length in this value for a tractor/trailer. If you have tandem trailers that don't articulate (rigid connection) then it would be the combined length of the trailers. More than just a legal setting, vehLength is used to calculate turning radius using the maximum straight length to see if the driver can make the turn.
Valid range is between 8' and 70' in North America, or between 5 and 25 meters in Europe. |
string | Read more about setting vehicle dimensions. |
| vehWidth |
The width of the truck in inches or meters depending on vehDimUnits.
Valid range is between 60" and 102" in North America, or between 2 and 3 meters in Europe. |
string | Read more about setting vehicle dimensions. |
| vehWeight |
The weight of the truck in pounds or kilograms depending on vehDimUnits.
Valid range is between 1500 and 156470 lbs in North America, or between 680.39 and 60000 kgs in Europe. |
string | Read more about setting vehicle dimensions. |
| axles | The number of axles on the truck |
Int | Acceptable values are 2 through 14 and the default value is 5 |
| LCV | Indicates whether the truck is a multi-trailer or longer combination vehicle. |
boolean | True False(Default) |
| elevLimit | Indicates the elevation limit when generating a route. Elevation unit is specified in feet or meters depending on the value of the distUnits query parameter being Miles or Kilometers respectively. This restriction is only available for the Current or PCM_NA datasets.
|
Int | No restriction(Default) 5000 1524 |
| region | The data region in which stop coordinates lie. Required to specify regions outside of NA. |
Enum | 4 - NA(Default) 1 - AF 2 - AS 3 - EU 5 - OC 6 - SA 7 - ME |
| dataset | For users licensed for multiple regional datasets. |
Enum |
0 - Current(Default) 1 - PCM_EU 2 - PCM_OC 3 - PCM_SA 4 - PCM_GT 5 - PCM_AF 6 - PCM_AS 7 - PCM_ME 8 - PCM_NA 9 - PCM_WW |
Try the API
With your API key, you can try a Drive Time Polygon request using the form below. The required parameters are marked with an asterisk. You can enter values for any of the optional parameters by first checking the box next to them. Scroll down the page to submit your request.
Request
Request Parameters
| Data Element | Description | Data Type | Value/Example |
|---|---|---|---|
| center | Coordinates of the center point represented in lon, lat format. There must be at least two numbers. |
Double | -76.12345,42.12345 |
| minutes | Time limit from center. |
Int | Valid numbers are between 1 and 120 (2 hours). |
| hwyOnly | Indicates whether to use highways only. |
boolean | True False(Default) |
| vehType | Restricts the route to roads that are accessible by the selected vehicle type. |
Enum | 0 - Truck (Default) 1 - LightTruck 2 - Auto 3 - Midsize Truck 4 - School Bus |
| overrideClass | A comma separated list of class overrides |
Enum | 1 - NationalNetwork (U.S. Only) 2 - FiftyThreeFoot 0 - None (Default) |
| distUnits | Sets whether to use miles or kilometers in distance and speed measurements. |
Enum | 0 - Miles (Default) 1 - Kilometers |
| tollAvoid | Indicates whether or not to avoid tolls. |
boolean | True False(Default) |
| borders | Indicates whether borders are open for travel. |
boolean | True False(Default) |
| ovrdRestrict | Indicates whether or not to override truck restrictions. |
boolean | True False(Default) |
| hazMat | Indicates the hazardous material type. Read more about hazmat routing. |
Enum | 0 - None(Default) 1 - General 2 - Caustic 3 - Explosives 4 - Flammable 5 - Inhalants 6 - Radioactive |
| vehDimUnits | Vehicle dimension units. Read more about setting vehicle dimensions. |
Enum | 0 - English(Default) 1 - Metric |
| vehHeight | The height of the truck in feet and inches or meters depending on units. |
string | 13'6" or 4.1148 |
| vehLength | The length of the truck in feet and inches or meters depending on units. |
string | 13'6" or 4.1148 |
| vehWidth | The width of the truck in feet and inches or meters depending on units. |
string | 13'6" or 4.1148 |
| vehWeight | The weight of the truck in pounds or kilograms depending on units. |
string | |
| axles | The number of axles on the truck. |
Int | Acceptable values are 2 through 14 and the default value is 5 |
| trkLCV | Indicates whether the truck is a multi-trailer or longer combination vehicle. |
boolean | True False(Default) |
| elevLimit | Indicates the elevation limit when generating a route. Elevation unit is specified in feet or meters depending on the value of the distUnits query parameter being Miles or Kilometers respectively. This restriction is only available for the Current or PCM_NA datasets.
|
Int | No restriction(Default) 5000 1524 |
| region | The data region in which pings are located. |
Enum | 4 - NA(Default) 1 - AF 2 - AS 3 - EU 5 - OC 6 - SA 7 - ME |
| dataset | For users licensed for multiple regional datasets. |
Enum |
0 - Current(Default) 1 - PCM_EU 2 - PCM_OC 3 - PCM_SA 4 - PCM_GT 5 - PCM_AF 6 - PCM_AS 7 - PCM_ME 8 - PCM_NA 9 - PCM_WW |