Upon successful execution, the service returns the service areas around the facilities and the status indicating the analysis was successful by using the service_areas and solve_succeeded output parameters.
service_areas
Use this parameter to get the area that can be reached from the input location within a given travel time or travel distance. The polygon_overlap_type, polygons_for_multiple_facilities, polygon_trim_distance, and the polygon_simplification_tolerance parameters highly influence the shape of the output service areas. The service area geometries are returned in the spatial reference specified as the env:outSR parameter.
The following provides a description of fields that are returned for each service area:
| Field name | Description |
|---|---|
ObjectID | A unique identifier for the service area. This identifier is auto generated by the service. |
Name | The name of the service area is based on the name of the associated facility and the break range; for instance, Store1: 0.0 – 5.0 represents a service area that covers all traversable streets within five minutes of a facility named Store1. The break values are returned without the name of the facility, for example, 0.0 – 5.0, when polygons_for_multiple_facilities is set to Merge by Break Value. |
FacilityName | The name of the facility the service area was created around. These field values are copied from the Name field of the input facilities. However, multiple facilities may be associated with one service area when polygons_for_multiple_facilities is set to Merge by Break Value; therefore, FacilityName is excluded from the results when service areas are merged. |
FacilityID | The unique identifier of the associated facility. FacilityID contains an auto-generated identifier. Multiple facilities may be associated with one service area when polygons_for_multiple_facilities is set to Merge by Break Value; therefore, FacilityID field values are set to null or -1 when service areas are merged. |
FacilityOID | The ObjectID value of the input facility feature used to generate the service area polygon. Multiple facilities may be associated with one service area when polygons_for_multiple_facilities is set to Merge by Break Value; therefore, FacilityOID field values are set to null or -1 when service areas are merged. |
FromBreak | The lower bound of the service area's break range. The value is in the units specified by the break_units parameter. |
ToBreak | The upper bound of the service area's break range. The value is in the units specified by the break_units parameter. |
If Merge by Break Value wasn't used, the output also includes any fields you added to the input facilities.
solve_succeeded
Use this parameter to determine if the service was able to successfully find the service areas. The error messages for the failure can be obtained by making a request to get the status of the job.