Types

DocumentInfo

Example
Use dark colors for code blocksCopy
{
  "Title": "ArcGIS Streets",
  "Author": "Esri",
  "Comments": "string",
  "Subject": "imagery, satellite, aerial",
  "Category": "imageryBaseMapsEarthCover (Imagery, basemaps, and land cover)",
  "AntialiasingMode": "None",
  "TextAntialiasingMode": "None",
  "Keywords": "World,Global,United States"
}

Provides various information about the service such as title, author, keywords and comments.

Properties

Name	Type	Description
`Title`	`string`	The document title.
`Author`	`string`	The document author.
`Comments`	`string`	The document comments.
`Subject`	`string`	The document subject.
`Category`	`string`	The document category.
`AntialiasingMode`	`string`	The anti-aliasing mode.
`TextAntialiasingMode`	`string`	The text anti-aliasing mode.
`Keywords`	`string`	The document keywords.

Enumerated values

AntialiasingMode

None

Click to copy

Fastest

Click to copy

Fast

Click to copy

Normal

Click to copy

Best

Click to copy

TextAntialiasingMode

None

Click to copy

Normal

Click to copy

Force

Click to copy

Error

Example
Use dark colors for code blocksCopy
{
  "error": {
    "code": 400,
    "message": "Parameter invalid.",
    "details": [
      "string"
    ]
  }
}

Properties

Name	Type	Required	Description
`error`	`object`		Error information

`error` properties

Name Type Required Description

Name	Type	Description
`code`	`integer`	A code identifying the type of error. This can be an HTTP status code, `498` (invalid or expired token), or `499` (missing token).
`message`	`string`	A message describing the error.
`details`	`[string]`	List of details about the error.

code

integer

A code identifying the type of error.

This can be an HTTP status code, 498 (invalid or expired token), or 499 (missing token).

message

string

A message describing the error.

details

[string]

List of details about the error.

Enumerated values

code

400

Click to copy

401

Click to copy

403

Click to copy

404

Click to copy

498

Click to copy

499

Click to copy

500

Click to copy

Extent

Example
Use dark colors for code blocksCopy
{
  "spatialReference": {
    "wkid": 102100,
    "latestWkid": 3857
  },
  "xmax": 20037507.22959434,
  "xmin": -20037507.22959434,
  "ymax": 19971868.880408563,
  "ymin": -19971868.880408563
}

Defines a bounding geometry given the lower-left and upper-right corners of the bounding box.

Properties

Name	Type	Description
`spatialReference`	`SpatialReference`	An object used to specify the spatial reference of the given geometry.
`xmax`	`number`	A numeric value indicating the top-right X-coordinate of an extent envelope.
`xmin`	`number`	A numeric value indicating the bottom-left X-coordinate of an extent envelope.
`ymax`	`number`	A numeric value indicating the top-right Y-coordinate of an extent envelope.
`ymin`	`number`	A numeric value indicating the bottom-left Y-coordinate of an extent envelope.

LevelOfDetail

Example
Use dark colors for code blocksCopy
{
  "level": 6,
  "resolution": 1222.992452562495,
  "scale": 4622324.434309
}

A level of detail (LOD) in a tiling scheme.

Properties

Name	Type	Description
`level`	`integer`	ID for each level.
`resolution`	`number`	Resolution in map units of each pixel in a tile for each level.
`scale`	`number`	Scale for each level.

MetaData

Example
Use dark colors for code blocksCopy
{
  "serviceDescription": "string",
  "mapName": "ArcGIS Streets",
  "description": "This layer provides a detailed basemap for the world symbolized with a classic Esri street map style.",
  "copyrightText": "Sources: Esri, TomTom, Garmin, FAO, NOAA, USGS, © OpenStreetMap contributors, and the GIS User Community",
  "supportsDynamicLayers": false,
  "spatialReference": {
    "wkid": 102100,
    "latestWkid": 3857
  },
  "singleFusedMapCache": true,
  "tileInfo": {
    "rows": 512,
    "cols": 512,
    "dpi": 96,
    "compressionQuality": 75,
    "format": "PNG",
    "lods": [
      {
        "level": 6,
        "resolution": 1222.992452562495,
        "scale": 4622324.434309
      }
    ],
    "origin": {
      "m": 0,
      "spatialReference": {
        "wkid": 102100,
        "latestWkid": 3857
      },
      "x": 0,
      "y": 0,
      "z": 0
    },
    "spatialReference": {
      "wkid": 102100,
      "latestWkid": 3857
    }
  },
  "initialExtent": {
    "spatialReference": {
      "wkid": 102100,
      "latestWkid": 3857
    },
    "xmax": 20037507.22959434,
    "xmin": -20037507.22959434,
    "ymax": 19971868.880408563,
    "ymin": -19971868.880408563
  },
  "fullExtent": {
    "spatialReference": {
      "wkid": 102100,
      "latestWkid": 3857
    },
    "xmax": 20037507.22959434,
    "xmin": -20037507.22959434,
    "ymax": 19971868.880408563,
    "ymin": -19971868.880408563
  },
  "minScale": 0,
  "maxScale": 0,
  "units": "esriMeters",
  "supportedImageFormatTypes": "PNG",
  "documentInfo": {
    "Title": "ArcGIS Streets",
    "Author": "Esri",
    "Comments": "string",
    "Subject": "imagery, satellite, aerial",
    "Category": "imageryBaseMapsEarthCover (Imagery, basemaps, and land cover)",
    "AntialiasingMode": "None",
    "TextAntialiasingMode": "None",
    "Keywords": "World,Global,United States"
  },
  "capabilities": "Map",
  "exportTilesAllowed": false,
  "maxRecordCount": 100,
  "maxImageHeight": 512,
  "maxImageWidth": 512
}

The metadata.

Properties

Name	Type	Description
`serviceDescription`	`string`	A description of the static basemap tiles service.
`mapName`	`string`	The name of the basemap style.
`description`	`string`	A description of the map.
`copyrightText`	`string`	Copyright information for the map.
`supportsDynamicLayers`	`boolean`	Whether the service supports dynamic layers.
`spatialReference`	`SpatialReference`	The spatial reference of the map.
`singleFusedMapCache`	`boolean`	Whether the service has a single fused map cache.
`tileInfo`	`TileInfo`	The tile information of the service.
`initialExtent`	`Extent`	The initial extent of the service.
`fullExtent`	`Extent`	The full extent of the service.
`minScale`		A number representing the minimum scale at which the layer will be visible. The number is the scale's denominator.
`maxScale`		A number representing the maximum scale at which the layer will be visible. The number is the scale's denominator.
`units`	`string`	Units used by the service.
`supportedImageFormatTypes`	`string`	The image format types supported by the service when generating a map image.
`documentInfo`	`DocumentInfo`	Information about the service.
`capabilities`	`string`	The service's capabilities.
`exportTilesAllowed`	`boolean`	Whether exporting tiles in compact format (.tpk) is supported.
`maxRecordCount`	`integer`	The maximum number of records that will be returned at once for a query.
`maxImageHeight`	`integer`	The maximum image height in pixels.
`maxImageWidth`	`integer`	The maximum image width in pixels.

Enumerated values

units

esriMeters

Click to copy

Point

Example
Use dark colors for code blocksCopy
{
  "m": 0,
  "spatialReference": {
    "wkid": 102100,
    "latestWkid": 3857
  },
  "x": 0,
  "y": 0,
  "z": 0
}

Properties

Name	Type	Description
`m`	`number`	M coordinate which contains measures used for linear referencing.
`spatialReference`	`SpatialReference`	The spatial reference can be defined using a well-known ID (WKID) or well-known text (WKT).
`x`	`number`	X coordinate which is measured along the east/west axis.
`y`	`number`	Y coordinate which is measured along the north/south axis.
`z`	`number`	Z coordinate which measures height or elevation.

ServiceSelf

Example
Use dark colors for code blocksCopy
{
  "languages": [
    {
      "name": "French",
      "code": "fr"
    }
  ],
  "styleFamilies": [
    {
      "name": "ArcGIS",
      "code": "arcgis"
    }
  ],
  "worldviews": [
    {
      "name": "United States of America",
      "code": "unitedStatesOfAmerica"
    }
  ],
  "styles": [
    {
      "name": "ArcGIS Navigation",
      "deprecated": false,
      "complete": true,
      "path": "/arcgis/navigation",
      "provider": "arcgis",
      "styleFamily": "arcgis",
      "url": "https://static-map-tiles-api.arcgis.com/arcgis/rest/services/static-basemap-tiles-service/v1/arcgis/navigation/static",
      "templateUrl": "https://static-map-tiles-api.arcgis.com/arcgis/rest/services/static-basemap-tiles-service/v1/arcgis/navigation/static/tile/{z}/{y}/{x}",
      "thumbnailUrl": "https://www.arcgis.com/sharing/rest/content/items/ea3befe305494bb5b2acd77e1b3135dc/info/thumbnail/thumbnail1607389425104.jpeg",
      "supportedLanguageCodes": [
        [
          "fr",
          "de"
        ]
      ],
      "supportedWorldviewCodes": [
        [
          "unitedStatesOfAmerica"
        ]
      ],
      "description": "This layer provides a detailed basemap for the world featuring a custom navigation map style."
    }
  ]
}

A JSON structure which describes the static basemap tiles service. Includes a list of all supported styles.

Properties

Name	Type	Description
`languages`	`[object]`	List of languages that are supported by certain basemap styles. The language code can be set in the `language` query parameter for tile requests of supported styles. Check the array of `supportedLanguageCodes` for a style to see which languages are available.
`styleFamilies`	`[object]`	A list of the available style families.
`worldviews`	`[object]`	Supported worldviews that can be passed to the {?worldview} parameter.
`styles`	`[StylesItemSelf]`	List of provided styles that can be used.

SpatialReference

Example
Use dark colors for code blocksCopy
{
  "wkid": 102100,
  "latestWkid": 3857
}

A spatial reference.

Properties

Name	Type	Required	Description
`wkid`	`integer`		The well-known ID (WKID) of the coordinate system.
`latestWkid`	`integer`		Identifies the current wkid value associated with the same spatial reference. For example a WKID of '102100' (Web Mercator) has a latestWKid of '3857'.

StyleFamily

Example
Use dark colors for code blocksCopy
"arcgis"

Type: string
Required: false
Restrictions: none

Enumerated values

anonymous

arcgis

Click to copy

StylesItemSelf

Example
Use dark colors for code blocksCopy
{
  "name": "ArcGIS Navigation",
  "deprecated": false,
  "complete": true,
  "path": "/arcgis/navigation",
  "provider": "arcgis",
  "styleFamily": "arcgis",
  "url": "https://static-map-tiles-api.arcgis.com/arcgis/rest/services/static-basemap-tiles-service/v1/arcgis/navigation/static",
  "templateUrl": "https://static-map-tiles-api.arcgis.com/arcgis/rest/services/static-basemap-tiles-service/v1/arcgis/navigation/static/tile/{z}/{y}/{x}",
  "thumbnailUrl": "https://www.arcgis.com/sharing/rest/content/items/ea3befe305494bb5b2acd77e1b3135dc/info/thumbnail/thumbnail1607389425104.jpeg",
  "supportedLanguageCodes": [
    [
      "fr",
      "de"
    ]
  ],
  "supportedWorldviewCodes": [
    [
      "unitedStatesOfAmerica"
    ]
  ],
  "description": "This layer provides a detailed basemap for the world featuring a custom navigation map style."
}

Describes a given style.

Properties

Name	Type	Description
`name`	`string`	Name of the style.
`deprecated`	`boolean`	Details whether the style is deprecated.
`complete`	`boolean`	Details whether the style can be used as a complete basemap, or whether it requires additional layers. To present a list of static basemap tiles that are ready to be used stand-alone, filter out styles that are not `complete`. For example, the `arcgis/streets` style is `complete` because it includes all of the basemap data required to provide the context for a mapping application. It contains a base layer of streets and buildings, with an overlay of place name labels and street names. By contrast the `arcgis/imagery/labels` style only provides the place name labels and street names. Without an accompanying satellite imagery base layer this style does not provide a complete basemap.
`path`	`string`	Endpoint path used to access the style.
`provider`	`string`	The style provider.
`styleFamily`	`StyleFamily`
`url`	`string(URL)`	Full URL to the style metadata. This can be used with mapping clients that read the tiling scheme etc. from the metadata XML as the entry point for fetching tiles (for example, the ArcGIS Maps SDKs). You can append the `language` query parameter to this style, using the codes shown in the `supportedLanguageCodes` property for the style. Append the `token` query parameter to this style to authenticate tile requests.
`templateUrl`	`string(URL)`	Template URL for fetching a tile from the style This can be used with mapping clients that form tile requests using the `{x}/{y}/{z}` syntax (for example, Cesium JS, OpenLayers, Leaflet and MapLibre). Note that the order of arguments for this service is `{z}/{y}/{x}` where `z` equates to the `level` path parameter, `y` is `row` and `x` is `column`. You can append the `language` query parameter to this style, using the codes shown in the `supportedLanguageCodes` property for the style. Append the `token` query parameter to this style to authenticate tile requests.
`thumbnailUrl`	`string(URL)`	Link to a thumbnail JPG for the style.
`supportedLanguageCodes`	`[string]`	A list of the language codes that are supported for this style. Language codes can be passed to a given style with the `language` query parameter. You can see full details of a given language, including it's display name in the top-level `languages` property for the service's `self` endpoint. If this array is empty for a give style, only the default language for the basemap is supported.
`supportedWorldviewCodes`	`[string]`	A list of the worldview codes that are supported for this style. Pass a worldview code to a given style with the `worldview` query parameter to get that edition of the basemap. You can see full details of an edition, including its display name in the top-level `worldviews` property for the service's `self` endpoint. If this array is empty for a given style, only the default worldview for the basemap is supported. Note: `worldview` is currently only supported with the default `language`. If a `worldview` parameter is provided, any `language` query parameter passed alongside it will be ignored.
`description`	`string`	A description of the style.

Enumerated values

provider

arcgis

Click to copy

TileInfo

Example
Use dark colors for code blocksCopy
{
  "rows": 512,
  "cols": 512,
  "dpi": 96,
  "compressionQuality": 75,
  "format": "PNG",
  "lods": [
    {
      "level": 6,
      "resolution": 1222.992452562495,
      "scale": 4622324.434309
    }
  ],
  "origin": {
    "m": 0,
    "spatialReference": {
      "wkid": 102100,
      "latestWkid": 3857
    },
    "x": 0,
    "y": 0,
    "z": 0
  },
  "spatialReference": {
    "wkid": 102100,
    "latestWkid": 3857
  }
}

Tile information, returned from the service.

Properties

Name	Type	Description
`rows`	`integer`	Requested tile's row.
`cols`	`integer`	Requested tile's column.
`dpi`	`number`	The dpi of the tiling scheme.
`compressionQuality`	`number`	Compression quality of the tile.
`format`	`string`	Image format of the tile.
`lods`	`[LevelOfDetail]`	An array of levels of detail that define the tiling scheme.
`origin`	`Point`	The tiling scheme origin.
`spatialReference`	`SpatialReference`	The spatial reference of the tiling schema.

Enumerated values

format

PNG

Click to copy

Types

DocumentInfo

Properties

Enumerated values

AntialiasingMode

TextAntialiasingMode

Error

Properties

error properties

Enumerated values

code

Extent

Properties

LevelOfDetail

Properties

MetaData

Properties

Enumerated values

units

Point

Properties

ServiceSelf

Properties

SpatialReference

Properties

StyleFamily

Enumerated values

anonymous

StylesItemSelf

Properties

Enumerated values

provider

TileInfo

Properties

Enumerated values

format

`error` properties