[ Whereis® API Home ] [ JSON API Home ] [ Object Index ] [ Return Types ]
Returned in an array in response to a rank request. Defines a point in terms of travel time and distance from a supplied reference point.
Parameters
Name | Type | Description |
coordinates | <point> | The coordinates being ranked |
distancemetres | int | This point's distance from the referencePoint |
sourceIndex | int | Identifies the position that this point occupied in the original list submitted to the rank request |
streetCoordinates | <point> | A streetPoint corresponding to this point, which can be used as a waypoint |
rankMethod | string | One of , corresponding to the method the service has used to order the points |
travTimeSeconds | int | The estimated travel time to this point from the referencePoint |
Example
{
"rankedPoints": [
{
"rankMethod": "STRAIGHT_LINE",
"coordinates": {
"lon": 100.0,
"lat": -30.0
},
"distanceMetres": 1110810,
"sourceIndex": 0,
"travTimeSeconds": 138851
},
{
"rankMethod": "STRAIGHT_LINE",
"coordinates": {
"lon": 100.1,
"lat": -32.1
},
"distanceMetres": 1344243,
"sourceIndex": 2,
"travTimeSeconds": 168030
},
{
"rankMethod": "STRAIGHT_LINE",
"coordinates": {
"lon": 120.0,
"lat": -30.0
},
"distanceMetres": 2294226,
"sourceIndex": 1,
"travTimeSeconds": 286778
}
]
}
NOTES