ArcGIS REST Services Directory
Login
|
Get Token
Home
>
services
>
Routes
>
SolveVehicleRoutingProblemWithDirectionsAsync (GPServer)
>
Solve Vehicle Routing Problem
>
submitJob
Help
|
API Reference
Submit Job (Solve Vehicle Routing Problem)
Orders:
(
GPFeatureRecordSetLayer
)
{ "displayFieldName": "", "geometryType": "esriGeometryPoint", "spatialReference": { "wkid": 4326, "latestWkid": 4326 }, "fields": [ { "name": "ObjectID", "type": "esriFieldTypeOID", "alias": "ObjectID" }, { "name": "Name", "type": "esriFieldTypeString", "alias": "Name", "length": 500 }, { "name": "ServiceTime", "type": "esriFieldTypeDouble", "alias": "ServiceTime" }, { "name": "TimeWindowStart1", "type": "esriFieldTypeDate", "alias": "TimeWindowStart1", "length": 16 }, { "name": "TimeWindowEnd1", "type": "esriFieldTypeDate", "alias": "TimeWindowEnd1", "length": 16 }, { "name": "TimeWindowStart2", "type": "esriFieldTypeDate", "alias": "TimeWindowStart2", "length": 16 }, { "name": "TimeWindowEnd2", "type": "esriFieldTypeDate", "alias": "TimeWindowEnd2", "length": 16 }, { "name": "MaxViolationTime1", "type": "esriFieldTypeDouble", "alias": "MaxViolationTime1" }, { "name": "MaxViolationTime2", "type": "esriFieldTypeDouble", "alias": "MaxViolationTime2" }, { "name": "InboundArriveTime", "type": "esriFieldTypeDate", "alias": "InboundArriveTime", "length": 16 }, { "name": "OutboundDepartTime", "type": "esriFieldTypeDate", "alias": "OutboundDepartTime", "length": 16 }, { "name": "DeliveryQuantities", "type": "esriFieldTypeString", "alias": "DeliveryQuantities", "length": 128 }, { "name": "PickupQuantities", "type": "esriFieldTypeString", "alias": "PickupQuantities", "length": 128 }, { "name": "Revenue", "type": "esriFieldTypeDouble", "alias": "Revenue" }, { "name": "SpecialtyNames", "type": "esriFieldTypeString", "alias": "SpecialtyNames", "length": 1024 }, { "name": "AssignmentRule", "type": "esriFieldTypeInteger", "alias": "AssignmentRule" }, { "name": "RouteName", "type": "esriFieldTypeString", "alias": "RouteName", "length": 1024 }, { "name": "Sequence", "type": "esriFieldTypeInteger", "alias": "Sequence" }, { "name": "CurbApproach", "type": "esriFieldTypeInteger", "alias": "CurbApproach" } ], "features": [], "exceededTransferLimit": false }
Depots:
(
GPFeatureRecordSetLayer
)
{ "displayFieldName": "", "geometryType": "esriGeometryPoint", "spatialReference": { "wkid": 4326, "latestWkid": 4326 }, "fields": [ { "name": "ObjectID", "type": "esriFieldTypeOID", "alias": "ObjectID" }, { "name": "Name", "type": "esriFieldTypeString", "alias": "Name", "length": 500 }, { "name": "TimeWindowStart1", "type": "esriFieldTypeDate", "alias": "TimeWindowStart1", "length": 16 }, { "name": "TimeWindowEnd1", "type": "esriFieldTypeDate", "alias": "TimeWindowEnd1", "length": 16 }, { "name": "TimeWindowStart2", "type": "esriFieldTypeDate", "alias": "TimeWindowStart2", "length": 16 }, { "name": "TimeWindowEnd2", "type": "esriFieldTypeDate", "alias": "TimeWindowEnd2", "length": 16 }, { "name": "CurbApproach", "type": "esriFieldTypeInteger", "alias": "CurbApproach" }, { "name": "Bearing", "type": "esriFieldTypeDouble", "alias": "Bearing" }, { "name": "BearingTol", "type": "esriFieldTypeDouble", "alias": "BearingTol" }, { "name": "NavLatency", "type": "esriFieldTypeDouble", "alias": "NavLatency" } ], "features": [], "exceededTransferLimit": false }
Routes:
(
GPRecordSet
)
{ "displayFieldName": "", "fields": [ { "name": "ObjectID", "type": "esriFieldTypeOID", "alias": "ObjectID" }, { "name": "Name", "type": "esriFieldTypeString", "alias": "Name", "length": 1024 }, { "name": "StartDepotName", "type": "esriFieldTypeString", "alias": "StartDepotName", "length": 500 }, { "name": "EndDepotName", "type": "esriFieldTypeString", "alias": "EndDepotName", "length": 500 }, { "name": "StartDepotServiceTime", "type": "esriFieldTypeDouble", "alias": "StartDepotServiceTime" }, { "name": "EndDepotServiceTime", "type": "esriFieldTypeDouble", "alias": "EndDepotServiceTime" }, { "name": "EarliestStartTime", "type": "esriFieldTypeDate", "alias": "EarliestStartTime", "length": 16 }, { "name": "LatestStartTime", "type": "esriFieldTypeDate", "alias": "LatestStartTime", "length": 16 }, { "name": "ArriveDepartDelay", "type": "esriFieldTypeDouble", "alias": "ArriveDepartDelay" }, { "name": "Capacities", "type": "esriFieldTypeString", "alias": "Capacities", "length": 128 }, { "name": "FixedCost", "type": "esriFieldTypeDouble", "alias": "FixedCost" }, { "name": "CostPerUnitTime", "type": "esriFieldTypeDouble", "alias": "CostPerUnitTime" }, { "name": "CostPerUnitDistance", "type": "esriFieldTypeDouble", "alias": "CostPerUnitDistance" }, { "name": "OvertimeStartTime", "type": "esriFieldTypeDouble", "alias": "OvertimeStartTime" }, { "name": "CostPerUnitOvertime", "type": "esriFieldTypeDouble", "alias": "CostPerUnitOvertime" }, { "name": "MaxOrderCount", "type": "esriFieldTypeInteger", "alias": "MaxOrderCount" }, { "name": "MaxTotalTime", "type": "esriFieldTypeDouble", "alias": "MaxTotalTime" }, { "name": "MaxTotalTravelTime", "type": "esriFieldTypeDouble", "alias": "MaxTotalTravelTime" }, { "name": "MaxTotalDistance", "type": "esriFieldTypeDouble", "alias": "MaxTotalDistance" }, { "name": "SpecialtyNames", "type": "esriFieldTypeString", "alias": "SpecialtyNames", "length": 1024 }, { "name": "AssignmentRule", "type": "esriFieldTypeInteger", "alias": "AssignmentRule" } ], "features": [], "exceededTransferLimit": false }
Breaks:
(
GPRecordSet
)
{ "displayFieldName": "", "fields": [ { "name": "ObjectID", "type": "esriFieldTypeOID", "alias": "ObjectID" }, { "name": "RouteName", "type": "esriFieldTypeString", "alias": "RouteName", "length": 1024 }, { "name": "Precedence", "type": "esriFieldTypeInteger", "alias": "Precedence" }, { "name": "ServiceTime", "type": "esriFieldTypeDouble", "alias": "ServiceTime" }, { "name": "TimeWindowStart", "type": "esriFieldTypeDate", "alias": "TimeWindowStart", "length": 16 }, { "name": "TimeWindowEnd", "type": "esriFieldTypeDate", "alias": "TimeWindowEnd", "length": 16 }, { "name": "MaxViolationTime", "type": "esriFieldTypeDouble", "alias": "MaxViolationTime" }, { "name": "MaxTravelTimeBetweenBreaks", "type": "esriFieldTypeDouble", "alias": "MaxTravelTimeBetweenBreaks" }, { "name": "MaxCumulWorkTime", "type": "esriFieldTypeDouble", "alias": "MaxCumulWorkTime" }, { "name": "IsPaid", "type": "esriFieldTypeInteger", "alias": "IsPaid" }, { "name": "Sequence", "type": "esriFieldTypeInteger", "alias": "Sequence" } ], "features": [], "exceededTransferLimit": false }
Time Field Units:
(
GPString
)
Minutes
Distance Field Units:
(
GPString
)
Miles
Network Dataset:
(
GPString
)
Routing_ND
Output Unassigned Stops Name:
(
GPString
)
UnassignedStops
Output Stops Name:
(
GPString
)
Stops
Output Routes Name:
(
GPString
)
Routes
Output Directions Name:
(
GPString
)
Directions
Default Date:
(
GPDate
)
null
U-Turn Policy:
(
GPString
)
ALLOW_UTURNS
Time Window Violation Importance:
(
GPString
)
Medium
Spatially Cluster Routes:
(
GPBoolean
)
true
Route Zones:
(
GPFeatureRecordSetLayer
)
{ "displayFieldName": "", "geometryType": "esriGeometryPolygon", "spatialReference": { "wkid": 4326, "latestWkid": 4326 }, "fields": [ { "name": "ObjectID", "type": "esriFieldTypeOID", "alias": "ObjectID" }, { "name": "RouteName", "type": "esriFieldTypeString", "alias": "RouteName", "length": 1024 }, { "name": "IsHardZone", "type": "esriFieldTypeInteger", "alias": "IsHardZone" }, { "name": "Shape_Length", "type": "esriFieldTypeDouble", "alias": "Shape_Length" }, { "name": "Shape_Area", "type": "esriFieldTypeDouble", "alias": "Shape_Area" } ], "features": [], "exceededTransferLimit": false }
Route Renewals:
(
GPRecordSet
)
{ "displayFieldName": "", "fields": [ { "name": "ObjectID", "type": "esriFieldTypeOID", "alias": "ObjectID" }, { "name": "RouteName", "type": "esriFieldTypeString", "alias": "RouteName", "length": 1024 }, { "name": "DepotName", "type": "esriFieldTypeString", "alias": "DepotName", "length": 500 }, { "name": "ServiceTime", "type": "esriFieldTypeDouble", "alias": "ServiceTime" }, { "name": "Sequences", "type": "esriFieldTypeString", "alias": "Sequences", "length": 128 } ], "features": [], "exceededTransferLimit": false }
Order Pairs:
(
GPRecordSet
)
{ "displayFieldName": "", "fields": [ { "name": "ObjectID", "type": "esriFieldTypeOID", "alias": "ObjectID" }, { "name": "FirstOrderName", "type": "esriFieldTypeString", "alias": "FirstOrderName", "length": 500 }, { "name": "SecondOrderName", "type": "esriFieldTypeString", "alias": "SecondOrderName", "length": 500 }, { "name": "MaxTransitTime", "type": "esriFieldTypeDouble", "alias": "MaxTransitTime" } ], "features": [], "exceededTransferLimit": false }
Excess Transit Time Importance:
(
GPString
)
Medium
Point Barriers:
(
GPFeatureRecordSetLayer
)
{ "displayFieldName": "", "geometryType": "esriGeometryPoint", "spatialReference": { "wkid": 4326, "latestWkid": 4326 }, "fields": [ { "name": "ObjectID", "type": "esriFieldTypeOID", "alias": "ObjectID" }, { "name": "Name", "type": "esriFieldTypeString", "alias": "Name", "length": 500 }, { "name": "CurbApproach", "type": "esriFieldTypeInteger", "alias": "CurbApproach" }, { "name": "BarrierType", "type": "esriFieldTypeInteger", "alias": "BarrierType" }, { "name": "Additional_Time", "type": "esriFieldTypeDouble", "alias": "Additional_Time" }, { "name": "Additional_Distance", "type": "esriFieldTypeDouble", "alias": "Additional_Distance" } ], "features": [], "exceededTransferLimit": false }
Line Barriers:
(
GPFeatureRecordSetLayer
)
{ "displayFieldName": "", "geometryType": "esriGeometryPolyline", "spatialReference": { "wkid": 4326, "latestWkid": 4326 }, "fields": [ { "name": "ObjectID", "type": "esriFieldTypeOID", "alias": "ObjectID" }, { "name": "Name", "type": "esriFieldTypeString", "alias": "Name", "length": 500 }, { "name": "BarrierType", "type": "esriFieldTypeInteger", "alias": "BarrierType" }, { "name": "Shape_Length", "type": "esriFieldTypeDouble", "alias": "Shape_Length" } ], "features": [], "exceededTransferLimit": false }
Polygon Barriers:
(
GPFeatureRecordSetLayer
)
{ "displayFieldName": "", "geometryType": "esriGeometryPolygon", "spatialReference": { "wkid": 4326, "latestWkid": 4326 }, "fields": [ { "name": "ObjectID", "type": "esriFieldTypeOID", "alias": "ObjectID" }, { "name": "Name", "type": "esriFieldTypeString", "alias": "Name", "length": 500 }, { "name": "BarrierType", "type": "esriFieldTypeInteger", "alias": "BarrierType" }, { "name": "Scaled_Time", "type": "esriFieldTypeDouble", "alias": "Scaled_Time" }, { "name": "Scaled_Distance", "type": "esriFieldTypeDouble", "alias": "Scaled_Distance" }, { "name": "Shape_Length", "type": "esriFieldTypeDouble", "alias": "Shape_Length" }, { "name": "Shape_Area", "type": "esriFieldTypeDouble", "alias": "Shape_Area" } ], "features": [], "exceededTransferLimit": false }
Time Attribute:
(
GPString
)
TravelTime
Distance Attribute:
(
GPString
)
Kilometers
Use Hierarchy in Analysis:
(
GPBoolean
)
true
Restrictions:
(
GPMultiValue:GPString
)
["Driving an Automobile","Through Traffic Prohibited","Avoid Unpaved Roads","Avoid Express Lanes","Avoid Carpool Roads","Avoid Private Roads","Roads Under Construction Prohibited","Avoid Gates"]
Attribute Parameter Values:
(
GPRecordSet
)
{ "displayFieldName": "", "fields": [ { "name": "ObjectID", "type": "esriFieldTypeOID", "alias": "ObjectID" }, { "name": "AttributeName", "type": "esriFieldTypeString", "alias": "AttributeName", "length": 255 }, { "name": "ParameterName", "type": "esriFieldTypeString", "alias": "ParameterName", "length": 255 }, { "name": "ParameterValue", "type": "esriFieldTypeString", "alias": "ParameterValue", "length": 25 } ], "features": [], "exceededTransferLimit": false }
Maximum Snap Tolerance:
(
GPLinearUnit
)
{ "distance": 20, "units": "esriKilometers" }
Exclude Restricted Portions of the Network:
(
GPBoolean
)
true
Populate Route Lines:
(
GPBoolean
)
true
Route Line Simplification Tolerance:
(
GPLinearUnit
)
{ "distance": 10, "units": "esriMeters" }
Populate Directions:
(
GPBoolean
)
false
Directions Language:
(
GPString
)
en
Directions Style Name:
(
GPString
)
NA Desktop
Save Output Network Analysis Layer:
(
GPBoolean
)
false
Ignore Invalid Order Locations:
(
GPBoolean
)
false
Travel Mode:
(
GPString
)
CUSTOM
Ignore Network Location Fields:
(
GPBoolean
)
false
Time Zone Usage for Time Fields:
(
GPString
)
GEO_LOCAL
Overrides:
(
GPString
)
Save Route Data:
(
GPBoolean
)
false
Options:
Output Spatial Reference:
Process Spatial Reference:
ReturnZ:
True
False
ReturnM:
True
False
Return True Curves:
True
False
Context:
Format:
HTML
JSON
KMZ
GeoJSON