The Search Along web service allows you to identify the best candidates from which to select the next nearest step in a pre-existing itinerary.
The algorithm explores all possible solutions before returning the best candidate selected as a function of best score for the requested criteria.
{
"url":"https://api.geoconcept.com/EU/GCW/geoconcept-web/api/lbs/searchAlong/v2.json",
"method":"POST",
"body":
{
"routes":[
{
"id":"dep",
"origin":{
"x":-1.553927,
"y":47.218580
},
"destination":{
"x":-1.593927,
"y":47.188580
},
"waypoints" : [ {
"x":-1.563927,
"y":47.224680
}, {
"x":-1.559927,
"y":47.212458
} ]
}
],
"resources":[
{
"id":"res1",
"x":-1.511092,
"y":47.208354
},
{
"id":"res2",
"x":-1.549524,
"y":47.195483
}
],
"method":"time",
"srs":"epsg:4326",
"maxDetourDurationSeconds":-1,
"maxDetourDistanceMeters":-1,
"maxDetourOriginDurationSeconds":-1,
"maxDetourOriginDistanceMeters":-1,
"maxDetourDestinationDurationSeconds":-1,
"maxDetourDestinationDistanceMeters":-1
}
}
Input
| parameter | description | optional | default |
|---|---|---|---|
|
routes array of routes/route (inputRouteV2) |
Table of journey input data. Pre-existing itineraries in which candidate steps must be inserted. |
yes * |
|
|
resources (array of Point) |
Candidate resources |
yes |
|
|
method |
Shortest (distance) or fastest (time) journey |
yes |
time |
|
exclusions |
List of restriction rules to use, separated by the ; character |
yes |
|
|
snapMethod |
Snap-to-graph method |
yes |
standard |
|
avoidArea |
Forbidden transit zone in WKT format (POLYGON or MULTIPOLYGON) in the requested projection (srs parameter) |
yes |
|
|
startDateTime |
Start date and time (format ISO8601: local time) example: 2014-01-21T09:00:00.000+01:00 (or 2014-01-21T09:00:00.000%2B01:00) for a start on 21 January 2014, at 9.00am in Paris |
yes |
|
|
srs |
projection (EPSG code such as epsg:4326 or wgs84) |
yes |
|
|
configName |
Name of the configuration to use: |
yes |
|
|
computeOptions |
Selection of variables to use in calculations, using semi-colons ; as separators: |
yes |
|
|
maxDetourDurationSeconds |
Filter: maximum detour authorised (in seconds) |
yes |
|
|
maxDetourDistanceMeters |
Filter: maximum detour authorised (in meters) |
yes |
|
|
maxDetourOriginDurationSeconds |
Filter: maximum authorised duration between the journey start point and the candidate (in seconds) |
yes |
|
|
maxDetourOriginDistanceMeters |
Filter: maximum authorised detour between the candidate and the journey arrival point (in meters) |
yes |
|
|
maxDetourDestinationDurationSeconds |
Filter: maximum authorised duration between the candidate and the journey arrival point (in seconds) |
yes |
|
|
maxDetourDestinationDistanceMeters |
Filter: maximum authorised detour from the arrival point (in meters) |
yes |
(*) At least one of the two parameters routes, and routeNodes must be entered.
Journeys in input (inputRouteV2)
| parameter | description | optional | default |
|---|---|---|---|
|
id |
Journey identifier |
No |
|
|
origin (Point) |
Coordinates of the journey departure point |
No |
|
|
destination (Point) |
Coordinates of the journey arrival point |
No |
|
|
waypoints (array of Point) |
waypoints of the journey |
No |
Geolocalized point (Point)
| parameter | description | optional | default |
|---|---|---|---|
|
id |
Point identifier |
No |
|
|
x |
First coordinate or longitude |
No |
|
|
y |
Second coordonnée or latitude |
No |
|
|
nodeId |
Point node id on the graph |
No |
Output
| parameter | type | min/max | description |
|---|---|---|---|
|
routes |
array of routes/route (searchAlongRouteResultV2) |
0/unlimited |
List of calculated journeys. |
List of calculated journeys (searchAlongRouteResultV2)
| parameter | type | min/max | description |
|---|---|---|---|
|
id |
string |
0/1 |
Journey identifier |
|
directDistanceMeters |
double |
1/1 |
Total distance without detour (in meters) |
|
directDurationSeconds |
double |
1/1 |
Total duration without detour (in seconds) |
|
resources |
(searchAlongResourceResultV2) |
0/unlimited |
List of candidates |
Candidates (searchAlongResourceResultV2)
| parameter | type | min/max | description |
|---|---|---|---|
|
id |
string |
0/1 |
Candidate identifier |
|
totalDistanceMeters |
double |
1/1 |
Total distance with detour (in meters) |
|
totalDurationSeconds |
double |
1/1 |
Total duration with detour (in seconds) |
|
detourDistanceMeters |
double |
1/1 |
Detour distance (in meters) |
|
detourDurationSeconds |
double |
1/1 |
Detour duration (in seconds) |
|
detourOriginDistanceMeters |
double |
1/1 |
Detour distance from the journey departure point to the candidate (in meters) |
|
detourOriginDurationSeconds |
double |
1/1 |
Detour duration from the journey departure point to the candidate (in seconds) |
|
detourDestinationDistanceMeters |
double |
1/1 |
Detour distance from the candidate to the arrival point (in meters) |
|
detourDestinationDurationSeconds |
double |
1/1 |
Detour duration from the candidate to the arrival point (in seconds) |
|
subPathIndex |
double |
1/1 |
Index of the sub path in the input route for this candidate |
|
previousStepId |
string |
1/1 |
Id of the origin of the sub path in the input route for this candidate |
|
nextStepId |
string |
1/1 |
Id of the destination of the sub path in the input route for this candidate |
- 1. Is it possible to give priority to either journey time or journey distance?
- 2. How does one structure the classification of returned addresses, in relation to the distance, the time, and to priorities generally?
- 3. What format should the priority take and is it possible to define a classification order? (increasing/decreasing)
- 4. If just one address in the list has a priority of 0, is the priority taken into account for one of the addresses in the list?
- 5. How do you perform a search around calculation without including any road tolls?
- 6. What are the maximum values allowed by predefined configName?
- 7. What are the exclusions available?
- 8. What are the Hazardous material exclusions?
- 9. What are Speed Patterns? How are they used?
- 10. How do you use heavy goods vehicle attributes?
