GetRoute
Descripción
El servicio GetRoute permite obtener información de ruta para un conjunto de dos puntos distintos o para múltiples puntos. Toma una ubicación de inicio y una de llegada con puntos intermedios opcionales como entrada y devuelve la ruta que es más rápida o más corta.
Formato de dirección URL de HTTP GET
El siguiente formato se utiliza para solicitudes HTTP GET. HTTP GET se utiliza para rutas simples, donde no se requiere carga JSON adicional. También se pueden agregar puntos intermedios a la solicitud HTTP GET.
HTTP GET /rest/Spatial/erm/databases/dbsource.json?q=route&query_parameters
Donde dbsource es el nombre de la base de datos que contiene los datos que se van a usar para la ruta. Utilice el nombre de la base de datos especificado en la herramienta Recursos de base de datos del módulo Enterprise Routing.
Formato de dirección URL de HTTP POST
El siguiente formato se utiliza para solicitudes HTTP POST:
HTTP POST: /rest/Spatial/erm/databases/dbsource.json?q=route&query_parameters
POST BODY: Content-Type:application/json {Route Data}
Route Data es el cuerpo POST json (Tipo de contenido: aplicación/json) para la información de ruta adicional que se va a utilizar en el cálculo que contiene puntos intermedios, las actualizaciones transitorias o la prioridad de tipos de camino. Para obtener información y ejemplos de estas opciones, consulte Opciones de GetRoute HTTP POST.
Parámetros de consulta
Esta operación toma los siguientes parámetros de consulta.
Parámetro | Tipo | Requerido | Descripción |
---|---|---|---|
startPoint | Cadena | sí | La ubicación de inicio de la ruta en formato: x,y,coordSys. Por ejemplo: -74.2,40.8,epsg:4326 |
endPoint | Cadena | sí | La ubicación de llegada de la ruta en formato: x,y,coordSys. Por ejemplo: -74.2,40.8,epsg:4326 |
intermediatePoints | Cadena | no | Una lista de puntos intermedios para incluir junto con la ruta. Para incluir en la solicitud HTTP GET, use el formato: Long,Lat,Long,Lat,…,coordsys. Por ejemplo: -74.2,40.8,-73,42,epsg:4326. Para incluir un conjunto de puntos intermedios en una solicitud HTTP POST, agregue una carga MultiPoint JSON que indique los puntos que debe incluir la ruta. Si los puntos intermedios se especifican en la URL y en la carga json, esta última tiene preferencia y se ignoran los que están en de la URL. |
oip | Boolean | no | Un parámetro de procesamiento que indica si los puntos intermedios se deben optimizar. El valor predeterminado es "false". De manera predeterminada, los puntos intermedios de usarán en el cálculo en el orden especificado. Si se configura como verdadero, los puntos especificados se reordenarán en una manera óptima durante el cálculo de la ruta. |
destinationSrs | Cadena | no | El sistema de coordenadas devuelve la ruta y las geometrías resultantes. El valor predeterminado es el sistema de coordenadas de los datos que se utilizan. |
optimizeBy | Cadena | no | El tipo de optimización para usar en la ruta. Los valores válidos son tiempo o distancia. El valor predeterminado es tiempo. |
returnDistance | Boolean | no | Las direcciones de la ruta incluyen la distancia recorrida. El valor predeterminado es verdadero. |
distanceUnit | Cadena | no | Las unidades para devolver la distancia. El valor predeterminado es m (metros). Los valores disponibles son : m(meter), km(kilometer), yd(yard), ft(foot), mi(mile). |
returnTime | Boolean | no | Las direcciones de la ruta incluyen el tiempo que tarda seguir una indicación. El valor predeterminado es verdadero. |
timeUnit | Cadena | no | Las unidades para devolver el tiempo. El valor predeterminado es min (minutos). Los valores disponibles son: min(minuto), msec (milisegundo), s(segundo), h(hora). |
idioma | Cadena | no |
El idioma de las indicaciones de recorrido se debe devolver, solo si se devuelven dichas indicaciones(si directionsStyle se define como normal o breve). El valor predeterminado es inglés (en). Las indicaciones se pueden devolver en los siguientes idiomas:
|
returnDirectionGeometry | Boolean | no | Incluye la geometría relacionada con cada instrucción de ruta en la respuesta de ruta. El valor predeterminado es "false". |
directionsStyle | Cadena | no |
El tipo de indicaciones de ruta que se van a devolver. El valor predeterminado es NINGUNO. Especifique este parámetro si requiere que se devuelvan las indicaciones de ruta. Las opciones al especificar las indicaciones de ruta son:
|
segmentGeometryStyle | Cadena | no |
El formato de la geometría que representa un segmento de la ruta. El valor predeterminado es NINGUNO. Especifique este parámetro si solicitó la devolución de geometrías de un segmento. Las opciones al especificar las indicaciones de ruta son:
|
primaryNameOnly | Boolean | no | Indica si se deben devolver todos los nombres de una calle dada o solo el nombre principal de la calle. Solo se usa cuando se devuelven las indicaciones de ruta. El valor predeterminado es falso. |
majorRoads | Boolean | no | Especifica si en el cálculo deben incluirse todos los caminos o solo los caminos principales. Si se opta por incluir solo los caminos principales, el rendimiento mejorará pero se reducirá la precisión. El valor predeterminado es "false". |
historicTrafficTimeBucket | Cadena | no |
Especifica si el cálculo de ruta utiliza las velocidades de tráfico histórico. Estas velocidades se basan en los diferentes depósitos de momento del día. Los datos deben incluir las velocidades de tráfico histórico para utilizar esta característica. Los datos para cada país/región tienen las mismas definiciones de depósito, donde las velocidades para estos valores de depósito pueden variar. Las opciones son:
|
Ejemplos
Ruta simple con puntos de inicio y llegada.
http://www.pb.com/rest/Spatial/erm/databases/usroutedatabase.json?q=route&startPoint=-73.97,40.79,epsg:4326&endPoint=-73.98,40.74,epsg:4326
Respuesta
{
"time": 7.67,
"timeUnit": "min",
"distance": 8865,
"distanceUnit": "m"
}
Ruta con puntos intermedios.
http://www.pb.com/rest/Spatial/erm/databases/usroutedatabase.json?q=route&startPoint=-73.970257, 40.794045,epsg:4326&endPoint=-73.972103,40.786605,epsg:4326&intermediatePoints=-73.976266, 40.788717,-73.973562,40.792193,-73.971802,40.794630,epsg:4326&oip=true
Ruta con indicaciones activadas.
http://www.pb.com/rest/Spatial/erm/databases/usroutedatabase.json? q=route&startPoint=-73.97,40.79,epsg:4326&endPoint=-73.98,40.74,
epsg:4326&language=en&directionsStyle=Normal&returnDirectionGeometry=true
Respuesta
{
"time": 10.58,
"timeUnit": "min",
"distance": 9035,
"distanceUnit": "m",
"language": "en",
"directionsStyle": "Normal",
"routeDirections": [
{
"time": 0.03,
"timeUnit": "min",
"distance": 25,
"distanceUnit": "m",
"instruction": "",
"directionGeometry":
{
"type": "LineString",
"coordinates":
[
[
-76.421169,
42.69302
],
[
-76.421353,
42.692645
],
...
]
}
},
{
"time": 0.7,
"timeUnit": "min",
"distance": 394,
"distanceUnit": "m",
"instruction": "Turn right on W 91st St and travel West 394.0 m
(0.7 min).",
"directionGeometry":
{
"type": "LineString",
"coordinates":
[
[
-76.429896,
42.67153
],
...
]
}
}
]
}