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	Restrictions	Description
`Title`	`string`	none	The document title.
`Author`	`string`	none	The document author.
`Comments`	`string`	none	The document comments.
`Subject`	`string`	none	The document subject.
`Category`	`string`	none	The document category.
`AntialiasingMode`	`string`	none	The anti-aliasing mode.
`TextAntialiasingMode`	`string`	none	The text anti-aliasing mode.
`Keywords`	`string`	none	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

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	Restrictions	Description
`error`	`object`	none	Error information
`code`	`integer`	none	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`	none	A message describing the error.
`details`	`[string]`	none	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	Restrictions	Description
`spatialReference`	`SpatialReference`	none	An object used to specify the spatial reference of the given geometry.
`xmax`	`number`	none	A numeric value indicating the top-right X-coordinate of an extent envelope.
`xmin`	`number`	none	A numeric value indicating the bottom-left X-coordinate of an extent envelope.
`ymax`	`number`	none	A numeric value indicating the top-right Y-coordinate of an extent envelope.
`ymin`	`number`	none	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	Restrictions	Description
`level`	`integer`	none	ID for each level.
`resolution`	`number`	none	Resolution in map units of each pixel in a tile for each level.
`scale`	`number`	none	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	Restrictions	Description
`serviceDescription`	`string`	none	A description of the static basemap tiles service.
`mapName`	`string`	none	The name of the basemap style.
`description`	`string`	none	A description of the map.
`copyrightText`	`string`	none	Copyright information for the map.
`supportsDynamicLayers`	`boolean`	none	Whether the service supports dynamic layers.
`spatialReference`	`SpatialReference`	none	The spatial reference of the map.
`singleFusedMapCache`	`boolean`	none	Whether the service has a single fused map cache.
`tileInfo`	`TileInfo`	none	The tile information of the service.
`initialExtent`	`Extent`	none	The initial extent of the service.
`fullExtent`	`Extent`	none	The full extent of the service.
`minScale`	`number`	none	A number representing the minimum scale at which the layer will be visible. The number is the scale's denominator.
`maxScale`	`number`	none	A number representing the maximum scale at which the layer will be visible. The number is the scale's denominator.
`units`	`string`	none	Units used by the service.
`supportedImageFormatTypes`	`string`	none	The image format types supported by the service when generating a map image.
`documentInfo`	`DocumentInfo`	none	Information about the service.
`capabilities`	`string`	none	The service's capabilities.
`exportTilesAllowed`	`boolean`	none	Whether exporting tiles in compact format (.tpk) is supported.
`maxRecordCount`	`integer`	none	The maximum number of records that will be returned at once for a query.
`maxImageHeight`	`integer`	none	The maximum image height in pixels.
`maxImageWidth`	`integer`	none	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	Restrictions	Description
`m`	`number`	none	M coordinate which contains measures used for linear referencing.
`spatialReference`	`SpatialReference`	none	The spatial reference can be defined using a well-known ID (WKID) or well-known text (WKT).
`x`	`number`	none	X coordinate which is measured along the east/west axis.
`y`	`number`	none	Y coordinate which is measured along the north/south axis.
`z`	`number`	none	Z coordinate which measures height or elevation.

ServiceSelf

Example
Use dark colors for code blocksCopy
{
  "languages": [
    {
      "name": "French",
      "code": "fr"
    }
  ],
  "styles": [
    {
      "name": "ArcGIS Navigation",
      "path": "/arcgis/navigation",
      "provider": "arcgis",
      "url": "https://static-map-tiles-api.arcgis.com/arcgis/rest/services/static-basemap-tiles-service/beta/arcgis/navigation/static",
      "templateUrl": "https://static-map-tiles-api.arcgis.com/arcgis/rest/services/static-basemap-tiles-service/beta/arcgis/navigation/static/tile/{z}/{y}/{x}",
      "thumbnailUrl": "https://www.arcgis.com/sharing/rest/content/items/ea3befe305494bb5b2acd77e1b3135dc/info/thumbnail/thumbnail1607389425104.jpeg",
      "supportedLanguageCodes": [
        [
          "fr",
          "de"
        ]
      ]
    }
  ]
}

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

Properties

Name	Type	Restrictions	Description
`languages`	`[object]`	none	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.
`name`	`string`	none	Name of the language.
`code`	`string`	none	Code for the language.
`styles`	`[StylesItemSelf]`	none	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	Restrictions	Description
`wkid`	`integer`		none	The well-known ID (WKID) of the coordinate system.
`latestWkid`	`integer`		none	Identifies the current wkid value associated with the same spatial reference. For example a WKID of '102100' (Web Mercator) has a latestWKid of '3857'.

StylesItemSelf

Example
Use dark colors for code blocksCopy
{
  "name": "ArcGIS Navigation",
  "path": "/arcgis/navigation",
  "provider": "arcgis",
  "url": "https://static-map-tiles-api.arcgis.com/arcgis/rest/services/static-basemap-tiles-service/beta/arcgis/navigation/static",
  "templateUrl": "https://static-map-tiles-api.arcgis.com/arcgis/rest/services/static-basemap-tiles-service/beta/arcgis/navigation/static/tile/{z}/{y}/{x}",
  "thumbnailUrl": "https://www.arcgis.com/sharing/rest/content/items/ea3befe305494bb5b2acd77e1b3135dc/info/thumbnail/thumbnail1607389425104.jpeg",
  "supportedLanguageCodes": [
    [
      "fr",
      "de"
    ]
  ]
}

Describes a given style.

Properties

Name	Type	Restrictions	Description
`name`	`string`	none	Name of the style.
`path`	`string`	none	Endpoint path used to access the style.
`provider`	`string`	none	The style provider.
`url`	`string(URL)`	none	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)`	none	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)`	none	Link to a thumbnail JPG for the style.
`supportedLanguageCodes`	`[string]`	none	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.

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	Restrictions	Description
`rows`	`integer`	none	Requested tile's row.
`cols`	`integer`	none	Requested tile's column.
`dpi`	`number`	none	The dpi of the tiling scheme.
`compressionQuality`	`number`	none	Compression quality of the tile.
`format`	`string`	none	Image format of the tile.
`lods`	`[LevelOfDetail]`	none	An array of levels of detail that define the tiling scheme.
`origin`	`Point`	none	The tiling scheme origin.
`spatialReference`	`SpatialReference`	none	The spatial reference of the tiling schema.

Enumerated Values

format

PNG

Click to copy