Difference between revisions of "Query Structures Web Service"
| Line 52: | Line 52: | ||
Accept-Language : all (all languages – no filter)<br> | Accept-Language : all (all languages – no filter)<br> | ||
|} | |} | ||
| + | |||
| + | =Parameters= | ||
| + | The following parameters are used for identifying resources: | ||
| + | |||
| + | {| class="wikitable" | ||
| + | ! Parameter !! Type !! Description | ||
| + | |- | ||
| + | | agencyID | ||
| + | | A string compliant with the SDMX ''common:NCNameIDType'' | ||
| + | | The agency maintaining the artefact to be returned. It is possible to set more than one agency, using <code>+</code> as separator (e.g. BIS+ECB). | ||
| + | |- | ||
| + | | resourceID | ||
| + | | A string compliant with the SDMX ''common:IDType'' | ||
| + | | The id of the artefact to be returned. It is possible to set more than one id, using <code>+</code> as separator (e.g. CL_FREQ+CL_CONF_STATUS). | ||
| + | |- | ||
| + | | version | ||
| + | | A string compliant with the SDMX ''common:VersionType'' | ||
| + | | The version of the artefact to be returned. It is possible to set more than one version, using <code>+</code> as separator (e.g. 1.0+2.1). | ||
| + | |} | ||
| + | |||
| + | The parameters mentioned above are specified using the following syntax: | ||
| + | |||
| + | <pre>protocol://ws-entry-point/resource/agencyID/resourceID/version</pre> | ||
Revision as of 13:47, 20 January 2021
Overview
Fusion Metadata Registry provides a web service for querying structural metadata which conforms to the SDMX specification.
Some additional Accept header values and query parameters are also supported both of which are explained in this guide.
| Entry Point | /ws/public/sdmxapi/rest/ |
| Access | Secure Public |
| Authentication | None |
| Http Method | GET |
| Response Format | Multiple SDMX formats supported which can be specified wither using the HTTP Accept header or the 'format' URL parameter |
| Response Statuses | 200 - Success 404 - Structure not found 500 - Server Error |
| Error Response | SDMX-ML 2.1 Error Response Document |
Headers
| HTTP Header | Purpose | Allowed Values |
|---|---|---|
| Accept | To define the response format |
|
| Accept-Language |
This optional header can be used to set the locale to return any multilingual text in (names and descriptions). If the text does not exist in the specified locale, then the default rules will be applied to find the next best appropriate locale. |
Examples: |
Parameters
The following parameters are used for identifying resources:
| Parameter | Type | Description |
|---|---|---|
| agencyID | A string compliant with the SDMX common:NCNameIDType | The agency maintaining the artefact to be returned. It is possible to set more than one agency, using + as separator (e.g. BIS+ECB).
|
| resourceID | A string compliant with the SDMX common:IDType | The id of the artefact to be returned. It is possible to set more than one id, using + as separator (e.g. CL_FREQ+CL_CONF_STATUS).
|
| version | A string compliant with the SDMX common:VersionType | The version of the artefact to be returned. It is possible to set more than one version, using + as separator (e.g. 1.0+2.1).
|
The parameters mentioned above are specified using the following syntax:
protocol://ws-entry-point/resource/agencyID/resourceID/version
