Documentation for "/api/v1/surfacewater/monitoring-stations/results":

Documentation score: Route: 100% Fields: 100%

Description:

Monitoring results for stations.

Search parameters:

One or more of the following search parameters need to be specified in order to retrieve data:
Parameter nameRequiredDescription
dataAfter Stations that have data after this date (in "yyyy-mm-dd" or "dd-mon-yyyy" format).
huc8 The 8-digit hydrological unit code.
specificGeoAreaCode The specific geographical area to search in. (Ref:/api/doc/v1/surfacewater/geographic-areas)
stationContractName Stations may be tied to a project/contract. (Ref:/api/doc/v1/surfacewater/monitoring-stations/contracts)
stationId The unique ID of the monitoring station where the sample was taken.
stationType The type of monitoring station. (Ref:/api/doc/v1/surfacewater/monitoring-stations/types)
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).

Result Set Definitions:

Field nameDescription
analysisDate The date that the sample was analyzed. Most often defaulted to 1/1/1901 for lab samples and to the sample collection data for field samples.
collectingOrg Organization collecting the data, low accuracy.
comments EQuIS staff can add in a comment about the organization/project. Usually specific to staffing changes.
county The county that the monitoring station is located in.
gtlt Greater than or less than.
parameter Water quality constituent that is being reported.
result Value measured or observed.
resultUnit Units of measure for the result.
sampleDate The date that the sample was taken.
sampleTime The time that the sample was taken.
labNameCode The name code of the lab which processed the sample.
labCompanyName The company name of the lab which processed the sample.
sampleDepthUnit Unit of measure for the depth of the sample.
sampleFractionType Partioning of the sample; total, dissolved, etc.
sampleLowerDepth For Lakes - integrated samples have an upper and lower depth because the collection method covers multiple depths.
sampleType How the sample was collected - grab sample, integrated sample, composite sample, etc.
sampleUpperDepth For Lakes - integrated samples have an upper and lower depth because the collection method covers multiple depths.
stationId The unique ID of the monitoring station where the sample was taken.
stationName The name of the station.
statisticType Most commonly used are Minumum and Maximum.
testMethodId ID for an analytical method.
testMethodName Name for an analytical method.

Example Queries: