DigitaleDeltaOrg / dd-api

Specification of the Digital Delta API (version 2 and later)
MIT License
2 stars 0 forks source link

Include optional query parameter 'SourceName' in /locations #24

Open bramhl opened 3 years ago

bramhl commented 3 years ago

The /TimeSeries endpoint supports the optional query parameter 'SourceName' where a user can query all available timeseries for the given datasource.

The /Locations endpoint does not have this optional parameter. If a DD service disseminates 2 datasources and a client wishes to connect to one datasource there is no way to determine which locations belong to this source without interpeting the responses from the /TimeSeries endpoint.

A /Locations request for a DD service with 2 data sources (Knmi.Synops and Fews.Hhrl) without paging returns locations for both sources:

image

A /Locations request with optional query parameter 'SourceName' included for the same DD service. This results in the locations that are linked to the datasource 'Knmi.Synops' instead of locations for all available datsources:

image

stefhummel commented 3 years ago

Na team-discussie DD-werkgroep: In versie 2.1 specificeren als optionele generieke filtering parameter, en optioneel implementeren. Zie ook comment in issue #25.

stefhummel commented 3 years ago

Opmerking: Van oorsprong is voor het onderkennen van bronnen de 'node' toegevoegd. Weliswaar is in dit geval Hydronet de node, maar laten we toch even goed checken of 'source' en 'node' elkaar hier niet gaan overlappen qua filtering rol.