FRAMES | NO FRAMES

 

B U S I N E S S   A N A L Y S T   10.0   R E S T   A P I   T R A D E   A R E A   U T I L I T Y

Threshold Rings Radii Endpoint

Calculates radii of threshold rings.

 

Availability: Business Analyst Server.

 

URL Example

http://localhost/ArcGIS/baserver/REST/services/DefaultMap/BAServer/ThresholdRingsRadii/execute

Specific Parameters

Parameter

Description

Radii (required)

Array of threshold values, in ascending size. Type array of double.

Stores (required)

A point layer containing point features such as businesses, hospitals, schools, etc. which represent the locations from which the drive time trade/service areas will originate. Type PointLayer.

SummarizationField (required)

The attribute field name in the input ThresholdData layer which specifies a demographic field to be used for summarization. Type string.

ThresholdData (required)

A point or polygon layer containing demography data. Type DataLayer.

AnalysisExtent (optional)

Data extent to restrict the analysis. Type ExtentData.

OutputUnits (optional)

The output distance units the radii of threshold rings will be calculated in. Default units are miles. Type esriUnits.

Default: esriMiles.

SingleStoreID (optional)

ID of a single store in the Stores layer to generate threshold ring areas. Type string.

StoreIDField (optional)

The attribute field name in the input Stores layer which is associated with unique store/business IDs (typically store numbers for retail establishments with multiple locations). Type string.

Default: STORE_ID.

Other Parameters

Parameter

Description

ActiveDatasetID (optional)

ID of the active dataset. Type string.

Default: ID of the first available dataset.

f (optional)

Response format. Type string. Available formats: HTML, JSON, PJSON, XML.

Default: HTML.

IsFullErrorMessage (optional)

Mode for composing error messages. Type boolean.

Default: false.

token

Authentication token. This parameter is required if your Business Analyst Server is secured. Type string.

Returns

Array of ThresholdRingRadii. In the case of JSON and PJSON response types, an invalid JSON string was returned in version 9.3.1. Since Business Analyst Server 10.0, the JSON output format is corrected.

Remarks

The Threshold Rings Radii endpoint calculates radii of trade areas that expand out from the store locations until they meet a specified criteria. You define the criteria, or size of each ring, manually.

 

The analysis can be restricted to an analysis extent if the AnalysisExtent parameter is specified. The optional SingleStoreID parameter restricts the analysis to a single store of the store layer.

Usage Tips

• The input store layer must be a point layer.

• In most cases, the input store layer will be a Business Analyst store layer.

• Valid numeric units must be used when defining radii values. Negative values cannot be used for threshold radii.

• The threshold data layer must be a point or polygon feature layer and be set up as a Business Analyst Dataset (BDS) layer. In most cases, you should select the block group or block points layer.

Example Usage

The example below generates and returns radius values of threshold rings.

 

Request

http://localhost/ArcGIS/baserver/REST/services/DefaultMap/BAServer/ThresholdRingsRadii/execute?
Stores={"Points":[
  {"longitude":-117.195683,"description":"Store Study Site 1","latitude":34.057596,"name":"store_study_site1","storeID":"1"},
  {"longitude":-117.235664,"description":"Store Study Site 2","latitude":32.781143,"name":"store_study_site2","storeID":"2"}
]}&
Radii=1000;2000;3000&
SummarizationField=TOTHH_FY&
ThresholdData={"StdLayer":{"ID":"US.BlockGroups"}}&
ActiveDatasetID=USA_ESRI&
OutputUnits=esriMiles&
f=PJSON

 

Response

{
  "results":
  [
    {
      "paramName":"RingRadii",
      "dataType":"BARadiiStoreIDPairs",
      "value":
      [
        {
          "StoreID":"1",
          "Radii":
          [
            0.423991,
            0.637289,
            0.693119
          ]
        },
        {
          "StoreID":"2",
          "Radii":
          [
            0.491051,
            0.667634,
            0.748669
          ]
        }
      ]
    }
  ],
  "messages":
  [
  ]
}

 

See Also

Threshold Rings Endpoint

Business Analyst Server REST API Reference