getServiceModuleDefinition

Last edit: 2026.11.04

Returns the module definition of the service itself, not of its content. Use it to check that your map data component can read the tiles of the service.

Request data

HTTP method: `POST`

URL request format

1
https://{serviceURL}/getServiceModuleDefinition?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.

HTTP request headers

This method needs no request headers.

Response data

Response body

On success, the body is a zserio-encoded ModuleDefinition object. It describes the Smart Layer module that the service implements:

Field	Description	Example
`name`	The name of the module.	`SMART`
`version`	The version of the module that the service implements.	`2026.06`
`minVersion`	The minimum version of the module that your map data component needs to parse the service’s responses.	`2024.09`

Check that the zserio code your map data component uses to decode responses was generated from a version of the Smart Layer module that is at least minVersion. Each layer also has its own minVersion, which getServiceDefinition lists. The registry response holds the same values, so your map data component can check them before it calls the service. Your map data component checks both as modules get new versions.

HTTP response headers

This method doesn’t return an ETag, so it doesn’t support conditional requests.

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 `ModuleDefinition`.
`410`	Gone. The Smart Layer Tile Service is decommissioned. Ask the NDS.Live Registry for another service.
`500`	Internal server error.