ArcGIS REST Services Directory
Login
|
Get Token
Home
>
services
>
NetworkAnalysis
>
SanDiego (GPServer)
>
FindRoutes
>
submitJob
Help
|
API Reference
Submit Job (FindRoutes)
Stops:
(
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": "RouteName", "type": "esriFieldTypeString", "alias": "Route Name", "length": 1024 }, { "name": "Sequence", "type": "esriFieldTypeInteger", "alias": "Sequence" }, { "name": "AdditionalTime", "type": "esriFieldTypeDouble", "alias": "Additional Time" }, { "name": "AdditionalDistance", "type": "esriFieldTypeDouble", "alias": "Additional Distance" }, { "name": "TimeWindowStart", "type": "esriFieldTypeDate", "alias": "Time Window Start", "length": 8 }, { "name": "TimeWindowEnd", "type": "esriFieldTypeDate", "alias": "Time Window End", "length": 8 }, { "name": "CurbApproach", "type": "esriFieldTypeSmallInteger", "alias": "Curb Approach" }, { "name": "LocationType", "type": "esriFieldTypeInteger", "alias": "Location Type" } ], "features": [], "exceededTransferLimit": false }
Measurement Units:
(
GPString
)
Minutes
Analysis Region:
(
GPString
)
Reorder Stops to Find Optimal Routes:
(
GPBoolean
)
false
Preserve Terminal Stops:
(
GPString
)
Preserve First
Return to Start:
(
GPBoolean
)
false
Use Time Windows:
(
GPBoolean
)
false
Time of Day:
(
GPDate
)
null
Time Zone for Time of Day:
(
GPString
)
Geographically Local
UTurn at Junctions:
(
GPString
)
Allowed Only at Intersections and Dead Ends
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": "BarrierType", "type": "esriFieldTypeInteger", "alias": "Barrier Type" }, { "name": "Additional_Time", "type": "esriFieldTypeDouble", "alias": "Additional Time" }, { "name": "Additional_Distance", "type": "esriFieldTypeDouble", "alias": "Additional Distance" }, { "name": "CurbApproach", "type": "esriFieldTypeSmallInteger", "alias": "CurbApproach" } ], "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": "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": "Barrier Type" }, { "name": "ScaledTimeFactor", "type": "esriFieldTypeDouble", "alias": "Scaled Time Factor" }, { "name": "ScaledDistanceFactor", "type": "esriFieldTypeDouble", "alias": "Scaled Distance Factor" }, { "name": "SHAPE_Length", "type": "esriFieldTypeDouble", "alias": "SHAPE_Length" }, { "name": "SHAPE_Area", "type": "esriFieldTypeDouble", "alias": "SHAPE_Area" } ], "features": [], "exceededTransferLimit": false }
Use Hierarchy:
(
GPBoolean
)
true
Restrictions:
(
GPMultiValue:GPString
)
["Driving an Automobile","Through Traffic Prohibited","Avoid Unpaved Roads","Avoid Private Roads","Avoid Gates","Avoid Carpool Roads","Avoid Express Lanes"]
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": [ {"attributes": { "OBJECTID": 28, "AttributeName": "Any Hazmat Prohibited", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" }}, {"attributes": { "OBJECTID": 29, "AttributeName": "Avoid Carpool Roads", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" }}, {"attributes": { "OBJECTID": 30, "AttributeName": "Avoid Express Lanes", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" }}, {"attributes": { "OBJECTID": 31, "AttributeName": "Avoid Ferries", "ParameterName": "Restriction Usage", "ParameterValue": "AVOID_MEDIUM" }}, {"attributes": { "OBJECTID": 32, "AttributeName": "Avoid Gates", "ParameterName": "Restriction Usage", "ParameterValue": "AVOID_MEDIUM" }}, {"attributes": { "OBJECTID": 33, "AttributeName": "Avoid Limited Access Roads", "ParameterName": "Restriction Usage", "ParameterValue": "AVOID_MEDIUM" }}, {"attributes": { "OBJECTID": 34, "AttributeName": "Avoid Private Roads", "ParameterName": "Restriction Usage", "ParameterValue": "AVOID_MEDIUM" }}, {"attributes": { "OBJECTID": 35, "AttributeName": "Avoid Toll Roads", "ParameterName": "Restriction Usage", "ParameterValue": "AVOID_MEDIUM" }}, {"attributes": { "OBJECTID": 36, "AttributeName": "Avoid Truck Restricted Roads", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" }}, {"attributes": { "OBJECTID": 37, "AttributeName": "Avoid Unpaved Roads", "ParameterName": "Restriction Usage", "ParameterValue": "AVOID_MEDIUM" }}, {"attributes": { "OBJECTID": 38, "AttributeName": "Driving a Bus", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" }}, {"attributes": { "OBJECTID": 39, "AttributeName": "Driving a Delivery Vehicle", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" }}, {"attributes": { "OBJECTID": 40, "AttributeName": "Driving a Taxi", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" }}, {"attributes": { "OBJECTID": 41, "AttributeName": "Driving a Truck", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" }}, {"attributes": { "OBJECTID": 42, "AttributeName": "Driving an Automobile", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" }}, {"attributes": { "OBJECTID": 43, "AttributeName": "Driving an Emergency Vehicle", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" }}, {"attributes": { "OBJECTID": 44, "AttributeName": "Height Restriction", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" }}, {"attributes": { "OBJECTID": 45, "AttributeName": "Height Restriction", "ParameterName": "Vehicle Height (meters)", "ParameterValue": "0" }}, {"attributes": { "OBJECTID": 46, "AttributeName": "Length Restriction", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" }}, {"attributes": { "OBJECTID": 47, "AttributeName": "Length Restriction", "ParameterName": "Vehicle Length (meters)", "ParameterValue": "0" }}, {"attributes": { "OBJECTID": 48, "AttributeName": "Through Traffic Prohibited", "ParameterName": "Restriction Usage", "ParameterValue": "AVOID_HIGH" }}, {"attributes": { "OBJECTID": 49, "AttributeName": "Use Preferred Hazmat Routes", "ParameterName": "Restriction Usage", "ParameterValue": "PREFER_MEDIUM" }}, {"attributes": { "OBJECTID": 50, "AttributeName": "Use Preferred Truck Routes", "ParameterName": "Restriction Usage", "ParameterValue": "PREFER_MEDIUM" }}, {"attributes": { "OBJECTID": 51, "AttributeName": "WalkTime", "ParameterName": "Walking Speed (km/h)", "ParameterValue": "5" }}, {"attributes": { "OBJECTID": 52, "AttributeName": "Walking", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" }}, {"attributes": { "OBJECTID": 53, "AttributeName": "Weight Restriction", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" }}, {"attributes": { "OBJECTID": 54, "AttributeName": "Weight Restriction", "ParameterName": "Vehicle Weight (kilograms)", "ParameterValue": "0" }} ], "exceededTransferLimit": false }
Route Shape:
(
GPString
)
True Shape
Route Line Simplification Tolerance:
(
GPLinearUnit
)
{ "distance": 10, "units": "esriMeters" }
Populate Route Edges:
(
GPBoolean
)
false
Populate Directions:
(
GPBoolean
)
true
Directions Language:
(
GPString
)
en
Directions Distance Units:
(
GPString
)
Miles
Directions Style Name:
(
GPString
)
NA Desktop
Travel Mode:
(
GPString
)
Custom
Impedance:
(
GPString
)
Drive Time
Time Zone for Time Windows:
(
GPString
)
Geographically Local
Save Output Network Analysis Layer:
(
GPBoolean
)
false
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