Make a request to the /structures/divrec/waterclasses endpoint to identify water classes via a spatial search or by division, county, water_district, GNIS, or WDID.
Usage
get_water_classes(
wdid = NULL,
county = NULL,
division = NULL,
water_district = NULL,
wc_identifier = NULL,
aoi = NULL,
radius = NULL,
gnis_id = NULL,
start_date = NULL,
end_date = NULL,
divrectype = NULL,
ciu_code = NULL,
timestep = NULL,
api_key = NULL
)Arguments
- wdid
character vector or list of characters indicating WDID code of structure
- county
character, county to query
- division
numeric, water division to query
- water_district
numeric, water district to query
- wc_identifier
character, series of water class codes that provide the location of the diversion, the SOURCE of water, the USE of the water and the administrative operation required to make the diversion. The Water Class, combined with a daily, monthly or annual volume, constitutes a Diversion Record.
- aoi
list of length 2 containing an XY coordinate pair, 2 column matrix/dataframe of XY coordinates, sf or Terra SpatVector point/polygon/linestring geometry
- radius
numeric, search radius in miles around given point (or the centroid of a polygon). If an AOI is given, radius defaults to 20 miles. If no AOI is given, then default is NULL.
- gnis_id
character, water source - Geographic Name Information System ID
- start_date
character date of first measurement in the well’s period of record (YYYY-MM-DD). Default is NULL.
- end_date
character date of last measurement in the well’s period of record (YYYY-MM-DD). Default is NULL.
- divrectype
character, type of record: "DivComment", "DivTotal", "RelComment", "RelTolal", "StageVolume", or "WaterClass".
- ciu_code
character, current in use code of structure
- timestep
character, timestep, one of "day", "month", "year"
- api_key
character, API authorization token, optional. If more than maximum number of requests per day is desired, an API key can be obtained from CDSS. Defaults to NULL.