Update at 11.0

• Use locateSettings to specify settings that affect how inputs are located.
• Use returnEmptyResults to return empty results instead of an error when the request fails.

Updates at 10.9.1

• Use returnTraversedEdges, returnTraversedJunctions, and returnTraversedTurns to specify whether the service will return the elements traversed during the solve operation.
• Use geometryPrecision, geometryPrecisionZ, and geometryPrecisionM to specify the output geometry precision for x-, y-, and z-coordinates and the value of m.

Updates at 10.8.1

When the authoring application for services is ArcGIS Pro, you can specify the now value in the startTime parameter to set the analysis to begin at the current time.

Updates at 10.8

Use the preserveObjectID parameter to specify whether the object IDs from the input locations will be preserved when the input locations are returned as output.

Updates at 10.5

Use the overrides parameter to specify additional settings that can influence the behavior of the solver when finding solutions for the network analysis problems.

Updates at 10.4

Pass in a complete JSON representation of a travel mode through travelMode and automatically set override values for various other parameters to quickly and consistently model cars, trucks, a type of truck, and so on.

Updates at 10.3

Use the travelMode parameter to automatically set override values for various other parameters to quickly and consistently model cars, trucks, a type of truck, and so on.

Updates at 10.2.1

Use the startTimeIsUTC parameter to specify whether the startTime parameter value is in UTC or the time zone of the first stop. Using startTimeIsUTC, you can start all the routes at the same time regardless of the time zone where the stops are located.

Updates at 10.1

• M-values—The outputLines parameter supports a new value: esriNAOutputLineTrueShapeWithMeasure. If specified, returned routes, compressed geometry, and service area lines will contain m-values on each vertex.
• Z-values—The route solver supports the new returnZ parameter. If returnZ=true and the route solver is using a z-aware network dataset, returned routes and compressed geometry will contain z-values on each vertex. Input point and line locations can have z-values on them.

  Routes, directions, stops, and barriers in the response include the hasZ and hasM properties that indicate whether the geometry includes z-values or m-values, respectively.

• CompressedGeometry—CompressedGeometry can contain m- and z-values and indicates how to decompress them.
• Use the optional url property to specify input stops, barriers, polylineBarriers, or polygonBarriers values. The url value contains a REST Query request to a feature, map, or geoprocessing service returning a JSON feature set. The advantage of using this property is that locations can be passed directly from a service endpoint as input to the network analysis operation, bypassing the client as intermediate storage.

stops

Especifica las ubicaciones que visitará la ruta o rutas de salida.

Puede utilizar una sintaxis simple basada en comas y punto y coma si pasa las ubicaciones de entrada con sus valores de longitud y latitud en el sistema de coordenadas WGS84 y no necesita pasar campos adicionales para cada ubicación.

Simple syntax for stops

stops=x1,y1; x2, y2; ...; xn, yn

Example using simple syntax

stops=-117.1957,34.0564; -117.184,34.0546

The stops parameter can be specified using a JSON structure that references a set of point features. The property is optional; however, the JSON structure must specify either the features, url, or layer property:

• url: especifique una solicitud de consulta REST para cualquier entidad, mapa o servicio de geoprocesamiento de ArcGIS Server que devuelva un conjunto de entidades JSON.

  La estructura JSON puede incluir esta propiedad:

  • doNotLocateOnRestrictedElements (opcional): especifique si los elementos de red restringidos se considerarán al buscar ubicaciones de red. El valor predeterminado es true.

• features: especifique una matriz de entidades.

  Each feature in the features array represents a stop and contains the following properties:

  • geometry: especifique la geometría de punto de entrada que contenga las propiedades x y y junto con la propiedad spatialReference. Si la propiedad spatialReference se define para todo el JSON, no es necesario que defina esta propiedad para cada geometría. Al hacerlo, se reduce el tamaño del JSON de entrada si la entrada tiene muchas entidades y también mejora el rendimiento. Esta propiedad no es necesaria si las coordenadas están en la referencia espacial predeterminada, WGS84. Si las coordenadas están en una referencia espacial diferente, debe especificar el Id. conocido de la referencia espacial (WKID). Consulte Utilizar referencias espaciales para buscar valores de WKID.

    Sugerencia:

    Se recomienda especificar explícitamente el valor de spatialReference y especificarlo para todo el JSON en lugar de para cada geometría individual.

  • attributes: especifique cada atributo como un par de clave-valor donde la clave es el nombre de un campo dado y el valor es el valor de atributo del campo correspondiente.

  The JSON structure can include the following property:

  • doNotLocateOnRestrictedElements (opcional): especifique si los elementos de red restringidos se considerarán al buscar ubicaciones de red. El valor predeterminado es true.

• layer—Specify a feature layer in the map service. Attribute and spatial filters can also be applied on the layer. The JSON structure can include the following properties:
  • type—Set the type property to layer to indicate that you're specifying the stops by referencing a layer.
  • layerName: el nombre o Id. de la capa de datos en el servicio de mapas al que se hace referencia.
  • where (opcional): una cláusula WHERE para el filtro de consulta. Se permite cualquier cláusula WHERE de SQL legal que funcione en los campos de la capa.
  • geometry (opcional): la geometría que se aplica como filtro espacial. La estructura de la geometría coincide con la estructura de los objetos de geometría JSON devueltos por la ArcGIS REST API.

    El tipo de geometría se especifica usando la propiedad geometryType.

  • geometryType (opcional): el tipo de geometría especificado por la propiedad geometry. Los tipos de geometría compatibles son sobre, punto, línea y polígono. El tipo de geometría predeterminado es esriGeometryEnvelope.

    Valores: esriGeometryPoint | esriGeometryMultipoint | esriGeometryPolyline | esriGeometryPolygon | esriGeometryEnvelope

  • spatialRel (opcional): la relación espacial que se aplicará en geometry de entrada. Entre las relaciones espaciales admitidas se incluyen interseca, contiene, el sobre interseca, dentro de, etc. La relación espacial predeterminada es esriSpatialRelIntersects.

    Valores: esriSpatialRelIntersects | esriSpatialRelContains | esriSpatialRelCrosses | esriSpatialRelEnvelopeIntersects | esriSpatialRelIndexIntersects | esriSpatialRelOverlaps | esriSpatialRelTouches | esriSpatialRelWithin

  • doNotLocateOnRestrictedElements (opcional): especifique si los elementos de red restringidos se considerarán al buscar ubicaciones de red. El valor predeterminado es true.

{
  "spatialReference": {
    "wkid": <wkid>,
    "latestWkid": <wkid>
  },
  "features": [
    {
      "geometry": {
        "x": <x>,
        "y": <y>,
      },
      "attributes": {
        "<field1>": <value11>,
        "<field2>": <value12>
      }
    },
    {
      "geometry": {
        "x": <x>,
        "y": <y>,
      },
      "attributes": {
        "<field1>": <value21>,
        "<field2>": <value22>
      }
    }
  ],
  "doNotLocateOnRestrictedElements": true | false
}

{
  "url": "<url>"
  "doNotLocateOnRestrictedElements": true | false
}

{ 
  "type" : "layer",
  "layerName" : "<layerName>",
  "where" : "<whereClause>",
  "geometry" : {<geometry>},
  "geometryType" : "<geometryType>",
  "spatialRel" : "<spatialRel>",
  "doNotLocateOnRestrictedElements" : true | false
}

{ 
  "spatialReference": {
    "wkid": 4326
  },
  "features": [
    {
      "geometry": {
        "x": -122.4079,
        "y": 37.78356
      },
      "attributes": {
        "Name": "From",
        "RouteName": "Route A"
      }
    },
    {
      "geometry": {
        "x": -122.404,
        "y": 37.782
      },
      "attributes": {
        "Name": "To",
        "RouteName": "Route A"
      }
    },
    {
      "geometry": {
        "x": -122.4095,
        "y": 37.78379
      },
      "attributes": {
        "Name": "From",
        "RouteName": "Route B"
      }
    },
    {
      "geometry": {
        "x": -122.480,
        "y": 37.734
      },
      "attributes": {
        "Name": "To",
        "RouteName": "Route B"
      }
    }
  ]
}

{
  "spatialReference": {
    "wkid": 102100}
      },
  "features": [
    {
      "geometry": {
        "x": -13635398.9398,
        "y": 4544699.034400001,
        
      },
      "attributes": {"Name": "Home"}
    },
    {
      "geometry": {
        "x": -13632733.3441,
        "y": 4547651.028300002,
        
      },
      "attributes": {"Name": "Office"}
    }
  ]
}

{
  "url": "https://machine.domain.com/webadaptor/rest/services/Network/USA/MapServer/1/query?where=1%3D1&outFields=Name,RouteName&f=json"
}

{ 
  "type" : "layer",
  "layerName" : "PointsOfInterest",
  "where" : "CITY = 'San Francisco'"
}

token

Utilice este parámetro para especificar un token que proporcione la identidad de un usuario que tenga permisos para acceder al servicio. La página de seguridad y autenticación ofrece más información sobre cómo se puede obtener un token de acceso.

token=<yourToken>

f

Utilice este parámetro para especificar el formato de respuesta. El parámetro puede tener html, json o pjson como argumentos, por ejemplo, f=json. El valor pjson se utiliza para imprimir la respuesta JSON en un formato embellecido.

travelMode

Seleccione el modo de transporte para el análisis.

Los modos de viaje se administran en ArcGIS Enterprise y el administrador de su organización puede configurarlos para reflejar mejor los flujos de trabajo de la organización.

Para obtener más información sobre los modos de viaje, consulte Configurar modos de viaje.

El valor del parámetro travelMode es el objeto JSON que contiene la configuración de un modo de viaje compatible con su organización. Para obtener los modos de viaje admitidos, ejecute el servicio retrieveTravelModes.

Puede hacer una solicitud para recuperar modos de viaje utilizando el siguiente formulario:

https://machine.domain.com/webadaptor/rest/services/Routing/NetworkAnalysis/NAServer/Route/retrieveTravelModes?f=json&token=<yourToken>

El servicio retrieveTravelModes devuelve la respuesta siguiente.

{
  "currentVersion": 10.8,
  "defaultTravelMode": "FEgifRtFndKNcJMJ",
  "supportedTravelModes": [
    {
      "attributeParameterValues": [
        {
          "parameterName": "Restriction Usage",
          "attributeName": "Avoid Private Roads",
          "value": "AVOID_MEDIUM"
        },
        {
          "parameterName": "Restriction Usage",
          "attributeName": "Walking",
          "value": "PROHIBITED"
        },
        {
          "parameterName": "Restriction Usage",
          "attributeName": "Preferred for Pedestrians",
          "value": "PREFER_LOW"
        },
        {
          "parameterName": "Walking Speed (km/h)",
          "attributeName": "WalkTime",
          "value": 5
        },
        {
          "parameterName": "Restriction Usage",
          "attributeName": "Avoid Roads Unsuitable for Pedestrians",
          "value": "AVOID_HIGH"
        }
      ],
      "description": "Follows paths and roads that allow pedestrian traffic and finds
                     solutions that optimize travel time. The walking speed is set to
                     5 kilometers per hour.",
      "impedanceAttributeName": "WalkTime",
      "simplificationToleranceUnits": "esriMeters",
      "uturnAtJunctions": "esriNFSBAllowBacktrack",
      "restrictionAttributeNames": [
        "Avoid Private Roads",
        "Avoid Roads Unsuitable for Pedestrians",
        "Preferred for Pedestrians",
        "Walking"
      ],
      "useHierarchy": false,
      "simplificationTolerance": 2,
      "timeAttributeName": "WalkTime",
      "distanceAttributeName": "Kilometers",
      "type": "WALK",
      "id": "caFAgoThrvUpkFBW",
      "name": "Walking Time"
    },
    {
      "attributeParameterValues": [
        {
          "parameterName": "Restriction Usage",
          "attributeName": "Avoid Unpaved Roads",
          "value": "AVOID_HIGH"
        },
        {
          "parameterName": "Restriction Usage",
          "attributeName": "Avoid Private Roads",
          "value": "AVOID_MEDIUM"
        },
        {
          "parameterName": "Restriction Usage",
          "attributeName": "Driving an Automobile",
          "value": "PROHIBITED"
        },
        {
          "parameterName": "Restriction Usage",
          "attributeName": "Through Traffic Prohibited",
          "value": "AVOID_HIGH"
        },
        {
          "parameterName": "Vehicle Maximum Speed (km/h)",
          "attributeName": "TravelTime",
          "value": 0
        },
        {
          "parameterName": "Restriction Usage",
          "attributeName": "Roads Under Construction Prohibited",
          "value": "PROHIBITED"
        },
        {
          "parameterName": "Restriction Usage",
          "attributeName": "Avoid Gates",
          "value": "AVOID_MEDIUM"
        },
        {
          "parameterName": "Restriction Usage",
          "attributeName": "Avoid Express Lanes",
          "value": "PROHIBITED"
        },
        {
          "parameterName": "Restriction Usage",
          "attributeName": "Avoid Carpool Roads",
          "value": "PROHIBITED"
        }
      ],
      "description": "Models the movement of cars and other similar small automobiles,
                      such as pickup trucks, and finds solutions that optimize travel
                      time. Travel obeys one-way roads, avoids illegal turns, and
                      follows other rules that are specific to cars. When you specify
                      a start time, dynamic travel speeds based on traffic are used
                      where it is available.",
      "impedanceAttributeName": "TravelTime",
      "simplificationToleranceUnits": "esriMeters",
      "uturnAtJunctions": "esriNFSBAtDeadEndsAndIntersections",
      "restrictionAttributeNames": [
        "Avoid Unpaved Roads",
        "Avoid Private Roads",
        "Driving an Automobile",
        "Through Traffic Prohibited",
        "Roads Under Construction Prohibited",
        "Avoid Gates",
        "Avoid Express Lanes",
        "Avoid Carpool Roads"
      ],
      "useHierarchy": true,
      "simplificationTolerance": 10,
      "timeAttributeName": "TravelTime",
      "distanceAttributeName": "Kilometers",
      "type": "AUTOMOBILE",
      "id": "FEgifRtFndKNcJMJ",
      "name": "Driving Time"
    }
  ]
}

Desde el JSON anterior, para pasar Walking Time como modo de viaje, utilice el siguiente JSON como valor para el parámetro travelMode:

travelMode={"attributeParameterValues": [{"parameterName": "Restriction Usage","attributeName": "Walking","value": "PROHIBITED"},{"parameterName": "Restriction Usage","attributeName": "Preferred for Pedestrians","value": "PREFER_LOW"},{"parameterName": "Walking Speed (km/h)","attributeName": "WalkTime","value": 5}],"description": "Follows paths and roads that allow pedestrian traffic and finds solutions that optimize travel time. The walking speed is set to 5 kilometers per hour.","impedanceAttributeName": "WalkTime","simplificationToleranceUnits": "esriMeters","uturnAtJunctions": "esriNFSBAllowBacktrack","restrictionAttributeNames": ["Preferred for Pedestrians","Walking"],"useHierarchy": false,"simplificationTolerance": 2,"timeAttributeName": "WalkTime","distanceAttributeName": "Miles","type": "WALK","id": "caFAgoThrvUpkFBW","name": "Walking Time"}

startTime

Indicate the time that travel begins from the input stops. You can also specify the now value to set the depart time to the current time.

Al especificar una hora del día, se obtienen estimaciones más precisas de tiempos de viaje porque los tiempos de viaje tienen en cuenta las condiciones del tráfico aplicables a esa fecha y hora.

To use traffic in the analysis, set impedanceAttributeName to TravelTime, and assign a value to startTime.

The startTime value represents the target start time of the routes in the analysis. The time is specified as UNIX time (milliseconds since midnight, January 1, 1970).

If the now value is used for the startTime parameter, the travel begins at the current time. This causes the startTimeIsUTC parameter value to be true. When startTime is nowand startTimeIsUTC is true, the travel will begin at input locations at the current time regardless of the time zone in which the input locations reside.

Si no se aprueba una hora del día, el servicio utiliza velocidades de carretera estáticas basadas en velocidades históricas promedio o límites de velocidad permitidos. Utiliza las velocidades permitidas en áreas donde la información de tráfico histórico no está disponible.

Cuando el servicio utiliza datos de ArcGIS StreetMap Premium, puede admitir dos tipos de tráfico: en directo y típico.

If the startTime value specified is within four hours of the current time, live traffic will be used where available. Live traffic retrieves speeds based on phone probe records, sensors, and other data sources and reflects the current travel speeds and predicts speeds for the near future. If the startTime value specified is more than four hours earlier or later than the current time, or the road does not have live traffic, typical traffic speeds will be used. Typical speeds are based on historical traffic patterns. The travel time data is aggregated in 15 minute intervals per day of the week based on multiple years worth of data. Consequently, a road may have a different travel time at Monday at 8 a.m., Monday at 8:15 a.m., or Tuesday at 8 a.m. Since the variance is at the day of week and time of day, the travel time is the same on a road for any Monday at 8 a.m., regardless of the month or year.

Si su objetivo es modelar las condiciones típicas de viaje y evitar grandes varianzas respecto a la media debido al tráfico en directo, se recomienda usar una fecha del pasado para garantizar que no coincida con la ventana de 4 horas desde la hora actual. Como ejemplo extremo, incluso puede utilizar fechas de 1990.

ArcGIS Online Directions and Routing Services Coverage muestra los países para los que Esri proporciona actualmente datos de tráfico.

"startTime": 631458180000

"startTime": 631731600000

"startTime": now

"startTime": 1426674000000

startTimeIsUTC

Especifique la zona o zonas horarias del parámetro startTime.

Falso (utilizar zonas horarias geográficamente locales)

El valor startTime hace referencia a la zona horaria en la que se encuentra la primera parada de cada ruta. La hora de inicio utiliza la zona horaria geográficamente local de la primera parada.

La siguiente imagen ilustra cómo establecer el valor en false (geográficamente local). Establecer startTime como 9:00, 4 de enero de 1990 (631443600000 milisegundos) y startTimeIsUTC a false, y enviar una solicitud válida causa que los tiempos de conducción para los puntos de la zona horaria del este empiecen a las 9:00 (14:00 UTC).

Verdadero (usar UTC)

El valor startTime hace referencia a la hora universal coordinada (UTC). Las horas de inicio son simultáneas para todos los puntos, independientemente de las zonas horarias.

La siguiente imagen ilustra cómo establecer el valor en true (UTC). Establecer startTime como 9:00, 4 de enero de 1990 (631443600000 milisegundos); y startTimeIsUTC como true hace que el tiempo de inicio de los puntos en la zona horaria del este sean las 4:00, hora del este, y las 3:00, hora del centro, para quienes se encuentren en la zona horaria central.

timeWindowsAreUTC

Especifique si los valores de los atributos TimeWindowStart y TimeWindowEnd en las paradas están especificados en hora UTC o en hora geográficamente local. Los valores posibles para este parámetro son true o false.

See the startTimeIsUTC section for an explanation of UTC versus local time.

findBestSequence

Utilice este parámetro para especificar si el servicio reorganizará las paradas para encontrar la ruta optimizada. Si el valor del parámetro es false, el servicio devuelve una ruta que visita las paradas en el orden que usted defina. Si el valor del parámetro es true, el servicio encuentra el mejor orden para visitar las paradas. El servicio tendrá en cuenta una variedad de variables para minimizar la distancia o el tiempo total de viaje para la ruta. Usted puede conservar las paradas de origen y destino y permitir que el servicio reordene las paradas intermedias definiendo los parámetros preserveFirstStop y preserveLastStop.

preserveFirstStop

Utilice este parámetro para indicar si el servicio mantendrá la primera parada fija al reordenar las paradas. Los valores posibles del parámetro son true o false. Este parámetro solo es aplicable si el valor del parámetro findBestSequence es true.

preserveLastStop

Utilice este parámetro para indicar si el servicio mantendrá la última parada fija al reordenar las paradas. Los valores posibles del parámetro son true o false. Este parámetro solo es aplicable si el valor del parámetro findBestSequence es true.

useTimeWindows

Utilice este parámetro para indicar si el servicio considerará ventanas de tiempo especificadas en las paradas al buscar la ruta mejor. Los valores posibles del parámetro son true o false. Las ventanas de tiempo se especifican en las paradas usando los atributos TimeWindowStart y TimeWindowEnd.

El valor predeterminado es false.

restrictUTurns

Use este parámetro para restringir o permitir que la ruta haga cambios de sentido en los cruces.

Para comprender los valores del parámetro disponibles, un cruce es un punto donde solo hay dos calles que intersecan entre sí. Si hay tres o más calles que se intersecan en un punto, se llama intersección. Un cul-de-sac es una calle sin salida. Este parámetro puede tener los siguientes valores:

Valor del parámetro	Descripción
esriNFSBAllowBacktrack	Los cambios de sentido están permitidos en todas partes. Permitir los cambios de sentido implica que el vehículo puede girar en un cruce y volver por la misma calle.
esriNFSBAtDeadEndsAndIntersections	Los cambios de sentido están prohibidos en los cruces donde se cruzan dos calles.
esriNFSBAtDeadEndsOnly	Los cambios de sentido están prohibidos en todos los cruces y todas las intersecciones y solo se permiten en calles sin salida.
esriNFSBNoBacktrack	Los cambios de sentido están prohibidos en todos los cruces, todas las intersecciones y todas las calles sin salida. Aunque se elija este valor para el parámetro, una ruta puede hacer cambios de sentido en paradas. Para prohibir los cambios de sentido en una parada, puede cambiar la propiedad CurbApproach al valor adecuado (3).

useHierarchy

Especifique si se usará la jerarquía para buscar las rutas más cortas.

• true: usar la jerarquía al viajar entre paradas. Cuando se usa una jerarquía, el servicio da preferencia a las calles de orden superior (como las autovías) frente a las de orden inferior (como las carreteras locales), y se puede usar para simular la preferencia del conductor de viajar por autovías en lugar de carreteras locales, aunque suponga un viaje más largo. Esto se da especialmente al buscar rutas hasta ubicaciones lejanas, porque los conductores que realizan viajes de larga distancia prefieren viajar por autovías y así evitar paradas, intersecciones y giros. Desde el punto de vista del cómputo, usar la jerarquía es más rápido, especialmente en rutas de larga distancia, porque el servicio puede determinar la ruta mejor en un subconjunto de calles relativamente más pequeño.

• false: no usar la jerarquía al viajar entre paradas. Si no se utiliza la jerarquía, el servicio tiene en cuenta todas las calles y no da preferencia a las calles de mayor orden al buscar una ruta. A menudo esto se usa al buscar rutas a corta distancia dentro de una ciudad.

impedanceAttributeName

Especifique la impedancia.

La impedancia es un valor que cuantifica el viaje a lo largo de la red de transporte. La distancia de viaje es un ejemplo de impedancia; cuantifica la longitud de caminos y segmentos de la carretera. Del mismo modo, el tiempo de conducción (el tiempo típico que lleva conducir un coche a lo largo de un segmento de carretera), es un ejemplo de impedancia. Los tiempos de conducción pueden variar según el tipo de vehículo (por ejemplo, el tiempo que un camión tarda en viajar a lo largo de una ruta suele ser más largo que el de un coche) por lo que pueden existir muchos valores de impedancia que representan los tiempos de viaje para distintos tipos de vehículos. Los valores de la impedancia también pueden variar con el tiempo; el tráfico en directo y típico hace referencia a los valores de la impedancia dinámica. Cada recorrido a pie y segmento de carretera almacena al menos un valor de impedancia. Al realizar un análisis de red, los valores de impedancia se utilizan para calcular los mejores resultados, como buscar la ruta más corta (la ruta que minimiza la impedancia) entre dos puntos.

The impedanceAttributeName parameter can be specified using the following values:

• TravelTime: se utilizan datos de tráfico históricos y en directo. Esta opción resulta útil para modelar el tiempo que tardan los automóviles en desplazarse por carreteras a una hora concreta del día utilizando datos de velocidad del tráfico en directo si están disponibles. Si utiliza TravelTime, si lo desea puede definir el parámetro de atributos TravelTime::Vehicle Maximum Speed (km/h) para especificar los límites físicos de la velocidad a la que el vehículo es capaz de desplazarse.
• Minutos: no se utilizan datos de tráfico en directo, sino velocidades medias históricas de los datos de automóviles.
• TruckTravelTime: se utilizan datos de tráfico históricos y en directo, pero se establece una velocidad máxima al límite de velocidad especificado para camiones. Resulta útil para modelar el tiempo que tardan los camiones en desplazarse por carreteras a una hora concreta del día. Si utiliza TruckTravelTime, si lo desea puede definir el parámetro de atributos TruckTravelTime::Vehicle Maximum Speed (km/h) para especificar los límites físicos de la velocidad a la que el camión es capaz de desplazarse.
• TruckMinutes: no utiliza datos de tráfico en directo, pero sí utiliza las velocidades más bajas del promedio histórico para automóviles y los límites de velocidad permitidos para camiones.
• WalkTime: el valor predeterminado es una velocidad de 5 km/h en todas las carreteras y caminos, pero se puede configurar mediante el parámetro de atributos WalkTime::Walking Speed (km/h).
• Millas: las mediciones de longitud de carreteras se almacenan en millas y se pueden utilizar para realizar análisis según la distancia más corta.
• Kilómetros: las mediciones de longitud de carreteras se almacenan en kilómetros y se pueden utilizar para realizar análisis según la distancia más corta.

accumulateAttributeNames

Utilice este parámetro para especificar si el servicio acumulará valores además del valor especificado de impedanceAttributeName. Por ejemplo, si impedanceAttributeName tiene el valor TravelTime, el servicio calculará el tiempo de viaje total para la ruta. Sin embargo, si también desea calcular la distancia total de la ruta en millas, puede especificar Miles como el valor del parámetro accumulateAttributeNames.

Especifique el valor del parámetro como una lista de nombres separados por comas. Los valores del parámetro son los mismos que los del parámetro impedanceAttributeName. Por ejemplo, accumulateAttributeNames=Miles,Kilometers indica que el coste total de la ruta también se calculará en millas y kilómetros.

restrictionAttributeNames

Utilice este parámetro para especificar las restricciones que cumplirá el servicio. Una restricción representa una preferencia o un requisito de conducción. En la mayoría de casos, las restricciones ocasionan la prohibición de carreteras o rutas, pero también pueden hacer que se eviten o se les dé preferencia. Por ejemplo, utilizar la restricción Avoid Toll Roads dará como resultado una ruta que incluirá las carreteras de peaje solo si se requiere viajar por ellas para llegar a una parada. Utilice Height Restriction para trazar una ruta evitando cualquier lugar con una distancia al suelo que sea inferior a la altura del vehículo. Si el vehículo transporta materiales peligrosos, puede utilizar la restricción Any Hazmat Prohibited para impedir que los materiales se transporten por carreteras donde sea ilegal hacerlo.

Este valor de parámetro se especifica como una lista de nombres de restricción separados por comas. El valor none indica que no se utilizarán restricciones para buscar las rutas más cortas.

The restrictionAttributeNames parameter can be specified using the following values:

• Prohibidos todos los materiales peligrosos: los resultados no incluirán las carreteras en las que esté prohibido el transporte de cualquier tipo de material peligroso.

• Evitar carreteras VAO: el resultado evitará las carreteras designadas exclusivamente para los vehículos compartidos.

• Evitar carriles rápidos: los resultados evitarán las carreteras diseñadas como carriles rápidos.

• Evitar transbordadores: los resultados evitarán los transbordadores.

• Evitar puertas: los resultados evitarán las carreteras en las que haya puertas, como los accesos con clave o las entradas controladas por guardas.

• Evitar carreteras con acceso limitado: los resultados evitarán las carreteras que sean de acceso limitado.

• Evitar carreteras privadas: los resultados evitarán las carreteras que no sean de propiedad pública y no se mantengan con recursos públicos.

• Evitar las carreteras no aptas para peatones: los resultados evitarán las carreteras que no sean aptas para peatones.

• Evitar tramos de escalera: los resultados evitarán todos los tramos de escalera de una ruta adecuada para peatones.

• Evitar carreteras de peaje: los resultados evitarán todas las carreteras de peaje para automóviles.

• Evitar carreteras de peaje para camiones: los resultados evitarán todas las carreteras de peaje para camiones.

• Evitar carreteras con restricciones para camiones: los resultados evitarán las carreteras donde no estén permitidos los camiones excepto para hacer entregas.

• Evitar carreteras sin pavimentar: los resultados evitarán las carreteras que no estén pavimentadas (de tierra, de gravilla, etc.).

• Restricción de número de ejes: los resultados no incluirán carreteras en las que los camiones con el número especificado de ejes estén prohibidos. El número de ejes se puede especificar mediante el parámetro de restricción Número de ejes.

• Conduciendo autobús: los resultados no incluirán carreteras en las que estén prohibidos los autobuses. Usar esta restricción también garantizará que los resultados respetarán las calles con sentido único.

• Conduciendo taxi: los resultados no incluirán carreteras en las que estén prohibidos los taxis. Usar esta restricción también garantizará que los resultados respetarán las calles con sentido único.

• Conduciendo camión: los resultados no incluirán carreteras en las que estén prohibidos los camiones. Usar esta restricción también garantizará que los resultados respetarán las calles con sentido único.

• Conduciendo automóvil: los resultados no incluirán carreteras en las que estén prohibidos los automóviles. Usar esta restricción también garantizará que los resultados respetarán las calles con sentido único.

• Conduciendo vehículo de emergencia: los resultados no incluirán carreteras en las que estén prohibidos los vehículos de emergencia. Usar esta restricción también garantizará que los resultados respetarán las calles con sentido único.

• Restricción de altura: los resultados no incluirán las carreteras en las que la altura del vehículo supere la altura máxima permitida para la carretera. La altura del vehículo se puede especificar usando el parámetro de restricción Altura del vehículo (metros).

• Restricción de longitud de eje de dirección a eje trasero: los resultados no incluirán las carreteras en las que la longitud del vehículo supere la distancia máxima permitida entre el eje de dirección y el eje trasero para la carretera. La longitud entre el eje de dirección y el eje trasero se puede especificar usando el parámetro de restricción Longitud de eje de dirección a eje trasero del vehículo (metros).

• Restricción de longitud: los resultados no incluirán las carreteras en las que la longitud del vehículo supere la longitud máxima permitida para la carretera. La longitud del vehículo se puede especificar usando el parámetro de restricción Longitud del vehículo (metros).

• Preferido para peatones: los resultados utilizarán rutas preferidas adecuadas para la navegación para peatones.

• En moto: los resultados no incluirán carreteras en las que estén prohibidas las motocicletas. Usar esta restricción también garantizará que los resultados respetarán las calles con sentido único.

• Prohibidas las carreteras en obras: los resultados no incluirán carreteras que estén en obras.

• Prohibidos los camiones o tractores con uno o varios remolques: los resultados no incluirán las carreteras en las que estén prohibidos los camiones o tractores con uno o varios remolques.

• Prohibidos los vehículos de un solo eje: los resultados no incluirán carreteras en las que los vehículos de un solo eje estén prohibidos.

• Prohibidos los vehículos de doble eje: los resultados no incluirán carreteras en las que los vehículos de doble eje estén prohibidos.

• Prohibido el tráfico de paso: los resultados no incluyen las carreteras donde no se permita el tráfico de paso (tráfico no local).

• Restricción de camiones con remolques: los resultados no incluirán carreteras en las que los camiones con el número especificado de remolques estén prohibidos. El número de remolques del camión se puede especificar mediante el parámetro de restricción Número de remolques del camión.

• Usar rutas preferidas para materiales peligrosos: los resultados darán prioridad a las carreteras designadas para el transporte de materiales peligrosos.

• Usar rutas preferidas para camiones: los resultados darán prioridad a las carreteras que se hayan diseñado como rutas para camiones, como las que forman parte de la red nacional descrita en la National Surface Transportation Assistance Act de Estados Unidos, las carreteras que se hayan diseñado como rutas de camiones en un estado o una provincia, o aquellas que prefieran los camioneros cuando conducen por un área.

• A pie: los resultados no incluirán carreteras en las que estén prohibidos los peatones.

• Restricción de peso: los resultados no incluirán las carreteras en las que el peso del vehículo supere el peso máximo permitido para la carretera. El peso del vehículo se puede especificar usando el parámetro de restricción Peso del vehículo (kilogramos).

• Restricción de peso por eje: los resultados no incluirán las carreteras en las que el peso del vehículo por eje supere el peso máximo permitido por eje para la carretera. El peso por eje del vehículo se puede especificar usando el parámetro de restricción Peso por eje del vehículo (kilogramos).

• Restricción de ancho: los resultados no incluirán las carreteras en las que el ancho del vehículo supere el ancho máximo permitido para la carretera. El ancho del vehículo se puede especificar usando el parámetro de restricción Ancho del vehículo (metros).

El atributo de restricción Driving a Delivery Vehicle ya no está disponible. El servicio ignorará esta restricción, puesto que no es válida. Para obtener unos resultados similares, use el atributo de restricción Driving a Truck junto con el atributo de restricción Avoid Truck Restricted Roads.

El valor de parámetro restrictionAttributeName se especifica como una lista de nombres de restricción. Un valor de null indica que no se utilizarán restricciones para buscar la ruta mejor, sino solo si travelMode tiene el valor null.

attributeParameterValues

Utilice este parámetro para especificar valores adicionales requeridos por un atributo o restricción, como por ejemplo para especificar si la restricción prohíbe, evita o prefiere circular en carreteras restringidas. Si la restricción se ha ideado para evitar carreteras o darles preferencia, puede especificar en qué medida se deben evitar o se les debe dar preferencia usando este parámetro. Por ejemplo, puede elegir que nunca se usen carreteras de peaje, que se eviten en la medida de lo posible o que se les dé preferencia.

Este valor de parámetro se especifica como una matriz de objetos, cada uno con las siguientes propiedades:

• attributeName: el nombre de la restricción.

• parameterName: el nombre del parámetro asociado con la restricción. Una restricción puede tener una o más propiedades de parameterName.

• value: el valor de parameterName.

La mayoría de parámetros de atributos están relacionados con los atributos de restricción en restrictionAttributeNames. Cada restricción tiene por lo menos un parámetro de atributos llamado Restriction Usage, que especifica si la restricción prohíbe, evita o prefiere los viajes por las carreteras asociadas con la restricción y en qué medida las carreteras se evitan o tienen preferencia. Es posible asignar al parámetro Restriction Usage cualquiera de los siguientes valores de cadena de caracteres o sus valores numéricos equivalentes entre paréntesis:

• Prohibited (-1): está prohibido viajar por las carreteras que presenten esta restricción.
• Avoid_High (5): es muy improbable que el servicio incluya en la ruta las carreteras asociadas a esta restricción.
• Avoid_Medium (2): es improbable que el servicio incluya en la ruta las carreteras asociadas a esta restricción.
• Avoid_Low (1.3): es algo improbable que el servicio incluya en la ruta las carreteras asociadas a esta restricción.
• Prefer_Low (0.8): es algo probable que el servicio incluya en la ruta las carreteras asociadas a esta restricción.
• Prefer_Medium (0.5): es probable que el servicio incluya en la ruta las carreteras asociadas a esta restricción.
• Prefer_High (0.2): es muy probable que el servicio incluya en la ruta las carreteras asociadas a esta restricción.

En la siguiente tabla, se muestran los nombres de parámetro de atributos y los valores predeterminados de los parámetros.

[
    {
        "attributeName": "<attribute1>",
        "parameterName": "<parameter1>",
        "value": "<value1>"
    },
    {
        "attributeName": "<attribute2>",
        "parameterName": "<parameter2>",
        "value": "<value2>"
    }
]

attributeParameterValues=
[
    {
        "attributeName": "Height Restriction",
        "parameterName": "Vehicle Height (meters)",
        "value": 4.12
    },
    {
        "attributeName": "Weight Restriction",
        "parameterName": "Vehicle Weight (kilograms)",
        "value": 36287
    },
    {
        "attributeName": "Use Preferred Truck Routes",
        "parameterName": "Restriction Usage",
        "value": "Prefer_High"
    }
]

barriers

Utilice este parámetro para especificar uno o varios puntos que actuarán como restricciones temporales o representen el tiempo o la distancia adicionales que puede que se necesiten para viajar en las calles subyacentes. Por ejemplo, una barrera de punto se puede usar para representar un árbol caído en una calle o el retraso acumulado en un cruce de ferrocarril.

Puede utilizar una sintaxis simple basada en comas y en punto y coma si pasa las ubicaciones de barrera de punto con sus valores de longitud y latitud en el sistema de coordenadas WGS84 y no necesita pasar campos adicionales para cada ubicación.

Sintaxis simple para barreras

barriers=x1,y1; x2, y2; ...; xn, yn

Ejemplo con la sintaxis simple

barriers=-117.1957,34.0564; -117.184,34.0546

You can specify barrier geometries as well as attributes using a more comprehensive JSON structure that references a set of features. The property is optional; however, the JSON structure must specify either the url, features, or layer property:

• url: especifique una solicitud de consulta REST para cualquier entidad, mapa o servicio de geoprocesamiento de ArcGIS Server que devuelva un conjunto de entidades JSON.

  La estructura JSON puede incluir esta propiedad:

  • doNotLocateOnRestrictedElements (opcional): especifique si los elementos de red restringidos se considerarán al buscar ubicaciones de red. El valor predeterminado es true.

• features: especifique una matriz de entidades.

  Cada entidad de la matriz representa una barrera de punto y contiene los siguientes campos:

  • geometry: especifique la geometría de punto de entrada que contenga las propiedades x y y junto con la propiedad spatialReference. Si la propiedad spatialReference se define para todo el JSON, no es necesario que defina esta propiedad para cada geometría. Al hacerlo, se reduce el tamaño del JSON de entrada si la entrada tiene muchas entidades y también mejora el rendimiento. Esta propiedad no es necesaria si las coordenadas están en la referencia espacial predeterminada, WGS84. Si las coordenadas están en una referencia espacial diferente, debe especificar el Id. conocido de la referencia espacial (WKID). Consulte Utilizar referencias espaciales para buscar valores de WKID.

    Sugerencia:

    Se recomienda especificar explícitamente el valor de spatialReference y especificarlo para todo el JSON en lugar de para cada geometría individual.

  • attributes: especifique cada atributo como un par de clave-valor donde la clave es el nombre de un campo dado y el valor es el valor de atributo del campo correspondiente.

  The JSON structure can include the following property:

  • doNotLocateOnRestrictedElements (opcional): especifique si los elementos de red restringidos se considerarán al buscar ubicaciones de red. El valor predeterminado es true.

• layer—Specify a feature layer in the map service. Attribute and spatial filters can also be applied on the layer. The JSON structure can include the following properties:
  • type—Set the type property to layer to indicate that you're specifying the point barriers by referencing a layer.
  • layerName: el nombre o Id. de la capa de datos en el servicio de mapas al que se hace referencia.
  • where (opcional): una cláusula WHERE para el filtro de consulta. Se permite cualquier cláusula WHERE de SQL legal que funcione en los campos de la capa.
  • geometry (opcional): la geometría que se aplica como filtro espacial. La estructura de la geometría coincide con la estructura de los objetos de geometría JSON devueltos por la ArcGIS REST API.

    El tipo de geometría se especifica usando la propiedad geometryType.

  • geometryType (opcional): el tipo de geometría especificado por la propiedad geometry. Los tipos de geometría compatibles son sobre, punto, línea y polígono. El tipo de geometría predeterminado es esriGeometryEnvelope.

    Valores: esriGeometryPoint | esriGeometryMultipoint | esriGeometryPolyline | esriGeometryPolygon | esriGeometryEnvelope

  • spatialRel (opcional): la relación espacial que se aplicará en geometry de entrada. Entre las relaciones espaciales admitidas se incluyen interseca, contiene, el sobre interseca, dentro de, etc. La relación espacial predeterminada es esriSpatialRelIntersects.

    Valores: esriSpatialRelIntersects | esriSpatialRelContains | esriSpatialRelCrosses | esriSpatialRelEnvelopeIntersects | esriSpatialRelIndexIntersects | esriSpatialRelOverlaps | esriSpatialRelTouches | esriSpatialRelWithin

  • doNotLocateOnRestrictedElements (opcional): especifique si los elementos de red restringidos se considerarán al buscar ubicaciones de red. El valor predeterminado es true.

{
  "spatialReference": {
    "wkid": <wkid>,
    "latestWkid": <wkid>
  },
  "features": [
    {
      "geometry": {
        "x": <x>,
        "y": <y>
      },
      "attributes": {
        "<field1>": <value11>,
        "<field2>": <value12>
      }
    },
    {
      "geometry": {
        "x": <x>,
        "y": <y>
      },
      "attributes": {
        "<field1>": <value21>,
        "<field2>": <value22>
      }
    }
  ],
  "doNotLocateOnRestrictedElements": true | false
}

{
  "url": "<url>"
  "doNotLocateOnRestrictedElements": true | false
}

{ 
  "type" : "layer",
  "layerName" : "<layerName>",
  "where" : "<whereClause>",
  "geometry" : {<geometry>},
  "geometryType" : "<geometryType>",
  "spatialRel" : "<spatialRel>"
  "doNotLocateOnRestrictedElements": true | false
}

{
  "spatialReference": {
    "wkid": 4326
  },
  "features": [
    {
      "geometry": {
        "x": -122.053461,
        "y": 37.541479
      },
      "attributes": {
        "Name": "Haley St rail road crossing",
        "BarrierType": 2,
        "Attr_TravelTime": 5
      }
    }
  ]
}

{
  "url": "https://machine.domain.com/webadaptor/rest/services/Network/USA/MapServer/0/query?where=1%3D1&returnGeometry=true&f=json"
}

{ 
  "type" : "layer",
  "layerName" : "TrafficAccidents",
  "where" : "SEVERITY > 0"
}

polylineBarriers

Utilice este parámetro para especificar una o varias líneas que prohíban viajar a cualquier ubicación en la que las líneas se intersequen con las calles. Por ejemplo, un desfile o una protesta que bloquee el tráfico por varios segmentos de calle se puede modelar con una barrera de línea. Una barrera de línea también puede cercar rápidamente varios caminos para que no se puedan atravesar, alejando así las posibles rutas de las partes no deseadas de la red de calles.

You can specify polyline barrier geometries as well as attributes using a JSON structure that references a set of features. The property is optional; however, the JSON structure must specify either the url, features, or layer property:

• url: especifique una solicitud de consulta REST para cualquier entidad, mapa o servicio de geoprocesamiento de ArcGIS Server que devuelva un conjunto de entidades JSON.

  La estructura JSON puede incluir esta propiedad:

  • doNotLocateOnRestrictedElements (opcional): especifique si los elementos de red restringidos se considerarán al buscar ubicaciones de red. El valor predeterminado es true.

• features: especifique una matriz de entidades.

  Cada entidad de la matriz representa una barrera de polilínea y contiene los siguientes campos:

  • geometry: especifique la geometría de punto de entrada que contenga las propiedades x y y junto con la propiedad spatialReference. Si la propiedad spatialReference se define para todo el JSON, no es necesario que defina esta propiedad para cada geometría. Al hacerlo, se reduce el tamaño del JSON de entrada si la entrada tiene muchas entidades y también mejora el rendimiento. Esta propiedad no es necesaria si las coordenadas están en la referencia espacial predeterminada, WGS84. Si las coordenadas están en una referencia espacial diferente, debe especificar el Id. conocido de la referencia espacial (WKID). Consulte Utilizar referencias espaciales para buscar valores de WKID.

    Sugerencia:

    Se recomienda especificar explícitamente el valor de spatialReference y especificarlo para todo el JSON en lugar de para cada geometría individual.

  • attributes: especifique cada atributo como un par de clave-valor donde la clave es el nombre de un campo dado y el valor es el valor de atributo del campo correspondiente.

  The JSON structure can include the following property:

  • doNotLocateOnRestrictedElements (opcional): especifique si los elementos de red restringidos se considerarán al buscar ubicaciones de red. El valor predeterminado es true.

• layer—Specify a feature layer in the map service. Attribute and spatial filters can also be applied on the layer. The JSON structure can include the following properties:
  • type—Set the type property to layer to indicate that you're specifying the polyline barriers by referencing a layer.
  • layerName: el nombre o Id. de la capa de datos en el servicio de mapas al que se hace referencia.
  • where (opcional): una cláusula WHERE para el filtro de consulta. Se permite cualquier cláusula WHERE de SQL legal que funcione en los campos de la capa.
  • geometry (opcional): la geometría que se aplica como filtro espacial. La estructura de la geometría coincide con la estructura de los objetos de geometría JSON devueltos por la ArcGIS REST API.

    El tipo de geometría se especifica usando la propiedad geometryType.

  • geometryType (opcional): el tipo de geometría especificado por la propiedad geometry. Los tipos de geometría compatibles son sobre, punto, línea y polígono. El tipo de geometría predeterminado es esriGeometryEnvelope.

    Valores: esriGeometryPoint | esriGeometryMultipoint | esriGeometryPolyline | esriGeometryPolygon | esriGeometryEnvelope

  • spatialRel (opcional): la relación espacial que se aplicará en geometry de entrada. Entre las relaciones espaciales admitidas se incluyen interseca, contiene, el sobre interseca, dentro de, etc. La relación espacial predeterminada es esriSpatialRelIntersects.

    Valores: esriSpatialRelIntersects | esriSpatialRelContains | esriSpatialRelCrosses | esriSpatialRelEnvelopeIntersects | esriSpatialRelIndexIntersects | esriSpatialRelOverlaps | esriSpatialRelTouches | esriSpatialRelWithin

  • doNotLocateOnRestrictedElements (opcional): especifique si los elementos de red restringidos se considerarán al buscar ubicaciones de red. El valor predeterminado es true.

{
  "spatialReference": {
    "wkid": <wkid>,
    "latestWkid": <wkid>
  },
  "features": [
    {
      "geometry": {
        "paths": [
          [
            [<x11>,<y11>],
            [<x12>,<y12>]
          ],
          [
            [<x21>,<y21>],
            [<x22>,<y22>]
          ]
        ],
      },
      "attributes": {
        "<field1>": <value11>,
        "<field2>": <value12>
      }
    },
    {
      "geometry": {
        "paths": [
          [
            [<x11>,<y11>],
            [<x12>,<y12>]
          ],
          [
            [<x21>,<y21>],
            [<x22>,<y22>]
          ]
        ]
      },
      "attributes": {
        "<field1>": <value21>,
        "<field2>": <value22>
      }
    }
  ],
  "doNotLocateOnRestrictedElements": true | false
}

{
  "url": "<url>"
  "doNotLocateOnRestrictedElements": true | false
}

{ 
  "type" : "layer",
  "layerName" : "<layerName>",
  "where" : "<whereClause>",
  "geometry" : {<geometry>},
  "geometryType" : "<geometryType>",
  "spatialRel" : "<spatialRel>"
  "doNotLocateOnRestrictedElements": true | false
}

{
  "spatialReference": {
    "wkid": 102100
  },
  "features": [
    {
      "geometry": {
        "paths": [
          [
            [-10804823.397,3873688.372],
            [-10804811.152,3873025.945]
          ]
        ]
      },
      "attributes": {
        "Name": "Barrier 1"
      }
    },
    {
      "geometry": {
        "paths": [
          [
            [-10804823.397,3873688.372],
            [-10804807.813,3873290.911],
            [-10804811.152,3873025.945]
          ],
          [
            [-10805032.678,3863358.76],
            [-10805001.508,3862829.281]
          ]
        ]
      },
      "attributes": {
        "Name": "Barrier 2"
      }
    }
  ]
}

{
  "url": "https://machine.domain.com/webadaptor/rest/services/Network/USA/MapServer/6/query?where=1%3D1&returnGeometry=true&f=json"
}

{ 
  "type" : "layer",
  "layerName" : "PolylineBarrier"
}

polygonBarriers

Utilice este parámetro para especificar polígonos que restrinjan completamente el viaje o ajusten de una forma proporcional el tiempo o la distancia que se requieren para viajar por las calles que se intersecan con los polígonos.

You can specify polygon barrier geometries as well as attributes using a JSON structure that references a set of features. The property is optional; however, the JSON structure must specify either the url, features, or layer property:

• url: especifique una solicitud de consulta REST para cualquier entidad, mapa o servicio de geoprocesamiento de ArcGIS Server que devuelva un conjunto de entidades JSON.

  La estructura JSON puede incluir esta propiedad:

  • doNotLocateOnRestrictedElements (opcional): especifique si los elementos de red restringidos se considerarán al buscar ubicaciones de red. El valor predeterminado es true.

• features: especifique una matriz de entidades.

  Cada entidad de la matriz representa una barrera de polígono y contiene los siguientes campos:

  • geometry: especifique la geometría de punto de entrada que contenga las propiedades x y y junto con la propiedad spatialReference. Si la propiedad spatialReference se define para todo el JSON, no es necesario que defina esta propiedad para cada geometría. Al hacerlo, se reduce el tamaño del JSON de entrada si la entrada tiene muchas entidades y también mejora el rendimiento. Esta propiedad no es necesaria si las coordenadas están en la referencia espacial predeterminada, WGS84. Si las coordenadas están en una referencia espacial diferente, debe especificar el Id. conocido de la referencia espacial (WKID). Consulte Utilizar referencias espaciales para buscar valores de WKID.

    Sugerencia:

    Se recomienda especificar explícitamente el valor de spatialReference y especificarlo para todo el JSON en lugar de para cada geometría individual.

  • attributes: especifique cada atributo como un par de clave-valor donde la clave es el nombre de un campo dado y el valor es el valor de atributo del campo correspondiente.

  The JSON structure can include the following property:

  • doNotLocateOnRestrictedElements (opcional): especifique si los elementos de red restringidos se considerarán al buscar ubicaciones de red. El valor predeterminado es true.

• layer—Specify a feature layer in the map service. Attribute and spatial filters can also be applied on the layer. The JSON structure can include the following properties:
  • type—Set the type property to layer to indicate that you're specifying the polygon barriers by referencing a layer.
  • layerName: el nombre o Id. de la capa de datos en el servicio de mapas al que se hace referencia.
  • where (opcional): una cláusula WHERE para el filtro de consulta. Se permite cualquier cláusula WHERE de SQL legal que funcione en los campos de la capa.
  • geometry (opcional): la geometría que se aplica como filtro espacial. La estructura de la geometría coincide con la estructura de los objetos de geometría JSON devueltos por la ArcGIS REST API.

    El tipo de geometría se especifica usando la propiedad geometryType.

  • geometryType (opcional): el tipo de geometría especificado por la propiedad geometry. Los tipos de geometría compatibles son sobre, punto, línea y polígono. El tipo de geometría predeterminado es esriGeometryEnvelope.

    Valores: esriGeometryPoint | esriGeometryMultipoint | esriGeometryPolyline | esriGeometryPolygon | esriGeometryEnvelope

  • spatialRel (opcional): la relación espacial que se aplicará en geometry de entrada. Entre las relaciones espaciales admitidas se incluyen interseca, contiene, el sobre interseca, dentro de, etc. La relación espacial predeterminada es esriSpatialRelIntersects.

    Valores: esriSpatialRelIntersects | esriSpatialRelContains | esriSpatialRelCrosses | esriSpatialRelEnvelopeIntersects | esriSpatialRelIndexIntersects | esriSpatialRelOverlaps | esriSpatialRelTouches | esriSpatialRelWithin

  • doNotLocateOnRestrictedElements (opcional): especifique si los elementos de red restringidos se considerarán al buscar ubicaciones de red. El valor predeterminado es true.

{
  "spatialReference": {
    "wkid": <wkid>,
    "latestWkid": <wkid>
  },
  "features": [
    {
      "geometry": {
        "rings": [
          [
            [<x11>,<y11>],
            [<x12>,<y12>],
            [<x11>,<y11>]
          ],
          [
            [<x21>,<y21>],
            [<x22>,<y22>],
            [<x21>,<y21>]
          ]
        ]
      },
      "attributes": {
        "<field1>": <value11>,
        "<field2>": <value12>
      }
    },
    {
      "geometry": {
        "rings": [
          [
            [<x11>,<y11>],
            [<x12>,<y12>],
            [<x11>,<y11>]
          ],
          [
            [<x21>,<y21>],
            [<x22>,<y22>],
            [<x21>,<y21>]
          ]
        ]
      },
      "attributes": {
        "<field1>": <value21>,
        "<field2>": <value22>
      }
    }
  ],
  "doNotLocateOnRestrictedElements": true | false
}

{
  "url": "<url>"
  "doNotLocateOnRestrictedElements": true | false
}

{ 
  "type" : "layer",
  "layerName" : "<layerName>",
  "where" : "<whereClause>",
  "geometry" : {<geometry>},
  "geometryType" : "<geometryType>",
  "spatialRel" : "<spatialRel>"
  "doNotLocateOnRestrictedElements": true | false
}

{
  "spatialReference": {
    "wkid": 4326
  },
  "features": [
    {
      "geometry": {
        "rings": [
          [
            [-97.0634,32.8442],
            [-97.0554,32.84],
            [-97.0558,32.8327],
            [-97.0638,32.83],
            [-97.0634,32.8442]
          ]
        ]
      },
      "attributes": {
        "Name": "Flood zone",
        "BarrierType": 0
      }
    },
    {
      "geometry": {
        "rings": [
          [
            [-97.0803,32.8235],
            [-97.0776,32.8277],
            [-97.074,32.8254],
            [-97.0767,32.8227],
            [-97.0803,32.8235]
          ],
          [
            [-97.0871,32.8311],
            [-97.0831,32.8292],
            [-97.0853,32.8259],
            [-97.0892,32.8279],
            [-97.0871,32.8311]
          ]
        ]
      },
      "attributes": {
        "Name": "Severe weather zone",
        "BarrierType": 1,
        "Attr_TravelTime": 3
      }
    }
  ]
}

{
  "url": "https://machine.domain.com/webadaptor/rest/services/Network/USA/MapServer/7/query?where=1%3D1&returnGeometry=true&f=json"
}

{ 
  "type" : "layer",
  "layerName" : "PolygonBarrier"
}

returnDirections

Especifique si el servicio generará indicaciones de conducción para cada ruta.

The default value is true.

• true: generar indicaciones. Las indicaciones se configuran en función de los valores de los parámetros directionsLanguage, directionsOutputType, directionsStyleName y directionsLengthUnits. Las indicaciones estarán disponibles en la propiedad directions de la respuesta JSON.

• false: no generar indicaciones.

directionsLanguage

El idioma que se utilizará para generar las indicaciones de viaje.

This parameter applies only when the returnDirections parameter is set to true. The service supports generating directions in the following languages:

• ar: árabe
• bg: búlgaro
• bs: bosnio
• ca: catalán
• cs: checo
• da: danés
• de: alemán
• el: griego
• en: inglés
• es: español
• et: estonio
• fi: finés
• fr: francés
• he: hebreo
• hr: croata
• hu: húngaro
• id: indonesio
• it: italiano
• ja: japonés
• ko: coreano
• lt: lituano
• lv: letón
• nb: noruego
• nl: neerlandés
• pl: polaco
• pt-BR: portugués (Brasil)
• pt-PT: portugués (Portugal)
• ro: rumano
• ru: ruso
• sk: eslovaco
• sl: esloveno
• sr: serbio
• sv: sueco
• th: tailandés
• tr: turco
• uk: ucraniano
• vi: vietnamita
• zh-CN: chino (China)
• zh-HK: chino (Hong Kong)
• zh-TW: chino (Taiwán)

El servicio intenta buscar una coincidencia exacta del idioma especificado, incluida cualquier localización de idioma. Si no se encuentra ninguna coincidencia exacta, intenta hacer una coincidencia con la familia lingüística. Si no se encuentra ninguna coincidencia, el servicio devuelve las indicaciones en el idioma predeterminado del sistema operativo del servidor. Por ejemplo, si el idioma de las indicaciones se especifica como es-MX (español de México), el servicio generará las indicaciones en español, puesto que admite el código de idioma es, no es-MX.

directionsOutputType

Defina el contenido y texto de las indicaciones de conducción. Este parámetro solo se aplica si el parámetro returnDirections está establecido en true. Este parámetro se puede especificar mediante estos valores:

• esriDOTComplete: la salida de indicaciones incluye todas las propiedades de indicaciones.
• esriDOTCompleteNoEvents: la salida de indicaciones incluye todas las propiedades de indicaciones excepto los eventos.
• esriDOTInstructionsOnly: salida de indicaciones incluye instrucciones de texto, tiempo, longitud y hora estimada de llegada. Las indicaciones no incluyen geometría.
• esriDOTStandard: la salida de indicaciones incluye instrucciones de texto, tiempo, longitud, hora estimada de llegada y geometría. Las indicaciones no incluyen eventos, nuevos tipos de cadenas de caracteres (nombres de calles, información de postes indicadores), tipo de maniobra, rumbos ni ángulo de giro.
• esriDOTSummaryOnly: la salida de indicaciones contiene un resumen (tiempo y longitud). No se incluyen instrucciones detalladas de texto ni geometría.
• esriDOTFeatureSets: la salida de indicaciones incluye dos conjuntos de entidades, puntos de dirección y líneas de dirección. El conjunto de puntos de dirección contiene entidades de puntos que representan las maniobras de dirección como llegar a o salir de una parada, girar a izquierda o derecha y otros eventos a lo largo de la ruta. Este conjunto de entidades contiene también las indicaciones paso a paso de la ruta. El conjunto de líneas de dirección contiene entidades de línea para cada segmento de la ruta. Este conjunto de entidades se puede utilizar para visualizar las indicaciones paso a paso en un mapa.

El valor predeterminado es esriDOTStandard.

directionsStyleName

Especifique el nombre del estilo de formato de las indicaciones. Este parámetro se puede especificar mediante estos valores:

• NA Desktop: genera indicaciones paso a paso adecuadas para imprimir.
• NA Navigation: genera indicaciones paso a paso diseñadas para un dispositivo de navegación desde el vehículo.
• NA Campus: genera indicaciones paso a paso a pie, diseñadas para rutas de peatones.

Este parámetro solo se aplica si el parámetro returnDirections está establecido en true.

directionsLengthUnits

Especifique las unidades para mostrar la distancia de viaje en las indicaciones de conducción. Este parámetro solo se aplica si el parámetro returnDirections está establecido en true. Este parámetro se puede especificar mediante estos valores:

• esriNAUFeet
• esriNAUKilometers
• esriNAUMeters
• esriNAUMiles
• esriNAUNauticalMiles
• esriNAUYards

El valor predeterminado es esriNAUMiles.

directionsTimeAttributeName

Establezca el atributo de impedancia basado en el tiempo para visualizar la duración de una maniobra, como "Diríjase al noroeste por Cl. Alvarado durante 5 minutos". Las unidades para todos los atributos de tiempo son minutos.

• TravelTime: tiempo de viaje para un coche
• Minutes: tiempo de viaje para un coche sin usar datos de tráfico en directo
• TruckTravelTime: tiempo de viaje para un camión
• TruckMinutes: tiempo de viaje para un camión sin usar datos de tráfico en directo
• WalkTime: tiempo de viaje para un peatón

returnRoutes

Utilice este parámetro para especificar si el servicio devolverá rutas.

El valor predeterminado es true.

• true: se devuelven rutas. Las rutas están disponibles en la propiedad routes de la respuesta JSON. La forma de las rutas depende del valor del parámetro outputLines.
• false: no se devuelven rutas.

outputLines

Use este parámetro para especificar el tipo de entidades de ruta que constituyen la salida del servicio. Este parámetro solo es aplicable si el parámetro returnRoutes está establecido en true. El parámetro outputLines puede tener uno de los valores siguientes:

• esriNAOutputLineTrueShape: devolver la forma exacta de la ruta resultante basada en las calles subyacentes.

• esriNAOutputLineTrueShapeWithMeasure: devolver la forma exacta de la ruta resultante basada las calles subyacentes e incluir mediciones de ruta que rastreen el tiempo de viaje o distancia de viaje acumulativos a lo largo de la ruta relativa a la primera parada. Cuando se elige este valor para el parámetro outputLines, cada punto de la forma de la ruta incluirá un valor m junto con los valores x e y. El valor m, también conocido como valor de medición, indica el tiempo de viaje acumulado o la distancia de viaje acumulada en ese punto a lo largo de la ruta. Los valores m se pueden utilizar para determinar a qué distancia ha viajado desde el inicio de la ruta o la distancia restante o el tiempo restante para llegar al destino. Los valores m están en las mismas unidades que el atributo de impedancia.

• esriNAOutputLineStraight: devuelve una línea recta entre las paradas.

• esriNAOutputLineNone: no devuelve ninguna forma para las rutas. Este valor puede ser útil si solo le interesa determinar el tiempo o la distancia total de viaje de la ruta. Por ejemplo, si la aplicación ha calculado la ruta y, transcurrido algún tiempo, calculará la hora estimada de llegada al destino, puede establecer el parámetro returnRoutes como true y el parámetro outputLines como esriNAOutputLineNone. La propiedad routes de la respuesta JSON solo contendrá el tiempo total de viaje que se pueda utilizar para determinar la hora estimada de llegada. Dado que la forma de la ruta no se devuelve al utilizar el valor esriNAOutputLineNone, el tamaño de la respuesta será considerablemente menor.

returnStops

Use este parámetro para especificar si el servicio devolverá las paradas. Los valores posibles para este parámetro son true o false. Un valor true indica que las paradas usadas como entradas se devuelven como parte de la propiedad stops en la respuesta JSON. El valor predeterminado de este parámetro es false.

Al buscar rutas optimizadas, la propiedad returnStops se puede establecer como true para determinar la secuencia óptima en la que la ruta visita una parada en particular revisando la propiedad Sequence en la respuesta JSON. Si especificó el valor del parámetro stops mediante una solicitud de consulta REST para cualquier servicio de geoprocesamiento, mapas o entidades de ArcGIS Server que devuelva un conjunto de entidades JSON, puede definir el parámetro returnStops como true para poder dibujar las ubicaciones de paradas en la aplicación. También puede establecer la propiedad returnStops como true para determinar si se han ubicado correctamente las paradas en la red de calles o hubo otros errores al revisar la propiedad Status en la respuesta JSON.

returnBarriers

Especifique si el servicio devolverá barreras.

• true: las barreras de punto de entrada se devuelven como parte de la propiedad barriers de la respuesta JSON.
• false: no se devuelven barreras de punto. Esta es la opción predeterminada.

Para que este parámetro tenga efecto, debe especificar también un valor para el parámetro barriers.

Si especificó el valor del parámetro barriers mediante una solicitud de consulta REST para cualquier servicio de geoprocesamiento, mapas o entidades de ArcGIS Server que devuelva un conjunto de entidades JSON, puede definir el parámetro returnBarriers como true para poder dibujar las ubicaciones de barreras de punto en la aplicación. También puede definir la propiedad returnBarriers como true para ver dónde se han localizado las barreras en la red de calles o, si no estaban ubicadas, comprender cuál era el problema al revisar la propiedad Status de la respuesta JSON.

returnPolylineBarriers

Especifique si el servicio devolverá barreras de polilínea.

• true: las barreras de polilínea de entrada se devuelven como parte de la propiedad polylineBarriers en la respuesta JSON.
• false: no se devuelven barreras de polilínea. Esta es la opción predeterminada.

Para que este parámetro tenga efecto, debe especificar también un valor para el parámetro polylineBarriers.

Si especificó el valor del parámetro polylineBarriers mediante una solicitud de consulta REST para cualquier servicio de geoprocesamiento, mapas o entidades de ArcGIS Server que devuelva un conjunto de entidades JSON, puede definir el parámetro returnPolylineBarriers como true para poder dibujar las ubicaciones de barreras de polilínea en la aplicación.

returnPolygonBarriers

Especifique si el servicio devolverá barreras de polígono.

• true: las barreras de polígono de entrada se devuelven como parte de la propiedad polygonBarriers en la respuesta JSON.
• false: no se devuelven barreras de polígono. Esta es la opción predeterminada.

Para que este parámetro tenga efecto, debe especificar también un valor para el parámetro polygonBarriers.

Si especificó el valor del parámetro polygonBarriers mediante una solicitud de consulta REST para cualquier servicio de geoprocesamiento, mapas o entidades de ArcGIS Server que devuelva un conjunto de entidades JSON, puede definir el parámetro returnPolygonBarriers como true para poder dibujar las ubicaciones de barreras de polígono en la aplicación.

returnTraversedEdges

Especifique si el servicio devolverá los ejes en los que se ha realizado el trazado poligonal.

• true: los ejes en los que se ha realizado el trazado poligonal se devuelven como parte de la respuesta JSON.
• false: los ejes en los que se ha realizado el trazado poligonal no se devolverán.

Si el parámetro está establecido en true, los ejes en los que se ha realizado el trazado poligonal estarán disponibles en la propiedad traversedEdges de la respuesta JSON.

El valor predeterminado es false

returnTraversedJunctions

Especifique si el servicio devolverá los cruces en los que se ha realizado el trazado poligonal.

• true: los cruces en los que se ha realizado el trazado poligonal se devuelven como parte de la respuesta JSON.
• false: los cruces en los que se ha realizado el trazado poligonal no se devolverán.

Si el parámetro está establecido en true, los cruces en los que se ha realizado el trazado poligonal estarán disponibles en la propiedad traversedJunctions de la respuesta JSON.

El valor predeterminado es false

returnTraversedTurns

Especifique si el servicio devolverá los giros en los que se haya realizado el trazado poligonal.

• true: los giros en los que se ha realizado el trazado poligonal se devuelven como parte de la respuesta JSON.
• false: los giros en los que se ha realizado el trazado poligonal no se devuelven.

Si el parámetro está establecido en true, los giros en los que se ha realizado el trazado poligonal están disponibles en la propiedad traversedTurns de la respuesta JSON.

El valor predeterminado es false

returnZ

Incluye valores z para las geometrías devueltas si es compatible con la red subyacente. El valor predeterminado es false.

• true: las geometrías de salida tendrán un valor z.
• false (predeterminado): no se devuelve ningún valor x.

ignoreInvalidLocations

Especifique si se ignorarán las ubicaciones de entrada no válidas al buscar la mejor solución. El servicio considera que un punto de entrada no es válido si no está dentro de la tolerancia de alineación máxima de cualquier calle transitable.

• true: se ignoran los puntos no válidos.
• false: cualquier punto no válido en la solicitud hará que el servicio devuelva un error.

El valor predeterminado es true.

outSR

Utilice este parámetro para especificar la referencia espacial de las geometrías, como entidades de líneas o puntos, que devuelve un servicio.

El valor del parámetro se puede especificar como un Id. conocido (WKID) para la referencia espacial. Consulte Utilizar referencias espaciales para buscar valores de WKID.

Muchos de los mapas base proporcionados por ArcGIS Online están en la referencia espacial Web Mercator (WKID 102100). Al especificar outSR=102100 se devuelven las geometrías de la referencia espacial Web Mercator, que se pueden dibujar sobre los mapas base.

outputGeometryPrecision

Utilice este parámetro para especificar el nivel de simplificación de la geometría de las rutas devueltas por el servicio.

La simplificación mantiene puntos críticos de una ruta, como los giros en intersecciones, para definir la forma esencial de la ruta y quita el resto de los puntos. La distancia de simplificación que especifique será el desplazamiento máximo permisible que puede apartarse la línea simplificada de la línea original. La simplificación de una línea reduce el número de vértices que forman parte de la geometría de la ruta. Con ello se reduce el tamaño global de la respuesta y también se mejora el rendimiento a la hora de dibujar las formas de las rutas en las aplicaciones.

Las unidades se especifican con el parámetro outputGeometryPrecisionUnits.

outputGeometryPrecisionUnits

Utilice este parámetro para especificar las unidades del valor del parámetro outputGeometryPrecision.

Especifique uno de los valores siguientes:

• esriCentimeters
• esriDecimalDegrees
• esriDecimeters
• esriFeet
• esriInches
• esriKilometers
• esriMeters
• esriMiles
• esriMillimeters
• esriNauticalMiles
• esriPoints
• esriYards

geometryPrecision

Utilice este parámetro para especificar el número de posiciones decimales que se utilizarán en las geometrías de respuesta devueltas por la operación de resolución. Esto se aplica solo a los valores x e y (no a los valores m o z).

geometryPrecision = 3

geometryPrecisionZ

Utilice este parámetro para especificar el número de posiciones decimales que se utilizarán en las geometrías de respuesta devueltas por la operación de resolución. Esto se aplica solo a los valores z (no a los valores x, y o m).

geometryPrecisionZ = 3

geometryPrecisionM

Utilice este parámetro para especificar el número de posiciones decimales que se utilizarán en las geometrías de respuesta devueltas por la operación de resolución. Esto se aplica solo a los valores m (no a los valores x, y o z).

geometryPrecisionM = 3

overrides

preserveObjectID

Utilice este parámetro para especificar si los Id. de objeto especificados para ubicaciones de entrada tales como paradas o barreras se conservarán cuando las ubicaciones de entrada se devuelvan como salida. Esto puede ser útil si desea asociar atributos adicionales con las ubicaciones de salida después de que la operación de resolución sea correcta y necesita un campo clave común para hacer la unión.

Por ejemplo, las paradas de entrada se especifican como la siguiente representación JSON de un conjunto de entidades:

{
  "spatialReference": {
    "wkid": 4326
  },
  "features": [
    {
      "geometry": {
        "x": -122.473948,
        "y": 37.7436
      },
      "attributes": {
        "ObjectID": 40,
        "Name": "Depot"
      }
    },
    {
      "geometry": {
        "x": -122.439613,
        "y": 37.746144
      },
      "attributes": {
        "ObjectID": 20,
        "Name": "Store 1"
      }
    },
    {
      "geometry": {
        "x": -122.488254,
        "y": 37.754092
      },
      "attributes": {
        "ObjectID": 30,
        "Name": "Store 2"
      }
    },
    {
      "geometry": {
        "x": -122.44915,
        "y": 37.731837
      },
      "attributes": {
        "ObjectID": 10,
        "Name": "Store 3"
      }
    }
  ]
}

Si resuelve una ruta y especifica preserveObjectID=false, las paradas de salida tendrán los Id. de objeto 1, 2, 3 y 4, aunque las paradas de entrada tengan los Id. de objeto 10, 20, 30 y 40. Sin embargo, si preserveObjectID=true, las paradas de salida tendrán los mismos Id. de objeto que las entradas: 10, 20, 30 y 40.

locateSettings

Use este parámetro para especificar configuraciones que afecten a cómo se ubican las entradas, como la máxima distancia de búsqueda que se usa al localizar las entradas en la red, o las fuentes de red que se usan para localizar. Para restringir la ubicación en una parte del origen, puede especificar una cláusula WHERE para un origen.

Más información sobre la localización de entradas

El valor de parámetro se especifica como un objeto JSON. El objeto JSON le permite especificar un JSON de localizador para todas las entidades de entrada en el análisis o puede especificar una excepción para una entrada concreta. La excepción le permite tener diferentes ajustes para cada entrada de análisis. Por ejemplo, es posible no permitir que las paradas se ubiquen en las rampas de autopista y permitir que las barreras de punto se ubiquen en las rampas de autopista. Al especificar el JSON locateSettings, deberá proporcionar todas las propiedades, incluidas tolerance, toleranceUnits, sources y allowAutoRelocate en el objeto JSON de localizador predeterminado. La cláusula where para cada fuente es opcional. Si necesita proporcionar un JSON de localizador diferente para una clase de entrada en particular, debe incluir la propiedad de invalidaciones para esa entrada. El nombre de propiedad debe coincidir con el nombre del parámetro de entrada. El JSON del localizador de una entrada concreta no tiene que incluir todas las propiedades; solo tiene que incluir las propiedades que son distintas de las propiedades del JSON del localizador predeterminado.

El objeto JSON del localizador tiene las siguientes propiedades:

• tolerance y toleranceUnits: permite controlar la distancia máxima de búsqueda al localizar las entradas. Si no se encuentra ninguna ubicación de red válida dentro de esta distancia, la entidad de entrada se considerará no ubicada. Una pequeña tolerancia de búsqueda disminuye la probabilidad de ubicarse en la calle equivocada, pero aumenta la probabilidad de no encontrar ninguna ubicación de red válida. El valor del parámetro toleranceUnits se puede especificar como uno de los siguientes valores:
  • esriCentimeters
  • esriDecimalDegrees
  • esriDecimeters
  • esriFeet
  • esriInches
  • esriIntFeet
  • esriIntInches
  • esriIntMiles
  • esriIntNauticalMiles
  • esriIntYards
  • esriKilometers
  • esriMeters
  • esriMiles
  • esriMillimeters
  • esriNauticalMiles
  • esriYards
• sources: le permite controlar qué fuente de red se puede utilizar para la ubicación. Por ejemplo, puede configurar el análisis para localizar entradas en calles, pero no en aceras. La lista de posibles fuentes en las que localizar es específica del dataset de red al que hace referencia este servicio. Solo se usan para ubicar las fuentes que estén presentes en la matriz de fuentes. Es posible especificar una cláusula where en cada fuente especificada en la matriz de fuentes para restringir aún más la localización en ese origen que coincida con ciertas características mediante una expresión SQL. Por ejemplo, puede configurar el análisis para que localice las entradas solo en las entidades de calles que coincidan con determinadas clases de carreteras, como evitar las rampas de las autopistas. Las fuentes se especifican como una matriz de objetos, cada uno con las siguientes propiedades:
  • name: nombre de la clase de entidad de la fuente de red que se puede usar para ubicar entradas.
  • where: una expresión SQL en la clase de entidad de fuente de red.
• allowAutoRelocate: permite controlar si las entradas con campos de ubicación de red existentes se pueden reubicar automáticamente al solucionar para garantizar que se disponga de campos de ubicación enrutables y válidos para el análisis. Si el valor es true, los puntos ubicados en elementos de red restringidos y los puntos afectados por las barreras se reubicarán en la ubicación enrutable más cercana. Si el valor es false, los campos de ubicación de red se utilizarán como están, aunque los puntos no sean accesibles, y esto puede hacer que la resolución falle. Aunque el valor sea false, las entradas sin campos de ubicación o campos de ubicación incompletos se localizarán durante la operación de resolución.

{
  "default": {
    "tolerance": <value>,
    "toleranceUnits": "<unit>",
    "allowAutoRelocate": true | false,
    "sources": [
      {
        "name": "<sourceName>",
        "where": "<whereClause>"
      }
    ]
  },
  "overrides": {
    "stops": {
      "tolerance": <value>,
      "toleranceUnits": "<unit>",
      "allowAutoRelocate": true | false,             
      "sources": [
        {
          "name": "<sourceName>",
          "where": "<whereClause>"
        }
      ]
    },
    "barriers": {
      "tolerance": <value>,
      "toleranceUnits": "<unit>",
      "allowAutoRelocate": true | false,             
      "sources": [
        {
          "name": "<sourceName>",
          "where": "<whereClause>"
        }
      ]
    },
    "polylineBarriers": {
      "allowAutoRelocate": true | false,       
      "sources": [
        {
          "name": "<sourceName>",
          "where": "<whereClause>"
        }
      ]
    },
    "polygonBarriers": {
      "allowAutoRelocate": true | false,  
      "sources": [
        {
          "name": "<sourceName>",
          "where": "<whereClause>"
        }
      ]
    }
  }
}

{
  "default": {
    "tolerance": 500,
    "toleranceUnits": "esriMeters",
    "allowAutoRelocate": true,
    "sources": [
      {
        "name": "Routing_Streets"
      }
    ]
  }
}

{
  "default": {
    "tolerance": 20,
    "toleranceUnits": "esriKilometers",
    "allowAutoRelocate": true,
    "sources": [
      {
        "name": "Routing_Streets"
      }
    ]
  },
  "overrides": {
    "stops": {
      "sources": [
        {
          "name": "Routing_Streets",
          "where": "ROAD_CLASS <> 3"
        }
      ]
    }
  }
}

{
  "default": {
    "tolerance": 20,
    "toleranceUnits": "esriKilometers",
    "allowAutoRelocate": true,
    "sources": [
      {
        "name": "Routing_Streets"
      }
    ]
  },
  "overrides": {
    "barriers": {
      "sources": [
        {
          "name": "Routing_ND_Junctions"
        }
      ]
    }
  }
}

returnEmptyResults

Especifique si el servicio devolverá resultados vacíos en lugar de la propiedad de error cuando la solicitud falle.

• true: la respuesta JSON no contiene la propiedad de error cuando la solicitud falla. Todos los errores se devuelven en la propiedad messages. El JSON de respuesta puede contener un conjunto de entidades vacío o un resultado vacío para las propiedades que solicitó.
• false: la respuesta JSON solo contiene la propiedad de error cuando la solicitud falla.

El valor predeterminado es false.

Normalmente, cuando una solicitud falla, el servicio devuelve una respuesta JSON que contiene la propiedad de error. En algunos casos, es posible que desee definir returnEmptyResults como true para que siempre devuelva las propiedades solicitadas en lugar de devolver una respuesta de error para ayudar a manejar la respuesta de forma más coherente.

Incluso si la solicitud falla, cuando se establece returnEmptyResults = true y returnStops = true, puede volver a las paradas para investigar por qué algunas de ellas no se han localizado.

routes

Ofrece acceso a las rutas resultantes.

La siguiente tabla muestra los campos que se devuelven para las rutas de salida:

stops

Ofrece acceso a los atributos de las paradas que visitan las rutas, así como las paradas que no puede alcanzar ninguna de las rutas.

Puede usar los atributos de este parámetro, como el campo Status, para determinar el motivo por el que una parada no se asignó a ninguna ruta.

barriers

This provides access to points that act as temporary restrictions or represent additional time or distance that may be required to travel on the underlying streets.

polylineBarriers

This provides access to one or more lines that prohibit travel anywhere the lines intersect the streets.

polygonBarriers

This provides access to polygons that either completely restrict travel or proportionately scale the time or distance required to travel on the streets intersected by the polygons.

traversedEdges

Este parámetro ofrece acceso a los ejes que se atraviesan al resolver una capa de análisis de red.

traversedJunctions

Este parámetro ofrece acceso a los cruces que se atraviesan al resolver una capa de análisis de red.

traversedTurns

Este parámetro ofrece acceso a los giros que se atraviesan al resolver una capa de análisis de red.

directions

Ofrece acceso a las indicaciones paso a paso para cada ruta resultante.

The data type supports the following fields:

directionPoints

Especifica las indicaciones paso a paso de salida para las rutas calculadas en el análisis, representadas como ubicaciones de puntos a lo largo de las rutas donde se producen eventos o maniobras de indicación específicos.

directionLines

Especifica las líneas de ruta de salida calculadas en el análisis dividido en zonas para representar cada segmento de ruta entre ubicaciones de eventos o maniobras de DirectionPoints.

JSON Response syntax for a successful request

{
  "directions": [
    {
      "routeId": <routeId>,
      "routeName": "<routeName>",
      "summary": {
        "totalLength": <totalLength>,
        "totalTime": <totalTime>,
        "totalDriveTime": <totalDriveTime>,
        "envelope": {<envelope>}
      },
      "hasZ": <true|false>,
      "hasM": <true|false>,
      "features": [
        {
          "attributes": {
            "length": <length1>,
            "time": <time1>,
            "text": "<text1>",
            "ETA": <ETA>,
            "maneuverType": "<maneuverType1>"
          },
          "compressedGeometry": "<compressedGeometry1>"
        },
        {
          "attributes": {
            "length": <length2>,
            "time": <time2>,
            "text": "<text2>",
            "maneuverType": "<maneuverType2>"
          },
          "compressedGeometry": "<compressedGeometry2>"
        }
      ]
    }
  ],
  "routes": {
    "spatialReference": {<spatialReference>},
    "hasZ": <true|false>,
    "hasM": <true|false>,
    "features": [
      {
        "attributes": {
          "<field1>": <value11>,
          "<field2>": <value12>
        },
        "geometry": {<polyline1>}
      },
      {
        "attributes": {
          "<field1>": <value21>,
          "<field2>": <value22>
        },
        "geometry": {<polyline2>}
      }
    ]
  },
  "stops": {
    "spatialReference": {<spatialReference>},
    "hasZ": <true|false>,
    "features": [
      {
        "attributes": {
          "<field1>": <value11>,
          "<field2>": <value12>
        },
        "geometry": {<point1>}
      },
      {
        "attributes": {
          "<field1>": <value21>,
          "<field2>": <value22>
        },
        "geometry": {<point2>}
      }
    ]
  },
  "barriers": {
    "spatialReference": {<spatialReference>},
    "hasZ": <true|false>,
    "features": [
      {
        "attributes": {
          "<field1>": <value11>,
          "<field2>": <value12>
        },
        "geometry": {<point1>}
      },
      {
        "attributes": {
          "<field1>": <value21>,
          "<field2>": <value22>
        },
        "geometry": {<point2>}
      }
    ]
  },  
  "traversedEdges": {
    "spatialReference": {<spatialReference>},
    "features": [
      {
        "attributes": {
          "<field1>": <value11>,
          "<field2>": <value12>
        },
        "geometry": {<polyline1>}
      },
      {
        "attributes": {
          "<field1>": <value21>,
          "<field2>": <value22>
        },
        "geometry": {<polyline2>}
      }
    ]
  },
  "traversedJunctions": {
    "spatialReference": {<spatialReference>},
    "features": [
      {
        "attributes": {
          "<field1>": <value11>,
          "<field2>": <value12>
        },
        "geometry": {<point1>}
      },
      {
        "attributes": {
          "<field1>": <value21>,
          "<field2>": <value22>
        },
        "geometry": {<point2>}
      }
    ]
  },
  "traversedTurns": {
    "spatialReference": {<spatialReference>},
    "features": [
      {
        "attributes": {
          "<field1>": <value11>,
          "<field2>": <value12>
        }
      },
      {
        "attributes": {
          "<field1>": <value21>,
          "<field2>": <value22>
        }
      }
    ]
  },
  "messages": [
    {
      "type": <type1>,
      "description": "<description1>"
    },
    {
      "type": <type2>,
      "description": "<description2>"
    }
  ]
}

JSON Response syntax for a failed request

{
  "error": {
    "code": <code>,
    "message": "<message>",
    "details": [
      "<details>"
    ]
  }
}