FRAMES | NO FRAMES

 

B U S I N E S S   A N A L Y S T   10.2   R E S T   R E N D E R I N G   U T I L I T Y

Get Default Map Description Endpoint

Gets the default map description.

 

Availability: Business Analyst Server.

 

URL Example

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

Parameters

Parameter

Description

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

Returns

Variable of type MapDescription. In the case of JSON and PJSON response types, the response format depends on the compatibility parameter value.

Example Usage

The example below requests the description of a default map.

 

Request

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

 

Response

{
  "results":
  [
    {
      "paramName":"MapDescription",
      "dataType":"GPString",
      "value":"
<MapDescription xsi:type='typens:MapDescription'
  xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
  xmlns:xs='http://www.w3.org/2001/XMLSchema'
  xmlns:typens='http://www.esri.com/schemas/ArcGIS/10.0'>
  <Name>Layers</Name>
  <MapArea xsi:type='typens:MapExtent'>
    <Extent xsi:type='typens:EnvelopeN'>
      <XMin>-183.79172161096986</XMin>
      <YMin>16.286802220481771</YMin>
      <XMax>-61.385931326997678</XMax>
      <YMax>74.014466842820596</YMax>
      <SpatialReference xsi:type='typens:GeographicCoordinateSystem'>
        <WKT>GEOGCS[&quot;GCS_North_American_1983&quot;,...]</WKT>
        ...
        <WKID>4269</WKID>
      </SpatialReference>
    </Extent>
  </MapArea>
  <LayerDescriptions xsi:type='typens:ArrayOfLayerDescription'>
    <LayerDescription xsi:type='typens:LayerDescription'>
      <LayerID>0</LayerID>
      <Visible>true</Visible>
      <ShowLabels>false</ShowLabels>
      <ScaleSymbols>true</ScaleSymbols>
      <SelectionFeatures xsi:type='typens:ArrayOfInt'></SelectionFeatures>
      <SelectionSymbol xsi:type='typens:SimpleFillSymbol'>
        ...
      </SelectionSymbol>
      <SetSelectionSymbol>false</SetSelectionSymbol>
      <SelectionBufferDistance>0</SelectionBufferDistance>
      <ShowSelectionBuffer>false</ShowSelectionBuffer>
      <DefinitionExpression></DefinitionExpression>
      <SelectionBufferSymbol xsi:type='typens:SimpleFillSymbol'>
       ...
      </SelectionBufferSymbol>
    </LayerDescription>
  </LayerDescriptions>
  <Rotation>0</Rotation>
  <SpatialReference xsi:type='typens:GeographicCoordinateSystem'>
    <WKT>GEOGCS[&quot;GCS_North_American_1983&quot;,...]</WKT>
    ...
    <WKID>4269</WKID>
  </SpatialReference>
  <SelectionColor xsi:type='typens:RgbColor'>
    ...
  </SelectionColor>
  <BackgroundSymbol xsi:type='typens:SimpleFillSymbol'>
    ...
  </BackgroundSymbol>
</MapDescription>"
    }
  ],
  "messages":
  [
  ]
}

 

NOTE: The XML string value in the response is split in lines for easy reading. The response has been abbreviated where "..." is noted.

 

See Also

Business Analyst Server REST Reference