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

Documentation score: Route: 100% Fields: 100%

Description:

Lookup table query: list of causes for which a water unit may be impaired.

Search parameters:

There are no search parameters available for this route.

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
impCauseCode The ID/code for an impairment cause.
impCauseName The parameter or pollutant that a water unit may be impaired for.

Example Queries: