Open-Harbor/osrm-backend
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 3 Wiki Activity

Update docs

Browse Source
This commit is contained in:
Kerrick Staley 2016-11-15 17:27:06 -08:00 committed by Patrick Niklaus
parent 2c9e18d5a9
commit 15359befdc
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/http.md
View File

@ -283,6 +283,12 @@ In addition to the [general options](#general-options) the following options are
|timestamp |`integer` UNIX-like timestamp | |timestamp |`integer` UNIX-like timestamp |
|radius |`double >= 0` (default 5m) | |radius |`double >= 0` (default 5m) |
The radius for each point should be the standard error of the location, measured in meters from the true location. Use
`Location.getAccuracy()` on Android or `CLLocation.horizontalAccuracy` on iOS. This value is used to determine which
points should be considered as candidates (larger radius means more candidates) and how likely each candidate is (larger
radius means far-away candidates are penalized less). The area to search is chosen such that the correct candidate
should be considered 99.9% of the time (for more details, see https://github.com/Project-OSRM/osrm-backend/pull/3184).
### Response ### Response
- `code` if the request was successful `Ok` otherwise see the service dependent and general status codes. - `code` if the request was successful `Ok` otherwise see the service dependent and general status codes.
- `tracepoints`: Array of `Waypoint` objects representing all points of the trace in order. - `tracepoints`: Array of `Waypoint` objects representing all points of the trace in order.