| Table of Contents |
|---|
The DissChain WDDS Translator API Statistics is a web service that translates a legacy WDDS 2.1 REST into a request sent to the RENOV API where the order of the parameters is agnostic. It means that these parameters for data query where parameters don’t have to respect a specific order .
The RENOV API returns a file as an attachment (data and metadata from a single dataset) in JSON-Stat 2.0 format to the WDDS Translator. The latter returns the content of the file as a JSON response without any content transformation to the requester.
opposed to API SDMX 2.1.
This The Web Service:
provides data in JSON-stat 2.0 format;
supports only REpresentation State Transfer (REST) protocol;
delivers responses in English, French and German.
| Info |
|---|
WDDS Translator replaces the legacy WDDS 2.1 web service allowing a smooth transition of the Estat.B4 visualisation applications. At the end, WDDS Translator’s features will be integrated into the new RENOV API endpoint and be transparently replaced by it. |
or German.
The structure of the REST request
...
URL part | Example | Comment |
|---|---|---|
Fixed part | ||
{host_url}/ | Fixed part of the request related to our website | |
{service}/ | statistics/ | Fixed part of the request related to the service |
{version}/ | 1.0/ | Fixed part of the request related to the version of the service |
Dynamic part | ||
{response_type}/ | data/ | Only statistical data are currently returned |
{datasetCode} | t2020nama_10_gdp | Unique code identifier of the queried data product (either a dataset or a predefined extraction) |
?{format} | ?format=JSON | Optional parameter |
&{lang} | &lang=EN | Optional parameter |
&{filters} | &time=2019 | Optional parameters |
...
Both "time" and "time_period" parameters are accepted in the URL. Both address the TIME_PERIOD dimension.
Defined Below are other Time parameters that can be used:
...
Fault Code | HTTP Status | Description | |||
|---|---|---|---|---|---|
Client Errors | |||||
100 No results found | 400 Bad request | The result from the query is empty. | |||
100 No results found | 404 Not Found | The requested resource is not available. | 110 Unauthorized | 401 Unauthorized | For use when authentication is needed but has failed or has not yet been provided. ECAS errors can be:
|
140 Syntax error | 400 Bad request | The query is invalid.140 Syntax error | 404 Not Found | The requested resource is not part of the supported methods. Unsupported resources:
| |
150 Semantic error | 400 Bad request | The request is syntactically correct but fails a semantic validation, business rules. | |||
Server errors | |||||
500 Internal Server error | 401 Unauthorized | The requested resource exist but is currently not available. | 500 Internal Server error500 Internal server error | The webservice should return this error code when none of the othererror other error codes better describes the reason for the failure of the serviceto service to provide a meaningful response. Also used in case of request not respecting the xsd definition. |
Asynchronous response in case of big extractions
When receiving a request from the WDDS Translator, API can determine if the response can be made synchronously or asynchronously.
In case of an asynchronous response, WDDS Translator API will return the following JSON response:
| Code Block |
|---|
{"warning":{"status":413, "label":"ASYNCHRONOUS_RESPONSE. Your request will be treated asynchronously. Please try again later."}} |
| Info |
|---|
WDDS API Statistics will not notify the user when the file is ready, the request must be made again to check its status. |