{"source":"nve","operation":"find_hydro_stations","description":"Find NVE hydrological measuring stations by name/area filters and/or\nnear a coordinate, and see which time series (parameters + resolutions)\neach one offers.","parameters":[{"name":"name","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":false,"default":null,"description":"Partial station name, e.g. \"Gaula\" (case-insensitive)."},{"name":"county","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":false,"default":null,"description":"County name, e.g. \"Tr\u00f8ndelag\"."},{"name":"municipality","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":false,"default":null,"description":"Municipality (kommune) name, e.g. \"Lier\"."},{"name":"active","schema":{"type":"boolean"},"required":false,"default":true,"description":"True (default) for currently operating stations only."},{"name":"lat","schema":{"anyOf":[{"type":"number"},{"type":"null"}]},"required":false,"default":null,"description":"WGS84 point for a spatial search. Give both to get only stations within radius_km, sorted nearest first with a distance_km field on each. Combines with the other filters."},{"name":"lon","schema":{"anyOf":[{"type":"number"},{"type":"null"}]},"required":false,"default":null,"description":"WGS84 point for a spatial search. Give both to get only stations within radius_km, sorted nearest first with a distance_km field on each. Combines with the other filters."},{"name":"radius_km","schema":{"type":"number"},"required":false,"default":50,"description":"Spatial search radius in km (default 50). Only used with lat/lon."},{"name":"limit","type":"integer","schema":{"type":"integer","minimum":1,"maximum":100,"default":25},"display_type":"integer","required":false,"default":25,"description":"Maximum list items returned by the gateway (default 25, maximum 100)."},{"name":"offset","type":"integer","schema":{"type":"integer","minimum":0,"default":0},"display_type":"integer","required":false,"default":0,"description":"Number of list items to skip before returning the page."}],"json_get_url_template":"https://allemannsdata.com/wiki/api/v1/kilder/nve/find_hydro_stations?name={name}&county={county}&municipality={municipality}&active=true&lat={lat}&lon={lon}&radius_km=50&limit=25&offset=0","schema_scope":"#/data in the successful operation envelope","response_schema":{"type":"object","properties":{"count":{"type":"integer"},"returned":{"type":["integer","null"]},"stations":{"anyOf":[{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."},{"type":"object","properties":{"station_id":{"type":["string","null"]},"station_name":{"type":["string","null"]},"river":{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."},"municipality":{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."},"county":{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."},"latitude":{"type":["number","null"]},"longitude":{"type":["number","null"]},"masl":{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."},"series":{"type":"array","items":{"type":"object","properties":{"parameter":{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."},"name":{"type":["string","null"]},"unit":{"type":["string","null"]},"from":{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."},"to":{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."},"resolutions":{"type":"array","items":{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."}}},"additionalProperties":false}},"distance_km":{"type":"number"}},"additionalProperties":false},{"type":"object","properties":{"station_id":{"type":["string","null"]},"station_name":{"type":["string","null"]},"river":{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."},"municipality":{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."},"county":{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."},"latitude":{"type":["number","null"]},"longitude":{"type":["number","null"]},"masl":{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."},"series":{"type":"array","items":{"type":"object","properties":{"parameter":{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."},"name":{"type":["string","null"]},"unit":{"type":["string","null"]},"from":{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."},"to":{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."},"resolutions":{"type":"array","items":{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."}}},"additionalProperties":false}}},"additionalProperties":false}]},"note":{"type":"string"}},"additionalProperties":false},"response_schema_status":{"status":"incomplete","codegen_safe":false,"description":"Not suitable for typed model generation: the container shape and field names are useful, but unresolved values accept any JSON value."},"entity_projection":{"status":"projected","entity_types":["hydrology_station","place"],"description":"Recognized records and stable operation identifiers are projected; an empty array means the successful payload contained no recognizable entity."},"error_contract":{"scope":"top-level HTTP error response; never part of a success payload","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object"}},"additionalProperties":false,"required":["code","message","retryable"]},"suggestion":{"type":"string"},"_meta":{"type":"object","properties":{"retrieved_at":{"type":"string","format":"date-time"},"language":{"type":"string","const":"en"},"content_languages":{"type":"array","items":{"type":"string"}},"sources":{"type":"array","items":{"type":"object"}}},"required":["retrieved_at","language","content_languages","sources"]},"_links":{"type":"object","properties":{"self":{"type":"string","format":"uri"},"api_index":{"type":"string","format":"uri"}},"required":["self","api_index"],"additionalProperties":false}},"additionalProperties":false,"required":["error","suggestion","_meta","_links"]},"statuses":{"400":{"codes":["MISSING_PARAMETER","INVALID_PARAMETER","INVALID_REQUEST"],"retryable":false},"404":{"codes":["SOURCE_NOT_FOUND","OPERATION_NOT_FOUND","ENTITY_NOT_FOUND"],"retryable":false},"429":{"codes":["RATE_LIMITED","GATEWAY_RATE_LIMITED"],"retryable":true},"502":{"codes":["SOURCE_UNAVAILABLE"],"retryable":true},"500":{"codes":["INTERNAL_ERROR"],"retryable":true}}},"_links":{"self":"https://allemannsdata.com/wiki/api/v1/kilder/nve/find_hydro_stations/schema","operation":"https://allemannsdata.com/wiki/api/v1/kilder/nve/find_hydro_stations","source":"https://allemannsdata.com/wiki/api/v1/kilder/nve"},"output_fields":["count","returned","stations","stations.station_id","stations.station_name","stations.river","stations.municipality","stations.county","stations.latitude","stations.longitude","stations.masl","stations.series","stations.series[].parameter","stations.series[].name","stations.series[].unit","stations.series[].from","stations.series[].to","stations.series[].resolutions","stations.distance_km","note"],"output_fields_truncated":false,"canonical_field_aliases":{"latitude":["stations.latitude"],"longitude":["stations.longitude"],"name":["stations.series[].name"]}}