getRegistryMetadata

Last edit: 2026.11.04

Returns the registry metadata of the service: how the service describes itself to the NDS.Live Registry. It sums up in one response what the service offers: its layers, the tile levels it serves, the methods it implements, and the content it covers.

Request data

HTTP method: `POST`

URL request format

1
https://{serviceURL}/getRegistryMetadata?apiKey={Your_API_Key}

serviceURL is your Smart Layer Tile Service endpoint, without /openapi.json.
Your_API_Key is a My.TomTom API key with NDS.Live services enabled.

Request body

This method takes no request body.

Response data

Response body

On success, the body is a zserio-encoded SmartLayerRegistryMetadata object:

Field	Description
`smartLayerType`	The type of smart layer service, for example `SMART_LAYER_TILE` for a Smart Layer Tile Service.
`dataContents`	The content that applies to all layers of the service: the geopolitical view, the road types covered and the vehicle specifications the data is valid for.
`layerDescriptors`	The layers of the service. For each layer: the module, the module version, the minimum module version your map data component needs to parse the data, and the zserio type.
`capabilities`	The methods the service implements, as the same bitmask that `getTileServiceCapabilities` returns.
`supportedLevels`	The tile levels the service serves. TomTom can change them, so read them from this field and request tiles only at these levels.
`smartLayerDefinition`	Optional. The full layer definitions, as returned by `getServiceDefinition`.

For example, the ADAS Road Model evaluation service returns these values:

Geopolitical view: XXX, the same code as at the start of the last segment of the endpoint URL.
Supported levels: level 13 only.
Layers: 10 layers.
Capabilities: 1093, the same value as getTileServiceCapabilities returns.
Layer definitions: not included. Call getServiceDefinition to get them.

HTTP response headers

TomTom’s service answers with 200 directly, without a redirect, and the response has no ETag. The service ignores If-None-Match, so conditional requests don’t work for this method, although its OpenAPI description lists them. To keep the registry metadata current, request it again from time to time.

HTTP status codes

Besides the codes below, any method can return the common errors, for example 401 for a missing API key.

Code	Meaning
`200`	OK. The response body holds the `SmartLayerRegistryMetadata`.
`404`	Not found.
`410`	Gone. The Smart Layer Tile Service is decommissioned. Ask the NDS.Live Registry for another service.
`500`	Internal server error.