Documentation for "/api/v1/surfacewater/cmp/sites":

Documentation score: Route: 100% Fields: 84%

Description:

Citizens Monitoring Project (CMP) monitoring sites.

Search parameters:

One or more of the following search parameters need to be specified in order to retrieve data:
Parameter nameRequiredDescription
cmpStationId Unique station ID for Citizen Monitoring Program.
cmpStationName The name of monitoring station.
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.
wuSearchString The name of the water unit to search for.
wuType The water unit type (lake, stream, etc.) (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
cmpStationId Unique station ID for Citizen Monitoring Program.
cmpStationName The name of monitoring station.
county The county that the monitoring station is located in.
huc8 The 8-digit hydrological unit code for the water unit.
latestMonitoringYear TODO
locationType Lake station, whole lake for trend analysis, or stream station.
monitoringYear Last year this station was monitored
trendId TODO
wid The ID for the water unit.
wuDisplayName The "display" name of the water unit-- a combination of Waterbody name and location description. For streams, a from-to descriptor. For lakes, a nearby municipality one org uses the same location.
wuType The water unit type (lake, stream, etc.)

Example Queries: