Documentation for "/api/v1/surfacewater/cf-dmr-summ":

Documentation score: Route: 100% Fields: 35%

Description:

Monthly discharge monitoring data

Search parameters:

One or more of the following search parameters need to be specified in order to retrieve data:
Parameter nameRequiredDescription
stationId Unique numerical identifier given to this station.
reportYear The year the DMR was created for.
specificGeoAreaCode The specific geographical area to search in. (Ref:/api/doc/v1/surfacewater/geographic-areas)
geoAreaTypeCode The geographical area type to search in. (Ref:/api/doc/v1/surfacewater/geographic-areas)
stationType The station type to search for. (Ref:/api/doc/v1/surfacewater/monitoring-stations)

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
stationId Unique numerical identifier given to this station.
reportYear The year the DMR was created for.
parameter the parameter monitored
limitType The statistic used to summarize the month's monitoring data
limit the limit value and unit
jan January monitoring results
feb February monitoring results
mar March monitoring results
apr April monitoring results
may May monitoring results
jun June monitoring results
jul July monitoring results
aug August monitoring results
sep September monitoring results
oct October monitoring results
nov November monitoring results
dec December monitoring results

Example Queries: