List sprites versions

Purpose

• The list sprites versions endpoint functionality shows the user the available sprites versions and allows them to choose the one needed.
• It returns an array of sprite versions, along with URLs to services which allow retrieval of further listings of sprites.
• With the appropriate sprite version, users can list the specific sprites available for that version using the List sprites functionality.

Request data

HTTPS method: GET

• Constants and parameters enclosed in curly brackets { } must be replaced with their values.
• Please see the following Request parameters section with the required and optional parameters tables for their values. The generic request format is as follows.

URL format

1
https://{baseURL}/maps/orbis/assets/sprites?key={Your_API_Key}&apiVersion={API_Version}

1
https://api.tomtom.com/maps/orbis/assets/sprites?key={Your_API_Key}&apiVersion=1

1
curl 'https://api.tomtom.com/maps/orbis/assets/sprites?key={Your_API_Key}&apiVersion=1

Request parameters

The following table describes the parameters that can be used in a request.

• Required parameters must be used or the call will fail.
• Parameters and values are case-sensitive.
• Optional parameters may be used.

Request headers

HTTP request headers are common in the Assets API service. For details, see HTTP request headers .

Response data

Successful response

For a single request, the service returns its response body in JSON format.

Response schema

1
{
2
  "versions": [
3
    {
4
      "version": "string",
5
      "url": "string"
6
    }
7
  ]
8
}

Response field structure

The following table describes JSON element fields that can appear in a response.

Example

1
{
2
  "versions": [
3
    {
4
      "version": "0.0.0-0",
5
      "url": "https://api.tomtom.com/maps/orbis/assets/sprites/0.0.0-0?apiVersion=1&key={api_key}"
6
    }
7
  ]
8
}

Error response

Error response field structure

The following table describes JSON element fields that can appear in an error response.

Example

1
{
2
  "detailedError" : {
3
    "code" : "BAD_REQUEST",
4
    "message" : "Invalid format of the api version."
5
  }
6
}

Response codes

HTTP response codes are common in the Assets API service. For details, see HTTP response codes .

Response headers

HTTP response headers are common in the Assets API service. For details, see HTTP response headers .