Documentation for "/api/v1/surfacewater/assessments":

Documentation score: Route: 66% Fields: 92%

Description:

Water quality assessments.

Search parameters:

One or more of the following search parameters need to be specified in order to retrieve data:
Parameter nameRequiredDescription
assessmentId System ID for an assessment.
auid The assessment unit ID.
huc8 The 8-digit hydrological unit code for the assessed water unit.
specificGeoAreaCode The specific geographical area to search in. (Ref:/api/doc/v1/surfacewater/geographic-areas)
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).
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
assessedStatus The assessed condition.
assessedUseName The use that the water unit was assessed for.
assessedUseNameAbbreviated The abbreviated name for the assessed use.
assessedYear The 4-digit year that the assessment was made.
assessmentId System ID for an assessment.
auid The assessment unit ID.
conditionStatus Status of the condition of the water unit for the assessment.
conditionSummary Summary text of the condition of the water unit for the assessment.
huc8 The 8-digit hydrological unit code for the assessed water unit.
wid The ID for the water unit.
wuDisplayName Waterbody name and brief location description.
wuType The water unit type (lake, stream, etc.)

Example Queries: