Job request

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.

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

• MaxViolationTimedouble (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_9double (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_9double (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.

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

  

  

• SourceIDlong (non-negative)nullable

  The numeric identifier of the network dataset source feature class on which the input point is located.

• SourceOIDlong (non-negative)nullable

  The object ID of the feature in the source on which the input point is located.

• PosAlongdouble (non-negative)nullable

  The position along the digitized direction of the source line feature. This value is stored as a ratio. This attribute is null if the network location references a junction.

• SideOfEdgeint enum

  Allowed values: 1, 2

  The side of the edge in relation to the digitized direction of the line feature.

  This attribute is limited to a domain of two values:

  • 1: Right Side
  • 2: Left Side

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

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

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

• SourceIDlong (non-negative)nullable

  The numeric identifier of the network dataset source feature class on which the input point is located.

• SourceOIDlong (non-negative)nullable

  The object ID of the feature in the source on which the input point is located.

• PosAlongdouble (non-negative)nullable

  The position along the digitized direction of the source line feature. This value is stored as a ratio. This attribute is null if the network location references a junction.

• SideOfEdgeint enum

  Allowed values: 1, 2

  The side of the edge in relation to the digitized direction of the line feature.

  This attribute is limited to a domain of two values:

  • 1: Right Side
  • 2: Left Side

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

  

  

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

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

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

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

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

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

• ArriveDepartDelaydouble (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_9double (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.

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

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

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

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

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

• MaxOrderCountlongnullable

  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.

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

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

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

Attributes for point_barriers

• Namestringnullable

  The name of the barrier.

• SourceIDlong (non-negative)nullable

  The numeric identifier of the network dataset source feature class on which the input point is located.

• SourceOIDlong (non-negative)nullable

  The object ID of the feature in the source on which the input point is located.

• PosAlongdouble (non-negative)nullable

  The position along the digitized direction of the source line feature. This value is stored as a ratio. This attribute is null if the network location references a junction.

• SideOfEdgeint enum

  Allowed values: 1, 2

  The side of the edge in relation to the digitized direction of the line feature.

  This attribute is limited to a domain of two values:

  • 1: Right Side
  • 2: Left Side

• CurbApproachint enumdefault:0

  Allowed values: 0, 1, 2, 3

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

  • 0: Either side of vehicle. The vehicle can approach and depart the network location in either direction. U-turns are allowed. You should choose this setting if your vehicle can make a U-turn at the stop 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 network location, 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 network location, 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 network location 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 network location. 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 network location, 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 network location, 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.

  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.

  

  

• FullEdgelong (non-negative)default:False

  This attribute is specific to restriction point barriers on edge elements.

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

• BarrierTypeint enumdefault:0

  Allowed values: 0, 2,

  Specifies 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 options:

  • 0:Restriction. Prohibits travel through the barrier.
  • 2:Added Cost. Traveling through the barrier increases the travel time or distance by the amount specified in the Additional_Time, Additional_Distance, or AdditionalCost attribute. This barrier type is referred to as an added cost point barrier.

• Additional_Timedouble (non-negative)default:0

  The added travel time when the barrier is traversed. This attribute is applicable only for added-cost barriers. The attribute value must be greater than or equal to zero, and its units are the same as those specified in the time_units parameter.

• Additional_Distancedouble (non-negative)default:0

  The added distance when the barrier is traversed. This attribute is applicable only for added-cost barriers. The attribute value must be greater than or equal to zero, and its units are the same as those specified in the distance_units parameter.

• AdditionalCostdouble (non-negative)default:0

  The added cost when the barrier is traversed. This attribute is applicable only for added-cost barriers. The attribute value must be greater than or equal to zero.

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

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

• NavLatencyint (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 attribute also have values; however, providing a NavLatency attribute value is optional, even when values are present in the Bearing and BearingTol.

Attributes for line_barriers

• Namestring (length: 500)

  The name of the barrier.

Attributes for line_barriers

• Namestringnullable

  The name of the barrier.

• BarrierTypeint enumdefault:0

  Allowed values: 0, 1

  Specifies whether the barrier restricts travel completely or scales the cost of traveling through it.

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

  • 0: Restriction. Prohibits traversing through any part of the barrier. .
  • 1: Scaled Cost. Scales the cost (such as travel time or distance) required to travel the underlying streets by a factor specified using the ScaledTimeFactor or ScaledDistanceFactor attribute. 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.

• ScaledTimeFactordouble (non-negative)default:1

  The scaled travel time when the barrier is traversed.

  This attribute is applicable only for scaled-cost barriers. The attribute value must be greater than or equal to zero, and its units are the same as those specified in the time_units parameter.

• ScaledDistanceFactordouble (non-negative)default:1

  The scaled distance when the barrier is traversed.

  This attribute is applicable only for scaled-cost barriers. The attribute value must be greater than or equal to zero, and its units are the same as those specified in the distance_units parameter.

• ScaledCostFactordouble (non-negative)default:1

  The scaled cost when the barrier is traversed. This attribute is applicable only for scaled-cost barriers. The attribute value must be greater than or equal to zero.

Examples for locate_settings

Example 1: Specify default 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"
      }
    ]
  }
}

Example 2: Specify default locate settings and locate settings overrides for some inputs using a JSON structure

This example shows how to specify locate settings to prevent orders and depots from locating on highway ramps. The default locate settings allow locating on the Routing_Streets source. For orders and depots, the overrides option is used to specify a where clause for the Routing_Streets source to prevent locating on highway ramps (a ROAD_CLASS attribute value of 3). With this locate_settings JSON, orders and depots cannot locate on highway ramps, but barriers can because they use the default locate settings, which do not include a where clause.

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
{
  "default": {
    "tolerance": 20,
    "toleranceUnits": "esriKilometers",
    "allowAutoRelocate": true,
    "sources": [
      {
        "name": "Routing_Streets"
      }
    ]
  },
  "overrides": {
    "orders": {
      "sources": [
        {
          "name": "Routing_Streets",
          "where": "ROAD_CLASS <> 3"
        }
      ]
    },

Example 3: Specify default locate settings and locate settings overrides using a JSON structure so different inputs are located using different sources

This example shows how to specify default locate settings to locate inputs on the Routing_Streets source feature class while permitting point barriers to only locate on the system junctions feature class (Routing_ND_Junctions).

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
  "default": {
    "tolerance": 20,
    "toleranceUnits": "esriKilometers",
    "allowAutoRelocate": true,
    "sources": [
      {
        "name": "Routing_Streets"
      }
    ]
  },
  "overrides": {
    "point_barriers": {
      "sources": [
        {
          "name": "Routing_ND_Junctions"
        }
      ]
    }
  }

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

• ObjectIDint

  The object ID of the feature.

• RouteNamestring (length: 500)nullable

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

  The RouteName attribute is a foreign key to the Name attribute in the routes parameter. After a solve operation, if the order is routed, the RouteName attribute contains the name of the route that the order is assigned to.

• Sequenceint (non-negative)nullable

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

• ViolatedConstraint_1 -- ViolatedConstraint_4int enumnullable

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

  The following are the possible values for the ViolatedConstraint_# attributes:

  • null: The order does not have any violated constraints.
  • 0: MaxOrderCount exceeded. 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 attribute value.
  • 1: Capacities exceeded. 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_# attribute value.
  • 2: MaxTotalTime exceeded. The travel time from the start depot to the end depot plus the service and wait times at the depot exceeds the total time for the route as specified by the route's MaxTotalTime attribute value.
  • 3: MaxTotalTravelTime exceeded. 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 attribute value.
  • 4: MaxTotalDistance exceeded. 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 attribute value.
  • 5: Hard time window. There is a hard time window violation on the start depot or end depot associated with the route.
  • 6: Unmatched specialty. The specialties required by an order are not found on the target route.
  • 7: Hard route zone. An order that was preassigned to the route does not fall within a hard route zone.
  • 9: Unreachable. A preassigned order is located on a network element that cannot be reached by the route.
  • 14: InboundArriveTime or OutboundDepartTime order violation . The order couldn't be serviced within the inbound arrive time or outbound depart time constraints. This violation occurs when all the routes must depart the starting depot before the InboundArriveTime value or none of the routes can reach a depot before the order's OutboundDepartTime value.
  • 15: Cannot anchor first/last. 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.

• FromPrevTravelTimedouble (non-negative)nullable

  The travel time from the preceding visit on the route to the depot. The unit for this attribute value is specified by the time_units parameter.

• FromPrevDistancedouble (non-negative)nullable

  The travel distance from the preceding visit on the route to the depot. The unit for this attribute value is specified by the distance_units parameter of the analysis layer.

• ArriveCurbApproachlongnullable

  The side of the vehicle the curb is on when the vehicle approaches the network location. If the network location's CurbApproach value is set to Right side of vehicle, the ArriveCurbApproach value after solving is Right side of vehicle. However, if the CurbApproach value is set to Either side of vehicle or No U-Turn, the ArriveCurbApproach value can be the right or left side depending on which produces the overall shortest path.

• DepartCurbApproachlongnullable

  The side of the vehicle the curb is on when the vehicle departs the network location. If the network location's CurbApproach value is set to Right side of vehicle, the DepartCurbApproach value after solving is Right side of vehicle. However, if the CurbApproach value is set to Either side of vehicle or No U-Turn, the DepartCurbApproach value can be the right or left side depending on which produces the overall shortest path.

• ArriveTimetimestamp offsetnullable

  The date and time value indicating the arrival time at the order. The route may arrive at the order before the beginning of one of the order's time windows, in which case there is a wait time at the order. For an order with soft time windows, the route may also arrive at the order after the end of the time window, in which case there is a violation time at the order. This arrival time reflects the travel times that were used during the optimization by the solver. If the network includes traffic data, it will use an average travel times across the whole day. When using traffic data that covers multiple time zones, the time zone for this time-of-day value is taken from the network element on which the order is located.

• DepartTimetimestamp offsetnullable

  The date and time value indicating the departure time for the order. The route departs from the order upon completion of service. This departure time reflects the travel times that were used during the optimization by the solver. If the network includes traffic data, it will use an average travel times across the whole day. When using traffic data that covers multiple time zones, the time zone for this time-of day value is taken from the network element on which the order is located.

• WaitTimedouble (non-negative)nullable

  The wait time or layover at the order. For example, a wait time occurs when a route must wait at the order for a time window to open. The unit for this attribute value is specified by the time_units parameter.

• ViolationTimedouble (non-negative)nullable

  The amount of time elapsed between the end of the order's time window and the arrival of the route vehicle. The unit for this attribute value is specified by the time_units parameter.

• Statusint enum

  Specifies the status of the point with respect to its location on the network and the outcome of the analysis. The possible values are as following:

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

• SourceIDlong (non-negative)

  The numeric identifier of the network dataset source feature class on which the input point is located.

• SourceOIDlong (non-negative)

  The object ID of the feature in the source on which the input point is located.

• PosAlongdouble (non-negative)

  The position along the digitized direction of the source line feature. This value is stored as a ratio. This attribute is null if the network location references a junction.

• SideOfEdgeint enum

  Allowed values: 1, 2

  The side of the edge in relation to the digitized direction of the line feature.

  This attribute is limited to a domain of two values:

  • 1: Right Side
  • 2: Left Side

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

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

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

• DistanceToNetworkInMetersdouble (non-negative)

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

• ObjectIDint

  The object ID of the feature.

• Namestring

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

• Shapegeometry

  The line shape of the route.

  If the Output Shape Type property of the analysis layer is set to None, no shape is returned. Setting the Output Shape Type property to Straight Line returns straight route lines that connect each pair of consecutive visits. Along Network returns lines that trace their corresponding routes on the network.

• ViolatedConstraint_1 -- ViolatedConstraint_4int enumnullable

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

  The following are the possible values for the ViolatedConstraint_# attributes:

  • null: The order does not have any violated constraints.
  • 0: MaxOrderCount exceeded. 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 attribute value.
  • 1: Capacities exceeded. 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_# attribute value.
  • 2: MaxTotalTime exceeded. The travel time from the start depot to the end depot plus the service and wait times at the depot exceeds the total time for the route as specified by the route's MaxTotalTime attribute value.
  • 3: MaxTotalTravelTime exceeded. 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 attribute value.
  • 4: MaxTotalDistance exceeded. 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 attribute value.
  • 5: Hard time window. There is a hard time window violation on the start depot or end depot associated with the route.
  • 6: Unmatched specialty. The specialties required by an order are not found on the target route.
  • 7: Hard route zone. An order that was preassigned to the route does not fall within a hard route zone.
  • 9: Unreachable. A preassigned order is located on a network element that cannot be reached by the route.
  • 14: InboundArriveTime or OutboundDepartTime order violation . The order couldn't be serviced within the inbound arrive time or outbound depart time constraints. This violation occurs when all the routes must depart the starting depot before the InboundArriveTime value or none of the routes can reach a depot before the order's OutboundDepartTime value.
  • 15: Cannot anchor first/last. 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.

• OrderCountlongnullable

  The number of orders assigned to the route.

• TotalCostdouble (non-negative)nullable

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

• RegularTimeCostdouble (non-negative)nullable

  The cost of regular work time.

• OvertimeCostdouble (non-negative)nullable

  The cost of overtime work.

• DistanceCostdouble (non-negative)nullable

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

• TotalTimedouble (non-negative)nullable

  The total route duration.

  This includes travel times as well as service and wait times at orders and depots. The TotalTime value is the sum of the following attribute values: StartDepotServiceTime, EndDepotServiceTime, TotalOrderServiceTime, TotalWaitTime, and TotalTravelTime. The unit for this attribute value is specified by the time_units parameter.

• TotalOrderServicetimedouble (non-negative)nullable

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

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

• TotalTravelTimedouble (non-negative)nullable

  The total travel time for the route.

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

• TotalDistancedouble (non-negative)nullable

  The total travel distance for the route.

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

• StartTimetimestamp offsetnullable

  The starting time of the route, where the time zone is taken from the network element that the starting depot is located on.

• EndTimetimestamp offsetnullable

  The ending time of the route, where the time zone is taken from the network element that the ending depot is located on.

  The route ends upon completion of service at the ending depot. This end time reflects the travel times that were used during the optimization by the solver. If the network includes traffic data, it will use average travel times across the whole day.

• TotalWaitTimedouble (non-negative)nullable

  The total wait time at all orders on the route. The unit for this attribute value is specified by the time_units parameter.

• TotalViolationTimedouble (non-negative)nullable

  The total violation time at all orders on the route. The unit for this attribute value is specified by the time_units parameter.

• ObjectIDint

  The object ID of the feature.

• Statusint enum

  Specifies the status of the point with respect to its location on the network and the outcome of the analysis. The possible values are as following:

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

• SourceIDlong (non-negative)

  The numeric identifier of the network dataset source feature class on which the input point is located.

• SourceOIDlong (non-negative)

  The object ID of the feature in the source on which the input point is located.

• PosAlongdouble (non-negative)

  The position along the digitized direction of the source line feature. This value is stored as a ratio. This attribute is null if the network location references a junction.

• SideOfEdgeint enum

  Allowed values: 1, 2

  The side of the edge in relation to the digitized direction of the line feature.

  This attribute is limited to a domain of two values:

  • 1: Right Side
  • 2: Left Side

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

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

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

• DistanceToNetworkInMetersdouble (non-negative)

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