This service allows to download Hydroweb data in format ASCII, JSON or CSV.
It is necessary to first manually download one product in order to sign the licence agreement (see section 7.1).
The authenticated data access service is available through the followinf URL:
https://hydroweb.theia-land.fr/hydroweb/authdownload
The character « ? » will be added to this URL followed by one or several parameters.
One of the 2 following parameters is mandatory:
products: products to download.
The request will return a single data file (if only one product is requested) or a ZIP file including
all the data relative to the requested products (1 file per product).
The parameter products will be:
the comma-separated list of the products references
lakes, lakes_operational or lakes_research: download data of all operational lakes, research lakes or both
rivers, rivers_operational or rivers_research: download data of all operational virtual stations, research virtual stations or both
list: provides the list of available products for downloading in CSV format. The parameter list will be:
all: full list
lakes, lakes_operational or lakes_research: list of the operational lakes, research lakes or both
rivers, rivers_operational or rivers_research: list of the operational virtual stations, research virtual stations or both
If the parameter list is set, the service authdownload is working without authentication.
If the parameter products is set, the service will respond only if the user is already authenticated using the Hydroweb site by clicking on the "Sign in" button OR by entering his login/password directly in the URL:
https://hydroweb.theia-land.fr/hydroweb/authdownload?products=[...]&user=[...]&pwd=[...]
Otherwise, an error message HTTP 500 will be displayed.
Moreover, the user shall have signed the Theia license, which is generally done during the first download of a product on the website.
The following parameters are optional:
sdate = begin date (in format YYYY-MM-DD)
edate = end date (in format YYYY-MM-DD)
user = user login (email address). This parameter is not mandatory if the user is already authenticated through the website. In that case, the service authdownload will retrieve the active session of that user when sending the request.
pwd = user password
format = data files format: txt (ASCII format, it is the most common format used in Hydroweb) or csv or json, default is txt.
validation = validation criteria: expert, automatic or insitu
updated = date of last update (format YYYY-MM-DD)
Examples:
Get the list of the available river data of type "research":
https://hydroweb.theia-land.fr/hydroweb/authdownload?list=rivers_research
Download the virtual station R_GARONNE_GARONNE_KM0001 in CSV format using Theia identifiers (XXX/YYY)
https://hydroweb.theia-land.fr/hydroweb/authdownload?products=R_GARONNE_GARONNE_KM0001&format=CSV&user=XXX&pwd=YYY
Download (while being authenticated) all the operational lake data in JSON format of the year 2015
https://hydroweb.theia-land.fr/hydroweb/authdownload?products=lakes_operational&format=json&sdate=2015-01-01&edate=2015-12-31&user=xxx&pwd=xxx