Point Updates - Spectrum_Routing_for_Big_Data - 3.0

Global Routing SDK Developer Guide
Product type
Software
Portfolio
Locate
Product family
Spectrum™ software
Product
Spatial Big Data > Routing for Big Data
Version
3.0
ft:locale
en-US
Product name
Routing for Big Data
ft:title
Global Routing SDK Developer Guide
Copyright
2024
First publish date
2007
ft:lastEdition
2024-10-15
ft:lastPublication
2024-10-15T10:39:39.482000

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:/webApp-context/services/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 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: /webApp-context/services/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 Database Resource tool.

Query Parameters

The HTTP POST operation takes the following query parameters.

Parameter Type Required Description
exclude String No Specifies whether to 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 Specifies the speed update where you can 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 Specifies the unit of speed for the velocity or velocityAdjustment (miles per hour). For speed updates, the velocity unit can have one of the following values where mph is the default value:
  • mph (miles per hour)
  • kph (kilometers per hour)
velocityAdjustment String No Specifies the 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 Specifies the 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.
version String No Specifies the version of the PointUpdates REST service. Valid values are 1 and 2.

Reset Parameter

The HTTP DELETE operation takes the following query parameter.

Parameter Type Required Description
resetType String No Specifies whether to reset (undo) an update for a point. Available options are:
  • speed: Reset the speed update for a specific point.
  • exclude: Reset the exclude for a specific point.

Examples

Exclude a point (HTTP POST)

http://<server>:<port>/<webApp-context>/services/databases/<usroutedatabase>/persistentUpdates.json?
     point=-73.6,43.5, epsg:4326 & exclude=true

Remove a point exclude persistent update (HTTP DELETE)

http://<server>:<port>/<webApp-context>/services/databases/<usroutedatabase>/persistentUpdates.json?
     point=-73.6,43.5, epsg:4326 & resetType=exclude