List glyphs ranges
Important notes:
- This TomTom Orbis API is in public preview.
- This API is powered by the TomTom Orbis Maps.
- See the TomTom Orbis Maps documentation for more information.
Purpose
- The list glyphs ranges functionality delivers an array of glyph ranges for the selected font, along with URLs which allow the user to retrieve them.
- Subsequently, users can proceed to Fetch glyphs ranges.
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.
https://{baseURL}/maps/orbis/assets/fonts/{assetVersion}/{fontName}?key={Your_API_Key}&apiVersion={API_Version}
https://api.tomtom.com/maps/orbis/assets/fonts/0.0.0-0/Noto-Bold?key={Your_API_Key}&apiVersion=1
https://api.tomtom.com/maps/orbis/assets/fonts/0.*/Noto-Bold?key={Your_API_Key}&apiVersion=1
curl 'https://api.tomtom.com/maps/orbis/assets/fonts/0.0.0-0/Noto-Bold?key={Your_API_Key}&apiVersion=1'
curl 'https://api.tomtom.com/maps/orbis/assets/fonts/1.*/Noto-Bold?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.
Required parameters | Description |
---|---|
| The base URL for calling TomTom services. |
| The chosen version of the asset. |
| The name of the font that glyphs are listed for. |
| The API version of the service to call. |
| An API Key valid for the requested service. |
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 "ranges": [3 {4 "name": "string",5 "url": "string"6 }7 ]8}
Response field structure
The following table describes JSON element fields that can appear in a response.
Field | Description |
---|---|
| The range of 256 unicode code points to be fetched. |
| The URL to the glyph range that allows fetching it. |
Example
1{2 "ranges": [3 {4 "name": "0-255",5 "url": "https://api.tomtom.com/maps/orbis/assets/fonts/0.0.0-0/Noto-Bold/0-255.pbf?apiVersion=1&key={api_key}"6 }7 ]8}
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.