The REST API supports automation by enabling systems to obtain structures in the desired format

https://urn.sdmx.io/resolve/[urn]

Path

The URN entry point is https://urn.sdmx.io/resolve/ followed by the URN to resolve.

The URN must be a valid SDMX URN, starting with the URN package name 'urn:sdmx:org.sdmx.infomodel'.

Examples

• Resolving a Codelist

https://urn.sdmx.io/resolve/urn:sdmx:org.sdmx.infomodel.codelist.Codelist=SDMX:CL_FREQ(2.1)

• Resolving a Code within a Codelist

https://urn.sdmx.io/resolve/urn:sdmx:org.sdmx.infomodel.codelist.Code=SDMX:CL_FREQ(2.1).A

• Resolving the latest minor version of a Codelist

https://urn.sdmx.io/resolve/urn:sdmx:org.sdmx.infomodel.codelist.Codelist=ESTAT:CL_ACTIVITY(1.0+.0)

HTTP Methods

The supported HTTP methods are

1. GET an HTTP GET will return the structure if it is found along with a 200 status code. If the structure is not found, or there is an error in the request a different status code will be returned. The status codes section describes what the meaning of each status code that can be returned by the service

2. HEAD an HTTP HEAD request will return the HTTP Response Headers, including status code and Content-Length, no actual content will be returned.

3. OPTIONS an HTTP OPTIONS will return the supported HTTP headers.

HTTP Request Headers

Supported HTTP reqeuest headers include

1. Accept-Encoding: gzip It is recommended to include this request header for performance reasons.

2. Accept The Accept header is used to define the required response format. See formats.

HTTP Response Headers

The following response headers will be included

1. Content-Length the length of the document, in bytes

2. Content-Encoding if gzip is requested, this will be set to gzip

3. Etag a value generated from the checksum of the requested structure. The ETag is used for client side caching.