/SolveLastMileDelivery

Attributes for orders

• Namestring (length: 500)

  The name of the order.

  The name must be unique. Order names are case sensitive and cannot be empty, even if the order is excluded from the solve operation. This attribute acts as a primary key and is used as a foreign key to refer to orders in the Orders Specialties table.

• ServiceTimenumber (non-negative)nullable

  The amount of time that will be spent at the order when the route visits it; that is, it stores the impedance value for the order location.

  A zero or null value indicates that the order requires no service time. The unit for this attribute value is specified by the time_units parameter.

• TimeWindowStartdatetimenullable

  The beginning time of the time window for the order.

  This attribute can contain a null value; a null value indicates no beginning time. A time window only states when a vehicle can arrive at an order; it doesn't state when the service time must be completed. To account for service time and departure before the time window ends, subtract the ServiceTime attribute value from the TimeWindowEnd attribute value.

• TimeWindowEnddatetimenullable

  The ending time of the time window for the order.

  This attribute can contain a null value, which indicates no ending time.

• MaxViolationTimenumber (non-negative)nullable

  The maximum allowable violation time for the time window of the order.

  A time window is considered violated if the arrival time occurs after the time window has ended. It can contain a zero value but can't contain negative values.

  • A zero value indicates that a time window violation is unacceptable; that is, the time window is hard.
  • A null value indicates that there is no limit on the allowable violation time.
  • A non-zero value specifies the maximum amount of lateness; for example, a route can arrive at an order up to 30 minutes beyond the end of the time window.

  The unit for this attribute value is specified by the time_units parameter.

• InboundArriveTimedatetimenullable

  The time when the item to be delivered to the order will be ready at the starting depot.

  The order can be assigned to a route only if the inbound arrive time precedes the route's start time, as the route could not leave the depot before the item is ready to be loaded onto it. The assignment is invalid even if the route has a start-depot service time that lasts until after the inbound arrive time.

  This attribute can help model scenarios involving inbound-wave transshipments. For example, a parcel or package being delivered is on an inbound flight that is scheduled to arrive and be sorted by 9:30 a.m. To ensure a route that leaves before the shipment arrives is not assigned this order, the order's inbound arrive time is set to 9:30 a.m.

• OutboundDepartTimedatetimenullable

  The time when the item to be picked up at the order must arrive at the ending depot.

  The order can be assigned to a route only if the route can visit the order and reach its end depot before the specified outbound depart time. If a route reaches a depot but doesn't complete its end-depot service time before the order's outbound depart time, the order cannot be assigned to the route.

  This attribute can help model scenarios involving outbound-wave transshipments. For instance, a shipping company sends out delivery trucks to pick up packages from orders and bring them into a depot where they are forwarded on to other facilities, en route to their final destination. At 3:00 p.m. every day, a semitrailer stops at the depot to pick up the high-priority packages and take them directly to a central processing station. To avoid delaying the high-priority packages until the next day's 3:00 p.m. trip, the shipping company plans to have delivery trucks pick up the high-priority packages from orders and bring them to the depot before 3:00 p.m.. This is done by setting the outbound depart time to 3:00 p.m.

• DeliveryQuantity_1 -- DeliveryQuantity_9number (non-negative)nullable

  The size of the delivery.

  You can specify size in any dimension such as weight, volume, or quantity. If there are multiple delivery quantities, specify them using the DeliveryQuantity_1 through DeliveryQuantity_9 fields as needed.

• PickupQuantity_1 -- PickupQuantity_9number (non-negative)nullable

  The size of the pickup.

  You can specify size in any dimension such as weight, volume, or quantity. If there are multiple pickup quantities, specify them using the PickupQuantity_1 through PickupQuantity_9 fields as needed.

• AnchorRuleint enumnullabledefault:null

  Allowed values: null, 1, 2

  The anchor rule for the order, which specifies whether it must be the first or last order on a route.

  If it is additionally constrained to a specific route, use the AssignmentRule attribute. The values are listed below:

  • null: The order does not have an anchor constraint and can be sequenced first, last, or anywhere in between.
  • 1: First. The order must be the first order on the route.
  • 2: Last. The order must be the last order on the route.

• AssignmentRuleint enumnullabledefault:null

  Allowed values: null, 1, 2, 3

  This attribute specifies the rule for the order's route assignment options.

  It is constrained by a domain of values, that are listed below:

  • null: The solver ignores the route pre-assignment (if any) for the order during the solve operation. It assigns a route to the order so as to minimize the overall value of the objective function.
  • 1: Preserve Route and Relative Sequence. The solver must always assign the order to the preassigned route and relative sequence during the solve operation. If this assignment rule cannot be followed, it results in an order violation. With this setting, only the relative sequence is maintained, not the absolute sequence.
  • 2: Preserve Route. The solver must always assign the order to the preassigned route during the solve operation. If a sequence value is given it will be used for the initial construction of the route. If the order cannot be assigned to the specified route, it results in an order violation.
  • 3: Unassign. The order will be removed from the assigned route.

• RouteNamestring (length: 500)nullable

  The name of the route to which the order is assigned.

  As an input attribute, it is used to preassign an order to a specific route. It can contain a null value, indicating that the order is not preassigned to any route, and the solver determines the best possible route assignment for the order. If this is set to null, the Sequence attribute must also be null. The RouteName attribute is a foreign key to the Name attribute in the Routes class. After a solve operation, if the order is routed, the RouteName attribute contains the name of the route that the order is assigned to.

• Sequenceinteger (non-negative)nullable

  The sequence of the order on its assigned route.

  As an input attribute, it is used to specify the relative sequence for an order on the route. This attribute can contain a null value indicating that the order can be placed anywhere along the route. The input sequence values must not be negative and must be unique for each route shared across depot visits and orders but do not need to start from 0 or be contiguous. After a solve operation, the Sequence attribute contains the sequence value of the order on its assigned route. Output sequence values for a route are shared across depot visits and orders. The sequences starts from 0 (at the starting depot) and are consecutive, except when sequence gaps are used. The smallest possible output sequence value for a routed order is 1, since a route always begins at a depot even if it is virtual depot.

• CurbApproachint enumdefault:0

  Allowed values: 0, 1, 2, 3

  Specifies the direction a vehicle may arrive at and depart from the order. The options are as following:

  • 0: Either side of vehicle. The vehicle can approach and depart the order in either direction. U-turns are allowed. You should choose this setting if your vehicle can make a U-turn at the order or if it can pull into a driveway or parking lot and turn around.
  • 1: Right side of vehicle. When the vehicle approaches and departs the order, the curb must be on the right side of the vehicle. A U-turn is prohibited.
  • 2: Left side of vehicle. When the vehicle approaches and departs the order, the curb must be on the left side of the vehicle. A U-turn is prohibited.
  • 3: No U-turn. When the vehicle approaches the order, the curb can be on either side of the vehicle; however, the vehicle must depart without turning around. Learn more about U-turn policies
  Show illustration

  Setting	Coded value	Description
  Either side of vehicle	0	The vehicle can approach and depart the order in either direction, so a U-turn is allowed at the order. This setting can be chosen if it is possible and desirable for a vehicle to turn around at the order. This decision may depend on the width of the road and the amount of traffic or whether the order has a parking lot where vehicles can pull in and turn around. All arrival and departure combinations are allowed with the Either side of vehicle curb approach.
  Right side of vehicle	1	When the vehicle approaches and departs the order, the order must be on the right side of the vehicle. A U-turn is prohibited. The allowed arrival and departure combination is shown for the Right side of vehicle curb approach.
  Left side of vehicle	2	When the vehicle approaches and departs the order, the order must be on the left side of the vehicle. A U-turn is prohibited. The allowed arrival and departure combination is shown for the Left side of vehicle curb approach.
  No U-Turn	3	When the vehicle approaches the order, the order can be on either side of the vehicle; however, when it departs, the vehicle must continue in the same direction it arrived. A U-turn is prohibited. The allowed arrival and departure combinations are shown for the No U-Turn curb approach.

  The CurbApproach attribute is designed to work with both kinds of national driving standards: right-hand traffic (United States) and left-hand traffic (United Kingdom). First, consider an order on the left side of a vehicle. It is always on the left side regardless of whether the vehicle travels on the left or right half of the road. What may change with national driving standards is your decision to approach an order from one of two directions, that is, so it ends up on the right or left side of the vehicle. For example, if you want to arrive at an order and not have a lane of traffic between the vehicle and the order, choose 1 (Right side of vehicle) in the United States and 2 (Left side of vehicle) in the United Kingdom.

  

  

• Bearinginteger (non-negative)nullable

  The direction in which a point is moving. The units are degrees and are measured clockwise from true north.

  This attribute is used in conjunction with the BearingTol attribute. Bearing data is usually sent automatically from a mobile device equipped with a GPS receiver. Try to include bearing data if you are loading an input location that is moving, such as a pedestrian or a vehicle. Using this attribute tends to prevent adding locations to the wrong edges, which can occur when a vehicle is near an intersection or an overpass, for example. Bearing also helps the solver determine the side of the street that the point is on.

  Learn more about bearing and bearing tolerance

• BearingTolinteger (non-negative)default:30nullable

  The bearing tolerance value creates a range of acceptable bearing values when locating moving points on an edge using the Bearing attribute.

  If the Bearing attribute value is within the range of acceptable values that are generated from the bearing tolerance on an edge, the point can be added as a network location there; otherwise, the closest point on the next-nearest edge is evaluated. The units are in degrees, and the default value is 30. Values must be greater than 0 and less than 180. A value of 30 means that when Network Analyst attempts to add a network location on an edge, a range of acceptable bearing values is generated 15 degrees to either side of the edge (left and right) and in both digitized directions of the edge.

  Learn more about bearing and bearing tolerance

• NavLatencyinteger (non-negative)nullable

  Indicates how much cost is expected to elapse from the moment GPS information is sent from a moving vehicle to a server and the moment the processed route is received by the vehicle's navigation device.

  This attribute is only used in the solve process if the Bearing and BearingTol fields also have values; however, providing a NavLatency attribute value is optional, even when values are present in the Bearing and BearingTol.

Attributes for depots

• Namestring (length: 500)

  The name of the depot.

  This attribute is a primary key and is used as a foreign key in the Routes feature layer and Depot Visits feature layer to refer to depots. Depot names are case sensitive and must be nonempty and unique.

• CurbApproachint enumdefault:0

  Allowed values: 0, 1, 2, 3

  Specifies the direction a vehicle may arrive at and depart from the depot. The options are as following:

  • 0: Either side of vehicle. The vehicle can approach and depart the depot in either direction. U-turns are allowed. You should choose this setting if your vehicle can make a U-turn at the depot or if it can pull into a driveway or parking lot and turn around.
  • 1: Right side of vehicle. When the vehicle approaches and departs the depot, the curb must be on the right side of the vehicle. A U-turn is prohibited.
  • 2: Left side of vehicle. When the vehicle approaches and departs the depot, the curb must be on the left side of the vehicle. A U-turn is prohibited.
  Show illustration

  Setting	Coded value	Description
  Either side of vehicle	0	The vehicle can approach and depart the depot in either direction, so a U-turn is allowed at the depot. This setting can be chosen if it is possible and desirable for a vehicle to turn around at the depot. This decision may depend on the width of the road and the amount of traffic or whether the order has a parking lot where vehicles can pull in and turn around. All arrival and departure combinations are allowed with the Either side of vehicle curb approach.
  Right side of vehicle	1	When the vehicle approaches and departs the depot, the depot must be on the right side of the vehicle. A U-turn is prohibited. The allowed arrival and departure combination is shown for the Right side of vehicle curb approach.
  Left side of vehicle	2	When the vehicle approaches and departs the depot, the depot must be on the left side of the vehicle. A U-turn is prohibited. The allowed arrival and departure combination is shown for the Left side of vehicle curb approach.

  The CurbApproach attribute is designed to work with both kinds of national driving standards: right-hand traffic (United States) and left-hand traffic (United Kingdom). First, consider an order on the left side of a vehicle. It is always on the left side regardless of whether the vehicle travels on the left or right half of the road. What may change with national driving standards is your decision to approach an order from one of two directions, that is, so it ends up on the right or left side of the vehicle. For example, if you want to arrive at an order and not have a lane of traffic between the vehicle and the order, choose 1 (Right side of vehicle) in the United States and 2 (Left side of vehicle) in the United Kingdom.

  

  

• Bearinginteger (non-negative)nullable

  The direction in which a point is moving. The units are degrees and are measured clockwise from true north.

  This attribute is used in conjunction with the BearingTol attribute. Bearing data is usually sent automatically from a mobile device equipped with a GPS receiver. Try to include bearing data if you are loading an input location that is moving, such as a pedestrian or a vehicle. Using this attribute tends to prevent adding locations to the wrong edges, which can occur when a vehicle is near an intersection or an overpass, for example. Bearing also helps the solver determine the side of the street that the point is on.

  Learn more about bearing and bearing tolerance

• BearingTolinteger (non-negative)default:30nullable

  The bearing tolerance value creates a range of acceptable bearing values when locating moving points on an edge using the Bearing attribute.

  If the Bearing attribute value is within the range of acceptable values that are generated from the bearing tolerance on an edge, the point can be added as a network location there; otherwise, the closest point on the next-nearest edge is evaluated. The units are in degrees, and the default value is 30. Values must be greater than 0 and less than 180. A value of 30 means that when Network Analyst attempts to add a network location on an edge, a range of acceptable bearing values is generated 15 degrees to either side of the edge (left and right) and in both digitized directions of the edge.

  Learn more about bearing and bearing tolerance

• NavLatencyinteger (non-negative)nullable

  Indicates how much cost is expected to elapse from the moment GPS information is sent from a moving vehicle to a server and the moment the processed route is received by the vehicle's navigation device.

  This attribute is only used in the solve process if the Bearing and BearingTol fields also have values; however, providing a NavLatency attribute value is optional, even when values are present in the Bearing and BearingTol.

Attributes for routes

• Namestring

  The name of the route.

  This attribute is the primary key and is used as a foreign key in the Orders, Depot Visits feature layers; and RouteSpecialties tables. Route names are case sensitive and cannot be empty, even if the route is not part of the solve operation. The name must be unique.

• StartDepotNamestringnullable

  The name of the starting depot for the route.

  This attribute is a foreign key to the Name attribute in the depots parameter. All routes must have the same starting depot. They can all be the same location specified in the depots parameter or all left null. The starting depot and the ending depot can be different. Omitting the start depot is useful when the vehicle's starting location is unknown or irrelevant to the problem. Virtual start depots are not allowed if orders or depots are in multiple time zones. If the route is making deliveries and StartDepotName is null, it is assumed that the cargo is loaded on the vehicle at a virtual depot before the route begins.

• EndDepotNamestringnullable

  The name of the ending depot for the route.

  This attribute is a foreign key to the Name attribute in the depots parameter. All routes must have the same ending depot. They can all be the same location specified in the depots parameter or all left null. The starting depot and the ending depot can be different.

• StartDepotServiceTimenumber (non-negative)nullable

  The service time at the starting depot.

  This can be used to model the time spent loading the vehicle. This attribute can contain a null value, which indicates zero service time. The unit for this attribute value is specified by the time_units parameter.

• EndDepotServiceTimenumber (non-negative)nullable

  The service time at the ending depot.

  This can be used to model the time spent unloading the vehicle. This attribute can contain a null value, which indicates zero service time. The unit for this attribute value is specified by the time_units parameter.

• EarliestStartDatedatenullable

  The earliest allowable starting date for the route.

  This is used by the solver in conjunction with the earliest_route_start_date parameter value to indicate the earliest date the route should start. Either this attribute or the earliest_route_start_date parameter must be populated. If this attribute is left null, the earliest_route_start_date value will be used for the route.

• EarliestStartTimetimenullable

  The earliest allowable starting time for the route.

  This is used by the solver in conjunction with the earliest_route_start_time parameter value to indicate the earliest time the route should start. Either this attribute or the earliest_route_start_time parameter must be populated. If this attribute is left null, the earliest_route_start_time will be used for the route.

• StartFlexibilitynumber (non-negative)nullable

  Indicates how long after the earliest allowed route start time the route can start.

  The value can be null or zero, which means that there is no flexibility in the starting time, or a positive number. The unit for this attribute value is specified by the time_units parameter of the analysis object.

• ArriveDepartDelaynumber (non-negative)nullable

  The amount of travel time needed to accelerate the vehicle to normal travel speeds, decelerate it to a stop, and move it off and on the network (for example, in and out of parking).

  The unit for this attribute value is specified by the time_units parameter. By including an ArriveDepartDelay value, the solver is deterred from sending many routes to service physically coincident orders. The cost for this attribute is incurred between visits to non-coincident orders and depots. For example, when a route starts from a depot and visits the first order, the total arrive/depart delay is added to the travel time. The same is true when traveling from the first order to the second order. If the second and third orders are coincident, the ArriveDepartDelay value is not added between them, since the vehicle doesn't need to move.

  For example, there are five coincident orders in a high-rise building, and they are serviced by three different routes. This means three arrive/depart delays will be incurred; that is, three drivers will need to find parking places and enter the same building. However, if the orders can be serviced by one route instead, only one driver will need to park and enter the building, and only one arrive/depart delay will be incurred. Since the solver tries to minimize cost, it will attempt to limit the arrive/depart delays by specifying the single-route option. (Multiple routes may need to be sent when other constraints—such as specialties, time windows, or capacities—require it.)

• Capacity_1 -- Capacity_9number (non-negative)nullable

  The maximum amount (for example, volume, weight, or quantity) that can be carried by the vehicle. If there are multiple capacities, specify them using the Capacity_1 through Capacity_9 fields as needed.

• FixedCostnumber (non-negative)nullable

  A fixed monetary cost that is incurred when the route is used in a solution (that is, it has orders assigned to it).

  This attribute can contain null values, which indicates zero fixed cost. This cost is part of the total route operating cost.

• CostPerUnitTimenumber (non-negative)default:1.0

  The monetary cost incurred per unit of work time for the total route duration, including travel times as well as service times and wait times at orders and depots.

  This attribute cannot contain a null value and has a default value of 1.0. The unit for this attribute value is specified by the time_units parameter.

• CostPerUnitDistancenumber (non-negative)nullable

  The monetary cost incurred per unit of distance traveled for the route length (total travel distance). This attribute can contain null values, which indicates zero cost. The distance unit is specified by the distance_units parameter.

• OvertimeStartTimenumber (non-negative)nullable

  The duration of regular work time before overtime computation begins.

  This attribute can contain null values, which indicates that overtime does not apply. If including an OvertimeStartTime value, it should be greater than zero and less than the MaxTotalTime value. The unit for this attribute value is specified by the time_units parameter.

  For example, if the driver is to be paid overtime pay when the total route duration extends beyond eight hours, OvertimeStartTime is specified as 8 if the time_units property of the analysis layer is set to Hours.

• CostPerUnitOverTimenumber (non-negative)nullable

  The monetary cost incurred per time unit of overtime work. This can only contain a null value if OvertimeStartTime is also null. Otherwise, it must be a positive value greater than the CostPerUnitTime value.

• MaxOrderCountintegernullable

  The maximum allowable number of orders on the route.

  This attribute can contain null values, which indicates that there is no constraint on the number of orders a route can visit.

• MaxTotalTimenumber (non-negative)nullable

  The maximum allowable route duration.

  The route duration includes travel times as well as service and wait times at orders and depots. Either this attribute or the max_route_total_time parameter must be populated. If this attribute is left null, the max_route_total_time value will be used for the route.

• MaxTotalTravelTimenumber (non-negative)nullable

  The maximum allowable travel time for the route.

  The travel time includes only the time spent driving on the network and does not include service or wait times. The unit for this attribute value is specified by the time_units parameter. This attribute can contain null values, which indicates there is no constraint on the maximum allowable travel time. This attribute value can't be larger than the MaxTotalTime attribute value.

• MaxTotalDistancenumber (non-negative)nullable

  The maximum allowable travel distance for the route.

  The unit for the total distance is specified by the distance_units parameter of the analysis layer. This attribute can contain null values, which indicates that there is no constraint on the maximum allowable travel distance.

• ZoneNamestringnullable

  The name of the zone that will be used for this route.

  These are zones that specify a work territory for this route. ZoneName is a foreign key to the Name attribute in the zones parameter. This attribute can contain null values, which indicates that there is no route zone for this route.

• IsHardZoneboolnullabledefault:null

  A Boolean value indicating a hard or soft route zone.

  • A value of True (1) indicates that the route zone is hard; that is, an order that falls outside the route zone polygon can't be assigned to the route.
  • A value of False (0) indicates that the order can still be assigned, but the cost of servicing the order is weighted by a function that is based on the Euclidean distance from the route zone. This means that as the straight-line distance from the soft zone to the order increases, the likelihood of the order being assigned to the route decreases.

• AssignmentRuleint enumnullabledefault:null

  This specifies whether the route can be used when solving the problem.

  This attribute is constrained by a domain of values. The possible values are as following:

  • Null: The route is open to new orders.
  • 1: Closed. The route will not accept new orders but it can be re-sequenced or have the outputs updated.
  • 2: Exclude. The route is excluded from the solve operation. The output for this route will not be updated. The orders with the corresponding route will also be excluded from the route, and the output from those orders will not be updated.

Attributes for order_specialties

• OrderNamestring

  The name of the order. This attribute is a foreign key to the name attribute in the orders parameter.

• SpecialtyNamestring

  The name of the specialty.

  This indicates the required specialty for the order. Only a single specialty is listed per line. If an order requires more than one specialty, create a new entry. Specialty names cannot contain spaces. For example, a senior technician specialty should be entered as SeniorTechnician. Specialty names are case sensitive and cannot be empty.

Attributes for route_specialties

• RouteNamestring

  The name of the route. This attribute is a foreign key to the Name attribute in the routes parameter.

• SpecialtyNamestring

  The name of the specialty.

  This indicates the specialty that the route supports. Only a single specialty is listed per line. If a route supports more than one specially, create a new entry. Specialty names cannot contain spaces. For example, a senior technician specialty should be entered as SeniorTechnician. Specialty names are case sensitive and cannot be empty.

Attributes for zones

• Namestring

  The name of the zone.

  The name attribute is useful for describing the zone since it can be used for multiple routes. The name must be unique. Names are case sensitive and cannot be empty. This attribute is the primary key and is used as a foreign key in the routes parameter.

• Namestringnullable

  The name of the barrier.

• BarrierTypeint enumdefault:0

  Allowed values: 0, 2

  Specify whether the point barrier restricts travel completely or adds time or distance when it is crossed.

  The value for this attribute is specified as one of the following integers:

  • 0: Restriction. Prohibits travel through the barrier. The barrier is referred to as a restriction point barrier since it acts as a restriction.

    

    The first map shows the shortest path between two stops without any restriction point barriers. The second map has a road that is blocked by a fallen tree, so the shortest path between the same points is longer.

  

  The map on the left shows the shortest path between two stops without any added cost point barrier. For the map on the right, the travel time from stop one to stop two would be the same whether going around the north end of the block or the south end; however, since crossing railroad tracks incurs a time penalty (modeled with added cost point barriers), the route with only one railroad crossing is chosen. The cost of crossing the barrier is added to the accumulated travel time of the resulting route.

• FullEdgeint enumdefault:0

  Allowed values: 0, 1

  Specify how the restriction point barriers are applied to the edge elements during the analysis

  • 0:False—Permits travel on the edge up to the barrier but not through it.
  • 1:True—Restricts travel anywhere on the associated edge.

• Namestring (length: 500)nullable

  The name of the barrier.

This example shows how to add two lines as polyline barriers to restrict travel on the streets intersected by the lines. Barrier 1 is a single-part line feature composed of two points. Barrier 2 is a two-part line feature. The first part is composed of three points, and the second part is composed of two points.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
{
  "spatialReference": {
    "wkid": 102100
  },
  "features": [
    {
      "geometry": {
        "paths": [
          [
            [-10804823.397, 3873688.372],
            [-10804811.152, 3873025.945]
          ]
        ]
      },
      "attributes": {
        "Name": "Barrier 1"
      }
    },
    {
      "geometry": {

• Namestringnullable

  The name of the barrier.

• BarrierTypeint enumdefault:0

  Allowed values: 0, 1

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

  The value for this attribute can be specified as one of the following integers:

  • 0: Restriction. Prohibits traveling through any part of the barrier. The barrier is referred to as a restriction polygon barrier since it prohibits traveling on streets intersected by the barrier. One use of this type of barrier is to model floods covering areas of the street that make traveling on those streets impossible.

    

    The first map depicts the shortest path between two stops. The second map shows a polygon barrier blocking flooded streets, so the shortest path between the same two stops is different.

  

  The first map shows a route that goes through inclement weather without regard for the effect that poor road conditions have on travel time. The second map shows a scaled polygon barrier that doubles the travel time of the roads covered by the storm. The route still passes through the southern tip of the storm since it is quicker to spend more time driving slowly through a small part of the storm rather than driving completely around it. The service uses the modified travel time in calculating the best route, and the modified travel time is reported as the total travel time in the response.

This example shows how to add two polygons as barriers. The first polygon, Flood zone, is a restriction polygon barrier that prohibits travel on the underlying streets. The polygon is a single-part polygon feature composed of four points. The second polygon, Severe weather zone, is a scaled-cost polygon barrier that reduces the travel time on underlying streets to one-third of the original value. The polygon is a two-part polygon feature. Both parts are composed of four points.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
{
  "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

Example for locate_settings

Example 1: Specify locate settings using a JSON structure

This example shows how to specify locate settings so inputs are only located within 500 meters of the specified location. A small search tolerance like this can be helpful if you are solving using a walking travel mode and don't want inputs to be located farther than 500 meters from the original point location.

1
2
3
4
5
6
7
8
9
10
11
12
{
  "default": {
    "tolerance": 500,
    "toleranceUnits": "esriMeters",
    "allowAutoRelocate": true,
    "sources": [
      {
        "name": "Routing_Streets"
      }
    ]
  }
}

The service supports generating directions in the following languages:

• ar: Arabic
• bg: Bulgarian
• bs: Bosnian
• ca: Catalan
• cs: Czech
• da: Danish
• de: German
• el: Greek
• en: English
• es: Spanish
• et: Estonian
• fi: Finnish
• fr: French
• he: Hebrew
• hr: Croatian
• hu: Hungarian
• id: Indonesian
• it: Italian
• ja: Japanese
• ko: Korean
• lt: Lithuanian
• lv: Latvian
• nb: Norwegian
• nl: Dutch
• pl: Polish
• pt-BR: Portuguese (Brazil)
• pt-PT: Portuguese (Portugal)
• ro: Romanian
• ru: Russian
• sk: Slovak
• sl: Slovenian
• sr: Serbian
• sv: Swedish
• th: Thai
• tr: Turkish
• uk: Ukrainian
• vi: Vietnamese
• zh-CN: Chinese (China)
• zh-HK: Chinese (Hong Kong)
• zh-TW: Chinese (Taiwan)