Documentation for "/api/v1/surfacewater/water-units":

Documentation score: Route: 100% Fields: 100%

Description:

Search for lakes, stream segments, or other surface water "units".

Search parameters:

One or more of the following search parameters need to be specified in order to retrieve data:
Parameter nameRequiredDescription
auid The assessment unit ID for water units that have been assessed.
hasAssessments Whether or not any water quality assessments have been performed on the water unit {'Y', 'N'}.
huc8 The 8-digit hydrological unit code for the water unit.
specificGeoAreaCode The specific geographical area to search in. (Ref:/api/doc/v1/surfacewater/geographic-areas)
wid The ID for the water unit.
wuDisplayName The "display" name of the water unit.
wuSearchString The name of the water unit and/or county, city, township to search for.
wuType The water unit type {'Stream', 'Lake', 'Wetland'}. (Ref:/api/doc/v1/surfacewater/water-units/types)

Additional parameters:

The following, optional, parameters may be specified:
Parameter nameDescription
format The desired return format. Valid formats are: {json, jsonp, text, csv, xls, ods, and tab}. The default is json.
callback The JSONP callback function name (Note that format needs to be "jsonp").
fields The comma-separated-list of the field names to return from the query. The default is to return all available fields.
nullValue Value to substitute in place of null values. The default is to return null values as "null" (per JSON.org).
limit The number of records to limit the result set to. Behaves like the SQL standard LIMIT clause.
offset Used with Limit-- the record number to start retrieving from. Behaves like the SQL standard OFFSET clause.

Result Set Definitions:

Field nameDescription
countyList The list of counties that are spatially associated with the water unit.
ctuList The list of cities/towns/un-incorporated areas that are spatially associated with the water unit.
downstreamWid (stream water units) The ID of the stream segment immediately downstream from this one. NOTE: MPCA may not have assessed that downstream segment.
ecoregionName The ecoregion that the water unit is lLocated in or flows thru. (some streams flow thru more than one)
formerWidList Former ID: MPCA sometimes splits an water unit into two or more segments. Less often, two or more units are merged into one for future assessments. The Former ID is the MPCA ID this water unit had before the most recent split or merge involving it. Old numbers with an "-RF1" extension were simply replaced with a new number, usually without a split or merge involved.
hasAssessments Whether or not any water quality assessments have been performed on the water unit {'Y', 'N'}.
hasMonDataGraph Has monthly data graph.
huc8 The 8-digit hydrological unit code for the water unit.
lakeAltName (lake water units) The alternate name for the lake.
lakeAreaAcres (lake water units) The surface area of the lake (in acres).
lakeCriteriaType (lake water units) The category of water quality standards applicable to this lake: Lake; Shallow Lake or Reservoir; or Wetland.
lakeDepthMaxFt (lake water units) The maximum depth of the lake (in feet).
lat The latitude of the midpoint of the waterbody.
long The longitude of the midpoint of the waterbody.
retiredDate Retired date: The MPCA sometimes splits a water unit into two or more segments, or merges water units, which results in the "old" water unit being retired.
streamSegmentLength (stream water units) The length of the stream segment (in miles).
watershedName The name of the major watershed that the water unit is located in.
wid The ID for the water unit.
wuDisplayName The "display" name of the water unit.
wuLocation The water unit location. For streams, a from-to descriptor. For lakes, a nearby municipality.
wuSpecialDesignation Special Designation: Minnesota law mandates special protections for certain very-high-quality waters (Minn. Rules 7050.0180).
wuType The water unit type {'Stream', 'Lake', 'Wetland'}.
wuUseClassification Indicates the applicable water quality standards for assessment .
wuUseClassificationCode Code(s) to indicate the applicable water quality standards for assessment .

Example Queries: