Home | Groundwater | /api/v1/groundwater/monitoring-stations

Documentation for "/api/v1/groundwater/monitoring-stations":

Documentation score: Route: 100% Fields: 100%

Description:

Groundwater monitoring station data.

Search parameters:

One or more of the following search parameters need to be specified in order to retrieve data:

Parameter name	Required	Description
analyteGroupCode		The analyte group to search stations results for. (Ref:/api/doc/v1/groundwater/analyte-groups)
dataAfter		Only select stations that have data after this date (in "yyyy-mm-dd" or "dd-mon-yyyy" format).
siteId		The query id for the site that the station is associated with.
specificGeoAreaCode		The specific geographical area to search in. (Ref:/api/doc/v1/groundwater/geographic-areas)
stationId		The unique id for a monitoring station
stationName		The name of the station.
stationPurpose		The purpose for the station. (Ref:/api/doc/v1/groundwater/monitoring-stations/purposes)
stationType		The type of station. (Ref:/api/doc/v1/groundwater/monitoring-stations/types)

Additional parameters:

The following, optional, parameters may be specified:

Parameter name	Description
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 name	Description
countyList	The list of counties that are spatially associated with the station.
ctuList	The list of cities/towns/un-incorporated areas that are spatially associated with the station.
cwiUrl	For stations that have a county well index, the URL for the county well index page.
endYear	The latest year that sampling was performed.
lat	The latitude of the station (in decimal degrees).
latLongDatum	The datum for the lat/long.
long	The longitude of the station (in decimal degrees).
resultCount	The number of sampling results for the station.
sampleCount	The number of sampling events for the station.
siteList	The list of sites that are associated with the station.
startYear	The earliest year that sampling was performed.
stationId	The unique id for a monitoring station
stationName	The name of the station.
stationPurpose	The purpose for the station.
stationType	The type of station.

Example Queries: