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

Documentation score: Route: 100% Fields: 100%

Description:

Search for impaired water units.

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 the assessment associated with the impairement.
huc8 The 8-digit hydrological unit code for the water unit.
impCauseCode The ID/code for the parameter or pollutant that is the basis for the impairment. (Ref:/api/doc/v1/surfacewater/impairments/causes)
impStatusCode The ID/code for the impairment status. (Ref:/api/doc/v1/surfacewater/impairments/statuses)
impUseCode The ID/code for the use that the water unit is impaired for. (Ref:/api/doc/v1/surfacewater/impairments/impaired-uses)
prjId The ID of the project that is associated with the impairment (e.g. PRJ07620-001).
specificGeoAreaCode The specific geographical area to search in. (Ref:/api/doc/v1/surfacewater/geographic-areas)
wid The ID for the impaired 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)
yearFirstListed The 4-digit year that the impairment was first listed.

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
assessmentId System ID for the assessment associated with the impairement.
huc8 The 8-digit hydrological unit code for the water unit.
impCauseCode The ID/code for the parameter or pollutant that is the basis for the impairment.
impCauseName The parameter or pollutant that is the basis for the impairment.
impStatusCode The ID/code for the impairment status.
impStatusName The name/description of the impairment status.
impUseCode The ID/code for the use that the water unit is impaired for.
impUseName The use that the water unit is impaired for.
impUseNameAbbreviated The abbreviated name for the impaired use.
prjId The ID of the project that is associated with the impairment (e.g. PRJ07620-001).
prjUrl The URL for the project page that is associated with the impairment.
wid The ID for the impaired water unit.
wuDisplayName The "display" name for the impaired water unit.
wuType The water unit type (lake, stream, etc.)
yearFirstListed The 4-digit year that the impairment was first listed.

Example Queries: