ArcGIS REST Services Directory
Login
Home
>
services
>
RoutingSMP
>
NetworkAnalysis (GPServer)
>
FindClosestFacilities
>
submitJob
API Reference
Submit Job (FindClosestFacilities)
Incidents:
(
GPFeatureRecordSetLayer
)
{ "features": [], "exceededTransferLimit": false, "displayFieldName": "", "spatialReference": { "latestWkid": 4326, "wkid": 4326 }, "fields": [ { "name": "OBJECTID", "alias": "OBJECTID", "type": "esriFieldTypeOID" }, { "name": "Name", "length": 500, "alias": "Name", "type": "esriFieldTypeString" }, { "name": "ID", "length": 128, "alias": "ID", "type": "esriFieldTypeString" }, { "name": "AdditionalTime", "alias": "Additional Time", "type": "esriFieldTypeDouble" }, { "name": "AdditionalDistance", "alias": "Additional Distance", "type": "esriFieldTypeDouble" }, { "name": "CurbApproach", "alias": "Curb Approach", "type": "esriFieldTypeSmallInteger" }, { "name": "AdditionalCost", "alias": "Additional Cost", "type": "esriFieldTypeDouble" }, { "name": "Cutoff", "alias": "Cutoff", "type": "esriFieldTypeDouble" }, { "name": "TargetFacilityCount", "alias": "Target Facility Count", "type": "esriFieldTypeInteger" } ], "geometryType": "esriGeometryPoint" }
Facilities:
(
GPFeatureRecordSetLayer
)
{ "features": [], "exceededTransferLimit": false, "displayFieldName": "", "spatialReference": { "latestWkid": 4326, "wkid": 4326 }, "fields": [ { "name": "OBJECTID", "alias": "OBJECTID", "type": "esriFieldTypeOID" }, { "name": "Name", "length": 500, "alias": "Name", "type": "esriFieldTypeString" }, { "name": "ID", "length": 128, "alias": "ID", "type": "esriFieldTypeString" }, { "name": "AdditionalTime", "alias": "Additional Time", "type": "esriFieldTypeDouble" }, { "name": "AdditionalDistance", "alias": "Additional Distance", "type": "esriFieldTypeDouble" }, { "name": "CurbApproach", "alias": "Curb Approach", "type": "esriFieldTypeSmallInteger" }, { "name": "AdditionalCost", "alias": "Additional Cost", "type": "esriFieldTypeDouble" }, { "name": "Cutoff", "alias": "Cutoff", "type": "esriFieldTypeDouble" } ], "geometryType": "esriGeometryPoint" }
Measurement Units:
(
GPString
)
Minutes
Analysis Region:
(
GPString
)
Number of Facilities to Find:
(
GPLong
)
1
Cutoff:
(
GPDouble
)
Travel Direction:
(
GPString
)
Incident to Facility
Use Hierarchy:
(
GPBoolean
)
true
Time of Day:
(
GPDate
)
Time of Day Usage:
(
GPString
)
Start Time
UTurn at Junctions:
(
GPString
)
Allowed Only at Intersections and Dead Ends
Point Barriers:
(
GPFeatureRecordSetLayer
)
{ "features": [], "exceededTransferLimit": false, "displayFieldName": "", "spatialReference": { "latestWkid": 4326, "wkid": 4326 }, "fields": [ { "name": "OBJECTID", "alias": "OBJECTID", "type": "esriFieldTypeOID" }, { "name": "Name", "length": 500, "alias": "Name", "type": "esriFieldTypeString" }, { "name": "BarrierType", "alias": "Barrier Type", "type": "esriFieldTypeInteger" }, { "name": "Additional_Time", "alias": "Additional Time", "type": "esriFieldTypeDouble" }, { "name": "Additional_Distance", "alias": "Additional Distance", "type": "esriFieldTypeDouble" }, { "name": "AdditionalCost", "alias": "Additional Cost", "type": "esriFieldTypeDouble" }, { "name": "CurbApproach", "alias": "Curb Approach", "type": "esriFieldTypeSmallInteger" }, { "name": "FullEdge", "alias": "Full Edge", "type": "esriFieldTypeInteger" } ], "geometryType": "esriGeometryPoint" }
Line Barriers:
(
GPFeatureRecordSetLayer
)
{ "features": [], "exceededTransferLimit": false, "displayFieldName": "", "spatialReference": { "latestWkid": 4326, "wkid": 4326 }, "fields": [ { "name": "OBJECTID", "alias": "OBJECTID", "type": "esriFieldTypeOID" }, { "name": "Name", "length": 500, "alias": "Name", "type": "esriFieldTypeString" }, { "name": "SHAPE_Length", "alias": "SHAPE_Length", "type": "esriFieldTypeDouble" } ], "geometryType": "esriGeometryPolyline" }
Polygon Barriers:
(
GPFeatureRecordSetLayer
)
{ "features": [], "exceededTransferLimit": false, "displayFieldName": "", "spatialReference": { "latestWkid": 4326, "wkid": 4326 }, "fields": [ { "name": "OBJECTID", "alias": "OBJECTID", "type": "esriFieldTypeOID" }, { "name": "Name", "length": 500, "alias": "Name", "type": "esriFieldTypeString" }, { "name": "BarrierType", "alias": "Barrier Type", "type": "esriFieldTypeInteger" }, { "name": "ScaledTimeFactor", "alias": "Scaled Time Factor", "type": "esriFieldTypeDouble" }, { "name": "ScaledDistanceFactor", "alias": "Scaled Distance Factor", "type": "esriFieldTypeDouble" }, { "name": "ScaledCostFactor", "alias": "Scaled Cost Factor", "type": "esriFieldTypeDouble" }, { "name": "SHAPE_Length", "alias": "SHAPE_Length", "type": "esriFieldTypeDouble" }, { "name": "SHAPE_Area", "alias": "SHAPE_Area", "type": "esriFieldTypeDouble" } ], "geometryType": "esriGeometryPolygon" }
Restrictions:
(
GPMultiValue:GPString
)
["Avoid Carpool Roads","Avoid Express Lanes","Avoid Gates","Avoid Private Roads","Avoid Unpaved Roads","Driving an Automobile","Roads Under Construction Prohibited","Through Traffic Prohibited"]
Attribute Parameter Values:
(
GPRecordSet
)
{ "features": [ {"attributes": { "OBJECTID": 1, "ParameterValue": "PROHIBITED", "AttributeName": "Any Hazmat Prohibited", "ParameterName": "Restriction Usage" }}, {"attributes": { "OBJECTID": 2, "ParameterValue": "PROHIBITED", "AttributeName": "Avoid Carpool Roads", "ParameterName": "Restriction Usage" }}, {"attributes": { "OBJECTID": 3, "ParameterValue": "PROHIBITED", "AttributeName": "Avoid Express Lanes", "ParameterName": "Restriction Usage" }}, {"attributes": { "OBJECTID": 4, "ParameterValue": "AVOID_MEDIUM", "AttributeName": "Avoid Ferries", "ParameterName": "Restriction Usage" }}, {"attributes": { "OBJECTID": 5, "ParameterValue": "AVOID_MEDIUM", "AttributeName": "Avoid Gates", "ParameterName": "Restriction Usage" }}, {"attributes": { "OBJECTID": 6, "ParameterValue": "AVOID_MEDIUM", "AttributeName": "Avoid Limited Access Roads", "ParameterName": "Restriction Usage" }}, {"attributes": { "OBJECTID": 7, "ParameterValue": "AVOID_MEDIUM", "AttributeName": "Avoid Private Roads", "ParameterName": "Restriction Usage" }}, {"attributes": { "OBJECTID": 8, "ParameterValue": "AVOID_HIGH", "AttributeName": "Avoid Roads Unsuitable for Pedestrians", "ParameterName": "Restriction Usage" }}, {"attributes": { "OBJECTID": 9, "ParameterValue": "AVOID_HIGH", "AttributeName": "Avoid Stairways", "ParameterName": "Restriction Usage" }}, {"attributes": { "OBJECTID": 10, "ParameterValue": "AVOID_MEDIUM", "AttributeName": "Avoid Toll Roads", "ParameterName": "Restriction Usage" }}, {"attributes": { "OBJECTID": 11, "ParameterValue": "AVOID_MEDIUM", "AttributeName": "Avoid Toll Roads for Trucks", "ParameterName": "Restriction Usage" }}, {"attributes": { "OBJECTID": 12, "ParameterValue": "AVOID_HIGH", "AttributeName": "Avoid Truck Restricted Roads", "ParameterName": "Restriction Usage" }}, {"attributes": { "OBJECTID": 13, "ParameterValue": "AVOID_HIGH", "AttributeName": "Avoid Unpaved Roads", "ParameterName": "Restriction Usage" }}, {"attributes": { "OBJECTID": 14, "ParameterValue": "PROHIBITED", "AttributeName": "Axle Count Restriction", "ParameterName": "Restriction Usage" }}, {"attributes": { "OBJECTID": 15, "ParameterValue": "0", "AttributeName": "Axle Count Restriction", "ParameterName": "Number of Axles" }}, {"attributes": { "OBJECTID": 16, "ParameterValue": "PROHIBITED", "AttributeName": "Driving a Bus", "ParameterName": "Restriction Usage" }}, {"attributes": { "OBJECTID": 17, "ParameterValue": "PROHIBITED", "AttributeName": "Driving a Taxi", "ParameterName": "Restriction Usage" }}, {"attributes": { "OBJECTID": 18, "ParameterValue": "PROHIBITED", "AttributeName": "Driving a Truck", "ParameterName": "Restriction Usage" }}, {"attributes": { "OBJECTID": 19, "ParameterValue": "PROHIBITED", "AttributeName": "Driving an Automobile", "ParameterName": "Restriction Usage" }}, {"attributes": { "OBJECTID": 20, "ParameterValue": "PROHIBITED", "AttributeName": "Driving an Emergency Vehicle", "ParameterName": "Restriction Usage" }}, {"attributes": { "OBJECTID": 21, "ParameterValue": "PROHIBITED", "AttributeName": "Height Restriction", "ParameterName": "Restriction Usage" }}, {"attributes": { "OBJECTID": 22, "ParameterValue": "0", "AttributeName": "Height Restriction", "ParameterName": "Vehicle Height (meters)" }}, {"attributes": { "OBJECTID": 23, "ParameterValue": "PROHIBITED", "AttributeName": "Kingpin to Rear Axle Length Restriction", "ParameterName": "Restriction Usage" }}, {"attributes": { "OBJECTID": 24, "ParameterValue": "0", "AttributeName": "Kingpin to Rear Axle Length Restriction", "ParameterName": "Vehicle Kingpin to Rear Axle Length (meters)" }}, {"attributes": { "OBJECTID": 25, "ParameterValue": "PROHIBITED", "AttributeName": "Length Restriction", "ParameterName": "Restriction Usage" }}, {"attributes": { "OBJECTID": 26, "ParameterValue": "0", "AttributeName": "Length Restriction", "ParameterName": "Vehicle Length (meters)" }}, {"attributes": { "OBJECTID": 27, "ParameterValue": "PREFER_LOW", "AttributeName": "Preferred for Pedestrians", "ParameterName": "Restriction Usage" }}, {"attributes": { "OBJECTID": 28, "ParameterValue": "PROHIBITED", "AttributeName": "Riding a Motorcycle", "ParameterName": "Restriction Usage" }}, {"attributes": { "OBJECTID": 29, "ParameterValue": "PROHIBITED", "AttributeName": "Roads Under Construction Prohibited", "ParameterName": "Restriction Usage" }}, {"attributes": { "OBJECTID": 30, "ParameterValue": "PROHIBITED", "AttributeName": "Semi or Tractor with One or More Trailers Prohibited", "ParameterName": "Restriction Usage" }}, {"attributes": { "OBJECTID": 31, "ParameterValue": "PROHIBITED", "AttributeName": "Single Axle Vehicles Prohibited", "ParameterName": "Restriction Usage" }}, {"attributes": { "OBJECTID": 32, "ParameterValue": "PROHIBITED", "AttributeName": "Tandem Axle Vehicles Prohibited", "ParameterName": "Restriction Usage" }}, {"attributes": { "OBJECTID": 33, "ParameterValue": "AVOID_HIGH", "AttributeName": "Through Traffic Prohibited", "ParameterName": "Restriction Usage" }}, {"attributes": { "OBJECTID": 34, "ParameterValue": "0", "AttributeName": "TravelTime", "ParameterName": "Vehicle Maximum Speed (km/h)" }}, {"attributes": { "OBJECTID": 35, "ParameterValue": "PROHIBITED", "AttributeName": "Truck with Trailers Restriction", "ParameterName": "Restriction Usage" }}, {"attributes": { "OBJECTID": 36, "ParameterValue": "0", "AttributeName": "Truck with Trailers Restriction", "ParameterName": "Number of Trailers on Truck" }}, {"attributes": { "OBJECTID": 37, "ParameterValue": "0", "AttributeName": "TruckTravelTime", "ParameterName": "Vehicle Maximum Speed (km/h)" }}, {"attributes": { "OBJECTID": 38, "ParameterValue": "PREFER_MEDIUM", "AttributeName": "Use Preferred Hazmat Routes", "ParameterName": "Restriction Usage" }}, {"attributes": { "OBJECTID": 39, "ParameterValue": "PREFER_MEDIUM", "AttributeName": "Use Preferred Truck Routes", "ParameterName": "Restriction Usage" }}, {"attributes": { "OBJECTID": 40, "ParameterValue": "5", "AttributeName": "WalkTime", "ParameterName": "Walking Speed (km/h)" }}, {"attributes": { "OBJECTID": 41, "ParameterValue": "PROHIBITED", "AttributeName": "Walking", "ParameterName": "Restriction Usage" }}, {"attributes": { "OBJECTID": 42, "ParameterValue": "PROHIBITED", "AttributeName": "Weight Restriction", "ParameterName": "Restriction Usage" }}, {"attributes": { "OBJECTID": 43, "ParameterValue": "0", "AttributeName": "Weight Restriction", "ParameterName": "Vehicle Weight (kilograms)" }}, {"attributes": { "OBJECTID": 44, "ParameterValue": "PROHIBITED", "AttributeName": "Weight per Axle Restriction", "ParameterName": "Restriction Usage" }}, {"attributes": { "OBJECTID": 45, "ParameterValue": "0", "AttributeName": "Weight per Axle Restriction", "ParameterName": "Vehicle Weight per Axle (kilograms)" }}, {"attributes": { "OBJECTID": 46, "ParameterValue": "PROHIBITED", "AttributeName": "Width Restriction", "ParameterName": "Restriction Usage" }}, {"attributes": { "OBJECTID": 47, "ParameterValue": "0", "AttributeName": "Width Restriction", "ParameterName": "Vehicle Width (meters)" }} ], "exceededTransferLimit": false, "displayFieldName": "", "fields": [ { "name": "OBJECTID", "alias": "ObjectID", "type": "esriFieldTypeOID" }, { "name": "AttributeName", "length": 255, "alias": "AttributeName", "type": "esriFieldTypeString" }, { "name": "ParameterName", "length": 255, "alias": "ParameterName", "type": "esriFieldTypeString" }, { "name": "ParameterValue", "length": 25, "alias": "ParameterValue", "type": "esriFieldTypeString" } ] }
Route Shape:
(
GPString
)
True Shape
Route Line Simplification Tolerance:
(
GPLinearUnit
)
{ "distance": 10, "units": "esriMeters" }
Populate Directions:
(
GPBoolean
)
false
Directions Language:
(
GPString
)
en
Directions Distance Units:
(
GPString
)
Miles
Directions Style Name:
(
GPString
)
NA Desktop
Time Zone for Time of Day:
(
GPString
)
Geographically Local
Travel Mode:
(
GPString
)
Custom
Impedance:
(
GPString
)
Drive Time
Save Output Network Analysis Layer:
(
GPBoolean
)
false
Overrides:
(
GPString
)
Save Route Data:
(
GPBoolean
)
false
Time Impedance:
(
GPString
)
TravelTime
Distance Impedance:
(
GPString
)
Kilometers
Output Format:
(
GPString
)
Feature Set
Accumulate Attributes:
(
GPMultiValue:GPString
)
[]
Ignore Network Location Fields:
(
GPBoolean
)
false
Ignore Invalid Locations:
(
GPBoolean
)
true
Locate Settings:
(
GPString
)
{"default": { "toleranceUnits": "esriMeters", "allowAutoRelocate": true, "sources": [{"name": "Routing_Streets"}], "tolerance": 20000 }}
Options:
ReturnZ:
True
False
ReturnM:
True
False
Return True Curves:
True
False
Simplify Features:
True
False
Context:
Format:
HTML
JSON
KMZ
GeoJSON