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
Required parameters are marked with an asterisk. See parameter descriptions below.
Request
Request Parameter Descriptions
| 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 |
| 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. See details in Glossary. |
Enum | 0 - None(Default) 1 - General 2 - Caustic 3 - Explosives 4 - Flammable 5 - Inhalants 6 - Radioactive |
| trkUnits | Vehicle dimension units. |
Enum | 0 - English(Default) 1 - Metric |
| trkHeight | The height of the truck in feet and inches or meters depending on units. |
string | 13'6" or 4.1148 |
| trkLength | The length of the truck in feet and inches or meters depending on units. |
string | 13'6" or 4.1148 |
| trkWidth | The width of the truck in feet and inches or meters depending on units. |
string | 13'6" or 4.1148 |
| trkWeight | The weight of the truck in pounds or kilograms depending on units. |
string | |
| trkAxles | 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 |