Open topic with navigation

S A M P L E S

REST v2006.1 mapping example URLs

The following example URLs demonstrate how to access ArcWeb Services using REST. See map parameters and raster tile parameters for details on the different options you have for building your maps.

See the following sections for examples to get started using REST with ArcWeb Services:

Using map parameters

• Using the required map parameters
• Using best available map

Using the c parameter to pan the map

Using layers

• Getting service information
• Turning off a layer
• Turning off multiple layers

Using optional acetate parameters

• Using acetate line parameter
• Using acetate point parameter
• Using acetate polygon parameter

Using other optional parameters

• Using graticule parameter
• Using legend parameter
• Using north arrow parameter
• Using scale bar parameter
• Using north arrow and scale bar parameters

Using projection parameters

• Using best map projection
• Using specific map projections
• Using the default projection

Using raster tile imagery

• Getting data source information
• Getting available tiles
• Getting a raster tile image
• Getting a copyright

Using map parameters

The following samples demonstrate the required map parameters and best available map option.

Using the required map parameters

The required parameters for a REST map are center point (c), scale factor (sf), and data source (ds). You also need to send in a token (tkn or usrid) validating you as an authorized ArcWeb user. The following examples show some basic map requests.

This request contains only the required parameters: token (tkn), center point (c), scale factor (sf), and data source (ds).

This request returns the above map with an image width (w) of 800 pixels and a height (h) of 600 pixels.

This request returns the above map with a grayscale style sheet (stl).

This request returns the above map in PNG format (fmt).

This request rotates the above map by an angle (a) of 45 degrees in a clockwise direction.

Using best available map (ds=bam)

You can request the best available map (ds=bam), and the generated map will use the most appropriate data source for your input scale and center point. The following examples show how the data source changes as you change the center point (c) and scale factor (sf) parameter values.

In this example, the generated map uses the data source ArcWeb:TA.Streets.US.

If you change the center point to a place in Canada (c=-80.58657|45.99326), the generated map uses the data source ArcWeb:TA.Streets.NA.

If you change the center point to a place in Europe (c=1.58657|45.99326), the generated map uses the data source ArcWeb:TA.Streets.EU.

If you change the scale to a world view (sf=110000000), the generated map uses the data source ArcWeb:AND.World.Roads.

Using the c parameter to pan the map

The following sample demonstrates how to pan a map using the c parameter. The first request gets a map. The second request pans the map.

1. This request uses c along with other required parameters to get a map. Note that the ocs parameter is not used.

EXAMPLE

http://www.arcwebservices.com/services/v2006_1/restmap?actn=getMap<&tkn=ArcWeb Token OR &usrid=ArcWeb usrid>&c=-117|34&sf=5000000&ds=ArcWeb:TA.Streets.US

The map is returned in the default projection of 4326.

2. This request pans the map. Panning is performed by changing the value of the c parameter in the above request.

EXAMPLE

http://www.arcwebservices.com/services/v2006_1/restmap?actn=getMap<&tkn=ArcWeb Token OR &usrid=ArcWeb usrid>&c=-120|33&sf=5000000&ds=ArcWeb:TA.Streets.US

Note that the map is panned 3 decimal degrees to the west and 1 decimal degree to the south.

Using layers

Use a ServiceInfo request to get a list of layer names and scale visibility information for a data source. Then use the layer parameters to turn layers on and off.

Getting service information

This request is used to obtain information on a data source's (ds) layer names and the scales at which they are visible. The response can be sorted by layer name or visibility using the order parameter (ord).

Turning off a layer

This request turns off the Oceans and Seas layer using two parameters: layer list (ll) and layer visibility (lv).

Turning off multiple layers

This request turns off multiple layers using two parameters: layer list (ll) and layer visibility (lv). Note that each layer name is separated by a pipeline (|) and that layer visibility is turned off for each layer using a pipeline.

Using optional acetate parameters

The following samples demonstrate the acetate line, acetate point, and acetate polygon parameters.

Using acetate line parameter

This request overlays two polylines on a map. Notice for each polyline, three parameters are set: x|y coordinate series for line location (ln), color (lnc), and width (lnw).

Using acetate point parameter

This request adds three point markers with labels on your map. Notice for each point, three parameters are set: location (p), icon (pi), and label (pl).

Using acetate polygon parameter

This request adds two polygons on your map. Notice for each polygon, two parameters are set: x|y coordinate series for vertices location (plg) and color (plc).

Using other optional parameters

The following samples demonstrate the graticule, legend, north arrow, scale bar, and combined north arrow and scale bar parameters.

Using graticule parameter

This request overlays a graticule (g) on the map.

Using legend parameter

This request displays a legend (l) on the map.

Using north arrow parameter

This request adds a north arrow to your map. Notice that four parameters are set: center point (na), width (naw), height (nah), and type (nat).

Using scale bar parameter

This request adds a scale bar to your map. Notice that three parameters are set: location (sbx), width (sbw), and type (sbt).

Using north arrow and scale bar parameters

This request adds a north arrow and a scale bar to your map. Notice that four parameters are set for the north arrow: center point (na), width (naw), height (nah), and type (nat). Three parameters are set for the scale bar: location (sbx), width (sbw), and type (sbt).

Using projection parameters

The following samples demonstrate best map projection, specific map projections, and the default projection for SVG format.

For each projected map, you need to make two requests. The first request returns a projected map and turns projection on using the ocs parameter. The second request works in projection mode and requires two additional parameters to pan and zoom the map: cmr and dc. The cmr value is derived from the results of the first projection request.

Projections in REST URLs are done this way so all the projection calculations are made on the server side. This ensures a swift response and makes it easy to use.

See projection parameters for valid values.

Using best map projection

The following sample uses two requests. The first request gets a map and turns projection mode on. The second request pans and zooms the map within projection mode.

1. This request returns an automatically projected map using ocs=0, along with c and other required map parameters. See OCS types for details.

EXAMPLE

http://www.arcwebservices.com/services/v2006_1/restmap?actn=getMap<&tkn=ArcWeb Token OR &usrid=ArcWeb usrid>&sf=250000000&ds=ArcWeb:AND.Roads.World&c=-117.875871|33.93265&fmt=svg&ocs=0

Note that the map is returned in projection 3 (Transverse Mercator). This information is returned in the desc tag (for SVG format) in the source. To view it, right-click on the map, click View Source, and view the contents of the desc tag. You will need this information for the cmr string in the next request. See projection parameters for details.

Once the projected map is turned on, use dc and cmr along with other required map parameters to pan the map 50 pixels to the west and 100 pixels to the south. Note that cmr can be obtained from the HTTP header or, for SVG format, right-click the map from the projection request and click View Source. Then copy the contents of the desc tag and assign that value to the cmr string in the URL for the request to pan the map. Note that ocs in the following request is set to 0.

EXAMPLE

http://www.arcwebservices.com/services/v2006_1/restmap?actn=getMap<&tkn=ArcWeb Token OR &usrid=ArcWeb usrid>&sf= 1000000&ds=ArcWeb:AND.Roads.World&c=-117.87587|33.93265&fmt=svg&ocs=0&cmr=-117.87587|33.93265|0.0|0.0|1000000.0|0.0|3&dc=50|100

Using specific map projections

The following sample uses two requests. The first request gets a map and turns projection mode on. The second request pans and zooms the map within projection mode.

1. This request uses c and ocs, along with other required parameters to get a map in OCS type 6 (Bonne). See OCS types for details.

EXAMPLE

http://www.arcwebservices.com/services/v2006_1/restmap?actn=getMap<&tkn=ArcWeb Token OR &usrid=ArcWeb usrid>&sf=100000&ds=ArcWeb:AND.Roads.World&c=-117.87587|33.93265&fmt=svg&ocs=6



2. This request uses dc and cmr along with other required map parameters to pan the map keeping the same projection. Note that ocs in the following request is set to 6.

Right-click the map in the previous request and click View Source, copy the contents of the desc tag, and assign that value to the cmr string in the URL for this request.

EXAMPLE

http://www.arcwebservices.com/services/v2006_1/restmap?actn=getMap<&tkn=ArcWeb Token OR &usrid=ArcWeb usrid>&sf=100000&ds=ArcWeb:AND.Roads.World&c=-117.87587|33.93265&fmt=svg&ocs=6&cmr=-117.875871|33.93265|0.0|0.0|100000.0|0.0|6&dc=50|100

Note that the map is panned 50 pixels to the west and 100 pixels to the south but the projection remains the same. To confirm, right-click the map, click View Source, and view the contents of the desc tag.

Using the default projection

The following sample uses two requests. The first request gets a map and turns projection mode on. The second request pans and zooms the map within projection mode.

1. This request uses c along with other required parameters to get a map in the default projection. Note that the ocs parameter is not used.

   EXAMPLE

   http://www.arcwebservices.com/services/v2006_1/restmap?actn=getMap<&tkn=ArcWeb Token OR &usrid=ArcWeb usrid>&sf=100000&ds=ArcWeb:AND.Roads.World&c=-117.87587|33.93265&fmt=svg

   The map is returned in the default projection of 4326.

2. This request uses dc and cmr along with other required map parameters to pan the map. Note that ocs parameter is not used in this request. For the cmr parameter, right-click the map in the REST request in step 1, click View Source, copy the contents of the desc tag, and assign that value to the cmr string in the URL for this new request.

   EXAMPLE

   http://www.arcwebservices.com/services/v2006_1/restmap?actn=getMap<&tkn=ArcWeb Token OR &usrid=ArcWeb usrid>&sf=100000&ds=ArcWeb:AND.Roads.World&c=-117.87587|33.93265&fmt=svg&cmr=-117.87587|33.93265|0.0|0.0|100000.0|0.0|4326&dc=50|100

   Note that the map is panned 50 pixels to the west and 100 pixels to the south.

Using raster tile imagery

Use a getTileInfo request to obtain raster tile data source information. Then get available tiles or a raster tile image.

Getting data source information

This request gets information about a raster tile data source (ds). This request uses the ArcWeb:ESRI.Satellite_Tiles.World data source.

Getting available tiles

This request gets the available tiles at the specified scale for the given location. In addition to the required parameters for a REST map, the following client display parameters are required for a getTiles request to a raster data source: width (w) and height (h). The XML response includes a set of tiles at a particular level as welll as row and column information.

Getting a raster tile image

This request gets a raster tile image at a specified level. In addition to the required parameters for a REST map, the following parameters are required for a getTile request: tile level (lev), row level (row), and column level (col). The optional error request (re) parameter displays HTTP error codes if a tile is not found instead of a "Map imagery not available" image.

This invalid request demonstrates the raster tile error request (re) parameter.

Getting a copyright

This request gets a copyright for a raster tile image at a specified level. In addition to the required parameters for a REST map, the following client display parameters are required for a getCopyright request to a raster data source: width (w) and height (h). The XML response includes publication date and publisher.

See also

• REST error messages
• REST mapping live samples
• REST mapping projections
• REST raster tile mapping parameters

Visit the Feedback page to give comments or suggestions about the ArcWeb Developer's Guide.

ArcWeb site | ArcWeb support | support.esri.com

Copyright © ESRI