Difference between revisions of "Data Query Web Service"
| Line 4: | Line 4: | ||
The Data Query web service offers both a RESTful GET API which conforms the SDMX Specification, and a RESTful POST API which supports advanced features such as joining mulitple datasets and selecting lists of series. Both the GET and POST web service support the SDMX standard parameters such as startPeriod and endPeriod, in addition to this, both APIs support advanced parameters to support features such as paging and calculations. | The Data Query web service offers both a RESTful GET API which conforms the SDMX Specification, and a RESTful POST API which supports advanced features such as joining mulitple datasets and selecting lists of series. Both the GET and POST web service support the SDMX standard parameters such as startPeriod and endPeriod, in addition to this, both APIs support advanced parameters to support features such as paging and calculations. | ||
| − | Both REST and POST APIs offer the same [[ | + | Both REST and POST APIs offer the same [[Category:SdmxDataFormat|data formats]] as valid reponse formats, this can be controlled via the '''format''' data query parameter, or by using the HTTP Accept Header. |
= REST GET = | = REST GET = | ||
Revision as of 00:35, 17 September 2020
Overview
The Data Query web service offers both a RESTful GET API which conforms the SDMX Specification, and a RESTful POST API which supports advanced features such as joining mulitple datasets and selecting lists of series. Both the GET and POST web service support the SDMX standard parameters such as startPeriod and endPeriod, in addition to this, both APIs support advanced parameters to support features such as paging and calculations.
Both REST and POST APIs offer the same as valid reponse formats, this can be controlled via the format data query parameter, or by using the HTTP Accept Header.
REST GET
| Entry Point | /ws/public/sdmxapi/rest |
| Access | Public |
| Http Method | GET |
| Compression | gzip supported |
| Response Format | Determined by Accept Header - default SDMX 2.1 Structure Specific Data |
| Response Statuses | 200 - Ok 400 - Bad URL Syntax 500 - Server Error |
HTTP Headers
The Accept Header is used to define the output format, to transform the data to. The supported accept header values are
In addition, the following optional header parameters can be used to provide further details on the incoming dataset. If these details are not provided, the Fusion Registry will interrogate the dataset header to get the information. If the dataset is a non-SDMX format, or does not contain the required information in the header, then an error response will be returned.
| HTTP Header | Purpose | Allowed Values |
|---|---|---|
| Accept | This can be used to define the response format of the data |
A valid Provision Agreement URN |
| DatasetAction | Specifies the action to perform when submitting the dataset. If this value is specified it will override any action specified in the dataset. |
Append, Replace or Delete |
