GetTravelBoundary - web_services - 23.1

Guía de servicios web de Spectrum

Product type
Portfolio
Integrate
Product family
Product
Spectrum > Web Services
Version
23.1
Language
Español (México)
Product name
Spectrum Technology Platform
Title
Guía de servicios web de Spectrum
First publish date
2007
ft:lastEdition
2024-02-07
ft:lastPublication
2024-02-07T18:09:34.894393

Descripción

GetTravelBoundary determina la frontera de tiempo o distancia a pie o en vehículo desde una ubicación. Esta función permite obtener polígonos que corresponden a un cálculo de elemento isócrono o equidistancia. Un elemento isócrono es un polígono o conjunto de puntos que representan un área que puede recorrerse en una red desde un punto inicial en un tiempo dado. La equidistancia es un polígono o conjunto de puntos que representan el área que se encuentra a cierta distancia desde un punto de partida. La operación GetTravelBoundary (también conocida como definición "iso") toma un punto de partida, una unidad (lineal o de tiempo), uno o más costos como entrada y arroja el límite de viaje resultante. Costos hace referencia a la cantidad de tiempo o distancia que se usará para calcular un iso. Múltiples costos también se pueden entregar como entrada. En el caso de múltiples costos, estos también se pueden proporcionar como una cadena delimitada por comas.

Nota: La respuesta del servicio REST será en formato JSON. Cuando una solicitud contiene parámetros de consulta no válidos en la URL de GET o una carga no válida para POST, se obtiene una respuesta de error acumulativa en un conjunto JSON. El nodo value en la respuesta JSON está obsoleto. Para comprobar los errores, solo se debe utilizar el nodo errors.

Formato de dirección URL de HTTP GET

El siguiente formato se utiliza para solicitudes HTTP GET. HTTP GET se utiliza para todos los límites de viaje, donde no se requiere carga JSON adicional (cambios de la velocidad ambiente).

HTTP GET /rest/Spatial/erm/databases/dbsource.json?q=travelBoundary&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=travelBoundary&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 las velocidades ambiente de los tipos de camino. Para obtener información y ejemplos de estas opciones, consulte Opciones de GetTravelBoundary HTTP POST.

Parámetros de consulta

Esta operación toma los siguientes parámetros de consulta.

Parámetro Tipo Requerido Descripción
point Cadena de caracteres Especifica la ubicación de inicio desde donde se va a calcular el límite de viaje en el formato: x, y, coordSys. Por ejemplo: -74.2,40.8,epsg:4326
costs Double Especifica el tiempo o la distancia de costo en las unidades de costo especificadas (puede ser un valor decimal). Por ejemplo, si la unidad especificada es millas y especifica 10 en este parámetro, el límite de viaje se calculará para la distancia que puede viajar 10 millas. También puede especificar múltiples costos, al indicar los valores como una cadena delimitada por comas. Se devolverá un límite de viaje independiente para cada costo especificado. Si identifica múltiples costos, cada respuesta tendrá un costo y las unidades de costo relacionadas con dicha respuesta.
costUnit Cadena de caracteres Especifica el tipo de métrica utilizada para calcular el límite de viaje. Los valores de distancia disponibles son los siguientes:
  • m (metro)
  • km (kilómetro)
  • yd (yarda)
  • ft (pie)
  • mi (milla)
Los valores de tiempo disponibles son:
  • min (minuto)
  • msec (milisegundo)
  • s (segundo)
  • h (hora)
maxOffroadDistance Double No La distancia máxima para permitir el recorrido fuera de la red de carreteras por medio del uso de maxOffroadDistanceUnit. Algunos ejemplos de caminos fuera de la red son los caminos de entrada y las carreteras de acceso. Por ejemplo, si se especifica una distancia máxima fuera de camino de 1 milla (1,6 kilómetros), la frontera de viaje no se extenderá más allá de esa distancia desde el camino perteneciente a la red. Si se especifica el valor 0, la frontera de viaje se limitará al camino mismo. Utilice las opciones de velocidad ambiente para especificar la velocidad de viaje en caminos y carreteras que no pertenecen a la red.
maxOffroadDistanceUnit Cadena de caracteres No Especifica la unidad de distancia que define maxOffroadDistance. También debe definir maxOffroadDistance, si define este parámetro. Los valores de distancia disponibles son los siguientes:
  • m (metro)
  • km (kilómetro)
  • yd (yarda)
  • ft (pie)
  • mi (milla)
destinationSrs Cadena de caracteres No Especifica el sistema de coordenadas que va a devolver las geometrías de límite de viaje. El valor predeterminado es el sistema de coordenadas de los datos que se utilizan (por ejemplo, epsg:4326).
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 verdadero.
returnHoles Boolean No Especifica si se desean obtener huecos, esto es, áreas dentro del límite mayor a las que no es posible llegar en el tiempo o la distancia deseados sobre la base de la red de carreteras. El valor predeterminado es "false".
returnIslands Boolean No Especifica si se desean obtener islas, esto es, pequeñas áreas por fuera del límite principal a las que es posible llegar en el tiempo o la distancia deseados. El valor predeterminado es "false".
simplificationFactor Entero No Especifica el porcentaje de puntos originales que debe devolverse o en el que debe basarse la complejidad resultante de las geometrías. Se espera un número del 0,0 al 1,0, sin incluir el 0,0 pero incluido el 1,0. La complejidad aumenta a medida que el valor aumenta, por lo tanto, un 1,0 representa el valor más complejo. El valor predeterminado es 0.5.
bandingStyle Cadena de caracteres No

Especifica el estilo de banda a usar en el resultado. Los estilos de bandas son los tipos de múltiples bandas de distancia, que pueden mostrarse sobre la base de múltiples costos. Los estilos de banda se pueden devolver en los siguientes formatos:

Donut
Cada límite se determina restándole el siguiente límite menor. Este es el método predeterminado.
Encompassing
Cada límite se determina independientemente de los demás.
historicTrafficTimeBucket Cadena de caracteres 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:

None
El valor predeterminado. No se utilizan los datos del tráfico histórico en el cálculo. En su lugar, se utiliza un valor de velocidad promedio.
AMPeak
Calcule las rutas con las velocidades máximas de la mañana. El depósito de tiempo AMPeak es el momento desde las 07:00 hasta las 10:00 hs.
PMPeak
Calcule las rutas con las velocidades máximas de la tarde. El depósito de tiempo PMPeak es el momento desde las 16:00 hasta las 19:00 hs.
OffPeak
Calcule las rutas con las velocidades fuera del horario pico (durante el día). El depósito de tiempo OffPeak es el momento desde las 10:00 hasta las 16:00 hs.
Night
Calcule las rutas con las velocidades nocturnas. El depósito de tiempo Night es el momento desde las 22:00 hasta las 04:00 hs.
defaultAmbientSpeed Cadena de caracteres No
Especifica la velocidad de viaje al salir de un camino de la red para encontrar el límite de viaje (para todos los tipos de camino). Para controlar la forma en que se usa el viaje fuera de la red en el cálculo de la frontera de viaje, es necesario especificar la velocidad del viaje fuera de la red de carreteras (la velocidad ambiente). La velocidad ambiente puede afectar el tamaño y la forma del polígono de frontera de viaje. Por lo general, cuanto mayor sea la velocidad ambiente, más grande será el polígono. Por ejemplo, usted se encuentra en un punto a 5 minutos de distancia y la velocidad ambiente es de 15 millas por hora, los puntos de frontera estarían a una distancia de 1,25 millas. Si la velocidad ambiente se reduce a 10 millas por horas, los puntos de frontera estarían a una distancia de 0,83 millas.
Nota: El valor predeterminado defaultAmbientSpeed es 15
ambientSpeedUnit Cadena de caracteres No
Especifica la unidad de medida para calcular la velocidad ambiente. Las unidades de velocidad disponibles son las siguientes:
  • MPH (millas por hora)
  • KPH (kilómetros por hora)
  • MTPS (metros por segundo)
  • MTPM (metros por minuto)
Nota: La unidad predeterminada de ambientSpeedUnit es MPH
propagationFactor Cadena de caracteres No

Especifica el porcentaje del costo utilizado para calcular la distancia entre el punto de inicio y la equidistancia (para todos los tipos de caminos). El factor de propagación tiene el mismo propósito respecto a las equidistancias, como la velocidad ambiente con los isócronos, es decir, controla la manera en que se utiliza el viaje fuera de la red en el cálculo del límite de viaje. El factor de propagación puede afectar el tamaño y la forma del polígono de límite de viaje. En general, mientras mayor sea el valor del factor de propagación, más grande será el polígono.

Esto se aplica a las equidistancias. Si no se especifica esta propiedad, el cálculo utiliza la configuración del servidor. Los valores válidos están entre 0,0 y 1,0; ambos incluidos.
Nota:
  • El valor predeterminado propagationFactor es 0.16
  • Este parámetro también se puede especificar en el cuerpo POST. Cuando el mismo parámetro está establecido en GET y POST, el valor POST es el que se considera.
version Cadena de caracteres No Especifica la versión del servicio REST GetTravelBoundary. Los valores válidos son 1 y 2. El valor predeterminado para version es 1.

Ejemplos

Límite de viaje con un costo simple.

http://<server>:<port>/rest/Spatial/erm/databases/usroutedatabase.json? q=travelBoundary&point=-77.092609,38.871256,epsg:4326&costs=5&costUnit=m

Respuesta

{ 	"travelBoundary": { 		"costs": [ 			{ 				"cost": 5, 				"costUnit": "m", 				"geometry": {"type":"MultiPolygon","coordinates":[[[...]]]} 			} 		] 	} }

Límite de viaje con múltiples costos.

http://<server>:<port>/rest/Spatial/erm/databases/usroutedatabase.json?​q=travelBoundary&point=-77.092609,38.871256,epsg:4326&costs=2,5&costUnit=m

Respuesta

{ 	"travelBoundary": { 		"costs": [ 			{ 				"cost": 2, 				"costUnit": "m", 				"geometry": "{"type":"MultiPolygon","coordinates":[[[...]]]}" 			}, 			{ 				"cost": 5, 				"costUnit": "m", 				"geometry": "{"type":"MultiPolygon","coordinates":[[[...]]]}" 			} 		] 	} }

Respuesta de error específica de la versión

Cuando ingresa un valor de parámetro no válido (por ejemplo, puntos que quedan fuera de los límites) en una solicitud, la respuesta de error que obtiene depende de la versión que ingresó. Cuando la versión es 1, obtiene valor y error, y cuando la versión es 2, la respuesta sólo contiene el error.

  • Solicitud cuando version es 1:
    http://<server>:<port>/rest/Spatial/erm/databases/usroutedatabase.json?q=travelBoundary&costs=5&costUnit=min&point=-14.321600,60.662859,epsg:4326&version=1
  • Respuesta:
    {   "value": "Point outside boundaries: (-14.3216,60.662859,0)",   "errors": [     {       "errorCode": 5008,       "userMessage": "Point outside boundaries: (-14.3216,60.662859,0)"     }   ] }
  • Solicitud cuando version es 2:
     http://<server>:<port>/rest/Spatial/erm/databases/usroutedatabase.json?q=travelBoundary &costs=5&costUnit=min&point=-14.321600,60.662859,epsg:4326&version=2 
  • Respuesta:
    {   "errors": [     {       "errorCode": 5008,       "userMessage": "Point outside boundaries: (-14.3216,60.662859,0)"     }   ] }