Output from SolveLocationAllocation

After successful execution, the service returns the chosen facilities, participating demand points, connecting lines between demand points and the facilities they were assigned to, and the status of whether the analysis was successful. This information is output in the following output parameters:

output_facilities

Use this parameter to access the chosen facilities as well as any required, competitor, or unchosen candidate facilities.

The following table describes the attributes of the output facilities:

Field name	Description
OID	A unique identifier for the facility. This identifier is automatically generated by the service.
Name	The name of the facility.
FacilityType	The best facilities, or those that are chosen in the analysis, are indicated in this field. All facility types are as follows: 0 (Candidate)—The service didn't choose the candidate facility to be part of the solution. 1 (Required)—Prior to submitting the analysis, the facility was designated as "required"; therefore, it is part of the solution regardless of how much demand it was able to capture. 2 (Competitor)—The facility is a competitor and any demand it captures is removes potential demand from your facilities. Competitor facilities are specific to the Maximize Market Share and Target Market Share problem types; they are ignored in other problem types. 3 (Chosen)—These are the chosen facilities; that is, candidate facilities that capture the most demand. The number of chosen facilities equals number_of_facilities_to_find minus the number of required facilities.
Weight	The relative weighting of the facility, which is used to rate the attractiveness, desirability, or bias of one facility compared to another. The values are copied from the corresponding input facilities.
Capacity	The amount of weighted demand the facility is capable of supplying. The values are copied from the corresponding input facilities.
DemandCount	A count of demand points allocated to the facility. A nonzero value means the facility was part of the solution, either as a required, competitor, or chosen facility.
DemandWeight	A sum of the effective weight from all demand points that were allocated to the facility. The value is a sum of all the Weight values from the demand points that were allocated to the facility. In the case of the Maximize Attendance and Market Share Problem types, the value is an apportioned sum of the Weight field values, since these problem types allow demand to decay with distance or be split among many facilities.
CurbApproach	The direction in which vehicles are allowed to arrive at or depart from the facility. The values are copied from the corresponding input facilities.
Status	Indicates how the corresponding input facility was evaluated in the analysis. The possible values are the following: 0 (OK)—The facility was successfully located on the transportation network and analyzed. 1 (Not Located)—A traversable road wasn't within 12.42 miles (20 kilometers) of the facility and therefore was excluded from the analysis. 3 (Invalid Field Values)—Field values fall outside a range or coded-value domain. 4 (Not Reached)—The facility couldn't be reached due to constraints; for example, a curb approach is set so that a vehicle must travel in the wrong direction on a one-way street to reach the facility.
Total_[cost] (such as Total_Minutes or Total_Miles)	A sum of travel distance or travel time between the facility and each of the demand points that were allocated to the facility.
TotalWeighted_[cost] (such as TotalWeighted_Minutes or TotalWeighted_Miles)	The cumulative weighted travel costs for a facility. The weighted travel cost for a demand point is its weight multiplied by the shortest or quickest path between the facility and the demand point. The weighted cost for a facility is the sum of all the weighted costs of demand points that are allocated to the facility. For example, if a demand point with a weight of two is allocated to a facility 10 miles away, the TotalWeighted_Miles value is 20 (2 x 10). If another demand point with a weight of three is allocated to the same facility and is five miles away, the TotalWeighted_Miles value increases to 35 (3 x 5 + 20). The units of the specified cost attribute are converted to the units that were set in the Measurement Units input parameter.
FacilityOID	The object ID value of the corresponding input facility feature.

output_demand_points

Use this parameter to access the demand points that participated in the analysis: both those that were and were not allocated to facilities.

Field name	Description
OID	A unique identifier for the demand point. This identifier is automatically generated by the service.
Name	The name of the demand point.
Weight	The relative weighting of the demand point. The values are copied from the corresponding input demand points.
AllocatedWeight	The amount of demand allocated to chosen and required facilities. The value excludes demand allocated to competing facilities. The value can have three interpretations: Null—The demand point wasn't assigned to any facility. This can result, for example, if the demand point could not be reached from any facility. 0—The demand point was only assigned to competing facilities. Positive, nonzero value—Indicates how much demand is assigned to your chosen and required facilities.
GroupName	The name of the group that the demand point is a part of. The values are copied from the corresponding input demand points.
CurbApproach	The direction in which vehicles are allowed to arrive at or depart from the demand point. The values are copied from the corresponding input demand points.
DemandOID	The object ID value of the corresponding input demand point feature.
FacilityOID	The object ID value of the corresponding input facility feature.
TimeCutoff or DistanceCutoff	The maximum time or distance that the input demand point was allowed to travel to reach a facility. The values is copied from the corresponding input demand points.

output_allocation_lines

Use this parameter to access the lines that connect demand points to the facilities they were allocated to. The lines include data about the demand allocated from each demand point to the associated facility.

Field name	Description
OID	A unique identifier for the allocation line. This identifier is automatically generated by the service.
Name	The name of the allocation line included the names of the demand point and facility the demand point is allocated to.
Weight	he weight assigned from the connected demand point to the connected facility.
TotalWeighted_[cost]	The weighted cost of traveling between the facility and the demand point. This is the Total_[cost] value multiplied by the weight of the demand point allocated to the facility. Note that though the lines have either straight or null geometries, the cost always refers to travel times or distances, not straight-line distances.
Total_[cost]	The travel time or travel distance between the facility and the demand point.
FacilityOID	The object ID value of the corresponding input facility feature.
DemandOID	The object ID value of the corresponding input demand point feature.

solve_succeeded

Use this parameter to determine if the service was able to successfully choose the best facilities. The error messages for any failure can be obtained by making a request to get the status of the job.