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.

GET /route/DriveTimePolygon

Resource URL

https://pcmiler.alk.com/apis/rest/v1.0/Service.svc/route/DriveTimePolygon

Request Parameters

Required parameters are highlighted in yellow. See parameter descriptions below.

Request

API KEY
GET

Response

Request Parameter Descriptions

Data ElementDescriptionData TypeValue/Example
centerCoordinates of the center point represented in lon, lat format. There must be at least two numbers.
Double
-76.12345,42.12345
minutesTime limit from center.
Int
Valid numbers are between 1 and 120 (2 hours).
hwyOnlyIndicates whether to use highways only.
boolean
True
False(Default)
vehTypeThe vehicle type.
Enum
0 - Truck(Default)
1 - LightTruck
2 - Auto
routingThe desired routing algorithm.
Enum
0 - Practical(Default)
1 - Shortest
overrideClassA comma separated list of class overrides
Enum
1 - NationalNetwork (U.S. Only)
2 - FiftyThreeFoot
0 - None (Default)
distUnitsDistance Units
Enum
0 - Miles(Default)
1 - Kilometers
tollAvoidIndicates whether or not to avoid tolls.
boolean
True
False(Default)
bordersIndicates whether borders are open for travel.
boolean
True
False(Default)
ovrdRestrictIndicates whether or not to override truck restrictions.
boolean
True
False(Default)
hazMatIndicates the hazardous material type
Enum
0 - None(Default)
1 - General
2 - Caustic
3 - Explosives
4 - Flammable
5 - Inhalants
6 - Radioactive
trkUnitsVehicle dimension units.
Enum
0 - English(Default)
1 - Metric
trkHeightThe height of the truck in feet and inches or meters depending on units.
string
13'6" or 4.1148
trkLengthThe length of the truck in feet and inches or meters depending on units.
string
13'6" or 4.1148
trkWidthThe width of the truck in feet and inches or meters depending on units.
string
13'6" or 4.1148
trkWeightThe weight of the truck in pounds or kilograms depending on units.
string
trkAxlesThe number of axles on the truck.
Int
Acceptable values are 2 through 14 and the default value is 5
trkLCVIndicates whether the truck is a multi-trailer or longer combination vehicle.
boolean
True
False(Default)
elevLimitIndicates 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
regionThe data region in which pings are located.
Enum
4 - NA(Default)
1 - AF
2 - AS
3 - EU
5 - OC
6 - SA
7 - ME
datasetFor 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
Last updated May 11, 2020.