Point Updates
HTTP POST URL Format
The following format is used for HTTP POST requests. HTTP POST is used to set a persistent update to a point.
HTTP POST: /rest/Spatial/erm/databases/dbsource/persistentUpdates.json?point=x,y,srsName&query_parameters
Where dbsource is the name of the database to update the route data. Use the database name specified in the Spatial Module Routing Database Resource tool.
HTTP DELETE URL Format
The following format is used for HTTP DELETE requests. HTTP DELETE is used to remove a specific persistent update to a point.
HTTP DELETE: /rest/Spatial/erm/databases/dbsource/persistentUpdates.json?point=x,y,srsName&resetType=query_parameters
Where dbsource is the name of the database that contains the persistent update to remove. Use the database name specified in the Enterprise Routing Module Routing Database Resource tool.
Query Parameters
The HTTP POST operation takes the following query parameters.
| Parameter | Type | Required | Description |
|---|---|---|---|
| exclude | String | no | Exclude the specified point from all route calculations. The parameter’s existence in the URL specifies whether to exclude, not the parameter value. |
| velocity | String | no | This is a speed update where you define the new speed of the point by specifying the new velocity. The default unit is mph (miles per hour) unless you specify the velocityUnit parameter. |
| velocityUnit | String | no | This is a unit of speed for the velocity or velocityAdjustment (miles per hour). For speed updates, the velocity unit can have one of the following values: mph (miles per hour) and kph (kilometers per hour). The default value is mph. |
| velocityAdjustment | String | no | This is a speed update where you define a change in the speed of the point by specifying the change in velocity (unit and value). Speed values can be increased (positive value) or decreases (negative value). The default unit is mph (miles per hour) unless you specify the velocityUnit parameter. |
| velocityPercentage | Integer | no | This is a speed update where you define an increase in the speed of the point by specifying a percentage to increase (positive value) or decrease (negative value) the speed. |
Reset Parameter
The HTTP DELETE operation takes the following query parameter.
| Parameter | Type | Required | Description |
|---|---|---|---|
| resetType | String | no |
Reset (undo) a type of update for a point.
|
Examples
Exclude a point (HTTP POST)
http://www.pb.com/rest/Spatial/erm/databases/usroutedatabase/persistentUpdates.json?point=-73.6,43.5,epsg:4326&exclude=true
Remove a point exclude persistent update (HTTP DELETE)
http://www.pb.com/rest/Spatial/erm/databases/usroutedatabase/persistentUpdates.json?point=-73.6,43.5,epsg:4326&resetType=exclude