GetTravelBoundary HTTP POST Options
HTTP POST URL Format
In addition to the regular HTTP GET parameters, you can add an HTTP POST payload option to your request that specifies ambient speed changes for road types. The content type must be set to application/json. The following format is used for HTTP POST requests:
HTTP POST: /rest/Spatial/erm/databases/dbsource.json?q=travelBoundary&query_parameters
POST BODY: Content-Type:application/json {Route Data}
Ambient Speeds
This set of preferences allows you to set ambient speed changes for each request. An ambient speed is a change to the speed in the normal data to travel off a network road when finding the travel boundary. Examples of off-network travel include driveways and access roads. The following is a description of the ambient speed parameters:
|
Parameter |
Description |
|---|---|
|
DefaultAmbientSpeed |
Specifies the speed to travel when going off a network road to find the travel boundary
(for all road types). To control how off-network travel is used
in the travel boundary calculation, you need to specify the
speed of travel off the road network (the ambient speed).
Ambient speed can affect the size and shape of the travel
boundary polygon. In general, the faster the ambient speed, the
larger the polygon. For example, if you were at a point with 5
minutes left, and if the ambient speed were 15 miles per hour,
boundary points would be put at a distance of 1.25 miles. If the
ambient speed were reduced to 10 miles per hour, boundary points
would be put at a distance of 0.83 miles.
Note: Default
DefaultAmbientSpeed is
15 |
|
AmbientSpeedUnit |
Specifies the unit of measure to calculate the ambient speed. Available speed units are:
Note: Default AmbientSpeedUnit is
MPH |
|
AmbientSpeed.RoadType |
Specifies the ambient speed to use for off-network travel based on the road type. You must specify both the road type and the new speed for that road type. The speed is defined in the defined AmbientSpeedUnit. Road types can be returned in all supported types. The following road types can be used:
|
| propagationFactor | See Query Parameters
for description of propagationFactor. Note: This
parameter is only supported in
getTravelBoundary version 2 is
specified. |
| RoadType | Specifies the propagationFactor to use for
off-network travel based on the road type. You must specify both the
road type and the new value of propagationFactor for that road type.
See propagationFactor to know more. Road types can be
returned in all supported types. The following road types can be used:
Note: This parameter is only supported in
getTravelBoundary version 2 is
specified. |
| avoid | Specifies a comma-separated list of road types to be avoided during travel boundary calculation. This is a String parameter. When a road type is provided as the value of the parameter, the boundary excludes that type of roads in the calculation. For example, if tollRoad is provided as the parameter value, the calculated boundary will have no toll roads. |
Example with ambient speed parameters in HTTP POST payload in gettravelboundary version 1.
{
"DefaultAmbientSpeed": 45,
"AmbientSpeedUnit": "MPH"
"AmbientSpeed.RoadType.PrimaryHighwayUrban": 15,
"AmbientSpeed.RoadType.SecondaryHighwayUrban": 10
}Example with ambient speed and propagationFactor parameters in HTTP POST payload in gettravelboundary version 2.
{
"ambientSpeeds": {
"defaultAmbientSpeed": 24,
"ambientSpeedUnit": "MPH",
"ambientSpeedOverrides": {
"Primary Highway Urban": ".51",
"Secondary Highway Urban": ".1"
}
},
"propagationFactors": {
"propagationFactor": "1",
"propagationFactorOverrides": {
"Primary Highway Urban": ".51",
"Secondary Highway Urban": ".1"
}
}
}
{
"ambientSpeeds": {
"ambientSpeedOverrides": {
"Primary Highway Urban": 25,
"Secondary Highway Urban": 10
}
},
"propagationFactors": {
"propagationFactor": "0.2",
"propagationFactorOverrides": {
"Primary Highway Urban": "0.51",
"Secondary Highway Urban": "0.1"
}
}
}