facilities

The input locations around which service areas are generated.

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

• url—Specify a REST query request to any ArcGIS Server feature, map, or geoprocessing service that returns a JSON feature set.

• features—Specify an array of features.

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

  • geometry—Specify the input point geometry containing x and y properties along with the spatialReference property. If the spatialReference property is defined for the entire JSON, you don't need to define this property for each geometry. Doing so reduces the size of the input JSON if the input has many features and improves performance. This property is not required if the coordinates are in the default spatial reference, WGS84. If the coordinates are in a different spatial reference, you must specify the spatial reference's well-known ID (WKID). See Using spatial references to look up WKID values.

    Tip:

    It is recommended that you explicitly specify the spatialReference value, and specify it for the entire JSON rather than each individual geometry.

  • attributes—Specify each attribute as a key-value pair in which the key is the name of a given field, and the value is the attribute value for the corresponding field.

{
  "spatialReference": {
    "wkid": <wkid>,
    "latestWkid": <wkid>
  },
  "features": [
    {
      "geometry": {
        "x": <x1>,
        "y": <y1>
      },
      "attributes": {
        "<field1>": <value1_1>,
        "<field2>": <value1_2>
      }
    },
    {
      "geometry": {
        "x": <x2>,
        "y": <y2>
      },
      "attributes": {
        "<field1>": <value2_1>,
        "<field2>": <value2_2>
      }
    }
  ] 
}

{
  "spatialReference": {
    "wkid": <wkid>,
    "latestWkid": <wkid>
  },
  "fields": [
    {
      "name": <name1>,
      "type": <esriFieldType>,
      "alias": <alias1>,
      "length": <length>
    },
    {
      "name": <name2>,
      "type": <esriFieldType>,
      "alias": <alias2>,
      "length": <length>
    }
  ],
  "features": [
    {
      "geometry": {
        "x": <x1>,
        "y": <y1>
      },
      "attributes": {
        "<name1>": <value1_1>,
        "<name2>": <value1_2>
      }
    },
    {
      "geometry": {
        "x": <x2>,
        "y": <y2>
      },
      "attributes": {
        "<name1>": <value2_1>,
        "<name2>": <value2_2>
      }
    }
  ] 
}

{
  "url": "<url>"
}

{
  "features": [
    {
      "geometry": {
        "x": -0.1891,  
        "y": 51.5254
      },
      "attributes": {
        "Name": "Fire Station 35"                             
      }
    },
    {
      "geometry": {
        "x": -0.1744,
        "y": 51.5353
      },
      "attributes": {
        "Name": "Fire Station 29"
      }
    }
  ]
}

{
  "spatialReference": {
    "wkid": 102100
  },
  "features": [
    {
      "geometry": {                
        "x": 2698533.989,
        "y": 5192521.476
      },
      "attributes": {
        "Name": "123 Main Street" 
      }
    },
    {
      "geometry": {
        "x": 2697821.094, 
        "y": 5191915.261
      },
      "attributes": {
        "Name": "845 Cypress Ave"
      }
    }
  ]
}

{
  "fields": [
    {
      "name": "Name",
      "type": "esriFieldTypeString",
      "alias": "Square Footage",
      "length": 128
    },
    {
      "name": "SquareFootage",
      "type": "esriFieldTypeInteger",
      "alias": "Square Footage",
      "length": 10
    }
  ],
  "features": [
    {
      "geometry": {
        "x": -122.253,
        "y": 37.757
      },
      "attributes": {
        "Name": "SF Store",
        "SquareFootage": 1800
      }
    },
    {
      "geometry": {
        "x": -77.067,
        "y": 38.907
      },
      "attributes": {
        "Name": "DC Store",
        "SquareFootage": 1300
      }
    }
  ]
}

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

token

Use this parameter to specify a token that provides the identity of a user that has the permissions to access the service. The security and authentication page provides more information about how an access token can be obtained.

token=<yourToken>

f

Use this parameter to specify the response format. The parameter can have html, json or pjson as arguments, for example, f=json. The pjson value is used for printing the JSON response in a prettified format.

travel_mode

Choose the mode of transportation for the analysis.

Travel modes are managed in ArcGIS Enterprise and can be configured by the administrator of your organization to better reflect the organization's workflows.

To learn more about travel modes, see Configure travel modes.

You must specify the JSON object containing the settings for a travel mode supported by your organization. To get a list of supported travel modes, execute the GetTravelModes tool from the Utilities service.

The value for the travel_mode parameter should be a JSON object representing travel mode settings. When you use the GetTravelModes tool from the Utilities service, you get a string representing the travel mode JSON. You need to convert this string to a valid JSON object using your API and then pass the JSON object as the value for the travel_mode parameter.

For example, below is a string representing the Walking Time travel mode as returned by the GetTravelModes tool.

"{\"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\"}"

The above value should be converted to a valid JSON object and passed as the value for the travel_mode parameter.

travel_mode={"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"}

The default value,Custom, allows you to configure your own travel mode. When you pass in Custom, you can set values for the following parameters: impedance, time_impedance, distance_impedance, uturn_at_junctions, use_hierarchy, route_line_simplification_tolerance, restrictions, and attribute_parameter_values. You can choose Custom and set the custom travel mode parameters listed above, for example, to model a pedestrian with a fast walking speed or a truck with a given height, weight, and cargo of certain hazardous materials. You can try out different settings to get desired analysis results. Once you have identified the analysis settings, you should work with your organization's administrator and save these settings as part of new or existing travel mode so that everyone in your organization can rerun the analysis with the same settings.

The default values of the custom travel mode parameters model traveling by car. If you specify the travel mode as Custom or do not provide a value for the travel_mode parameter, the analysis will be similar to using the default Driving Time travel mode.

break_values

Use this parameter to specify the size and number of service areas to generate for each facility. The units are determined by the break_units parameter. If units are time based, the service areas are generated based on travel time along underlying streets. If units are distance based, the service areas are generated based on travel distances.

Multiple area breaks can be specified to create concentric service areas per facility. For instance, to find 2-, 3-, and 5-mile service areas for each facility, specify break_values=2 3 5, separating the values with a space, and set break_units to Miles.

The default value for this parameter is demonstrated in the example below:

break_values=5 10 15

break_units

Use this parameter to specify the units for the break_values parameter. The parameter is specified using the following values:

• Meters
• Kilometers
• Feet
• Yards
• Miles
• NauticalMiles
• Seconds
• Minutes
• Hours
• Days

The default value is Minutes.

analysis_region

This parameter is ignored by the service and specifying a value does not have any effect on the analysis.

travel_direction

Specifies whether the direction of travel used to generate the service area polygons is toward or away from the facilities.

• Facility to Incident—Direction of travel is from facilities to incidents.
• Incident to Facility—Direction of travel is from incidents to facilities.

The direction of travel may change the shape of the polygons because impedances on opposite sides of streets may differ or one-way restrictions may exist, such as one-way streets. The direction you should choose depends on the nature of your service area analysis. The service area for a pizza delivery store, for example, should be created away from the facility, whereas the service area of a hospital should be created toward the facility.

The default value for this parameter is Incident to Facility.

time_of_day

Specify the time and date to depart from or arrive at facilities. This parameter is ignored when break_units is set to distance units.

To use traffic in the analysis, set break_units to a time-based unit, and assign a value to time_of_day. The time_of_day value represents the time at which travel begins, or departs, from the input points. The time is specified as Unix time (milliseconds since midnight, January 1, 1970).

The interpretation of the parameter value depends on whether travel is toward or away from the facilities as specified by the travel_direction parameter.

• It represents the departure time if travel_direction is set to Away From Facility. This is the default.
• It represents the arrival time if travel_direction is set to Towards Facility.

If a time of day is not passed in, the service uses static road speeds based on average historical speeds or posted speed limits. It uses posted speeds in areas where historical traffic information isn't available.

When the service is using the ArcGIS StreetMap Premium data, it can support two kinds of traffic: live and typical.

If the time_Of_day specified is within 4 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 time_Of_day specified is earlier than 4 hours or later than 4 hours from 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 week based on multiple years worth of data. So a road may have a different travel time at Monday at 8 am, Monday at 8:15 am, or Tuesday at 8 am. Since the variance is just at the day of week and time of day, the travel time is the same on a road for any Monday at 8 am, regardless of the month or year.

If your goal is to model typical travel conditions and avoid large variances from the average due to live traffic, it is recommended to use a date from the past to ensure it doesn't coincide with the 4 hour window from the current time. As an extreme example, you can even use dates from 1990.

The Data Coverage page shows the countries Esri currently provides traffic data for.

"time_Of_day": 631458180000

"time_Of_day": 631731600000

"time_Of_day": 1426674000000

time_zone_for_time_of_day

Specify the time zone or zones of the time_Of_day parameter. There are two options: Geographically Local and UTC.

The default value is Geographically Local

False (use geographically local time zones)

The timeOfDay value refers to the time zone or zones in which the input points are located. This option causes the analysis to have rolling start times across time zones.

The following image illustrates setting the value to false (geographically local). Setting timeOfDay to 9:00 a.m., January 4, 1990 (631443600000 milliseconds) and timeOfDayIsUTC to false, and submitting a valid request causes the drive times for points in the eastern time zone to start at 9:00 a.m. and 9:00 a.m. central time for points in the central time zone. (The start times are offset by an hour in real or UTC time.)

True (use UTC)

The timeOfDay value refers to coordinated universal time (UTC). The start times for all points are simultaneous, regardless of time zones.

The following image illustrates setting the value to true (UTC). Setting timeOfDay to 9:00 a.m., January 4, 1990 (631443600000 milliseconds) and timeOfDayIsUTC to true causes the start time for points in the eastern time zone to be 4:00 a.m. eastern time and 3:00 a.m. central time for those in the central time zone.

use_hierarchy

Use this parameter to specify whether hierarchy will be used when generating service areas.

• true—The service will use hierarchy. When generating hierarchical service areas, the service prefers higher-order streets, such as freeways, to lower-order streets, such as local roads. This means that if a facility is located on a local road (the lowest level in a hierarchy), the service spans out on the local roads in that area, but it tries to step up the hierarchy to secondary and primary roads. Once on secondary and primary roads, the service ignores local roads throughout the rest of the service area. Mainly because of this hierarchical approach, hierarchical service areas are generated much faster compared to nonhierarchical service areas, as the service has to generate service areas from a relatively smaller subset of streets. Hierarchical service areas can be used to simulate the driver preference of traveling on freeways instead of local roads even if that means a longer trip. However, the areas can overlap some lower-order roads that can't be reached within the given travel distance or travel time. Consequently, hierarchical service areas can be less accurate.

• false—The service will not use hierarchy. This results in service areas that are measured along all the streets, regardless of hierarchy level, and tend to be higher quality compared to their hierarchical counterparts.

The default value is false.

Some service parameters are not applicable when generating hierarchical service areas.

• The polygon_trim_distance parameter is ignored and, if specified, results in a warning message in the service response.
• Generating detailed service areas, specified using a value of true for the detailed_polygons parameter, is not supported and results in a failed request.

• The polygon_trim_distance parameter is ignored and, if specified, results in a warning message in the service response.
• Generating detailed service areas, specified using a value of true for the detailed_polygons parameter, is not supported and results in a failed request.

uturn_at_junctions

Use this parameter to restrict or permit the route from making U-turns at junctions.

To understand the available parameter values, a junction is a point where only two streets intersect each other. If three or more streets intersect at a point, it is called as an intersection. A cul-de-sac is a dead-end. This parameter can have the following values:

Parameter Value	Description
Allowed	U-turns are permitted everywhere. Permitting U-turns implies that the vehicle can turn around at a junction and double back on the same street.
Allowed only at Intersections and Dead Ends	U-turns are prohibited at junctions where exactly two adjacent streets meet.
Allowed only at Dead Ends	U-turns are prohibited at all junctions and intersections and are permitted only at dead ends.
Not Allowed	U-turns are prohibited at all junctions, intersections, and dead-ends. Even when this parameter value is chosen, a route can still make U-turns at stops. To prohibit U-turns at a stop, you can set its CurbApproach property to the appropriate value (3).

The default value for this parameter is Allowed only at Intersections and Dead Ends.

polygons_for_multiple_facilities

Use this parameter to specify how to generate service areas when multiple facilities are present. The parameter is specified using one of the following values:

• Overlapping—Create individual service areas for each facility. The service areas from different facilities can overlap each other.
• Not Overlapping—Create individual service areas for each facility such that a service area from one facility cannot overlap service areas from other facilities. With this option, the area inside any given service area is closer to the corresponding facility than any other facility.
• Merge by Break Value—Join the service areas of different facilities that have the same break value. Unlike the Overlapping and Not Overlapping options, this option does not result in individual service areas for each facility.

The default value for this parameter is Overlapping.

polygon_overlap_type

Use this parameter to specify whether multiple service areas around a facility are created as disks or rings. The parameter is specified using one of the following values:

• Rings—When creating multiple service areas around a facility, do not include the region covered by the smaller service area into the region covered by the larger service area. Use this option if you want to find the area from one break to another. For instance, If you create 5- and 10-minute service areas, the 10-minute service areas will exclude the area under the 5-minute service areas and thus would appear like rings.
• Disks—When creating multiple service areas around a facility, creates service areas going from the facility to the break. For instance, If you create 5- and 10-minute service areas, the 10-minute service area will include the area under the 5-minute service area.

The default value for this parameter is Rings.

detailed_polygons

Use this parameter to specify the option to create detailed or generalized service areas.

The default value for this parameter is false.

polygon_trim_distance

Use this parameter to specify the distance within which the service areas are trimmed. This is useful when finding service areas in places that have very sparse street networks and you don't want the service area to cover large areas where there are no street features.

The parameter is specified as a JSON structure that includes the following properties:

• distance—The trim distance value. A 0 (zero) distance value specifies that the service areas should not be trimmed.
• units—The units for the trim distance value.

The property value should be specified as one of the following values:

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

The default value for this parameter is 100 meters. The parameter value is ignored when the use_hierarchy parameter is set to true.

 
{
  "distance": <value>,
  "units": "<unit>"
}

 
{
  "distance": 75,
  "units": "esriMeters"
}

polygon_simplification_tolerance

Use this parameter to specify by how much you want to simplify the service area geometry returned by the service.

Simplification maintains critical points of an area to define its essential shape and removes other points. The simplification distance you specify is the maximum allowable offset that the simplified area can deviate from the original area. Simplifying an area reduces the number of points that are used to construct the area and tends to reduce drawing times.

The parameter is specified as a JSON structure that includes the following properties:

• distance—The simplification distance value.
• units—The units for the simplification distance value.

  The property value should be specified as one of the following values:

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

The default value for this parameter is 10 meters.

 
{
  "distance": <value>,
  "units": "<unit>"
}

 
{
  "distance": 10,
  "units": "esriMeters"
}

point_barriers

Use this parameter to specify one or more points that will act as temporary restrictions or represent additional time or distance that may be required to travel on the underlying streets. For example, a point barrier can be used to represent a fallen tree along a street or a time delay spent at a railroad crossing.

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 or features property:

• url—Specify a REST query request to any ArcGIS Server feature, map, or geoprocessing service that returns a JSON feature set.

• features—Specify an array of features.

  Each feature in this array represents a point barrier and contains the following fields:

  • geometry—Specify the input point geometry containing x and y properties along with the spatialReference property. If the spatialReference property is defined for the entire JSON, you don't need to define this property for each geometry. Doing so reduces the size of the input JSON if the input has many features and improves performance. This property is not required if the coordinates are in the default spatial reference, WGS84. If the coordinates are in a different spatial reference, you must specify the spatial reference's well-known ID (WKID). See Using spatial references to look up WKID values.

    Tip:

    It is recommended that you explicitly specify the spatialReference value, and specify it for the entire JSON rather than each individual geometry.

  • attributes—Specify each attribute as a key-value pair in which the key is the name of a given field, and the value is the attribute value for the corresponding field.

{
  "spatialReference": {
    "wkid": <wkid>,
    "latestWkid": <wkid>
  },
  "features": [
    {
      "geometry": {
        "x": <x1>,
        "y": <y1>
      },
      "attributes": {
        "<field1>": <value11>,
        "<field2>": <value12>
      }
    },
    {
      "geometry": {
        "x": <x2>,
        "y": <y2>
      },
      "attributes": {
        "<field1>": <value21>,
        "<field2>": <value22>
      }
    }
  ] 
}

{
  "url": "<url>"
}

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

{
  "spatialReference": {
    "wkid": 102100
  },
  "features": [
    {
      "geometry": {
        "y": -13635398.9398,
        "x": 4544699.034400001
      },
      "attributes": {
        "Name": "Fallen tree at 123 Main St", 
        "BarrierType": 0
      }
    }
  ]
}

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

line_barriers

Use this parameter to specify one or more lines that prohibit travel anywhere the lines intersect the streets. For example, a parade or protest that blocks traffic across several street segments can be modeled with a line barrier. A line barrier can also quickly fence off several roads from being traversed, thereby channeling possible routes away from undesirable parts of the street network.

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 or features property:

• url—Specify a REST query request to any ArcGIS Server feature, map, or geoprocessing service that returns a JSON feature set.

• features—Specify an array of features.

  Each feature in this array represents a polyline barrier and contains the following fields:

  • geometry—Specify the input point geometry containing x and y properties along with the spatialReference property. If the spatialReference property is defined for the entire JSON, you don't need to define this property for each geometry. Doing so reduces the size of the input JSON if the input has many features and improves performance. This property is not required if the coordinates are in the default spatial reference, WGS84. If the coordinates are in a different spatial reference, you must specify the spatial reference's well-known ID (WKID). See Using spatial references to look up WKID values.

    Tip:

    It is recommended that you explicitly specify the spatialReference value, and specify it for the entire JSON rather than each individual geometry.

  • attributes—Specify each attribute as a key-value pair in which the key is the name of a given field, and the value is the attribute value for the corresponding field.

{
  "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>
      }
    }
  ] 
}

{
  "url": "<url>"
}

{
  "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"
}

polygon_barriers

Use this parameter to specify polygons that either completely restrict travel or proportionately scale the time or distance required to travel on the streets intersected by the polygons.

You can specify polygon barrier geometries as well as attributes using a JSON structure that references a set of features. The JSON structure can be specified using the url or features property:

• url—Specify a REST query request to any ArcGIS Server feature, map, or geoprocessing service that returns a JSON feature set.

• features—Specify an array of features.

  Each feature in this array represents a polygon barrier and contains the following fields:

  • geometry—Specify the input point geometry containing x and y properties along with the spatialReference property. If the spatialReference property is defined for the entire JSON, you don't need to define this property for each geometry. Doing so reduces the size of the input JSON if the input has many features and improves performance. This property is not required if the coordinates are in the default spatial reference, WGS84. If the coordinates are in a different spatial reference, you must specify the spatial reference's well-known ID (WKID). See Using spatial references to look up WKID values.

    Tip:

    It is recommended that you explicitly specify the spatialReference value, and specify it for the entire JSON rather than each individual geometry.

  • attributes—Specify each attribute as a key-value pair in which the key is the name of a given field, and the value is the attribute value for the corresponding field.

{
  "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>
      }
    }
  ]
}

{
  "url": "<url>"
}

{
  "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,
        "ScaledTimeFactor": 3
      }
    }
  ]
}

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

restrictions

Use this parameter to specify the restrictions that will be honored by the service. A restriction represents a driving preference or requirement. In most cases, restrictions cause roads or pathways to be prohibited, but they can also cause them to be avoided or preferred. For instance, using the Avoid Toll Roads restriction will result in a route that will include toll roads only when it is required to travel on toll roads to visit a stop. Use Height Restriction to route around clearances that are lower than the height of the vehicle. If the vehicle is carrying corrosive materials, you can use the Any Hazmat Prohibited restriction to prevent hauling the materials along roads where it is marked as illegal to do so.

This parameter value is specified as a comma-separated list of restriction names. A value of none indicates that no restrictions will be used when finding the shortest paths.

The service supports the following restriction names:

• Any Hazmat Prohibited—The results will not include roads where transporting any kind of hazardous material is prohibited.

• Avoid Carpool Roads—The results will avoid roads that are designated exclusively for car pool (high-occupancy) vehicles.

• Avoid Express Lanes—The results will avoid roads designated as express lanes.

• Avoid Ferries—The results will avoid ferries.

• Avoid Gates—The results will avoid roads where there are gates, such as keyed access or guard-controlled entryways.

• Avoid Limited Access Roads—The results will avoid roads that are limited-access highways.

• Avoid Private Roads—The results will avoid roads that are not publicly owned and maintained.

• Avoid Roads Unsuitable for Pedestrians—The results will avoid roads that are unsuitable for pedestrians.

• Avoid Stairways—The results will avoid all stairways on a pedestrian-suitable route.

• Avoid Toll Roads—The results will avoid all toll roads for automobiles.

• Avoid Toll Roads for Trucks—The results will avoid all toll roads for trucks.

• Avoid Truck Restricted Roads—The results will avoid roads where trucks are not allowed, except when making deliveries.

• Avoid Unpaved Roads—The results will avoid roads that are not paved (for example, dirt, gravel, and so on).

• Axle Count Restriction—The results will not include roads where trucks with the specified number of axles are prohibited. The number of axles can be specified using the Number of Axles restriction parameter.

• Driving a Bus—The results will not include roads where buses are prohibited. Using this restriction will also ensure that the results will honor one-way streets.

• Driving a Taxi—The results will not include roads where taxis are prohibited. Using this restriction will also ensure that the results will honor one-way streets.

• Driving a Truck—The results will not include roads where trucks are prohibited. Using this restriction will also ensure that the results will honor one-way streets.

• Driving an Automobile—The results will not include roads where automobiles are prohibited. Using this restriction will also ensure that the results will honor one-way streets.

• Driving an Emergency Vehicle—The results will not include roads where emergency vehicles are prohibited. Using this restriction will also ensure that the results will honor one-way streets.

• Height Restriction—The results will not include roads where the vehicle height exceeds the maximum allowed height for the road. The vehicle height can be specified using the Vehicle Height (meters) restriction parameter.

• Kingpin to Rear Axle Length Restriction—The results will not include roads where the vehicle length exceeds the maximum allowed kingpin to rear axle for all trucks on the road. The length between the vehicle kingpin and the rear axle can be specified using the Vehicle Kingpin to Rear Axle Length (meters) restriction parameter.

• Length Restriction—The results will not include roads where the vehicle length exceeds the maximum allowed length for the road. The vehicle length can be specified using the Vehicle Length (meters) restriction parameter.

• Preferred for Pedestrians—The results will use preferred routes suitable for pedestrian navigation.

• Riding a Motorcycle—The results will not include roads where motorcycles are prohibited. Using this restriction will also ensure that the results will honor one-way streets.

• Roads Under Construction Prohibited—The results will not include roads that are under construction.

• Semi or Tractor with One or More Trailers Prohibited—The results will not include roads where semis or tractors with one or more trailers are prohibited.

• Single Axle Vehicles Prohibited—The results will not include roads where vehicles with single axles are prohibited.

• Tandem Axle Vehicles Prohibited—The results will not include roads where vehicles with tandem axles are prohibited.

• Through Traffic Prohibited—The results will not include roads where through traffic (nonlocal traffic) is prohibited.

• Truck with Trailers Restriction—The results will not include roads where trucks with the specified number of trailers on the truck are prohibited. The number of trailers on the truck can be specified using the Number of Trailers on Truck restriction parameter.

• Use Preferred Hazmat Routes—The results will prefer roads that are designated for transporting hazardous materials.

• Use Preferred Truck Routes—The results will prefer roads that are designated as truck routes, such as roads that are part of the national network as specified by the National Surface Transportation Assistance Act in the United States, or roads that are designated as truck routes by the state or province, or roads that are preferred by truckers when driving in an area.

• Walking—The results will not include roads where pedestrians are prohibited.

• Weight Restriction—The results will not include roads where the vehicle weight exceeds the maximum allowed weight for the road. The vehicle weight can be specified using the Vehicle Weight (kilograms) restriction parameter.

• Weight per Axle Restriction—The results will not include roads where the vehicle weight per axle exceeds the maximum allowed weight per axle for the road. The vehicle weight per axle can be specified using the Vehicle Weight per Axle (kilograms) restriction parameter.

• Width Restriction—The results will not include roads where the vehicle width exceeds the maximum allowed width for the road. The vehicle width can be specified using the Vehicle Width (meters) restriction parameter.

The restrictions parameter value is specified as a list of restriction names. A value of null indicates that no restrictions should be used when finding the best route, but only when travel_mode is set to Custom.

restrictions=[Driving a Truck, Height Restriction, Length Restriction]

attribute_parameter_values

Use this parameter to specify additional values required by an attribute or restriction, such as to specify whether the restriction prohibits, avoids, or prefers travel on restricted roads. If the restriction is meant to avoid or prefer roads, you can further specify the degree to which they are avoided or preferred using this parameter. For example, you can choose to never use toll roads, avoid them as much as possible, or prefer them.

You can specify attribute_parameter_values parameter using JSON structure that represents a set of features. The JSON structure can include the following properties:

• features—Specify an array of features.

  • geometry—Specify the input point geometry containing x and y properties along with the spatialReference property. If the spatialReference property is defined for the entire JSON, you don't need to define this property for each geometry. Doing so reduces the size of the input JSON if the input has many features and improves performance. This property is not required if the coordinates are in the default spatial reference, WGS84. If the coordinates are in a different spatial reference, you must specify the spatial reference's well-known ID (WKID). See Using spatial references to look up WKID values.

    Tip:

    It is recommended that you explicitly specify the spatialReference value, and specify it for the entire JSON rather than each individual geometry.

  • attributes—Specify each attribute as a key-value pair in which the key is the name of a given field, and the value is the attribute value for the corresponding field.

• url—Specify a REST query request to any ArcGIS Server feature, map, or geoprocessing service that returns a JSON feature set.

Each feature in the features array represents an attribute parameter and contains the following fields:

• attributes—Specify each attribute as a key-value pair in which the key is the name of a given field, and the value is the attribute value for the corresponding field.

{
    "features": [
        {
            "attributes": {
                "<field1>": <value11>,
                "<field2>": <value12>,
                "<field3>": <value13>

            }
        },
        {
            "attributes": {
                "<field1>": <value21>,
                "<field2>": <value22>,
                "<field3>": <value13>
            }
        }
    ] 
}

attribute_parameter_values=
{
    "features": [
        {
            "attributes": {
                "AttributeName": "Height Restriction",
                "ParameterName": "Vehicle Height (meters)",
                "ParameterValue": 4.12
            }
        },
        {
            "attributes": {
                "AttributeName": "Weight Restriction",
                "ParameterName": "Vehicle Weight (kilograms)",
                "ParameterValue": 36287
            }
        },
        {
            "attributes": {
                "AttributeName": "Use Preferred Truck Routes",
                "ParameterName": "Restriction Usage",
                "ParameterValue": "PREFER_HIGH"
            }
        }
    ]
}

impedance

Specify the impedance.

Impedance is a value that quantifies travel along the transportation network. Travel distance is an example of impedance; it quantifies the length of walkways and road segments. Similarly, drive time—the typical time it takes to drive a car along a road segment—is an example of impedance. Drive times may vary by type of vehicle—for instance, the time it takes for a truck to travel along a path tends to be longer than a car—so there can be many impedance values representing travel times for different vehicle types. Impedance values may also vary with time; live and typical traffic reference dynamic impedance values. Each walkway and road segment stores at least one impedance value. When performing a network analysis, the impedance values are used to calculate the best results, such as finding the shortest route—the route that minimizes impedance—between two points.

The impedance parameter can be specified using the following values:

• TravelTime—Historical and live traffic data is used. This option is good for modeling the time it takes automobiles to travel along roads at a specific time of day using live traffic speed data where available. When using TravelTime, you can optionally set the TravelTime::Vehicle Maximum Speed (km/h) attribute parameter to specify the physical limitation of the speed the vehicle is capable of traveling.
• Minutes—Live traffic data is not used, but historical average speeds for automobiles data is used.
• TruckTravelTime—Historical and live traffic data is used, but the speed is capped at the posted truck speed limit. This is good for modeling the time it takes for the trucks to travel along roads at a specific time. When using TruckTravelTime, you can optionally set the TruckTravelTime::Vehicle Maximum Speed (km/h) attribute parameter to specify the physical limitation of the speed the truck is capable of traveling.
• TruckMinutes—Live traffic data is not used, but the smaller of the historical average speeds for automobiles and the posted speed limits for trucks are used.
• WalkTime—The default is a speed of 5 km/hr on all roads and paths, but this can be configured through the WalkTime::Walking Speed (km/h) attribute parameter.
• Miles—Length measurements along roads are stored in miles and can be used for performing analysis based on shortest distance.
• Kilometers—Length measurements along roads are stored in kilometers and can be used for performing analysis based on shortest distance.

If you choose a time-based impedance, such as TravelTime, TruckTravelTime, Minutes, TruckMinutes, or WalkTime, the measurement_units parameter must be set to a time-based value; if you choose a distance-based impedance such as Miles, Kilometers, the measurement_units must be distance-based.

save_output_network_analysis_layer

Use this parameter to specify if the service should save the analysis settings as a network analysis layer file. You cannot directly work with this file even when you open the file in an ArcGIS Desktop application like ArcGIS Pro. It is meant to be sent to Esri Technical Support in order to diagnose the quality of results returned from the service.

• true—Saves network analysis layer file. The file can be downloaded from the URL provided as part of the output_network_analysis_layer parameter.
• false—Don't save network analysis layer file.

The default value is false.

overrides

time_impedance

The time-based impedance value represents the travel time along road segments or on other parts of the transportation network.

• Minutes
• TravelTime
• WalkTime
• TruckMinutes
• TruckTravelTime

distance_impedance

The distance-based impedance value represents the travel distance along road segments or on other parts of the transportation network.

• Miles
• Kilometers

polygon_detail

Specifies the level of detail for the output polygons.

• Standard—Polygons will be created with a standard level of detail. Standard polygons are generated quickly and are fairly accurate, but quality deteriorates somewhat as you move toward the borders of the service area polygons. This is the default.
• Generalized—Generalized polygons will be created using the hierarchy present in the network data source to produce results quickly. Generalized polygons are inferior in quality compared to standard or high-precision polygons.
• High—Polygons will be created with the highest level of detail. Holes in the polygon may exist; they represent islands of network elements, such as streets, that couldn't be reached without exceeding the cutoff impedance or due to travel restrictions This option should be used for applications in which precise results are important.

If your analysis covers an urban area with a grid-like street network, the difference between generalized and standard polygons will be minimal. However, for mountain and rural roads, the standard and detailed polygons may present significantly more accurate results than generalized polygons.

output_type

Specifies the type of output to be generated. Service area output can be line features representing the roads reachable before the cutoffs are exceeded or the polygon features encompassing these lines (representing the reachable area).

• Polygons—The service area output will contain polygons only. This is the default.
• Lines—The service area output will contain lines only.
• Polygons and lines—The service area output will contain both polygons and lines.

output_format

Specifies the format in which the output features will be returned.

• Feature Set—The output features will be returned as feature classes and tables. This is the default.
• JSON File—The output features will be returned as a compressed file containing the JSON representation of the outputs. When this option is specified, the output is a single file (with a .zip extension) that contains one or more JSON files (with a .json extension) for each of the outputs created by the service.
• GeoJSON File—The output features will be returned as a compressed file containing the GeoJSON representation of the outputs. When this option is specified, the output is a single file (with a .zip extension) that contains one or more GeoJSON files (with a .geojson extension) for each of the outputs created by the service.

env:outSR

Use this parameter to specify the spatial reference of the geometries, such as line or point features, returned by the service.

The parameter value can be specified as a well-known ID (WKID) for the spatial reference. See Using spatial references to look up WKID values.

Many of the basemaps provided by ArcGIS Online are in the Web Mercator spatial reference (WKID 102100). Specifying env:outSR=102100 returns the geometries in the Web Mercator spatial reference, which can be drawn on top of the basemaps.

ignore_network_location_fields

Specifies whether the network location fields will be considered when locating inputs such as stops or facilities on the network.

• true—Network location fields will not be considered when locating the inputs on the network. Instead, the inputs will always be located by performing a spatial search.
• false—Network location fields will be considered when locating the inputs on the network.

The default value is false.

ignore_invalid_locations

Specifies whether invalid input locations will be ignored.

• true—

  Network locations that are unlocated will be ignored and the analysis will run using valid network locations only. The analysis will also continue if locations are on nontraversable elements or have other errors. This is useful if you know the network locations are not all correct, but you want to run the analysis with the network locations that are valid. This is the default.

• false—

  Invalid locations will not be ignored. Do not run the analysis if there are invalid locations. Correct the invalid locations and rerun the analysis.

locate_settings

Use this parameter to specify settings that affect how inputs are located, such as the maximum search distance to use when locating the inputs on the network or the network sources being used for locating. To restrict locating on a portion of the source, you can specify a where clause for a source.

Learn more about locating inputs

The parameter value is specified as a JSON object. The JSON object allows you to specify a locator JSON for all input feature in the analysis, or you can specify an override for a particular input. The override allows you to have different settings for each analysis input. For example, you can disallow stops to locate on highway ramps and allow point barriers to locate on highway ramps.

The locator JSON object has the following properties:

• tolerance and toleranceUnits—Allows you to control the maximum search distance when locating inputs. If no valid network location is found within this distance, the input features will be considered unlocated. A small search tolerance decreases the likelihood of locating on the wrong street but increases the likelihood of not finding any valid network location. The toleranceUnits parameter value can be specified as one of the following values:
  • esriCentimeters
  • esriDecimalDegrees
  • esriDecimeters
  • esriFeet
  • esriInches
  • esriIntFeet
  • esriIntInches
  • esriIntMiles
  • esriIntNauticalMiles
  • esriIntYards
  • esriKilometers
  • esriMeters
  • esriMiles
  • esriMillimeters
  • esriNauticalMiles
  • esriYards
• sources—Allows you to control which network source can be used for locating. For example, you can configure the analysis to locate inputs on streets but not on sidewalks. The list of possible sources on which to locate is specific to the network dataset this service references. Only the sources that are present in the sources array are used for locating. You can specify a whereclause on each source you specified in the sources array to further restrict locating on that source matching certain characteristics using an SQL expression. For example, you can configure the analysis to locate inputs only on street features matching certain road classes such as avoiding highway ramps. Sources is specified as an array of objects, each having the following properties:
  • name—Name of the network source feature class that can be used for locating inputs.
  • where—An SQL expression on the network source feature class.
• allowAutoRelocate—Allows you to control whether inputs with existing network location fields can be automatically relocated when solving to ensure valid, routable location fields for the analysis. If the value is true, points located on restricted network elements and points affected by barriers will be relocated to the closest routable location. If the value is false, network location fields will be used as is even if the points are unreachable, and this may cause the solve to fail. Even if the value is false, inputs with no location fields or incomplete location fields will be located during the solve operation.

{
    "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>"
            }]
        },
        "point_barriers": {
            "tolerance": <value>,
            "toleranceUnits": "<unit>",
            "allowAutoRelocate": true | false,             
            "sources": [{
                "name": "<sourceName>",
                "where": "<whereClause>"
            }]
        },
        "line_barriers": {
            "allowAutoRelocate": true | false,       
            "sources": [{
                "name": "<sourceName>",
                "where": "<whereClause>"
            }]
        },
        "polygon_barriers": {
            "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": {
        "point_barriers": {
            "sources": [{
                "name": "Routing_ND_Junctions"
            }]
        }
    }
}

accumulate_attributes

A list of cost attributes to be accumulated during analysis. These accumulated attributes are for reference only; the solver only uses the cost attribute used by the designated travel mode when solving the analysis.

For each cost attribute that is accumulated, a Total_[Cost Attribute Name]_[Units] field is populated in the outputs created from the tool.

service_areas

Use this parameter to get the area that can be reached from the input location within a given travel time or travel distance. The polygon_overlap_type, polygons_for_multiple_facilities, polygon_trim_distance, and polygon_simplification_tolerance parameters influence the shape of the output service areas. The service area geometries are returned in the spatial reference specified in the env:outSR parameter.

The following table provides a description of the fields that are returned for each service area:

{
  "paramName": "service_areas",
  "dataType": "GPFeatureRecordSetLayer",
  "value": {
    "displayFieldName": "",
    "geometryType": "esriGeometryPolygon",
    "spatialReference": {
      "wkid": <wkid>,
      "latestWkid": <wkid>
    },
    "fields": [
      {
        "name": "<field1Name>",
        "type": "<field1Type>",
        "alias": "<field1Alias>",
        "length": "<field1Length>"
      },
      {
        "name": "<field2Name>",
        "type": "<field2Type>",
        "alias": "<field2Alias>",
        "length": "<field2Length>"
      }
    ],
    "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>
        }
      }
    ],
    "exceededTransferLimit": <true|false>
  }
}

{
  "paramName": "service_areas",
  "dataType": "GPFeatureRecordSetLayer",
  "value": {
    "displayFieldName": "",
    "geometryType": "esriGeometryPolygon",
    "spatialReference": {
      "wkid": 4326,
      "latestWkid": 4326
    },
    "fields": [
      {
        "name": "ObjectID",
        "type": "esriFieldTypeOID",
        "alias": "ObjectID"
      },
      {
        "name": "FacilityID",
        "type": "esriFieldTypeInteger",
        "alias": "FacilityID"
      },
      {
        "name": "Name",
        "type": "esriFieldTypeString",
        "alias": "Name",
        "length": 128
      },
      {
        "name": "FromBreak",
        "type": "esriFieldTypeDouble",
        "alias": "FromBreak"
      },
      {
        "name": "ToBreak",
        "type": "esriFieldTypeDouble",
        "alias": "ToBreak"
      },
      {
        "name": "FacilityOID",
        "type": "esriFieldTypeInteger",
        "alias": "FacilityOID"
      },
      {
        "name": "FacilityName",
        "type": "esriFieldTypeString",
        "alias": "Name",
        "length": 128
      },
      {
        "name": "Shape_Length",
        "type": "esriFieldTypeDouble",
        "alias": "Shape_Length"
      },
      {
        "name": "Shape_Area",
        "type": "esriFieldTypeDouble",
        "alias": "Shape_Area"
      }
    ],
    "features": [
      {
        "attributes": {
          "ObjectID": 1,
          "FacilityID": 1,
          "Name": "Facility 1 : 5 - 10",
          "FromBreak": 5,
          "ToBreak": 10,
          "FacilityOID": 1,
          "FacilityName": "Facility 1",
          "Shape_Length": 0.62070029717646258,
          "Shape_Area": 0.0033515430829082126
        },
        "geometry": {
          "rings": [
            [
              [
                -0.17744255103286832,
                51.558202743861614
              ],
              [
                -0.17631721496746877,
                51.557527541862612
              ]
            ],
            [
              [
                -0.19568443269037061,
                51.539964676228863
              ],
              [
                -0.19658470172254283,
                51.53816032413971
              ]
            ]
          ]
        }
      },
      {
        "attributes": {
          "ObjectID": 2,
          "FacilityID": 1,
          "Name": "Facility 1 : 0 - 5",
          "FromBreak": 0,
          "ToBreak": 5,
          "FacilityOID": 1,
          "FacilityName": "Facility 1",
          "Shape_Length": 0.16771059350061351,
          "Shape_Area": 0.00094631728859383775
        },
        "geometry": {
          "rings": [
            [
              [
                -0.18937839999313155,
                51.540412800310548
              ],
              [
                -0.18847760036089767,
                51.54018760017766
              ]
            ]
          ]
        }
      }
    ],
    "exceededTransferLimit": false
  }
}

output_facilities

This provides access to the attributes of the facilities that are used in the service area analysis. You can use the attributes from this data type, such as the Status field, to determine why a facility was not used in the analysis.

The data type supports the fields listed 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.

solve_succeeded

Use this parameter to determine whether the service successfully found the service areas. The error messages for the failure can be obtained by making a request to get the status of the job.

The solve_succeeded parameter is returned as a JSON feature set with the following syntax:

{
  "paramName": "solve_succeeded",
  "dataType": "GPBoolean",
  "value": <true | false>
}

The following shows an example of the solve_succeeded parameter:

{
  "paramName": "solve_succeeded",
  "dataType": "GPBoolean",
  "value": true
}

Calculate 5-, 10-, and 15-minute drive-time polygons around store locations

This example shows how to calculate 5-, 10-, and 15-minute drive-time polygons around a store. The store location is specified in the facilities parameter. The drive-time polygons must be drawn on an ArcGIS Online or ArcGIS Enterprise basemap that uses the Web Mercator spatial reference. Therefore, the env:outSR parameter is specified with a value of 102100 to return polygon geometries in the appropriate spatial reference. The default values for all the other parameters are appropriate for this request and are not specified.

https://<gpservice-url>/GenerateServiceAreas/submitJob?facilities={"features":[{"geometry":{"x":-122.253,"y":37.757},
"attributes":{"Name":"Store5689"}}]}&env:outSr=102100&f=json&token=<yourToken>

https://<gpservice-url>/GenerateServiceAreas/submitJob?facilities=%7B%22features%22:%5B%7B%22geometry%22:%7B%22x%22:-122.253,%22y%22:37.757%7D,
%22attributes%22:%7B%22Name%22:%22Store5689%22%7D%7D%5D%7D&env:outSr=102100&f=json&token=<yourToken>

{
  "jobId": "j54d8cee6384e45a594cc9f8fbc4697f3",
  "jobStatus": "esriJobSubmitted"
}

Query job status

The job ID obtained from the response of the first request can be queried periodically to determine the status of the job.

https://<gpservice-url>/GenerateServiceAreas/jobs/<yourJobID>?f=json&token=<yourToken>

https://<gpservice-url>/GenerateServiceAreas/jobs/<yourJobID>?f=json&token=<yourToken>

{
  "jobId": "j54d8cee6384e45a594cc9f8fbc4697f3",
  "jobStatus": "esriJobSucceeded",
  "results": {
    "Service_Areas": {
      "paramUrl": "results/Service_Areas"
    },
    "Solve_Succeeded": {
      "paramUrl": "results/Solve_Succeeded"
    }
  },
  "inputs": {
    "Facilities": {
      "paramUrl": "inputs/Facilities"
    },
    "Break_Values": {
      "paramUrl": "inputs/Break_Values"
    },
    "Break_Units": {
      "paramUrl": "inputs/Break_Units"
    },
    "Analysis_Region": {
      "paramUrl": "inputs/Analysis_Region"
    },
    "Travel_Direction": {
      "paramUrl": "inputs/Travel_Direction"
    },
    "Time_of_Day": {
      "paramUrl": "inputs/Time_of_Day"
    },
    "Use_Hierarchy": {
      "paramUrl": "inputs/Use_Hierarchy"
    },
    "UTurn_at_Junctions": {
      "paramUrl": "inputs/UTurn_at_Junctions"
    },
    "Polygons_for_Multiple_Facilities": {
      "paramUrl": "inputs/Polygons_for_Multiple_Facilities"
    },
    "Polygon_Overlap_Type": {
      "paramUrl": "inputs/Polygon_Overlap_Type"
    },
    "Detailed_Polygons": {
      "paramUrl": "inputs/Detailed_Polygons"
    },
    "Polygon_Trim_Distance": {
      "paramUrl": "inputs/Polygon_Trim_Distance"
    },
    "Polygon_Simplification_Tolerance": {
      "paramUrl": "inputs/Polygon_Simplification_Tolerance"
    },
    "Point_Barriers": {
      "paramUrl": "inputs/Point_Barriers"
    },
    "Line_Barriers": {
      "paramUrl": "inputs/Line_Barriers"
    },
    "Polygon_Barriers": {
      "paramUrl": "inputs/Polygon_Barriers"
    },
    "Restrictions": {
      "paramUrl": "inputs/Restrictions"
    },
    "Attribute_Parameter_Values": {
      "paramUrl": "inputs/Attribute_Parameter_Values"
    }
  },
  "messages": []
}

Return the output service areas

Because the job succeeded, you can make a request to return the service areas from the service_areas output parameter.

https://<gpservice-url>/GenerateServiceAreas/jobs/<yourJobID>/results/service_areas?f=pjson&token=<yourToken>

https://<gpservice-url>/GenerateServiceAreas/jobs/<yourJobID>/results/service_areas?f=pjson&token=<yourToken>

{
  "paramName": "Service_Areas",
  "dataType": "GPFeatureRecordSetLayer",
  "value": {
    "displayFieldName": "",
    "geometryType": "esriGeometryPolygon",
    "spatialReference": {
      "wkid": 102100,
      "latestWkid": 3857
    },
    "fields": [
      {
        "name": "ObjectID",
        "type": "esriFieldTypeOID",
        "alias": "ObjectID"
      },
      {
        "name": "FacilityID",
        "type": "esriFieldTypeInteger",
        "alias": "FacilityID"
      },
      {
        "name": "Name",
        "type": "esriFieldTypeString",
        "alias": "Name",
        "length": 128
      },
      {
        "name": "FromBreak",
        "type": "esriFieldTypeDouble",
        "alias": "FromBreak"
      },
      {
        "name": "ToBreak",
        "type": "esriFieldTypeDouble",
        "alias": "ToBreak"
      },
      {
        "name": "FacilityOID",
        "type": "esriFieldTypeInteger",
        "alias": "FacilityOID"
      },
      {
        "name": "FacilityName",
        "type": "esriFieldTypeString",
        "alias": "Name",
        "length": 128
      },
      {
        "name": "Shape_Length",
        "type": "esriFieldTypeDouble",
        "alias": "Shape_Length"
      },
      {
        "name": "Shape_Area",
        "type": "esriFieldTypeDouble",
        "alias": "Shape_Area"
      }
    ],
    "features": [
      {
        "attributes": {
          "ObjectID": 1,
          "FacilityID": 1,
          "Name": "Store5689 : 10 - 15",
          "FromBreak": 10,
          "ToBreak": 15,
          "FacilityOID": 1,
          "FacilityName": "Store5689",
          "Shape_Length": 186829.46238855206,
          "Shape_Area": 101157487.56126754
        },
        "geometry": {
          "rings": [
            [
              [
                -13609000.5407,
                4557625.0921000019
              ],
              [
                -13609011.581599999,
                4557630.4697000012
              ]
            ],
            [
              [
                -13609000.5407,
                4557625.0921000019
              ],
              [
                -13608886.309799999,
                4557567.0144999996
              ]
            ]          
          ]
        }
      },
      {
        "attributes": {
          "ObjectID": 2,
          "FacilityID": 1,
          "Name": "Store5689 : 5 - 10",
          "FromBreak": 5,
          "ToBreak": 10,
          "FacilityOID": 1,
          "FacilityName": "Store5689",
          "Shape_Length": 98556.221615700371,
          "Shape_Area": 45188876.257299371
        },
        "geometry": {
          "rings": [
            [
              [
                -13610967.0956,
                4551187.9716000035
              ],
              [
                -13610942.041099999,
                4551061.1401000023
              ]
            ],
            [
              [
                -13611418.2863,
                4546620.322300002
              ],
              [
                -13611451.621300001,
                4546606.3554000035
              ]
            ]
          ]
        }
      },
      {
        "attributes": {
          "ObjectID": 3,
          "FacilityID": 1,
          "Name": "Store5689 : 0 - 5",
          "FromBreak": 0,
          "ToBreak": 5,
          "FacilityOID": 1,
          "FacilityName": "Store5689",
          "Shape_Length": 21281.354678039555,
          "Shape_Area": 11623189.162529219
        },
        "geometry": {
          "rings": [
            [
              [
                -13609262.337400001,
                4547603.4253999963
              ],
              [
                -13609237.2831,
                4547476.6374000013
              ]
            ]
          ]
        }
      }
    ],
    "exceededTransferLimit": false
  }
}

Job execution

After the initial request is submitted, you can make a request of the following form to get the status of the job:

https://<gpservice-url>/GenerateServiceAreas/jobs/<yourJobID>/?token=<yourToken>&returnMessages=true&f=json

Below is a sample JSON syntax during job execution:

{
  "jobId": "<jobId>",
  "jobStatus": "<jobStatus>",
  "messages": [
    {
      "type": "<type1>",
      "description": "<description1>"
    },
    {
      "type": "<type2>",
      "description": "<description2>"
    }
  ]
}

While a job is executing, you can cancel it by making a request of the following form:

https://<gpservice-url>/GenerateServiceAreas/jobs/<yourJobID>/cancel?token=<yourToken>&f=json

Job completion

After the successful completion of the job, you can make a request of the following form to retrieve the outputs. Refer to the Output parameters section for more information on how to interpret the solution provided by the service.

https://<gpservice-url>/GenerateServiceAreas/jobs/<yourJobID>/results/<output_parameter_name>?token=<yourToken>&f=json

You can also retrieve the value for any input parameter by making a request of the following form:

https://<gpservice-url>/GenerateServiceAreas/jobs/<yourJobID>/inputs/<inputParameterName>?token=<yourToken>&f=json