Smart Layer Tile Service
Request accessA Smart Layer Tile Service delivers one kind of NDS.Live content, such as a road model package, as smart layer tiles. Your map data component discovers the services it can use through the NDS.Live Registry, then calls the methods in this section on each one.
Run the methods
Each service describes itself in an OpenAPI file at https://{serviceURL}/openapi.json.
Common request details
All methods share the same request and response patterns, including what your map data component should do with each HTTP status code.
- Authentication: add your My.TomTom API key as the
apiKeyquery parameter. - Encoding: request and response bodies are zserio-encoded binary, not JSON, with the media type
application/x-zserio-object. Use the NDS.Live SDK, the Smart Layer Client or MapViewer to read them. - Conditional requests: methods that support them accept
If-None-Matchand return304when nothing changed. TheETagrequest header is deprecated.
Methods
Call every method with an HTTP POST request, including methods that only return data: in the NDS.Live services, the HTTP method doesn’t tell what a request does.
TomTom’s Smart Layer Tile Service implements these 11 methods. The NDS.Live standard also defines list variants, such as getLayerByTileIdList. TomTom’s service doesn’t offer them, and its capabilities don’t set their flags.
| Method | Returns |
|---|---|
getLayerByTileId | The full smart layer tile |
getHeaderOnlyByTileId | The tile header only |
getDeltaLayerByTileId | Only the changed layers |
getSingleDataLayerByTileId | One layer of one tile |
getServiceDefinition | The layers the service contains |
getServiceModuleDefinition | The service’s module definition |
getServiceNodeLegalInfo | Legal and attribution metadata |
getServiceNodeSystemReference | The service node’s system reference |
getTileServiceCapabilities | The methods the service implements |
getSpatialExtent | The area the service covers |
getRegistryMetadata | The service’s registry metadata |
Common HTTP status codes
The most common codes are below. Request and response patterns lists all of them, with what your map data component should do.
| Code | Meaning |
|---|---|
204 | No data for this tile at this level. It isn’t an error: cache the empty result and don’t retry. |
302, 303 | The resource is at the URL in the Location response header. Follow it right away, and don’t cache it or write it to logs. |
304 | Not modified since the version in If-None-Match. |
404 | Not found. For a tile outside the coverage area, this is a final answer: don’t retry. |
410 | The service is decommissioned. Discard the data you cached from it, and ask the NDS.Live Registry for another service. |
Related resources
- Request and response patterns
- Request and response patterns: HTTP status codes
- Request and response patterns: Authentication
getTileServiceCapabilitiesgetLayerByTileIdgetHeaderOnlyByTileIdgetDeltaLayerByTileIdgetSingleDataLayerByTileIdgetServiceDefinitiongetServiceModuleDefinitiongetServiceNodeLegalInfogetServiceNodeSystemReferencegetSpatialExtentgetRegistryMetadata- OpenAPI Generator
- pack.nds.live