Documentation for "/api/v1/cmp/lake-eco-ref-ranges":

Documentation score: Route: 100% Fields: 100%

Description:

Provides summary data to TSI tab on report display. Based on sample data from an entire lake, not any particular station.

Search parameters:

One or more of the following search parameters need to be specified in order to retrieve data:
Parameter nameRequiredDescription
ecoregion The ecoregion that the lake is located in or flows through (some streams flow through more than one).
parameter Chlorophyll maximum, Chlorophyll mean, Secchi, Total Phosphorous

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
ecoregion The ecoregion that the lake is located in or flows through (some streams flow through more than one).
parameter Chlorophyll maximum, Chlorophyll mean, Secchi, Total Phosphorous
parameterUnit Unit of measure. Chlorophyll max & min=ug/l; Secchi=meters; Total Phos=ug/l
tsiMax Maximum Trophic State Index score for this ecoregion
tsiMin Minimum Trophic State Index score for this ecoregion

Example Queries: