Home | Groundwater | /api/v1/groundwater/analytes

Documentation for "/api/v1/groundwater/analytes":

Documentation score: Route: 100% Fields: 100%

Description:

Lookup table query: list of analytes for EDA monitoring results.

Search parameters:

One or more of the following search parameters may be specified when retrieving data:

Parameter name	Required	Description
analyteGroupCode		The ID/code for the analyte group that the analyte belongs to. (Ref:/api/doc/v1/groundwater/analyte-groups)

Additional parameters:

The following, optional, parameters may be specified:

Parameter name	Description
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 name	Description
analyteCode	The ID/code for the analyte.
analyteGroupCode	The ID/code for the analyte group that the analyte belongs to.
analyteName	The name of the analyte.

Example Queries: