Get Segmentation Bases Endpoint

Gets the list of all available segmentation bases.

Availability: Business Analyst Server.

URL Example

http://localhost:6080/arcgis/rest/services/DefaultMap/MapServer/exts/BAServer/GetSegBases/execute

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.
token	Authentication token. This parameter is required if your Business Analyst Server is secured. Type string.

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.

token

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

Returns

Array of string containing the list of all available segmentation bases.

Remarks

In Business Analyst Server, two segmentation base are available:

• "Total Adult Population"—the total population in a geographic area ages 18 years or older.

• "Total Households"—the total number of households in a geographic area.

Example Usage

The example below requests all available segmentation base names in the current instance of Business Analyst Server.

Request

http://localhost:6080/arcgis/rest/services/DefaultMap/MapServer/exts/BAServer/GetSegBases/execute?f=PJSON

Response

{
  "results":
  [
    {
      "paramName":"OutputString",
      "dataType":"GPString",
      "value":"Total Households"
    },
    {
      "paramName":"OutputString",
      "dataType":"GPString",
      "value":"Total Adult Population"
    }
  ],
  "messages":
  [
  ]
}