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

Documentation score: Route: 100% Fields: 85%

Description:

Trophic Status Index (TSI) for a water unit.

Search parameters:

One or more of the following search parameters need to be specified in order to retrieve data:
Parameter nameRequiredDescription
wid Yes The ID for the water unit.

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
chlCount Chlorophyll-a, number of samples
chlMean The June to September 10 year average for chlorophyll-a concentration (parts per billion).
chlTsc Chlorophyll-a, TSI
ecoChlMax Chlorophyll-a, expected maximum TSI for the eco-region
ecoChlMin Chlorophyll-a, expected minimum TSI for the eco-region
ecoTpMax Total Phosphorus, expected maximum TSI for the eco-region
ecoTpMin Total Phosphorus, expected minimum TSI for the eco-region
ecoTranspMax Transparency, expected maximum TSI for the eco-region
ecoTranspMin Transparency, expected minimum TSI for the eco-region
ecoregion The eco-region that the water unit is located in. TODO: how does this correspond to the eco-region in the water_unit query
endYear End year of the data collection.
overallTsi Overall TSI (average of tpTsi, chlTsc, and transpTsi)
startYear Start year of the data collection.
tpCount Total Phosphorus, number of samples
tpMean The June to September 10 year average for total phosphorus concentration (parts per billion)
tpTsi Total Phosphorus, TSI
transpCount Transparency, number of samples
transpMean The June to September 10 year average for Secchi depth transparency (meters)
transpTsi Transparency, TSI
wid The ID for the water unit.

Example Queries: