LastMileDeliveryParameters

Use this property to specify the region in which to perform the analysis. If a value is not specified for this parameter, the service will automatically calculate the region name based on the location of the input points. Setting the name of the region is recommended to speed up the analysis.

An authorization string used to access a resource or service. API keys are generated and managed in the portal. An API key is tied explicitly to an ArcGIS account; it is also used to monitor service usage. Setting a fine-grained API key on a specific class overrides the global API key.

Stores the depots that are part of a given last mile delivery analysis layer. A depot is a location that a vehicle departs from at the beginning of its workday and returns to at the end of the workday. Depots are locations where the vehicles are loaded (for deliveries) or unloaded (for pickups). For the Last Mile Delivery solver, the routes must all start at the same depot location and must all end at the same depot location. However, the start and end depot locations can be different or can be modeled as virtual depot locations not explicitly specified in the problem.

The language that will be used when generating travel directions. This parameter applies only when the populateDirections parameter is set to true. The service supports generating directions in the following languages: ar, bg, bs, ca, cs, da, de, el, en, es, et, fi, fr, he, hr, hu, id, it, ja, ko, lt, lv, nb, nl, pl, pt-BR, pt-PT, ro, ru, sk, sl, sr, sv, th, tr, uk, vi, zh-CN, zh-HK and zh-TW.

Specify the units that should be used to measure and report the total travel distance between each origin-destination pair. Many parameters in a last mile delivery problem analysis have attributes for storing distance values, such as MaxTotalDistance for the routes parameter. To minimize data entry requirements, these attribute values don't include units. Instead, all distance-based attribute values must be entered in the same units, and this parameter is used to specify the units of those values

Use this property to specify the default earliest start date for routes. This date is in the form YYYY-MM-DD and is used for all routes for which the EarliestStartDate attribute in the routes parameter is null. When this property is not specified, the EarliestStartDate attribute for all graphics in routes must be set.

Use this parameter to specify the default earliest start time for routes. This time of day is used for all routes for which the EarliestStartTime attribute in the routes parameter is null. When this property is not specified, all rows in the routes parameter must specify a value in the EarliestStartTime attribute. The format to provide the start date is hh:mm:ss, for example, 14:30:30.

If true the solver will ignore any invalid orders and return a solution, given it didn't encounter any other errors. To generate routes and deliver them to drivers immediately, you may be able to ignore invalid orders, solve, and distribute the routes to your drivers. Then, resolve any invalid orders from the last solve and include them in the fleet routing analysis for the next workday or work shift. If false the solve operation will fail when any invalid orders are encountered. An invalid order is an order that the fleet routing solver can't reach. An order may be unreachable for a variety of reasons, including when the order is located on a prohibited network element, isn't located on the network at all, or is located on a disconnected portion of the network.

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

Use this property to specify the maximum allowed total time for each route. The value can be any positive number. The value is used for all routes when the MaxTotalTime attribute in the routes parameter is null. When no value is specified for maximumRouteDuration, all rows in the routes parameter must specify a value in the MaxTotalTime attribute.

The value is interpreted in the units specified in the timeUnits property.

Lists the specialties that can be required by orders and supported by routes. A route can service an order only if it supports all the specialties required for that order.

Specifies one or more locations that the routes of the last mile delivery analysis will visit. For example, these are the final customer locations where routes deliver packages, or the initial customer location where they are picking up packages for shipment.

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

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

If true, directions will be generated and configured based on the value of the directionsLanguage property. If false, directions will not be generated, and the service returns an empty value for the feature sets returned by getDirectionPoints and getDirectionLines output parameter

Specifies the type of features that are returned by getRoutes method.

Lists the specialties that can be required by orders and supported by routes. A route can service an order only if it supports all the specialties required for that order.

Identifies one or more routes that describe vehicle and driver characteristics. A route can have start and end depot service times, a fixed or flexible starting time, time-based operating costs, distance-based operating costs, multiple capacities, various constraints on a driver's workday, and so on.

Use this parameter to specify the gap in numerical values to leave in the Sequence attribute in the orders parameter between adjacent orders when the analysis is solved. The value acts as a multiplier for the actual sequence of orders on each route.

Specifies the temporal units used by time-based properties like the ServiceTime and CostPerUnitTime graphic attributes in orders and routes respectively.

Use this parameter to specify the time zone for the input date-time fields.

A travel mode represents a means of transportation, such as driving or walking. Travel modes define the physical characteristics of a vehicle or pedestrian.

Use networkService.fetchServiceDescription to obtain a list of predefined travel modes and the default travel mode that is used if one is not specified in a routing reqest.

Zones specify a work territory. It is a polygon feature set and is used to constrain servicing to only those orders that fall within or near an area.