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

Documentation score: Route: 100% Fields: 100%

Description:

Search for surface water strategy projects.

Search parameters:

One or more of the following search parameters need to be specified in order to retrieve data:
Parameter nameRequiredDescription
detailedStatusCode An internal code to represent the current low level status of the project. (Ref:/api/doc/v1/surfacewater/projects/detailed-statuses)
generalStatusCode An internal code to represent the current high level status of the project. (Ref:/api/doc/v1/surfacewater/projects/general-statuses)
huc8 The 8-digit hydrological unit code associated with the project.
prjId The ID for the project (e.g. PRJ07620-001).
prjName The name of the project.
specificGeoAreaCode The specific geographical area to search in. (Ref:/api/doc/v1/surfacewater/geographic-areas)
wid The ID of the water unit associated with the project.
wuSearchString The name of the water unit to search for.
wuType The water unit type {'Stream', 'Lake', 'Wetland'}. (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
detailedStatus The current low level phase of the project as it moves toward completion.
generalStatus The current high level phase of the project as it moves toward completion.
generalStatusCategory The category that a status falls into, future start, in progress, public comment, or completed.
impairmentCount The number of impairments associated with the project.
prjId The ID for the project (e.g. PRJ07620-001).
prjName The name of the project.
prjUrl The URL for the project page.
statusDate The calendar date on which the most recent status started.
targetEndYear The projected completion year of the project in this row.

Example Queries: