BasemapSession
{
"sessionToken": "string",
"endTime": 0,
"startTime": 0,
"styleFamily": "arcgis"
}The basemap session is a duration of time that users can use a session token to access basemap styles and tiles from this service. The basemap session usage model allows ArcGIS Location Platform developers to use unlimited ArcGIS basemap tiles for a specific amount of time which is the session duration. The maximum duration is 12 hours. There is only one usage charge to create the session token and no additional usage charges to access individual basemap tiles.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
session | string | A session token is a token that can access this service for a set duration of time and for a fixed usage cost. | |
end | number(int64) | The time at which the session token expires. It is represented as the number of milliseconds since unix 1970 epoch. | |
start | number(int64) | The time at which the session token was created. It is represented as the number of milliseconds since unix 1970 epoch. | |
style | SessionStyleFamily | The family of styles that the session token can be used to access. The styleFamily can be an ArcGIS basemap style family or an Open basemap style family. |
Error
{
"error": {
"code": 400,
"message": "string",
"details": [
"string"
],
"restInfoUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/info"
}
}Properties
| Name | Type | Required | Description |
|---|---|---|---|
error | object | Error information |
error properties
| Name | Type | Required | Description |
|---|---|---|---|
code | integer | A code identifying the type of error, either an HTTP error code, | |
message | string | A message describing the error. | |
details | [string] | List of details about the error. | |
rest | string | URL that provides the basemap-styles service information. |
Enumerated values
code
ServiceSelf
{
"name": "Basemap Styles",
"version": "x.x.x",
"description": "Brief description of Basemap styles API",
"styleFamilies": [
{
"name": "ArcGIS",
"code": "arcgis"
}
],
"languages": [
{
"name": "English",
"code": "en"
}
],
"worldviews": [
{
"name": "China",
"code": "china"
}
],
"places": [
{
"name": "Attributed",
"code": "attributed"
}
],
"selfUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/self",
"stylesUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/styles/self",
"webmapsUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/webmaps/self"
}A JSON structure which describes the Basemap Styles Service. Includes a list of all supported languages, worldviews, and places.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
name | string | Name of the service. | |
version | string | Version of the service that you are using. | |
description | string | Description of the service. | |
style | [object] | A list of the available style families. | |
languages | [object] | Supported languages that can be passed to the {?language} parameters. | |
worldviews | [object] | Supported worldviews that can be passed to the {?worldview} parameter. | |
places | [object] | Supported places values that can be passed to the {?places} parameters. | |
self | string | URL that points to self. | |
styles | string | URL that points to styles self. | |
webmaps | string | URL that points to webmaps self. |
SessionStyleFamily
"arcgis"The family of styles that the session can access. This can be an ArcGIS basemap style family or an Open basemap style family.
- Type
- string
- Required
- false
- Restrictions
- none
Enumerated values
anonymous
Style
Provides a Style JSON as defined by the Maplibre Style specification.
StyleFamily
"arcgis"The family of the style.
- Type
- string
- Required
- false
- Restrictions
- none
Enumerated values
anonymous
StylesItemSelf
{
"name": "ArcGIS Human Geography Dark",
"deprecated": false,
"complete": true,
"path": "/styles/arcgis/human-geography-dark",
"provider": "arcgis",
"styleFamily": "arcgis",
"thumbnailUrl": "https://www.arcgis.com/sharing/rest/content/items/ea3befe305494bb5b2acd77e1b3135dc/info/thumbnail/thumbnail1659480292164.png",
"selfUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/styles/arcgis/human-geography-dark/self",
"styleUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/styles/arcgis/human-geography-dark{?language}{?worldview}{?places}",
"rootUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/styles/arcgis/human-geography-dark/base{?language}{?worldview}{?places}",
"baseUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/styles/arcgis/human-geography-dark/base/self",
"detailUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/styles/arcgis/human-geography-dark/detail/self",
"labelsUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/styles/arcgis/human-geography-dark/labels/self"
}Describes the provided style.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
name | string | Name of the style. | |
deprecated | boolean | True if the style is deprecated, false otherwise. | |
complete | boolean | True if the style can be used as a complete basemap, or false if it requires additional layers. To present users with a list of basemap styles that are ready to be used as a stand-alone basemap, filter out styles that are marked as not For example, the By contrast the | |
path | string | Endpoint path used to access the style. | |
provider | string | Style provider, arcgis or osm. | |
style | StyleFamily | The family of the style. | |
thumbnail | string | Link to thumnail of style. | |
self | string | URL that points to self. | |
style | string | URL that refers to a style, potentially including parameters such as language, worldview, or places at the end if they are supported. | |
root | string | URL that refers to a style's base portal id layer, potentially including parameters such as language, worldview, or places at the end if they are supported. | |
base | string | URL that points to the base layer self. | |
detail | string | URL that points to the detail layer self. | |
labels | string | URL that points to the labels layer self. |
StylesSelf
{
"languages": [
{
"name": "English",
"code": "en"
}
],
"worldviews": [
{
"name": "China",
"code": "china"
}
],
"places": [
{
"name": "Attributed",
"code": "attributed"
}
],
"styleFamilies": [
{
"name": "ArcGIS",
"code": "arcgis"
}
],
"styles": [
{
"name": "ArcGIS Human Geography Dark",
"deprecated": false,
"complete": true,
"path": "/styles/arcgis/human-geography-dark",
"provider": "arcgis",
"styleFamily": "arcgis",
"thumbnailUrl": "https://www.arcgis.com/sharing/rest/content/items/ea3befe305494bb5b2acd77e1b3135dc/info/thumbnail/thumbnail1659480292164.png",
"selfUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/styles/arcgis/human-geography-dark/self",
"styleUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/styles/arcgis/human-geography-dark{?language}{?worldview}{?places}",
"rootUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/styles/arcgis/human-geography-dark/base{?language}{?worldview}{?places}",
"baseUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/styles/arcgis/human-geography-dark/base/self",
"detailUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/styles/arcgis/human-geography-dark/detail/self",
"labelsUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/styles/arcgis/human-geography-dark/labels/self"
}
],
"selfUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/styles/self",
"customStylesUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/styles/items/{item_id}"
}Describes the list of available style endpoints.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
languages | [object] | Supported languages that can be passed to the {?language} parameters. | |
worldviews | [object] | Supported worldviews that can be passed to the {?worldview} parameter. | |
places | [object] | Supported places values that can be passed to the {?places} parameters. | |
style | [object] | A list of the available style families. | |
styles | [StylesItemSelf] | List of provided styles that can be used. | |
self | string | URL that points to self. | |
custom | string | URL that points to custom styles of the output type. |
Webmap
Provides a Webmap JSON as defined by the ESRI ArcGIS Webmap specification.
Contains a URL pointing to the location of the requested style.
WebmapItemSelf
{
"name": "ArcGIS Human Geography Dark",
"deprecated": false,
"complete": true,
"path": "/styles/arcgis/human-geography-dark",
"provider": "arcgis",
"styleFamily": "arcgis",
"thumbnailUrl": "https://www.arcgis.com/sharing/rest/content/items/ea3befe305494bb5b2acd77e1b3135dc/info/thumbnail/thumbnail1659480292164.png",
"selfUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/webmaps/arcgis/human-geography-dark/self",
"styleUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/webmaps/arcgis/human-geography-dark{?language}{?worldview}{?places}",
"rootUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/webmaps/arcgis/human-geography-dark/base{?language}{?worldview}{?places}",
"baseUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/webmaps/arcgis/human-geography-dark/base/self",
"detailUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/webmaps/arcgis/human-geography-dark/detail/self",
"labelsUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/webmaps/arcgis/human-geography-dark/labels/self"
}Describes the provided style.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
name | string | Name of the style. | |
deprecated | boolean | True if the style is deprecated, false otherwise. | |
complete | boolean | True if the style can be used as a complete basemap, or false if it requires additional layers. To present users with a list of basemap styles that are ready to be used as a stand-alone basemap, filter out styles that are marked as not For example, the By contrast the | |
path | string | Endpoint path used to access the webmap. | |
provider | string | Style provider, arcgis or osm. | |
style | StyleFamily | The family of the style. This can be an ArcGIS basemap style family or an Open basemap style family. | |
thumbnail | string | Link to thumnail of style. | |
self | string | URL that points to self. | |
style | string | URL that refers to a style, potentially including parameters such as language, worldview, or places at the end if they are supported. | |
root | string | URL that refers to a style's base portal id layer, potentially including parameters such as language, worldview, or places at the end if they are supported. | |
base | string | URL that points to the base layer self. | |
detail | string | URL that points to the detail layer self. | |
labels | string | URL that points to the labels layer self. |
WebmapsSelf
{
"languages": [
{
"name": "English",
"code": "en"
}
],
"worldviews": [
{
"name": "China",
"code": "china"
}
],
"places": [
{
"name": "Attributed",
"code": "attributed"
}
],
"styleFamilies": [
{
"name": "ArcGIS",
"code": "arcgis"
}
],
"styles": [
{
"name": "ArcGIS Human Geography Dark",
"deprecated": false,
"complete": true,
"path": "/styles/arcgis/human-geography-dark",
"provider": "arcgis",
"styleFamily": "arcgis",
"thumbnailUrl": "https://www.arcgis.com/sharing/rest/content/items/ea3befe305494bb5b2acd77e1b3135dc/info/thumbnail/thumbnail1659480292164.png",
"selfUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/webmaps/arcgis/human-geography-dark/self",
"styleUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/webmaps/arcgis/human-geography-dark{?language}{?worldview}{?places}",
"rootUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/webmaps/arcgis/human-geography-dark/base{?language}{?worldview}{?places}",
"baseUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/webmaps/arcgis/human-geography-dark/base/self",
"detailUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/webmaps/arcgis/human-geography-dark/detail/self",
"labelsUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/webmaps/arcgis/human-geography-dark/labels/self"
}
],
"selfUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/webmaps/self",
"customStylesUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/webmaps/items/{item_id}"
}Describes the list of available webmap endpoints.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
languages | [object] | Supported languages that can be passed to the {?language} parameters. | |
worldviews | [object] | Supported worldviews that can be passed to the {?worldview} parameter. | |
places | [object] | Supported places values that can be passed to the {?places} parameters. | |
style | [object] | A list of the available style families. | |
styles | [WebmapItemSelf] | List of provided styles that can be used. | |
self | string | URL that points to self. | |
custom | string | URL that points to the endpoint for custom style webmaps. |