European Commission logo
Englishen

INSPIRE registry

API Documentation

The content of the registry is available in different formats and languages.

All the resources available in the registry can be accessed in a number of formats listed below.

If you want to get the resource in a particular format or language you can:

  • Use the language selector in the web interface;
  • Directly call the resources using its name.

Direct call

If you want to directly call the resources using its name you have to follow the naming convention explained in the example below:

http://{base_uri}/{register_uriname}/{register_uriname}.{language_code}.{format}
http://{base_uri}/{register_uriname}/{itemclass}/{itemclass}.{language_code}.{format}
http://{base_uri}/{register_uriname}/{collection_uriname}/{item_uriname}/{item_uriname}.{language_code}.{format}

You can find the specific "language_code" and "format" in the list above (the codes are highlighted in bold).

Examples

How to call the APIs

Each above links is calling the API in the following way:

http://{base_uri}/{register_uriname}/rest?uri=https://{base_uri}/{register_uriname}&format={format}&lang={language_code}
http://{base_uri}/{register_uriname}/rest?uri=https://{base_uri}/{itemclass}.&format={format}&lang={language_code}
http://{base_uri}/{register_uriname}/rest?uri=https://{base_uri}/{itemclass_collection}/{collection_uriname}/{item_uriname}&format={format}&lang={language_code}

Let's consider the example above:

_registryApp_domainURL_/codelist/AgeBy5YearsValue/15-20/15-20.sl.xml

this is calling the API in following way:

_registryApp_domainURL_/registry/rest?uri=_registryApp_domainURL_/codelist/AgeBy5YearsValue/15-20&format=xml&lang=sl