Form Variables List

This page outlines all possible filters by name:value, such that scripts or other software programs could be written to automate the retrieval of the data through the web service.


Variable Name Variable Options Explanation
format (Required) Select one of the following:
csv
Comma Separated Values
xml
eXtensible Markup Language
json
JavaScript Object Notation
 E.g. format=json, format=xml, format=csv
units (Required) Select one of the following:
gallons
 
barrels
 
kgallons
 
mgallons
 
acre feet
(Default)
 If not specified, the default value is: units=acre feet
sys-status Select one or more of the following in a comma separated list:
A
Active systems
I
Inactive systems
all
(Default)
Select sys-status=A to return search results with system status active.
Select sys-status=I to return search results with system status inactive.
Select sys-status=A,I or sys-status=all to include both.
output Select one of the following:
all
 
custom
(Default)
 Specifying output=all will return all data for the system type(s) and their sources in the format you selected.
Example:

Variable Name Variable Options Explanation
pws-filter You may select one of the following:
all
(Default) All Public Water Supplier systems are included
none
No Public Water Supplier systems are included
Or one or more of the following in a comma separated list:
domUse
Include systems having domestic use
comUse
Include systems having commercial use
indUse
Include systems having industrial use
insUse
Include systems having institutional use
domCon
Include systems having domestic connections
comCon
Include systems having commercial connections
indCon
Include systems having industrial connections
insCon
Include systems having institutional connections
totCon
Include systems having any connections

Specifying pws-filter=none will exclude Public Water Supplier system records.

Specifying pws-filter=domUse,comUse,indUse will only include Public Water Supplier system records having non-zero domestic, commercial, or industrial use reported.
min-use number Include PWS systems if Total Annual Use is greater (>) than numerical input.
max-use number Include PWS systems if Total Annual Use is less (<) than numerical input.
min-pop number Include PWS systems if population is greater than numerical input.
max-pop number Include PWS systems if population is less than numerical input.
deq number Five Digit Drinking Water # (e.g. UTAH12345). deq=10023
Examples:

Variable Name Variable Options Explanation
sec-filter You may select one of the following:
all
(Default) All Secondary systems are included
none
No Secondary systems are included
Or you may select one or more of the following in a comma separated list:
dom
Include systems having domestic use
ind
Include systems having industrial use
com
Include systems having commercial use
inst
Include systems having institutional use
ag
Include systems having agricultural use

Specifying sec-filter=none will exclude Secondary system records.
Example:
Variable Name Variable Options Explanation
mgt-filter You may select one of the following:
all
(Default) All Management systems are included
none
No Management systems are included
Or you may select one or more of the following in a comma separated list:
cool
Include systems having cooling use
pro
Include systems having processing use
dom
Include systems having domestic use
misc
Include systems having miscellaneous use
lg
Include systems having lawn and garden irrigation use
irr
Include systems having agriculture irrigation use

Specifying mgt-filter=none will exclude Management system records.

Specifying mgt-filter=lg,irr will only include Management system records having non-zero irrigation (either lawn and garden or agriculture) use reported.
Example:

Variable Name Variable Options Explanation
ind-filter You may select one of the following:
all
(Default) All Industrial systems are included
none
No Industrial systems are included
Or you may select one or more of the following in a comma separated list:
cool
Include systems having cooling use
pro
Include systems having processing use
dom
Include systems having domestic use
misc
Include systems having miscellaneous use
lg
Include systems having lawn and garden irrigation use
irr
Include systems having agriculture irrigation use

Specifying ind-filter=none will exclude Industrial system records.

Specifying ind-filter=lg,irr will only include Industrial system records having non-zero irrigation (either lawn and garden or agriculture) use reported.
Example:

Variable Name Variable Options Explanation
src-status Select one or more of the following in a comma separated list:
A
Active sources
I
Inactive sources
all
(Default)
src-saline Select one or more of the following in a comma separated list:
Y
Saline sources
N
Not Saline sources
all
(Default)
min-src-use number Filter search results where Total Annual Use is greater (>) than numerical input using specified units (see units variable).
max-src-use number Filter search results where Total Annual Use is less (<) than numerical input using specified units (see units variable).
src-type Select one or more of the following in a comma separated list:
drain
 
well
 
tunnel
 
spring
 
stream
 
lake
 
reservoir
 
all
(Default)
div-type Select one or more of the following in a comma separated list:
delivery
 
return
 
transferin
 
transferout
 
withdrawal
 
all
(Default)
meas-type Select one or more of the following in a comma separated list:
meter
Measured with meter
weir
Measured with weir
est
Estimated
calc
Calculated
all
(Default)
use-type Select one or more of the following in a comma separated list:
agricultural
 
commercial
 
domestic
 
geothermal
 
industrial
 
irrigation
 
mining
 
powerHydroElec
 
powerFosFuel
 
powerGeothermal
 
powerNuclear
 
sTreatment
 
wSupplier
 
all
(Default)
Examples:

Variable Name Variable Options Explanation
min-yr number Filter search result where history year is greater than or equal to the numerical year.
max-yr number Filter search result where history year is less than or equal to the numerical year.
Examples:

Variable Name Variable Options Explanation
county Select one of the following:
Beaver
 
Box Elder
 
Cache
 
Carbon
 
Daggett
 
Davis
 
Duchesne
 
Emery
 
Garfield
 
Grand
 
Iron
 
Juab
 
Kane
 
Millard
 
Morgan
 
Piute
 
Rich
 
Salt Lake
 
San Juan
 
Sanpete
 
Sevier
 
Summit
 
Tooele
 
Uintah
 
Utah
 
Wasatch
 
Washington
 
Wayne
 
Weber
 
 Example: county=Utah
huc8 8-digit Hydrologic Unit Code
wr-area 2-digit water right area code Refer to the Water Rights Area Map for details. Example: areacode=01
custom-area WKT Polygon Polygon must be specified using Well-known text (WKT) format. Example: custom-area=POLYGON (( -113.3301 38.5480, -113.3466 38.0263, -112.8577 38.0133, -112.8412 38.5866,-113.3301 38.5480))
Examples:


Variable Name Variable Options Explanation
sys-output
date
Display date of system submission to DWRi
county
Display county name
cmt
Display the comments for this system
none
Do not output any of the above
all
(Default)
pws-output
pop
Display PWS system population
deqId
DEQ ID
domUse
Display Domestic Water Use
comUse
Display Commercial Water Use
indUse
Display Industrial Water Use
insUse
Display Institutional Water Use
totUse
Display Total Public Water Use
domCon
Display Domestic Connections
comCon
Display Commercial Connections
indCon
Display Industrial Connections
insCon
Display Institutional Connections
totCon
Display Total Connections
pDate
Peak Date
pDemand
Peak Demand
pUse
Peak Use Include
pMeter
Peak Measurement Type
pWholesale
Peak Wholesale Volume
method
Display the measurement method
pERCYesOrNo
Display answer to whether the calculated ERC is accepted
pERCValue
Display the ERC value
none
Do not output any of the above
all
(Default)
sec-output
dom
Output domestic percent
ind
Output industrial percent
com
Output commercial percent
inst
Output institutional percent
ag
Output agricultural percent
domCon
Output domestic connections
indCon
Output industrial connections
comCon
Output commercial connections
insCon
Output institutional connections
agrCon
Output agriculture connections
lgAc
Output irrigation (lawn and garden) acres
irrAc
Output irrigation (agriculture) acres
domConM
Output metered domestic connections
indConM
Output metered industrial connections
comConM
Output metered commercial connections
insConM
Output metered institutional connections
agrConM
Output metered agriculture connections
domUseM
Output metered domestic use
indUseM
Output metered industrial use
comUseM
Output metered commercial use
insUseM
Output metered institutional use
agrUseM
Output metered agriculture use
none
Do not output any of the above
all
(Default)
mgt-ind-output
cool
Output cooling percent
pro
Output process percent
dom
Output domestic percent
misc
Output miscellaneous percent
lg
irrigation percent
lgAF
acres irrigated
irr
irrigation
irrAF
acres irrigated
none
Do not output any of the above
all
(Default)
src-output
name
Source Name
latlon
Source Location (latitude, longitude)
srcType
Source Type
divType
Diversion Type
useType
Use Type
cmt
Display the comments for this source
none
Do not output any of the above
all
(Default)
Examples: