/EditVehicleRoutingProblem

Attributes for orders

• ObjectIDinteger

  The system-managed ID field.

• Namestring (length: 500)nullable

  The name of the order. The name must be unique. If the name is left null, a name is automatically generated at solve time.

• Descriptionstring (length: 500)

  The descriptive information about the order. This can contain any textual information for the order and has no restrictions for uniqueness. You may want to store a client's ID number in the Name field and the client's actual name or address in the Description field.

• ServiceTimenumber (non-negative)nullable

  The amount of time that will be spent at the network location when the route visits it; that is, it stores the impedance value for the network location. A zero or null value indicates that the network location requires no service time.

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

• TimeWindowStart1datetimenullable

  The beginning time of the first time window for the network location. This field 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 ServiceTime from the TimeWindowEnd1 field.

  The time window fields (TimeWindowStart1, TimeWindowEnd1, TimeWindowStart2, and TimeWindowEnd2) must be specified in a date field as an integer that represents the number of milliseconds since epoch (January 1, 1970) and not as date-time values. The time zone for time window fields is specified using the time_zone_usage_for_time_fields parameter. For example, if the orders are located in the Pacific standard time zone and you want to specify that the time window should start at 8:00 a.m. (local time) on November 18, 2019, the value for the TimeWindowStart1 field should be specified as milliseconds since epoch for this date and time, which is 1574064000000. You also should specify the time_zone_usage_for_time_fields parameter value as GEO_LOCAL.

  When solving a problem that spans multiple time zones, each order's time-window values refer to the time zone in which the order is located.

• TimeWindowEnd1datetimenullable

  The ending time of the first window for the network location. This field can contain a null value; a null value indicates no ending time.

• TimeWindowStart2datetimenullable

  The beginning time of the second time window for the network location. This field can contain a null value; a null value indicates that there is no second time window.

  If the first time window is null as specified by the TimeWindowStart1 and TimeWindowEnd1 fields, the second time window must also be null. If both time windows are non null, they can't overlap. Also, the second time window must occur after the first.

• TimeWindowEnd2datetimenullable

  The ending time of the second time window for the network location. This field can contain a null value.

  When TimeWindowStart2 and TimeWindowEnd2 are both null, there is no second time window. When TimeWindowStart2 is not null but TimeWindowEnd2 is null, there is a second time window that has a starting time but no ending time. This is valid.

• MaxViolationTime1number (non-negative)nullable

  A time window is considered violated if the arrival time occurs after the time window has ended. This field specifies the maximum allowable violation time for the first time window of the order. It can contain a zero value but can't contain negative values. A zero value indicates that a time window violation at the first time window of the order is unacceptable; that is, the first time window is hard. Conversely, a null value indicates that there is no limit on the allowable violation time. A nonzero value specifies the maximum amount of lateness; for example, a route can arrive at an order up to 30 minutes beyond the end of its first time window.

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

  Time window violations can be tracked and weighted by the solver. Consequently, you can direct the VRP solver to do one of the following:

  • Minimize the overall violation time regardless of the increase in travel cost for the fleet.
  • Find a solution that balances overall violation time and travel cost.
  • Ignore the overall violation time and minimize the travel cost for the fleet.

  By assigning an importance level for the time_window_factor parameter, you are essentially choosing one of these options. In any case, however, the solver will return an error if the value set for MaxViolationTime1 is surpassed.

• MaxViolationTime2number (non-negative)nullable

  The maximum allowable violation time for the second time window of the order. This field is analogous to the MaxViolationTime1 field.

• InboundArriveTimedatetimenullable

  Defines 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 latest start time value; this way, the route cannot leave the depot before the item is ready to be loaded onto it.

  This field can help model scenarios involving inbound-wave transshipments. For example, a job at an order requires special materials that are not currently available at the depot. The materials are being shipped from another location and will arrive at the depot at 11:00 a.m. To ensure a route that leaves before the shipment arrives isn't assigned to the order, the order's inbound arrive time is set to 11:00 a.m. The special materials arrive at 11:00 a.m., they are loaded onto the vehicle, and the vehicle departs from the depot to visit its assigned orders.

• OutboundDepartTimedatetimenullable

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

• DeliveryQuantitiesstring (length: 500)

  The size of the delivery. You can specify size in any dimension, such as weight, volume, or quantity. You can also specify multiple dimensions, for example, weight and volume.

  Enter delivery quantities without indicating units. For example, if a 300-pound object needs to be delivered to an order, enter 300. You will need to remember that the value is in pounds.

  If you are tracking multiple dimensions, separate the numeric values with a space. For example, if you are recording the weight and volume of a delivery that weighs 2,000 pounds and has a volume of 100 cubic feet, enter 2000 100. Again, you need to remember the units—in this case, pounds and cubic feet. You also need to remember the sequence in which the values and their corresponding units are entered.

  Make sure that Capacities for Routes and DeliveryQuantities and PickupQuantities for Orders are specified in the same manner; that is, the values must be in the same units. If you are using multiple dimensions, the dimensions must be listed in the same sequence for all parameters. For example, if you specify weight in pounds, followed by volume in cubic feet for DeliveryQuantities , the capacity of your routes and the pickup quantities of your orders must be specified the same way: weight in pounds, then volume in cubic feet. If you combine units or change the sequence, you will get unwanted results with no warning messages.

  An empty string or null value is equivalent to all dimensions being infinity. If the string has an insufficient number of values in relation to the capacity count or dimensions being tracked, the remaining values are treated as infinity. Delivery quantities can't be negative.

• PickupQuantitiesstring (length: 500)

  The size of the pickup. You can specify size in any dimension, such as weight, volume, or quantity. You can also specify multiple dimensions, for example, weight and volume. You cannot, however, use negative values. This field is analogous to the DeliveryQuantities field of Orders.

  In the case of an exchange visit, an order can have both delivery and pickup quantities.

• Revenuenumber (non-negative)nullable

  The income generated if the order is included in a solution. This field can contain a null value—a null value indicates zero revenue—but it can't have a negative value.

  Revenue is included in optimizing the objective function value but is not part of the solution's operating cost; that is, the TotalCost field in the routes never includes revenue in its output. However, revenue weights the relative importance of servicing orders.

• SpecialtyNamesstring (length: 500)

  A space-separated string containing the names of the specialties required by the order. A null value indicates that the order doesn't require specialties.

  The spelling of any specialties listed in the Orders and Routes classes must match exactly so that the VRP solver can link them together.

  To illustrate what specialties are and how they work, assume a lawn care and tree trimming company has a portion of its orders that requires a bucket truck to trim tall trees. The company enters BucketTruck in the SpecialtyNames field for these orders to indicate their special need. SpecialtyNames is left null for the other orders. Similarly, the company also enters BucketTruck in the SpecialtyNames field of routes that are driven by trucks with hydraulic booms. It leaves the field null for the other routes. At solve time, the VRP solver assigns orders without special needs to any route, but it only assigns orders that need bucket trucks to routes that have them.

• AssignmentRuleint enumnot nullabledefault:Override

  Allowed values: 0, 1, 2, 3, 4, 5

  This attribute specifies the rule for the order's route assignment options. It is constrained by a domain of values, that are listed below:

  • 0: Exclude—The order will be excluded from the subsequent solve operation.
  • 1: Preserve Route and Relative Sequence—The solver must always assign the order to the preassigned route at the preassigned relative sequence during the solve operation. If this assignment rule can't be followed, it results in an order violation. With this setting, only the relative sequence is maintained, not the absolute sequence. To illustrate what this means, imagine there are two orders: A and B. They have sequence values of 2 and 3, respectively. If you set their AssignmentRule field values to Preserve Route and Relative Sequence, the sequence values for A and B may change after solving because other orders, breaks, and depot visits can be sequenced before, between, or after A and B. However, B cannot be sequenced before A.
  • 2: Preserve Route—The solver must always assign the order to the preassigned route during the solve operation. A valid sequence must also be set even though the sequence may or may not be preserved. If the order can't be assigned to the specified route, it results in an order violation.
  • 3: Override—The solver tries to preserve the route and sequence preassignment for the order during the solve operation. However, a new route or sequence for the order may be assigned if it helps minimize the overall value of the objective function.
  • 4: Anchor first—The solver ignores the route and sequence preassignment (if any) for the order during the solve operation. It assigns a route to the order and makes it the first order on that route to minimize the overall value of the objective function.
  • 5: Anchor last—The solver ignores the route and sequence preassignment (if any) for the order during the solve operation. It assigns a route to the order and makes it the last order on that route to minimize the overall value of the objective function.

  This field can't contain a null value.

• CurbApproachint enumdefault:0

  Allowed values: 0, 1, 2, 3

  Specify 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 your 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. This is typically used for vehicles such as buses that must arrive with the bus stop on the right side. The allowed arrival and departure combination for the Right side of vehicle curb approach is shown.
  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. This is typically used for vehicles such as buses that must arrive with the bus stop on the left side. The allowed arrival and departure combination for the Left side of vehicle curb approach is shown.
  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 in. A U-turn is prohibited. The allowed arrival and departure combinations for the No U-Turn curb approach are shown.

  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.

  

  

• RouteNamestring (length: 1024)

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

  This field 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 identifies the best possible route assignment for the order. If this is set to null, the Sequence field must also be set to null.

  After a solve operation, if the order is routed, the RouteName field contains the name of the route to which the order is assigned.

• Sequenceinteger

  Indicates the sequence of the order on its assigned route.

  This field is used to specify the relative sequence of an order on the route. This field can contain a null value specifying that the order can be placed anywhere along the route. A null value can only occur together with a null RouteName value.

  The input sequence values are positive and unique for each route (shared across renewal depot visits, orders, and breaks) but do not need to start from 1 or be contiguous.

  After a solve operation, the Sequence field contains the sequence value of the order on its assigned route. Output sequence values for a route are shared across depot visits, orders, and breaks; start from 1 (at the starting depot); and are consecutive. The smallest possible output sequence value for a routed order is 2, since a route always begins at a depot.

• Bearingnumber (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

• BearingTolnumber (range: 0 - 180)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. 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

• NavLatencynumber (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

• ObjectIDinteger

  The system-managed ID field.

• Namestring (length: 500)

  The name of the depot. The StartDepotName and EndDepotName fields on routes reference the names you specify here. It is also referenced by the route renewals, when used.

  Depot names are not case sensitive but must be nonempty and unique.

• Descriptionstring (length: 500)

  The descriptive information about the depot location. This can contain any textual information and has no restrictions for uniqueness. For example, if you want to note which region a depot is in or the depot's address and telephone number, you can enter the information here rather than in the Name field.

• TimeWindowStart1datetimenullable

  The beginning time of the first time window for the network location. This field can contain a null value; a null value indicates no beginning time.

  The time window fields (TimeWindowStart1, TimeWindowEnd1, TimeWindowStart2, and TimeWindowEnd2) must be specified in a date field as an integer that represents the number of milliseconds since epoch (January 1, 1970) and not as date-time values. The time zone for time window fields is specified using the time_zone_usage_for_time_fields parameter. For example, if the orders are located in the Pacific standard time zone and you want to specify that the time window should start at 8:00 a.m. (local time) on November 18, 2019, the value for the TimeWindowStart1 field should be specified as milliseconds since epoch for this date and time, which is 1574064000000. You also should specify the time_zone_usage_for_time_fields parameter value as GEO_LOCAL.

  When solving a problem that spans multiple time zones, each depot's time-window values refer to the time zone in which the depot is located.

• TimeWindowEnd1datetimenullable

  The ending time of the first window for the network location. This field can contain a null value; a null value indicates no ending time.

• TimeWindowStart2datetimenullable

  The beginning time of the second time window for the network location. This field can contain a null value; a null value indicates that there is no second time window.

  If the first time window is null, as specified by the TimeWindowStart1 and TimeWindowEnd1 fields, the second time window must also be null.

  If both time windows are not null, they can't overlap. Also, the second time window must occur after the first.

• TimeWindowEnd2datetimenullable

  The ending time of the second time window for the network location. This field can contain a null value. When TimeWindowStart2 and TimeWindowEnd2 are both null, there is no second time window. When TimeWindowStart2 is not null but TimeWindowEnd2 is null, there is a second time window that has a starting time but no ending time. This is valid.

• CurbApproachint enumdefault:0

  Allowed values: 0, 1, 2, 3

  Specify 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.
  • 3: No U-turn. When the vehicle approaches the depot, 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 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 your 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 depot 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. This is typically used for vehicles such as buses that must arrive with the bus stop on the right side. The allowed arrival and departure combination 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. This is typically used for vehicles such as buses that must arrive with the bus stop on the left side. The allowed arrival and departure combination for the Left side of vehicle curb approach
  No U-Turn	3	When the vehicle approaches the depot, the depot can be on either side of the vehicle; however, when it departs, the vehicle must continue in the same direction it arrived in. A U-turn is prohibited. The allowed arrival and departure combinations 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 a depot 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 a depot 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 a depot and not have a lane of traffic between the vehicle and the depot, choose 1 (Right side of vehicle) in the United States and 2 (Left side of vehicle) in the United Kingdom.

  

  

• Bearingnumber (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

• BearingTolnumber (range: 0 - 180)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. 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

• NavLatencynumber (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 (length: 1024)

  The name of the route. The name must be unique.

  The service generates a unique name if the attribute value is null. Therefore, specifying a value is optional in most cases. However, you must specify a name if your analysis includes breaks, route renewals, route zones, or orders that are preassigned to a route because the route name is used as a foreign key in these cases. Note that route names are case insensitive.

• StartDepotNamestring (length: 500)

  The name of the starting depot for the route. This attribute is a foreign key to the Name attribute in the depots parameter, so the values must match.

  If the StartDepotName value is null, the route will begin from the first order assigned. Omitting the start depot is useful when the vehicle's starting location is unknown or irrelevant to your problem. However, when StartDepotName is null, EndDepotName cannot also be null.

  Virtual start depots are not allowed if orders or depots are in multiple time zones.

  If the route is making deliveries and StartDepotNameis null, it is assumed the cargo is loaded on the vehicle at a virtual depot before the route begins. For a route that has no renewal visits, its delivery orders (those with nonzero DeliveryQuantities values in the orders parameter) are loaded at the start depot or virtual depot. For a route that has renewal visits, only the delivery orders before the first renewal visit are loaded at the start depot or virtual depot.

• EndDepotNamestring (length: 500)

  The name of the ending depot for the route. This attribute is a foreign key to the Name attribute in the depots parameter, so the values must match.

• StartDepotServiceTimenumber (non-negative)

  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; a null value indicates zero service time. The unit for this attribute value is specified by the time_units parameter.

• EndDepotServiceTimenumber (non-negative)

  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; a null value indicates zero service time. The unit for this attribute value is specified by the time_units parameter.

  The service times at the start and end depots are fixed values (given by the StartDepotServiceTime and EndDepotServiceTime attribute values) and do not take into account the actual load for a route. For example, the time taken to load a vehicle at the starting depot may depend on the size of the orders. Therefore, the depot service times could be given values corresponding to a full truckload or an average truckload, or you could make your own time estimate.

• EarliestStartTimedatetimenullable

  The earliest allowable starting time for the route. This is used by the service in conjunction with the time window of the starting depot for determining feasible route start times.

  This attribute can't contain null values and has a default time-only value of 8:00 AM on the date given by the default_date parameter or the current date if unspecified.

• LatestStartTimedatetimenullable

  The latest allowable starting time for the route. This attribute can't contain null values and has a default time-only value of 10:00 AM; the default value is interpreted as 10:00 a.m. on the date given by the default_date parameter.

  The value for the EarliestStartTime and LatestStartTime attributes is specified in a date field as an integer that represents the number of milliseconds since epoch (January 1, 1970).

  The time zone is specified using the time_zone_usage_for_time_fields parameter. If set to GEO_LOCAL, the time is in the time zone where the route's depot is located. This is useful if your routes span multiple time zones but they all start at a consistent time (for example, 8:00 a.m. in the depot's time zone). If the parameter is set to UTC, the time is based on UTC time. This is useful if you don't know the time zone of an individual route's depot but know its absolute time (for example, the time window starts an hour from now).

• ArriveDepartDelaynumber (non-negative)

  Stores 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). By including an ArriveDepartDelay value, the service is deterred from sending many routes to service physically coincident orders.

  The cost for this attribute is incurred between visits to noncoincident orders, depots, and route renewals. 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 because the vehicle doesn't need to move. If the route travels to a route renewal, the value is added to the travel time again.

  Although a vehicle needs to slow down and stop for a break and accelerate afterward, the service cannot add the ArriveDepartDelay value for breaks. This means that if a route leaves an order, stops for a break, and continues to the next order, the arrive/depart delay is added only once, not twice.

  To illustrate, assume there are five coincident orders in a high-rise building, and they are serviced by three different routes. This means three arrive/depart delays would be incurred; that is, three drivers would need to separately find parking places and enter the same building. However, if the orders could be serviced by just one route instead, only one driver would need to park and enter the building—only one arrive/depart delay would be incurred. Since the service tries to minimize cost, it will try to limit the arrive/depart delays and thus choose the single-route option. (Note that multiple routes may need to be sent when other constraints—such as specialties, time windows, or capacities—require it.)

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

• Capacitiesstring (length: 128)

  The maximum capacity of the vehicle. You can specify capacity in any dimension you want, such as weight, volume, or quantity. You can even specify multiple dimensions, for example, weight and volume.

  Specify capacities without indicating units. For example, assume your vehicle can carry a maximum of 40,000 pounds; you would specify 40000 as the value for the Capacities attribute. You need to remember for future reference that the value is in pounds.

  If you are tracking multiple dimensions, separate the numeric values with a space. For instance, if you are recording both weight and volume and your vehicle can carry a maximum weight of 40,000 pounds and a maximum volume of 2,000 cubic feet, Capacities should be specified as 40000 2000. Again, you need to remember the units. You also need to remember the sequence in which the values and their corresponding units are specified (pounds followed by cubic feet in this case).

  Remembering the units and the unit sequence is important for a couple of reasons: first, so you can reinterpret the information later, and second, so you can properly enter values for the DeliveryQuantities and PickupQuantities attributes in the orders parameter. To elaborate on the second point, note that the service simultaneously refers to Capacities, DeliveryQuantities, and PickupQuantities attributes to make sure that a route doesn't become overloaded. Since units can't be entered in the field, the service can't make unit conversions, so you need to specify the values for the three attributes using the same units and the same unit sequence to ensure the values are correctly interpreted. If you mix units or change the sequence in any of the three attributes, you will get unwanted results without receiving any warning messages. Thus, it is a good idea to set up a unit and unit-sequence standard beforehand and continually refer to it whenever specifying values for these three attributes.

  If the Capacities string has an insufficient number of values in relation to the DeliveryQuantities or PickupQuantities attributes in the orders parameter, the unspecified values are treated as infinity.

• FixedCostnumber (non-negative)

  A fixed monetary cost that is incurred only if the route is used in a solution (that is, it has orders assigned to it). This attribute can contain null values; a null value indicates zero fixed cost. This cost is part of the total route operating cost.

• CostPerUnitTimenumber (non-negative)

  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, depots, and breaks. This attribute can't 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)

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

• OverTimeStartTimenumber (non-negative)

  The duration of regular work time before overtime computation begins. This attribute can contain null values; a null value indicates that overtime does not apply. 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 480 (8 hours * 60 minutes/hour), given the time_units parameter is set to Minutes.

• CostPerUnitOvertimenumber (non-negative)

  The monetary cost incurred per time unit of overtime work. This attribute can contain null values; a null value indicates that the CostPerUnitOvertime value is the same as the CostPerUnitTime value. The unit for this attribute value is specified by the time_units parameter.

• MaxOrderCountinteger

  The maximum allowable number of orders on the route. This attribute can't contain null values and has a default value of 30.

• MaxTotalTimenumber (non-negative)

  The maximum allowable route duration. The route duration includes travel times as well as service and wait times at orders, depots, and breaks. This attribute can contain null values; a null value indicates that there is no constraint on the route duration. The unit for this attribute value is specified by the time_units parameter.

• MaxTotalTravelTimenumber (non-negative)

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

• MaxTotalDistancenumber (non-negative)

  The maximum allowable travel distance for the route. This attribute can contain null values; a null value indicates that there is no constraint on the maximum allowable travel distance. The unit for this attribute value is specified by the distance_units parameter.

• SpecialtyNamesstr (length: 1024)

  A space-separated string containing the names of the specialties supported by the route. A null value indicates that the route does not support any specialties. This attribute is a foreign key to the SpecialtyNames attribute in the orders parameter, so the values must match.

  To illustrate what specialties are and how they work, assume a lawn care and tree trimming company has a portion of its orders that requires a bucket truck to trim tall trees. The company would specify BucketTruck as the value for the SpecialtyNames attribute for these orders to indicate their special need. SpecialtyNames would be left as null for the other orders. Similarly, the company would also specify BucketTruck as the value for the SpecialtyNames attribute for the routes that are driven by trucks with hydraulic booms. It would leave the attribute value as null for the other routes. When finding the solution, the service assigns orders without special needs to any route, but it only assigns orders that need bucket trucks to routes that have them.

• AssignmentRuleint enumdefault:1

  Allowed values: 0, 1

  Specifies whether the route can be used or not when solving the problem. The attribute value should be specified as one of the following integer values:

  • 0 —The route is excluded from the solution.
  • 1 —The route is included when finding the solution.

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

Attributes for breaks

• RouteNamestring (length: 1024)

  The name of the route that the break applies to. Although a break is assigned to exactly one route, many breaks can be assigned to the same route. This attribute is a foreign key to the Name attribute in the routes parameter, so the values must match. The attribute cannot have a null value.

• Precedenceintegerdefault:1

  Specify the values to sequence the breaks of a given route. Breaks with a precedence value of 1 occur before those with a value of 2, and so on. All breaks must have a precedence value, regardless of whether they are time window, maximum travel time, or maximum work time breaks.

• ServiceTimenumber (non-negative)default:60

  The duration of the break. The units for this attribute value are specified by the time_units parameter. This attribute can't contain a null value.

• TimeWindowStartdatetimedefault:null

  The starting time of the break's time window. Specifying this attribute indicates that the service should consider the breaks as time window breaks. The attribute value is specified as a numeric value representing the milliseconds since midnight, January 1, 1970.

  If this attribute is null and the TimeWindowEnd attribute has a valid time-of-day value, the break is allowed to start anytime before the TimeWindowEnd value.

• TimeWindowEnddatetimedefault:null

  The ending time of the break's time window. Specifying this attribute indicates that the service should consider the breaks as time window breaks. The attribute value is specified as a numeric value representing the milliseconds since midnight, January 1, 1970.

  If this attribute is null and the TimeWindowStart attribute has a valid time-of-day value, the break is allowed to start anytime after the TimeWindowStart value.

  For both the TimeWindowStart and TimeWindowEnd attributes, the time zone is specified by the time_zone_usage_for_time_fields parameter. If the parameter is set to GEO_LOCAL , the time is in the time zone where the route's depot is located. This is useful if your routes span multiple time zones but they all break at a consistent time (for example, 12:00 p.m. in the depot's time zone). If the parameter is set to UTC, the time is based on UTC time. This is useful if you don't know the time zone of an individual route's depot but know the absolute time for each break (for example, the break starts an hour from now).

• MaxViolationTimenumber (non-negative)default:null

  The maximum allowable violation time for a time window break. A time window is considered violated if the arrival time falls outside of the time range. The units for this attribute value are specified by the time_units parameter.

  A zero value indicates the time window cannot be violated; that is, the time window is hard. A nonzero value specifies the maximum amount of lateness; for example, the break can begin up to 30 minutes beyond the end of its time window, but the lateness is penalized as per the time_window_factor parameter. A null value indicates that there is no limit on the allowable violation time.

• MaxTravelTimeBetweenBreaksnumber (non-negative)default:null

  The maximum amount of travel time that can be accumulated before the break is taken. Specifying this attribute indicates that the service should consider the breaks as travel time breaks. The travel time is accumulated either from the end of the previous break or, if a break has not yet been taken, from the start of the route. If this is the route's final break, this attribute also indicates the maximum travel time that can be accumulated from the final break to the end depot.

  The MaxTravelTimeBetweenBreaks attribute is designed to limit how long a person can drive until a break is required. For instance, if the time_units parameter is set to Minutes , and MaxTravelTimeBetweenBreaks has a value of 120, the driver will get a break after two hours of driving. To assign a second break after two more hours of driving, the second break's MaxTravelTimeBetweenBreaks attribute value should be 120.

  The units for this attribute value are specified by the time_units parameter.

• MaxCumulWorkTimenumber (non-negative)default:null

  The maximum amount of work time that can be accumulated before the break is taken. Specifying this attribute indicates that the service should consider the breaks as work time breaks. Work time is always accumulated from the beginning of the route. Work time is the sum of travel time and service times at orders, depots, and breaks. Note, however, that this excludes wait time, which is the time a route (or driver) spends waiting at an order or depot for a time window to begin.

  The MaxCumulWorkTime attribute is designed to limit how long a person can work until a break is required. For instance, if the time_units parameter is set to Minutes, the MaxCumulWorkTime attribute has a value of 120, and the ServiceTime attribute has a value of 15, the driver will get a 15-minute break after two hours of work. If a second break is needed after three more hours of work, you would specify 315 (five hours and 15 minutes) as the second break's MaxCumulWorkTime value. This number includes the MaxCumulWorkTime and ServiceTime values of the preceding break, along with the three additional hours of work time before granting the second break. To avoid taking maximum work time breaks prematurely, remember that they accumulate work time from the beginning of the route and that work time includes the service time at previously visited depots, orders, and breaks.

  The units for this attribute value are specified by the time_units parameter.

• IsPaidintegerdefault:1

  Specifies whether the break is paid or unpaid. The attribute value is specified as an integer with possible values being 0 or 1. A value of 1 indicates that the time spent at the break is included in the route cost computation and overtime determination. A value of 0 indicates otherwise.

• Sequenceintegerdefault:null

  Indicates the relative sequence of the break on its route. The attribute values must be positive and unique for each route but need not start from 1 or be contiguous. In the service output, the Sequence attribute of the out_stops parameter contains the sequence value of the break on its route. This attribute can have null values specifying that the break can be placed anywhere along the route.

Attributes for route zones

• RouteNamestring (length: 1024)

  The name of the route to which this zone applies. A route zone can have a maximum of one associated route. This attribute is a foreign key to the Name attribute in the routes parameter, so the values must match. The attribute cannot have a null value.

• IsHardZoneint enumdefault:null

  Allowed values: 0, 1

  Specify if the route zone is hard or soft.

  • 0: Indicates that such orders 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. Basically, 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.
  • 1: Indicates that the route zone is hard; that is, an order that falls outside of the route zone area can't be assigned to the route.

Attributes for route renewals

• RouteNamestring (length: 1024)

  The name of the route that this renewal applies to. This attribute is a foreign key to the Name attribute in the routes parameter, so the values must match. The attribute cannot have a null value.

• DepotNamestring (length: 1024)

  The name of the depot where this renewal takes place. This attribute is a foreign key to the Name attribute in the depots parameter, so the values must match. The attribute cannot have a null value.

• ServiceTimenumber (non-negative)default:60

  The service time for the renewal. This attribute can contain a null value; a null value indicates zero service time. The units for this attribute value are specified by the time_units parameter.

• Sequenceintegerdefault:null

Specify one or more sequences of visits to the renewal depot. This attribute can be used to preassign visits to the renewal depot. The attribute value is specified as a space-separated string of sequence values. The attribute can contain a null value; a null value indicates that the service will determine the best sequence to visit the renewal depot.

Attributes for order pairs

• FirstOrderNamestring (length: 500)

  The name of the first order of the pair. This attribute is a foreign key to the Name attribute in the orders parameter, so the values must match. The attribute cannot have a null value.

• SecondOrderNameNamestring (length: 500)

  The name of the second order of the pair. This attribute is a foreign key to the Name attribute in the orders parameter, so the values must match. The attribute cannot have a null value.

• MaxTransitTimenumber (non-negative)default:60

  The maximum transit time for the pair. The transit time is the duration from the departure time of the first order to the arrival time at the second order. This constraint limits the time-on-vehicle, or ride time, between the two orders. When a vehicle is carrying people or perishable goods, the ride time is typically shorter than that of a vehicle carrying packages or nonperishable goods.

  Excess transit time (measured with respect to the direct travel time between order pairs) can be tracked and weighted by the service. Because of this, you can direct the service to take one of three approaches: minimize the overall excess transit time, regardless of the increase in travel cost for the fleet; find a solution that balances overall violation time and travel cost; or ignore the overall excess transit time and, instead, minimize the travel cost for the fleet. By assigning an importance level for the excess_transit_factor parameter, you are in effect choosing one of these three approaches. Regardless of the importance level, the service will always return an error if the MaxTransitTime attribute value is surpassed.

  This attribute can contain null values; a null value indicates that there is no constraint on the ride time. The default value for this attribute is null .

Attributes for barriers

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

  • 2: Added Cost. Traveling through the barrier increases the travel time or distance by the amount specified in the Attr_[Cost] attributes. This barrier type is referred to as an added cost point barrier.
  

  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.

• Attr_[Cost]number (non-negative)default:0

  Indicates how the cost (time or distance) is added when the barrier is traversed. This attribute is applicable only for added cost point barriers. The attribute value must be greater than or equal to zero.

Attributes for polylineBarriers

• Namestring (length: 500)nullable

  The name of the barrier.

• ObjectIDinteger (non-negative)nullable

  The object ID of the line barrier. ObjectID is a unique identifier for the line barrier. If you want to maintain a relationship between the input and output, set preserveObjectID to true. The ObjectID value of the input line barrier is included in the output line barrier (as the ObjectID field) and can be used to join additional information from analysis outputs to the attribute of the line barriers. If the ObjectID value is not specified, a unique ID is automatically generated in the output.

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

Attributes for polygonBarriers

• Namestringnullable

  The name of the barrier.

• ObjectIDinteger (non-negative)nullable

  The object ID of the polygon barrier. ObjectID is a unique identifier for the polygon barrier. If you want to maintain a relationship between the input and output, set preserveObjectID to true. The ObjectID value of the input polygon barrier is included in the output polygon barrier (as the ObjectID field) and can be used to join additional information from analysis outputs to the attribute of the polygon barriers. If the ObjectID value is not specified, a unique ID is automatically generated in the output.

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

  • 1: Scaled Cost. Scales the cost (such as travel time or distance) required to travel the underlying streets by a factor specified using the Attr_[Cost] attributes.

    If the streets are partially covered by the barrier, the travel time or distance is apportioned and then scaled. For example, a factor of 0.25 means that travel on underlying streets is expected to be four times faster than normal. A factor of 3.0 means it is expected to take three times longer than normal to travel on underlying streets. This barrier type is referred to as a scaled-cost polygon barrier. It can be used to model storms that reduce travel speeds in specific regions, for example.

  

  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.

• Attr_[Cost]number (non-negative)default:0

  This is the factor by which the cost of the streets intersected by the barrier is multiplied. This attribute is applicable only for scaled cost barriers. The attribute value must be greater than zero.

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

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)

• Namestring (length: 500)nullable

  The name of the stop. The value of this field is the same as the Name field from the input orders, depots, or breaks. You can use the StopType field to determine if the Name field value refers to a depot, an order, or a break.

• StopTypeintegernullable

  Indicates whether the stop represents a depot, an order, or a break. The field value is an integer that can be interpreted in the following ways:

  • 0 —The stop is an order
  • 1 —The stop is a depot
  • 2 —The stop is a break

• PickupQuantitiesstring

  The amount of cargo or number of people to be picked up from a stop. If multiple dimensions are delivered to a stop, each quantity is separated by a space.

  The units for the value of this field aren't stored. Interpret the units according to the way you specified the Capacities field on the input routes and the PickupQuantities and DeliveryQuantities fields on the input orders.

• DeliveryQuantitiesstring

  The amount of cargo or number of people to be delivered to a stop. If multiple dimensions are delivered to a stop, each quantity is separated by a space.

  The units for the value of this field aren't stored. Interpret the units according to the way you specified the Capacities field on the input routes and the PickupQuantities and DeliveryQuantities fields on the input orders.

• RouteNamestring (length: 1024)nullable

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

• Sequenceintegernullable

  The relative sequence in which the assigned route visits the stop.

• FromPrevTravelTimenumber (non-negative)nullable

  The elapsed travel time from the previous stop to the current stop. The value is in the units specified by the time_units parameter.

• FromPrevDistancenumber (non-negative)nullable

  The distance along the route from the previous stop to the current stop. The value is in the units specified by the distance_units parameter.

• ArriveCurbApproachintegernullable

  Indicates the side of the vehicle the curb is on when arriving at the stop. A value of 1 means the right side of the vehicle; a value of 2 means the left side.

• DepartCurbApproachintegernullable

  Indicates the side of the vehicle the curb is on when departing from the stop. A value of 1 means the right side of the vehicle; a value of 2 means the left side.

• ArriveTimedatedatetime

  The time of day the route arrives at the stop. The time of day value for this field is in the time zone in which the stop is located.

• DepartTimedatedatetime

  The time of day the route departs from the stop. The time of day value for this field is in the time zone in which the stop is located.

• ArriveTimeUTCdatedatetime

  The time of day the route arrives at the stop. This value is in coordinated universal time (UTC).

• DepartTimeUTCdatedatetime

  The time of day the route departs from the stop. This value is in coordinated universal time (UTC).

• WaitTimenumber (non-negative)nullable

  The wait time or layover at the stop. For example, a wait time is incurred when a route must wait at an order for a time window to open.

  The value is in the units specified by the time_unitsparameter.

• ViolationTimenumber (non-negative)nullable

  The amount of time elapsed from the end of the stop's time window to the arrival of the route vehicle.

  The value is in the units specified by the time_units parameter.

• ORIG_FIDintegernullable

  The ObjectID of the input order, depot, or break. This field can be used to join attributes from input features.

• SnapXnumber (non-negative)

  The x-coordinate of the position on the network dataset where the point was located, in the coordinate system of the network dataset.

• SnapYnumber (non-negative)

  The y-coordinate of the position on the network dataset where the point was located, in the coordinate system of the network dataset.

• SnapZnumber (non-negative)

  The z-coordinate of the position on the network dataset where the point was located, in the coordinate system of the network dataset. The SnapZ attribute is 0 if the network is two-dimensional.

• DistanceToNetworkInMetersnumber (non-negative)

  The distance in meters between the point's geographic location and the position where it was located on the network.

• Namestring (length: 500)nullable

  The name of the route. The values for this field are copied from the Name field on the input routes.

• ViolatedConstraintsintegernullable

  This field is deprecated and replaced by the four individual fields ViolatedConstraint_1 through ViolatedConstraint_4. The descriptions of the violations can be seen in ViolationConstraints_#.

• ViolatedConstraint_1 through ViolatedConstraint_4integernullable

  These fields contain a summary of violated constraints and are set after a solve operation. Each field will contain one violation. If an order has more than one violation, the next ViolatedConstraint_# field will be used.

  • MaxOrderCount exceeded(0)—The preassigned orders cannot be assigned to the route since assigning the orders would exceed the maximum number of orders that can be assigned to the route as specified by the route's MaxOrderCount field value.
  • Capacities exceeded(1)—The preassigned orders cannot be assigned to the route since assigning the orders would exceed the total route capacity as specified by the route's Capacities field value.
  • MaxTotalTime exceeded(2)—The travel time from the start depot to the end depot plus the service and wait times at both depots and any break exceeds the total time for the route as specified by the route's MaxTotalTime field value.
  • MaxTotalTravelTime exceeded(3)—The travel time from the start depot to the end depot exceeds the total travel time for the route as specified by the route's MaxTotalTravelTime field value.
  • MaxTotalDistance exceeded(4)—The travel distance from the start depot to the end depot exceeds the total travel distance for the route as specified by the route's MaxTotalDistance field value.
  • Hard time window(5)—There is a hard time window violation on the start depot, end depot, or break associated with the route.
  • Unmatched specialty(6)—The specialties required by an order are not found on the target route.
  • Hard route zone(7)—An order that was preassigned to the route does not fall within a hard route zone.
  • Order pair MaxTransitTime exceeded(8)—There is an order pair preassigned to the route, and assigning the orders in the order pair would exceed the maximum transit time for the order pair as specified by the order pair's MaxTransitTime field value.
  • Order pair violation(9)—An order belongs to an order pair and cannot be assigned to the preassigned route.
  • Unreachable(10)—A preassigned order is located on a network element that cannot be reached by the route.
  • Cannot insert required break(11)—A break for the route has a null sequence value in the presence of preassigned orders, and the break cannot be inserted anywhere without introducing other violations.
  • Cannot insert required renewal(12)—A route exceeds its capacity and needs to visit a route renewal; however, the associated route renewal has a null sequence value in the presence of preassigned orders and cannot be inserted anywhere without introducing other violations.
  • MaxTravelTimeBetweenBreaks exceeded(13)—The solver was unable to insert a break within the time specified by the break's MaxTravelTimeBetweenBreaks field. This is often caused by preassigning a sequence to a break such that it cannot be reached within the maximum travel time.
  • Break MaxCumulWorkTime exceeded(14)—The solver was unable to insert a break within the time specified by the break's MaxCumulWorkTime field. This is often caused by preassigning a sequence to a break such that it cannot be reached within the maximum work time.
  • InboundArriveTime or OutboundDepartTime order violation(15)—The order couldn't be serviced within the inbound arrive time or outbound depart time constraints. This violation occurs when all the routes' LatestStartTime field values precede the InboundArriveTime values or none of the routes can reach a depot before the order's OutboundDepartTime value.
  • Cannot anchor first/last(16)—The order has an Anchor first or Anchor last assignment rule, but the solver was not able to honor this constraint. This violation occurs when the number of Anchor first orders or the number of Anchor last orders is greater than the number of available routes.

• OrderCountintegernullable

  The number of orders assigned to the route.

• TotalCostnumber (non-negative)nullable

  The total operating cost of the route, which is the sum of the following field values: FixedCost, RegularTimeCost, OvertimeCost, and DistanceCost .

• RegularTimeCostnumber (non-negative)nullable

  The cost of regular work time, excluding any unpaid breaks.

• OvertimeCostnumber (non-negative)nullable

  The cost of overtime work, excluding any unpaid breaks.

• DistanceCostnumber (non-negative)nullable

  The distance cost component obtained by multiplying the TotalDistance and CostPerUnitDistance field values.

• TotalTimenumber (non-negative)nullable

  The total route duration. This includes travel times as well as service and wait times at orders, depots, and breaks. The TotalTime value is the sum of the following attribute fields:

  • StartDepotServiceTime
  • EndDepotServiceTime
  • TotalOrderServiceTime
  • TotalBreakServiceTime
  • TotalRenewalServiceTime
  • TotalWaitTime
  • TotalTravelTime

  The value is in the units specified by the time_units parameter.

• TotalOrderServiceTimenumber (non-negative)nullable

  The total service time spent at all orders on the route.

  The value is in the units specified by the time_units parameter.

• TotalBreakServiceTimenumber (non-negative)nullable

  The total service time spent at all breaks on the route.

  The value is in the units specified by the time_units parameter.

• TotalTravelTimenumber (non-negative)nullable

  The total travel time for the route.

  The value is in the units specified by the time_units parameter.

• TotalDistancenumber (non-negative)nullable

  The total travel distance for the route.

  The value is in the units specified by the distance_units parameter.

• StartTimedatedatetime

  The starting time of the route. The route may start before the beginning of its start depot's time window, in which case there is a wait time at the starting depot. The time of day value for this attribute is in the time zone in which the starting depot is located.

• EndTimedatedatetime

  The ending time of the route. The route ends upon completion of service at the ending depot. The time of day value for this attribute is in the time zone in which the ending depot is located.

• StartTimeUTCdatedatetime

  The start time of the route in coordinated universal time (UTC).

• EndTimeUTCdatedatetime

  The end time of the route in coordinated universal time (UTC).

• TotalWaitTimenumber (non-negative)nullable

  The total wait time at all orders, depots, and breaks on the route.

  The value is in the units specified by the time_units parameter.

• TotalViolationTimenumber (non-negative)nullable

  The total violation time at all orders and breaks on the route.

  The value is in the units specified by the time_units parameter.

• RenewalCountintegernullable

  For a route with renewals, this is equal to the number of visits to depots for the purpose of renewing a vehicle, that is, loading or unloading a vehicle.

• TotalRenewalServiceTimenumber (non-negative)nullable

  For a route with renewals, this is the total service time spent at all renewal visits on the route.

  The value is in the units specified by the time_units parameter.

• RouteNamestring (length: 500)nullable

  The name of the route to which the driving action applies. This value is the same as the Name field of the output routes.

• ArriveTimedatetimenullable

  The time of day to initiate the given driving action. If the route spans multiple days, the date and time of day are displayed.

• Typeintegernullable

  The type of maneuver that the directions feature represents or the type of the directions text. To determine whether Type refers to a maneuver type or a directions string type, review the SubItemType field value.

  Type can be used, for example, to assign an icon for direction text based on the maneuver type, or it can use a formatting style based on the directions string type when displaying the driving directions in the application.

  See Maneuver Types

  • 0: Unknown
  • 1: Arrive at Stop
  • 2: Go straight
  • 3: Bear left
  • 4: Bear right
  • 5: Turn left
  • 6: Turn right
  • 7: Make sharp left
  • 8: Make sharp right
  • 9: Make U-turn
  • 10: Take ferry
  • 11: Take roundabout
  • 12: Merge to highway
  • 13: Exit highway
  • 14: Go on another highway
  • 15: At fork keep center
  • 16: At fork keep left
  • 17: At fork keep right
  • 18: Depart stop
  • 19: Trip planning item
  • 20: End of ferry
  • 21: Ramp right
  • 22: Ramp left
  • 23: Turn left and immediately turn right
  • 24: Turn right and immediately turn left
  • 25: Turn right and immediately turn right
  • 26: Turn left and immediately turn left
  • 27: Pedestrian ramp
  • 28: Elevator
  • 29: Escalator
  • 30: Stairs
  • 31: Door passage
  See Directions String Types

  • 0: General directions string type
  • 1: Depart directions string type
  • 2: Arrive directions string type
  • 3: Length directions string type
  • 4: Time directions string type
  • 5: Time summary directions string type
  • 6: Time Window directions string type
  • 7: Violation Time directions string type
  • 8: Wait Time directions string type
  • 9: Service Time directions string type
  • 10: Estimated Arrival Time directions string type
  • 11: Cumulative Length directions string type
  • 12: Street name directions string type
  • 13: Alternate street name directions string type
  • 14: Sign branch information directions string type
  • 15: Sign toward information directions string type
  • 16: Cross street name directions string type
  • 17: Sign exit number directions string type

• SubItemTypeintegernullable

  Indicated whether the Type field refers to an integer from the Directions String Types table or the Maneuver Types table.

  • If the SubItemType value is 1, the Type field refers to the values from the Maneuver Types table.
  • If the SubItemType value is 2, the Type field refers to the values from the Directions String Types table.
  • If the SubItemType value is 3, the Type field refers to the values from the Directions String Types table.

• Textstring (length: 500)nullable

  A text description of the travel directions.

• ElaspsedTimeintegernullable

  The time elapsed in minutes from when the current driving direction starts until the next one starts, or until the route ends for the last driving direction.

• DriveDistanceintegernullable

  The distance from where the current driving direction occurs to where the next one occurs, or to where the route ends for the last driving direction.

  The value is in the units specified by the distance_units parameter.

  This value is zero for driving directions that occur at the same location where the next one begins. For example, the DriveDistance value is 0 for the directions text at the start of the route.

• Namestring (length: 500)nullable

  The name of the stop. The value of this field is the same as the Name field from input orders, depots, or breaks. You can use the StopType field to determine whether the Name field value refers to a depot, an order, or a break.

• StopTypeintegernullable

  Indicates whether the stop represents a depot, an order, or a break. The field value is an integer that can be interpreted in the following ways:

  • 0 —The stop is an order
  • 1 —The stop is a depot
  • 2 —The stop is a break

• ViolatedConstraintsintegernullable

  This field is deprecated and replaced by the four individual fields ViolatedConstraint_1 through ViolatedConstraint_4. The descriptions of the violations can be seen in ViolationConstraints_#.

• ViolatedConstraint_1 through ViolatedConstraint_4integernullable

  These fields contain a summary of violated constraints and are set after a solve operation. Each field will contain one violation. If an order has more than one violation, the next ViolatedConstraint_# field will be used.

  • MaxOrderCount exceeded(0)—The preassigned orders cannot be assigned to the route since assigning the orders would exceed the maximum number of orders that can be assigned to the route as specified by the route's MaxOrderCount field value.
  • Capacities exceeded(1)—The preassigned orders cannot be assigned to the route since assigning the orders would exceed the total route capacity as specified by the route's Capacities field value.
  • MaxTotalTime exceeded(2)—The travel time from the start depot to the end depot plus the service and wait times at both depots and any break exceeds the total time for the route as specified by the route's MaxTotalTime field value.
  • MaxTotalTravelTime exceeded(3)—The travel time from the start depot to the end depot exceeds the total travel time for the route as specified by the route's MaxTotalTravelTime field value.
  • MaxTotalDistance exceeded(4)—The travel distance from the start depot to the end depot exceeds the total travel distance for the route as specified by the route's MaxTotalDistance field value.
  • Hard time window(5)—There is a hard time window violation on the start depot, end depot, or break associated with the route.
  • Unmatched specialty(6)—The specialties required by an order are not found on the target route.
  • Hard route zone(7)—An order that was preassigned to the route does not fall within a hard route zone.
  • Order pair MaxTransitTime exceeded(8)—There is an order pair preassigned to the route, and assigning the orders in the order pair would exceed the maximum transit time for the order pair as specified by the order pair's MaxTransitTime field value.
  • Order pair violation(9)—An order belongs to an order pair and cannot be assigned to the preassigned route.
  • Unreachable(10)—A preassigned order is located on a network element that cannot be reached by the route.
  • Cannot insert required break(11)—A break for the route has a null sequence value in the presence of preassigned orders, and the break cannot be inserted anywhere without introducing other violations.
  • Cannot insert required renewal(12)—A route exceeds its capacity and needs to visit a route renewal; however, the associated route renewal has a null sequence value in the presence of preassigned orders and cannot be inserted anywhere without introducing other violations.
  • MaxTravelTimeBetweenBreaks exceeded(13)—The solver was unable to insert a break within the time specified by the break's MaxTravelTimeBetweenBreaks field. This is often caused by preassigning a sequence to a break such that it cannot be reached within the maximum travel time.
  • Break MaxCumulWorkTime exceeded(14)—The solver was unable to insert a break within the time specified by the break's MaxCumulWorkTime field. This is often caused by preassigning a sequence to a break such that it cannot be reached within the maximum work time.
  • InboundArriveTime or OutboundDepartTime order violation(15)—The order couldn't be serviced within the inbound arrive time or outbound depart time constraints. This violation occurs when all the routes' LatestStartTime field values precede the InboundArriveTime values or none of the routes can reach a depot before the order's OutboundDepartTime value.
  • Cannot anchor first/last(16)—The order has an Anchor first or Anchor last assignment rule, but the solver was not able to honor this constraint. This violation occurs when the number of Anchor first orders or the number of Anchor last orders is greater than the number of available routes.

• Statusint enum

  Indicates the status of the point with respect to its location on the network and the outcome of the analysis.

  Possible values:

  • 0: OK.The point was located on the network.
  • 1: Not Located. The point was not located on the network and was not included in the analysis.
  • 2: Network element not located. The network element identified by the point's network location fields cannot be found. This can occur when a network element where the point should be was deleted, and the network location was not recalculated.
  • 3: Element not traversable. The network element that the point is located on is not traversable. This can occur when the element is restricted by a restriction attribute.
  • 4: Invalid Field Values. Field values fall outside a range or coded-value domain. For example, a negative number exists where positive numbers are required.
  • 5: Not reached. The point cannot be reached by the solver. The point may be on a separate, disconnected area of the network from the other inputs, or barriers or restrictions prevent travel to or from the point.
  • 6: Time window violation. The point could not be reached within the designated time windows. This status only applies to network analysis types that support time windows.
  • 7: Not located on closest. The closest network location to the point is not traversable because of a restriction or barrier, so the point has been located on the closest traversable network feature instead. If time windows are used and the route arrives early or late, the value changes to 6 (Time window violation)