FRAMES | NO FRAMES

 

B U S I N E S S   A N A L Y S T   10.2   R E S T   L O O K U P   U T I L I T Y

Get Standard Geography Levels Endpoint

Gets IDs and names of standard geography levels.

 

Availability: Business Analyst Online, Business Analyst Server.

 

URL Example

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

Parameters

Parameter

Description

ActiveDatasetID (optional)

ID of the active dataset. Type string.

Default: ID of the first available dataset.

compatibility (optional)

Business Analyst Server version the JSON output is compatible with. Type string.

f (optional)

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

Default: HTML.

token

Authentication token. In Business Analyst Server, this parameter is required if your Business Analyst Server is secured. Type string.

Returns

Array of IDNamePair. In the case of JSON and PJSON response types, the response format depends on the compatibility parameter value.

Remarks

Use this method when you want IDs and names of standard geography levels available for use in Business Analyst Online REST endpoints.

Example Usage

The example below requests all standard geography levels available in Business Analyst Server core dataset.

 

Request

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

 

Response

{
  "results":
  [
    {
      "paramName":"StdLevels",
      "dataType":"BAIDNamePairs",
      "value":
      [
        {
          "Name":"Whole USA",
          "ID":"US.WholeUSA"
        },
        {
          "Name":"States",
          "ID":"US.States"
        },
        {
          "Name":"Counties",
          "ID":"US.Counties"
        },
        {
          "Name":"ZIP Codes",
          "ID":"US.ZIP5"
        },
        {
          "Name":"Census Tracts",
          "ID":"US.Tracts"
        },
        {
          "Name":"Block Groups",
          "ID":"US.BlockGroups"
        },
        {
          "Name":"CBSA",
          "ID":"US.CBSA"
        },
        {
          "Name":"DMA",
          "ID":"US.DMA"
        },
        {
          "Name":"Cities and Towns",
          "ID":"US.Places"
        },
        {
          "Name":"Congressional Districts",
          "ID":"US.CD"
        },
        {
          "Name":"County Subdivisions",
          "ID":"US.CS"
        }
      ]
    }
  ],
  "messages":
  [
  ]
}

 

See Also

Standard Geographies by Attributes Endpoint

Standard Geographies from Extent Endpoint

Business Analyst Server REST Reference