Updates at 11.0

• Use locateSettings to specify settings that affect how inputs are located.
• Use returnEmptyResults to return empty results instead of error when the request fails.
• Use includeSourceInformationOnLines to specify whether the service should include network source fields on the output saPolylines.

Updates at 10.9.1

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 timeOfDay parameter to set your analysis to begin or end 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 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 timeOfDayIsUTC parameter to specify whether the timeOfDay parameter value is in UTC or the time zone of the facilities. Using UTC, you can start or end all the service areas at the same time regardless of the time zones in which the facilities 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 service area solver supports the new returnZ parameter. If returnZ=true and the service area solver is using a z-aware network dataset, service area lines will contain z-values on each vertex. Input point and line locations can have z-values on them.
• saPolylines and saPolygons values in the response include the hasZ and hasM properties that indicate whether they contain z-values or m-values, respectively.
• An optional url property that specifies input facilities, 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 a client as intermediate storage.
• UseHierarchy—Improves the performance of polygon generation. This parameter cannot be used in conjunction with outputLines.
• TimeOfDay—The 10.1 service area solver is time aware and can be used in conjunction with historic and real-time traffic information.

facilities

Las ubicaciones de entrada alrededor de las cuales se generan áreas de servicio.

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 facilities

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

Example using simple syntax

facilities=-117.1957,34.0564; -117.184,34.0546

The facilities 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 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.

  Each feature in the features array represents a facility 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 the user is specifying the facilities 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": "Fire Station 34",
        "Attr_TravelTime": 4
      }
    },
    {
      "geometry": {
        "x": -122.404,
        "y": 37.782
      },
      "attributes": {
        "Name": "Fire Station 29",
        "Attr_TravelTime": 5
      }
    }
  ]
}

{
  "spatialReference": {
    "wkid": 102100
  }
  "features": [
    {
      "geometry": {
        "x": -13635398.9398,
        "y": 4544699.034400001,
        
      },
      "attributes": {
        "Name": "Store 45",
        "Attr_Miles": 0.29
      }
    },
    {
      "geometry": {
        "x": -13632733.3441,
        "y": 4547651.028300002,
      },
      "attributes": {
        "Name": "Store 67",
        "Attr_Miles" : 0.31
      }
    }
  ]
}

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

{ 
  "type" : "layer",
  "layerName" : "Hospitals",
  "where" : "BEDS > 100"
}

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/ServiceArea/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"}

defaultBreaks

Use este parámetro para especificar el tamaño y el número de áreas de servicio a generar para cada instalación. El servicio genera áreas de servicio basadas en tiempo o distancia de viaje en función de las unidades de este parámetro. Si las unidades se basan en el tiempo, las áreas de servicio se generan en función del tiempo de viaje a lo largo de las calles subyacentes. Si las unidades se basan en la distancia, las áreas de servicio se generan en función de la distancia de viaje.

La unidad de este parámetro se basa en la unidad del atributo de impedancia especificado usando el parámetro impedanceAttributeName o el valor de impedanceAttributeName del modo de viaje si se especifica el modo de viaje. Si el parámetro impedanceAttributeName se define como TravelTime, los valores especificados como el parámetro defaultBreaks se interpretan en minutos y el servicio genera áreas de servicio basadas en el tiempo. De lo contrario, los valores se interpretan como millas o kilómetros en función de si el parámetro impedanceAttributeName tiene el valor Miles o Kilometers, respectivamente, y el servicio genera áreas de servicio en función de la distancia.

El valor de parámetro se especifica como una lista de valores dobles separados por comas.

Se pueden especificar varios descansos de área para crear áreas de servicio concéntricas por instalación. Por ejemplo, para encontrar áreas de servicio a 2, 3 y 5 millas para cada instalación, especifique defaultBreaks=2,3,5 y especifique Miles para impedanceAttributeName.

travelDirection

Especifica si la dirección de recorrido que se utiliza para generar los polígonos de área de servicio se acerca a las instalaciones o se aleja de ellas.

Este parámetro se especifica con estos valores:

• esriNATravelDirectionFromFacility: el área de servicio se genera en la dirección que se aleja de las instalaciones.
• esriNATravelDirectionToFacility: el área de servicio se genera en la dirección que va hacia las instalaciones.

La dirección de viaje puede cambiar la forma de los polígonos porque las impedancias en lados opuestos de las calles pueden diferir o pueden existir restricciones de un solo sentido, como calles de una sola vía. La dirección que debería elegir depende de la naturaleza de su análisis del área de servicio. El área de servicio de una tienda de entrega de pizzas, por ejemplo, se debe crear alejada de la instalación, mientras que el área de servicio de un hospital se debe crear cerca de la instalación.

timeOfDay

Specify the time and date to depart from or arrive at facilities. You can also specify the now value to set the depart or arrive 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.

Para usar el tráfico en el análisis, establezca impedanceAttributeName en TravelTime y asigne un valor de timeOfDay.

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

Si se pasa un valor de now al parámetro timeOfDay, el viaje comienza en la hora actual. También invalidará el valor del parámetro timeOfDayIsUTC para que sea true. Cuando timeOfDay es now y timeOfDayIsUTC es true, el viaje comenzará o finalizará en las ubicaciones de entrada a la hora actual, independientemente de la zona horaria de las ubicaciones de entrada.

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.

Si el valor de timeOfDay especificado está a menos de cuatro horas de la hora actual, se utilizará el tráfico en directo cuando esté disponible. El tráfico en directo recupera las velocidades en función de los registros desde teléfonos móviles, sensores y otras fuentes de datos y refleja las velocidades de viaje actuales y predice las velocidades del futuro cercano. Si el valor de timeOfDay especificado es más de cuatro horas anterior o posterior a la hora actual o si la carretera no tiene tráfico en directo, se utilizarán velocidades de tráfico típico. Las velocidades típicas se basan en patrones de tráfico históricos. Los datos de tiempo de viaje se agregan en intervalos de 15 minutos por día de la semana basándose en datos de varios años. Por consiguiente, una carretera puede tener un tiempo de viaje diferente un lunes a las 8:00 a.m., un lunes a las 8:15 a.m. o un martes a las 8:00 a.m. Dado que la varianza es en el día de la semana y en la hora del día, el tiempo de viaje es el mismo en una carretera para cualquier lunes a las 8:00 a.m., independientemente del mes o el año.

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.

"timeOfDay": 631458180000

"timeOfDay": 631731600000

"timeOfDay": now

"timeOfDay": 1426674000000

timeOfDayIsUTC

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

Falso (utilizar zonas horarias geográficamente locales)

El valor timeOfDay hace referencia a las zonas horarias locales en las que se encuentran los puntos de entrada. Esta opción hace que el análisis tenga horas de inicio rotativas en las diferentes zonas horarias.

La siguiente imagen ilustra cómo establecer el valor en false (geográficamente local). Establecer timeOfDay como 9:00, 4 de enero de 1990 (631443600000 milisegundos) y timeOfDayIsUTC como false, y enviar una solicitud válida provoca que los tiempos de conducción de puntos en la zona horaria del este empiecen a las 9:00 y a las 9:00 hora central para puntos en la zona horaria central. (Las horas de inicio tienen una variación de una hora respecto a la hora real o UTC).

Verdadero (usar UTC)

El valor timeOfDay 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 timeOfDay como 9:00, 4 de enero de 1990 (631443600000 milisegundos) y timeOfDayIsUTC 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 central para quienes se encuentren en la zona horaria central.

outputPolygons

Utilice este parámetro para especificar el tipo de áreas de servicio. Este parámetro se especifica con estos valores:

• esriNAOutputPolygonNone: no crear áreas de servicio. Resulta útil si no desea generar áreas alrededor de las instalaciones, pero desea generar líneas de área de servicio.
• esriNAOutputPolygonDetailed: crear áreas de servicio detalladas.
• esriNAOutputPolygonSimplified: crear áreas de servicio generalizadas.

Las áreas de servicio detalladas modelan las áreas de servicio con mayor precisión y es posible que se produzcan islas de áreas no accesibles en algunos casos. Las áreas de servicio generalizadas son bastante precisas en la mayoría de los casos. Sin embargo, en algunos casos, crear áreas de servicio generalizadas puede cubrir islas de áreas no alcanzadas y no sería deseable si su objetivo es encontrar dichas islas.

Si las instalaciones se encuentran en un área urbana con una red de calles de tipo cuadrícula, la diferencia entre las áreas de servicio generalizadas y detalladas será mínima. Sin embargo, si las instalaciones están en una región que contiene caminos rurales y de montaña, las áreas de servicio detalladas pueden presentar resultados más precisos que las áreas de servicio generalizadas.

splitPolygonsAtBreaks

Utilice este parámetro para especificar si se crean varias áreas de servicio alrededor de una instalación como discos o anillos.

• true: al crear varias áreas de servicio alrededor de una instalación, no se incluye la región cubierta por el área de servicio más pequeña en la región cubierta por el área de servicio más grande. Utilice esta opción para buscar el área de un corte a otro. Por ejemplo, si crea áreas de servicio de 5 y 10 minutos, las áreas de servicio de 10 minutos excluirán el área bajo las áreas de servicio de 5 minutos y aparecerán como anillos.
• false: al crear varias áreas de servicio alrededor de una instalación, cree áreas de servicio que van desde la instalación hasta el descanso. Por ejemplo, si crea áreas de servicio de 5 y 10 minutos, el área de servicio de 10 minutos incluirá el área bajo el área de servicio de 5 minutos.

overlapPolygons

Utilice este parámetro para especificar si las áreas de servicio de distintas instalaciones se pueden superponer entre sí.

• true: las áreas de servicio se pueden superponer entre sí.
• false: un área de servicio de una instalación no se puede superponer a áreas de servicio de otras instalaciones. Con esta opción, el área contenida en un área de servicio determinada está más cerca de la instalación correspondiente que cualquier otra instalación.

Este parámetro producirá el mismo resultado con cualquier valor cuando solo se especifique una instalación.

mergeSimilarPolygonRanges

Utilice este parámetro para especificar si las áreas de servicio de distintas instalaciones que tienen el mismo valor de descanso se unirán o dividirán en los valores de descanso.

• true: los polígonos de áreas de servicio de varias instalaciones con el mismo valor de descanso se fusionarán, dando como resultado una única entidad poligonal por valor de descanso.
• false: los polígonos de áreas de servicio de varias instalaciones con los mismos valores de descanso seguirán siendo entidades poligonales separadas.

Este parámetro producirá el mismo resultado con cualquier valor cuando solo se especifique una instalación.

trimOuterPolygons

Utilice este parámetro para especificar si las áreas de servicio se recortan. Resulta útil al buscar áreas de servicio en lugares que tienen una red de calles muy dispersa y no desea que el área de servicio abarque áreas grandes sin entidades de calles.

• true: las áreas de servicio se recortarán.
• false: las áreas de servicio no se recortarán.

El valor del parámetro se ignora si el parámetro useHierarchy tiene el valor true.

trimPolygonDistance

Utilice este parámetro para especificar la distancia dentro de la cual el polígono de área de servicio se extenderá desde la carretera cuando no haya cerca otras carreteras a las que se pueda acceder, de forma parecida al tamaño de una zona de influencia de línea. Este parámetro solo es aplicable si el parámetro trimOuterPolygons está establecido en true. El valor del parámetro se ignora si el parámetro useHierarchy tiene el valor true.

trimPolygonDistanceUnits

Utilice este parámetro para especificar las unidades del valor especificado como trimPolygonDistance. Este parámetro se puede especificar mediante uno de estos valores:

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

Este parámetro solo es aplicable si el parámetro trimOuterPolygons está establecido en true. El valor del parámetro se ignora si el parámetro useHierarchy tiene el valor true.

useHierarchy

Use este parámetro para especificar si se utilizará jerarquía para generar las áreas de servicio.

• true: el servicio utilizará la jerarquía. Cuando se generan áreas de servicio jerárquicas, el servicio prefiere calles de orden superior, como autovías, frente a calles de orden inferior, como carreteras locales. Significa que si una instalación se encuentra en una carretera local (el nivel más bajo en una jerarquía), el servicio abarca las carreteras locales en esa área, pero intenta aumentar la jerarquía a vías secundarias y principales. Una vez en vías secundarias o principales, el servicio omite las carreteras locales durante el resto del área de servicio. Principalmente debido a este enfoque jerárquico, las áreas de servicio jerárquicas se generan mucho más rápido en comparación con las áreas de servicio no jerárquicas, ya que el servicio tiene que generar áreas de servicio a partir de un subconjunto de calles relativamente más pequeño. Es posible usar áreas de servicio jerárquicas para simular la preferencia del conductor de viajar por autovías en lugar de carreteras locales, aunque esto suponga un viaje más largo. Sin embargo, las áreas pueden superponerse a algunas carreteras de menor orden a las que no se puede llegar dentro de una distancia de viaje o tiempo de viaje determinados. Por consiguiente, las áreas de servicio jerárquicas pueden ser menos precisas.

• false: el servicio no utilizará la jerarquía. El resultado son áreas de servicio que se miden a lo largo de todas las calles, independientemente del nivel de jerarquía, y tienden a ser de mayor calidad en comparación con sus equivalentes jerárquicos.

Algunos parámetros de servicio no se aplican al generar áreas de servicio jerárquicas.

• Los parámetros trimOuterPolygons, trimPolygonDistance y trimPolygonDistanceUnits se ignoran y, si se especifican, generan un mensaje de advertencia en la respuesta del servicio.
• La generación de áreas de servicio detalladas, especificadas utilizando el valor esriNAOutputPolygonDetailed para el parámetro outputPolygons, no se admite y da como resultado una solicitud fallida.
• La generación de líneas de área de servicio, especificadas utilizando esriNAOutputLineTrueShape o esriNAOutputLineTrueShapeWithMeasure para el valor del parámetro outputLines, no se admite y da como resultado una solicitud fallida.

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).

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 del parámetro impedanceAttributeName al generar líneas de área de servicio. Por ejemplo, es posible generar líneas de área de servicio en función de la distancia de viaje y acumular el tiempo de viaje. Las líneas de área de servicio se basan en la distancia, pero también especifican el tiempo que se tardará en llegar a cada porción del área de servicio.

El valor de este parámetro se especifica como una lista de nombres separados por comas. Los posibles valores del parámetro son los mismos que los del parámetro impedanceAttributeName. Un valor de none indica que no se acumularán los valores.

Para cada valor especificado en el parámetro accumulateAttributeNames, se agregan dos atributos al objeto saLines de la respuesta. Por ejemplo, si el parámetro accumulateAttributeNames tiene el valor Miles, Kilometers, el objeto saLines de la respuesta contiene los atributos FromCumul_Miles, ToCumul_Miles, FromCumul_Kilometers y ToCumul_Kilometers.

Este parámetro no se tiene en cuenta si el parámetro outputLines está establecido en esriNAOutputLineNone.

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 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 the user is 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 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 the user is 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 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 the user is 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"
}

outputLines

Utilice este parámetro para especificar si el servicio creará líneas de área de servicio. Este parámetro se especifica con estos valores:

• esriNAOutputLineNone: no crear líneas de área de servicio. Resulta útil si no desea crear líneas de área alrededor de las instalaciones, pero desea generar áreas de servicio.
• esriNAOutputLineTrueShape: crear líneas de área de servicio en función de las calles incluidas en el margen de los valores especificados para el parámetro breakValues.
• esriNAOutputLineTrueShapeWithMeasure: crear medidas para las líneas de área de servicio. Se agrega así información de referenciación lineal a las líneas de salida con el fin de ayudar en el uso de líneas de área de servicio para las funciones tales como la segmentación dinámica de eventos.

splitLinesAtBreaks

Especifique si las líneas de área de servicio se separarán como valores de descanso.

• true: una línea de área de servicio que interseca un corte se divide en dos líneas. Resulta útil si desea visualizar líneas de área de servicio por valor de corte.
• false: las líneas de área de servicio no se dividen en los límites de los cortes.

La configuración de este parámetro no tiene ningún efecto si solo se especifica un valor para el parámetro defaultBreaks o si outputLines está establecido en esriNAOutputLineNone.

overlapLines

Especifique si las líneas de áreas de servicio de distintas instalaciones se pueden superponer entre sí.

• true: las líneas de las áreas de servicio pueden superponerse entre sí. Con esta opción, en el caso de que dos instalaciones tengan líneas de área de servicio coincidentes, habrá dos entidades, una por cada línea de área de servicio de cada instalación.
• false: las líneas de área de servicio de una instalación no pueden superponerse con las de otra instalación. Con esta opción, en el caso de que dos instalaciones tengan líneas de área de servicio coincidentes, solo existe una única línea de área de servicio que está asociada con la instalación más cercana.

La configuración de este parámetro no tiene ningún efecto si solo hay una instalación o outputLines está establecido en esriNAOutputLineNone.

returnFacilities

Especifique si el servicio devuelve las instalaciones.

• true: las instalaciones de entrada se devuelven como parte de la propiedad facilities en la respuesta JSON.
• false (predeterminado): no se incluyen las instalaciones de entrada en los resultados.

Si especificó el valor del parámetro facilities 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 returnFacilities como true para poder dibujar las ubicaciones de instalaciones en la aplicación. También puede definir la propiedad returnFacilities como true para ver dónde se han localizado las instalaciones 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.

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.

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 instalaciones 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.

For example, your input facilities are specified as the following JSON representation of a feature set:

{
  "spatialReference": {
    "wkid": 4326
  },
  "features": [
    {
      "geometry": {
        "x": -122.439613,
        "y": 37.746144
      },
      "attributes": {
        "ObjectID": 10,
        "Name": "Store 1"
      }
    },
    {
      "geometry": {
        "x": -122.488254,
        "y": 37.754092
      },
      "attributes": {
        "ObjectID": 20,
        "Name": "Store 2"
      }
    }
  ]
}

If you solve a service area and specify preserveObjectID=false, the output facilities will have object IDs 1 and 2 even though the input facilities have object IDs 10 and 20. However, if preserveObjectID=true, the output facilities will preserve the ObjectID from inputs.

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.

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.

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.

{
  "default": {
    "tolerance": <value>,
    "toleranceUnits": "<unit>",
    "allowAutoRelocate": true | false,
    "sources": [
      {
        "name": "<sourceName>",
        "where": "<whereClause>"
      }
    ]
  },
  "overrides": {
    "facilities": {
      "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": {
    "facilities": {
      "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.

Even if the request fails, when you set returnEmptyResults = true and returnFacilities = true, you can return facilities to investigate why some of them failed to locate.

includeSourceInformationOnLines

Specify whether the service will include network source fields on the output saPolylines. Source fields on saPolylines are SourceID, SourceOID, FromPosition and ToPosition.

• true—The saPolylines property in the JSON response will include network source fields.
• false—The saPolylines property in the JSON response will not include network source fields.

The default value is true.

Setting this parameter has no effect if outputLines is set to esriNAOutputLineNone. You can set this to false if you don't need network source fields on saPolylines and this will reduce the response size.

excludeSourcesFromPolygons

Specify the array of network dataset edge sources to exclude when generating polygons. The property is set as an array of strings where each value is the name of the network edge source.

Learn more about excluding edge sources from service area polygon generation

saPolygons

Ofrece acceso a entidades poligonales que representan áreas a las que se puede llegar desde las ubicaciones de entrada en un tiempo de viaje, distancia de viaje o coste de viaje determinados.

This data type supports the fields described below. In addition to these fields, the data type also includes all the fields from the input feature class used as facilities for the analysis when generating overlapping or nonoverlapping polygons.

saPolylines

Almacena las áreas de servicio resultantes como entidades lineales, que cubren las calles o ejes de la red que se pueden alcanzar en el tiempo, la distancia u otro valor límite de los costes de viaje especificados. Las líneas son una representación más fiel de un área de servicio que los polígonos, ya que los análisis del área de servicio se basan en mediciones a lo largo de las líneas de red.

This data type supports the following fields:

facilities

Ofrece acceso a los atributos de las instalaciones que se usan en el análisis del área de servicio. Puede utilizar los atributos de este tipo de datos, por ejemplo, el campo Status, para determinar el motivo por el que una instalación no se utilizó en el análisis.

The data type supports the following fields. In addition to these fields, the data type also includes all the fields from the input feature class used as facilities for the analysis.

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.

JSON Response syntax for successful requests

{
  "saPolygons": {
    "spatialReference": {
      <spatialReference>
    },
    "features": [
      {
        "attributes": {
          "<field1>": <value11>,
          "<field2>": <value12>
        },
        "geometry": {
          <polygon1>
        }
      },
      {
        "attributes": {
          "<field1>": <value21>,
          "<field2>": <value22>
        },
        "geometry": {
          <polygon2>
        }
      }
    ]
  },
  "saPolylines": {
    "spatialReference": {
      <spatialReference>
    },
    "features": [
      {
        "attributes": {
          "<field1>": <value11>,
          "<field2>": <value12>
        },
        "geometry": {
          <polyline1>
        }
      },
      {
        "attributes": {
          "<field1>": <value21>,
          "<field2>": <value22>
        },
        "geometry": {
          <polyline2>
        }
      }
    ]
  },
  "facilities": {
    "spatialReference": {
      <spatialReference>
    },
    "features": [
      {
        "attributes": {
          "<field1>": <value11>,
          "<field2>": <value12>
        },
        "geometry": {
          <point1>
        }
      },
      {
        "attributes": {
          "<field1>": <value21>,
          "<field2>": <value22>
        },
        "geometry": {
          <point2>
        }
      }
    ]
  },
  "barriers": {
    "spatialReference": {
      <spatialReference>
    },
    "features": [
      {
        "attributes": {
          "<field1>": <value11>,
          "<field2>": <value12>
        },
        "geometry": {
          <point1>
        }
      },
      {
        "attributes": {
          "<field1>": <value21>,
          "<field2>": <value22>
        },
        "geometry": {
          <point2>
        }
      }
    ]
  },
  "polylineBarriers": {
    "spatialReference": {
      <spatialReference>
    },
    "features": [
      {
        "attributes": {
          "<field1>": <value11>,
          "<field2>": <value12>
        },
        "geometry": {
          <polyline1>
        }
      },
      {
        "attributes": {
          "<field1>": <value21>,
          "<field2>": <value22>
        },
        "geometry": {
          <polyline2>
        }
      }
    ]
  },
  "polygonBarriers": {
    "spatialReference": {
      <spatialReference>
    },
    "features": [
      {
        "attributes": {
          "<field1>": <value11>,
          "<field2>": <value12>
        },
        "geometry": {
          <polygon1>
        }
      },
      {
        "attributes": {
          "<field1>": <value21>,
          "<field2>": <value22>
        },
        "geometry": {
          <polygon2>
        }
      }
    ]
  },
  "messages": [
    {
      "type": <type1>,
      "description": <description1>
    },
    {
      "type": <type1>,
      "description": <description1>
    }
  ]
}

JSON Response syntax for failed requests

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