Difference between revisions of "Data Availability Web Service"
(→Availability of EUR exchange rate data for Danish Krone (from ECB EXR) |
(→Overview) |
||
| Line 1: | Line 1: | ||
=Overview= | =Overview= | ||
| + | The Data Availability API is the RESTful web service accessed via the 'availableconstraint' resource. | ||
| + | |||
| + | The API is provided to enable external services to determine what data is available for a Dataflow, based on a current data query selection state, without having to retrieve the full dataset. The main use case is to offer an easy and efficient way for clients of the web service to build a data query form based on the available dimension values. | ||
=Examples= | =Examples= | ||
Revision as of 07:32, 15 September 2020
Contents
Overview
The Data Availability API is the RESTful web service accessed via the 'availableconstraint' resource.
The API is provided to enable external services to determine what data is available for a Dataflow, based on a current data query selection state, without having to retrieve the full dataset. The main use case is to offer an easy and efficient way for clients of the web service to build a data query form based on the available dimension values.
Examples
Availability of EUR exchange rate data for Danish Krone (from ECB EXR)
The response is a content constraint which describes the values for each dimension that have data, given that CURRENCY is fixed to DKK in the query. In particular it shows there are series for frequencies A, Q, D, H and M. There’s also a ‘series_count’ annotation which tells us the query would return 8 series if run.
Availability of EUR exchange rate data for the Egyptian Pound (ECB EXR again)
The same query as above, but this time querying for EUR vs EGP exchange rates. Here only series with frequencies A, Q and M are available. And the ‘series_count’ annotation tells us we would get 3 series.
