GetTravelBoundary HTTP POST Options
HTTP POST URL Format
In addition to the regular HTTP GET parameters, you can add a 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 |
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 |
The unit of measure to use to calculate the ambient speed. Available speed units are:
MPH(miles per hour), KPH(kilometers per hour), MTPS(meters per
second), MTPM(meters per minute).
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. The following road types can be used:
|
Example ambient speed update HTTP POST payload.
{
"DefaultAmbientSpeed": 45,
"AmbientSpeedUnit" : "MPH",
"AmbientSpeed.RoadType.PrimaryHighwayUrban":15,
"AmbientSpeed.RoadType.SecondaryHighwayUrban":10
}