Optioned return fields
Unlike the plain returnfields argument, which effectively specifies a list of 'on' switches for the required fields, the optioned return fields are individual arguments (i.e. each preceded by a & ) that take either one of several available options or a (variable) alphanumeric value.
| Name | Argument |
|---|---|
| addlinks | adds links for easier data discovery to the response |
| ca_group_returnfields | selects a set of custom defined group attributes (md_returnfield 'ca_group' must be active, allows comma separated list) |
| ca_par_returnfields | selects a set of custom defined parameter attributes (returnfield 'ca_par' must be active, allows comma separated list) |
| ca_site_returnfields | selects a set of custom defined site attributes (md_returnfield 'ca_site' must be active, allows comma separated list) |
| ca_sta_returnfields | selects a set of custom defined station attributes (returnfield 'ca_sta' must be active, allows comma separated list) |
| ca_ts_returnfields | selects a set of custom defined timeseries attributes (md_returnfield 'ca_ts' must be active, allows comma separated list) |
| crs | select which coordinates should be used for bbox filtering, possible values are 'local' and 'global' default is global |
| csvdiv | overwrite the standard CSV delimiter ( ) with another symbol in CSV requests |
| custattr_md_returnfields | DEPRECATED - use ca_sta_returnfields instead |
| custattr_returnfields | DEPRECATED - use ca_sta_returnfields instead |
| dateformat | the date format that will be returned, see date formats |
| downloadaszip | provides the result as a ZIP file containing a file in the selected format |
| downloadfilename | sets the file name if downloadaszip=true is set or CSV and Excel downloads are requested, default name is generic per request |
| flatten | if true, the list will be flattened to contain one station per station_id, all parameter and the object_type fields will be concatenated per entry default is false |
| forcecontentdisposition | setting this to true advises KiWIS to set a content disposition header for all formats, triggering the browser to offer a download |
| gapdetection | Detects and fills gaps with missings in equidistant timeseries (cannot be used with: last values, ensembles, transformation results, changedSince) Possible values: fillgaps - fills detected gaps between existing values, fillrange - fills the whole requested time range so that there either is a valid value or a missing for each timestamp, markgaps - marks detected gaps between existing values by inserting one missing at the beginning and one missing at the end of each gap |
| getensembletimestampsonly | can only be used if all ts_ids are ensemble timeseries and will return a list of available fore-/hindcast timestamps without values cannot be used for wml2 format |
| hidetsid | sets if timeseries ids should be hidden or shown in the layer default is false DEPRECATED - use returnfields instead |
| includeprivate | set to false to ignore private groups default is true |
| invalidperiod | sets the deviation period between requested and returned timestamp to determine which values will be invalidated, must be used together with 'invalidvalue' can be used like the normal period parameter for other requests |
| invalidvalue | sets the value that will be inserted for invalids, must be used together with 'invalidperiod' any numeric value can be used |
| locationascolumns | setting to true, adds lat/lon fields as column to every value will be ignored for WML2 and ZRXP format |
| maxquality | Maximum quality (0-255), values with higher value (lower quality) will be removed (not applicable for transformation results) |
| md_returnfields | specify exactly which metadata fields should be returned available fields: ts_id, ts_path, ts_name, ts_shortname, station_no, station_id, station_latitude, station_longitude, station_carteasting, station_cartnorthing, station_local_x, station_local_y, station_name, stationparameter_name, stationparameter_no, stationparameter_longname, ts_unitname, ts_unitsymbol, ts_unitname_abs, ts_unitsymbol_abs, parametertype_id, parametertype_name, ts_exchange, ts_precision, station_longname, site_id, site_no, site_name, catchment_id, catchment_no, catchment_name, ensembledate, ensembledispatchinfo, timezone (the timezone of the values), ts_spacing, ts_clientvalue## (client values 1-10), river_name, custom_attributes (deprecated - use ca_sta), ca_site (custom site attributes), ca_sta (custom station attributes), ca_par (custom parameter attributes), ca_ts (custom timeseries attributes) |
| metadata | set metadata=true to add more metadata fields to responses |
| minquality | Minimum quality (0-255), values with lower value (higher quality) will be removed (not applicable for transformation results) |
| optimizechanges | Changes will be optimized, meaning that interconnected changes for equidistant timeseries will be merged by KiWIS at the cost of losing the change_time |
| orderby | sorts the result set by the given field, this can be helpful e.g. for drawing order in a map available fields: value, timestamp, station_name, station_no, group_item_order (only with one group) |
| orderdir | sets the sort direction, only usable together with 'orderby' possible values: asc, desc default is ascending |
| qualitylist | Comma separated list of exact quality codes, values with any other quality will be removed (not applicable for transformation results) |
| renderer | supported values: XYTsRenderer, XYAreaRenderer, XYBarRenderer, XYLineAndShapeRenderer, XYStepAreaRenderer, YIntervalRenderer does not apply for template graphs |
| showemptytimeseries | sets if timeseries without a value should be removed or shown in the layer default is true |
| sincefirstchange | only active for the changedsince filter retrieves all data since the first changed timestamp without gaps |
| timezone | the time zone that will be returned for all timestamps, any time zone string as understood by Java (e.g. GMT+5, UTC, CET) |
| useprecision | advises KiWIS to use the WISKI precision for value formatting, true or false default is true |
| valuelocale | sets the locale in which the values will be formatted default is en for de, csvDiv will automatically be ' ', all json formats will use locale en only applies if useprecision=true |
| valueorder | sets the order in which the values will be returned, asc/ascending or desc/descending default is ascending |
| valuesasstring | advises KiWIS to return timeseries values in JSON as string instead of number, true or false default is false |