Check a measured value against every cited limit held for it

Every row find_limits would return, each with a verdict: over (above a ceiling or a band's top), under (below a floor or a band's bottom), within, or not_comparable with a why (parameter.named_differently, parameter.member_of_sum for a limit on a sum the asked substance is one member of, printed_reference, condition.dependent for a number that holds only at a stated hardness, pH or temperature, value.not_a_number, value.range_of_levels, direction.not_printed, unit.family_mismatch, unit.not_convertible, unit.unrecognised, unit.refused, unit.not_printed). Units convert exactly, in decimal, within a family (µg/L to mg/L) by the engine's registry; no limit is summed or inferred. Rows come over first, then under, within, not_comparable; counts and not_comparable_by cover every row, not only the page.

get/check

Request

  • Base URL: https://passage-data.com/api/v1
  • URL: https://passage-data.com/api/v1/check
  • Auth: one of:
    • none
    • HTTP bearer
    • API key in header x-api-key

Query parameters

parameterstring required

The substance or measure as a regulation names it (copper, ammonia, pH) or its CAS number (7440-50-8). A row held under a longer name holding these words is not compared: ask by that name.

valuestring required

The measured value, one decimal number: 0.15, 0,15, 1.5e-3. A result below detection (<0.005), a comma that reads two ways (1,500), an amount below zero and a number past 1e±30 are refused.

unitstring required

The value's unit: mg/L, µg/L (or ug/L), ng/L, mg/kg, µg/m³, pH ...

placestring

ISO 3166 code: US, US-OH, CA, CA-QC, DE, FR, IT, EU. A place also searches every place above it.

medium'water_discharge' | 'surface_water' | 'groundwater' | 'ambient_air' | 'air_emission' | 'sediment' | 'leachate'
statisticstring

daily_max, monthly_avg, instant, composite, ...

max_rowsinteger
offsetinteger

Response

Rows with verdicts, or a refused block (rows.none_held, parameter.unknown, parameter.ambiguous, place.not_held, unit.refused, unit.unrecognised)

queryobject
searchedobject
not_comparable_byobject
saysstring
reads_asstring
totalinteger
offsetinteger
returnedinteger
next_offsetinteger nullable
refusedobject

Changes

No recorded changes to this operation across all 1 revision of this API.