closestFacility



Description:
The closestFacility resource. This page simulates how to perform closest facility analysis through REST interfaces.
The closest facility analysis is to find one or multiple facilities with the minimum cost to reach a specified event point from the specified group of facilities. The results are routes with minimum cost, either from the event site to facility site or from facility site to incident site.

Application scenario 1: To find the closest hospitals within ten minutes from a traffic accident. In this scenario, the site where a traffic accident happens is the event site, the hospitals nearby are the facility points. The closest facility analysis is actually one type of path analyses. Barrier nodes, barrier edges can be involved in the analysis.


event * Event, it can be the ID of node like 2, or node coordinates like {"x":119.6100397551,"y":-122.6278394459}
facilities * Facility points set, it can be the array of ID, like[1,6,52], or array of node coordinates like [{"x":70.1515638201,"y":-54.7406354454} ,{"x":550.6770595320,"y":-56.1050211383} ,{"x":445.6471889264,"y":-229.2074549041}]
maxWeight:
expectFacilityCount:
fromEvent:
weightFieldName The wight field name, which indicates the weight field used during network analysis. If not set, the first field in the environment setting will be used.
turnWeightField Turn weight field name
barrierEdgeIDs Barrier edge ID array.
barrierNodeIDs Barrier node ID array
returnEdgeIDs: true indicates the ID collection of the passed edges is included.When you enable the SSC analysis model and use node coordinate to anlaysis,this value will not be included in the result.
returnNodeIDs: true indicates the ID collection of the passed nodes is included.When you enable the SSC analysis model and use node coordinate to anlaysis,this value will not be included in the result.
returnPathGuides: true indicates the collection of path guides is included.When you enable the SSC analysis model and use node coordinate to anlaysis,this value will not be included in the result.
returnRoutes: true indicates the collection of route objects is included.
returnEdgeFeatures: true indicates the collection of the edge features is included.When you enable the SSC analysis model and use node coordinate to anlaysis,this value will not be included in the result.
returnEdgeGeometry: The default is false, indicating the edge feature collection returned doesn't include the geometry information.When you enable the SSC analysis model and use node coordinate to anlaysis,this value will not be included in the result.
returnNodeFeatures: true indicates the collection of the node features is included.When you enable the SSC analysis model and use node coordinate to anlaysis,this value will not be included in the result.
returnNodeGeometry: The default is false, indicating the node feature collection returned doesn't include the geometry information.When you enable the SSC analysis model and use node coordinate to anlaysis,this value will not be included in the result.
Output format
 
HTTP methods

Output formats