Endpoints

Each endpoint includes request parameters, response schemas, and example responses. This information is generated from the OpenAPI specification →.

Areas

GETGet Area

Gets an area by its ID. A summary of its scheme and detailed information about its current stage will be provided, if set.

GETGet Area Scheduled Changes

Gets the scheduled stage changes for an area, including pending, approved, and cancelled changes.

Gets a page of areas with references to their restriction scheme, current stage, and managing organisations, and pagination metadata. Each area states its next approved stage change ahead of now, or null when none is scheduled ahead; cancelled, ignored, unapproved and past-dated changes are not stated. Filters narrow the list before it is counted: schemeId, organisationId and restrictionZoneId take a GUID or the literal null for the areas holding none, and trackingStatus takes a tracking status name. An unsupported query parameter is ignored.

Consents

GETGet Monitoring Consent Restrictions

Gets the restrictions a publisher's consent states, keyed on the publisher's own consent number. Each row carries the trigger level the consent stated and the restriction the site states for the same band on its current date. The optional publisherKey narrows the read to one publisher. A consent whose recorded rows resolved to no held site answers an empty list, which is indistinguishable from a consent whose rows state no threshold.

Monitoring Sites

GETGet Monitoring Site

Gets one monitoring site by its id, with the statuses the publisher states for it. A site the platform no longer serves still resolves here, and every row carries its own as-at. Its flow readings are served at the site's readings sub-collection.

GETGet Monitoring Site Readings

Gets a page of one monitoring site's readings, newest observed first, optionally narrowed to a span. A reading carries the value the publisher stated, and each row keeps the instant the publisher observed it, so a caller judges the value's age from the row itself.

GETGet Monitoring Site Restriction States

Gets the current restriction state of the served monitoring sites inside the given bounding box, carrying each site's identifier and the bands the publisher states for its current date with each band's allocation and allocation wording. The bounds are taken exactly as given and are not buffered, so a caller that wants the tile's buffered edge inflates its own bounds. A site in the bounds that is served but states no current status answers with an empty band list, which is distinct from a site that is absent because it is not served or not in the bounds. The response is never cached.

GETGet Monitoring Sites

Gets a page of the monitoring sites the platform currently serves, optionally narrowed by publisher, catchment number, the publisher's own site number or whether the publisher publishes a restriction for the site, with each site's publisher facts, the statuses it states for the current date and the next, and the age of each row. A retired site is absent from the page and still resolves by id.

Organisations

GETGet Organisation

Get an organisation by its ID.

GETGet Organisations

Get a page of organisations with pagination metadata.

Restriction Zones

GETGet Restriction Zone

Gets a restriction zone by its ID, including its type and aliases.

GETGet Restriction Zones

Gets a page of restriction zones with their type and aliases, and pagination metadata. Filters narrow the list before it is counted: type takes a restriction zone type name. An unsupported query parameter is ignored.

Scheduled Changes

GETGet Scheduled Changes

Gets a paginated list of scheduled stage changes across all areas.

Schemes

GETGet Scheme

Gets a scheme by its ID. Includes detailed information about its stages.

GETGet Schemes

Get a page of schemes. Includes detailed information about each scheme, summary information about their stages, and pagination metadata.

Search

GETSearch

Searches the records the platform holds for a plain term, as a case-insensitive substring over each record's names, a site's waterway and the numbers that identify it, and optionally narrowed to the kinds stated in 'type'. A wildcard character in the term is matched literally. Results are ranked by how the term matches a searched field: an exact match first, then a match at the start of a field, then a match anywhere in it. Within a rank they are ordered by kind in the declared order, then by name, with the id as the tiebreaker, so a page is deterministic across calls. An area and a monitoring site carry a restriction object holding the facts a consumer's tone rule reads; the other kinds carry none. The read is not a read-after-write surface.

Stages

GETGet Stage

Gets a stage by its ID.

Tiles

GETGet Area Tile

Returns a Mapbox Vector Tile (MVT) for the given XYZ tile coordinates. Returns 204 when no areas intersect the tile.

GETGet Area Tile Metadata

Returns a TileJSON 3.0.0 discovery document for the water restriction areas vector tile source.

GETGet Monitoring Site Tile

Returns a Mapbox Vector Tile (MVT) carrying individual monitoring sites at close zoom and, at wide zoom, a site that is alone in its cell beside the counted groups of the rest, for the given XYZ tile coordinates. Returns 204 when no served sites intersect the tile.

GETGet Monitoring Site Tile Metadata

Returns a TileJSON 3.0.0 discovery document for the monitoring site vector tile source, which carries individual sites at close zoom and, at wide zoom, a site that is alone in its cell beside the counted groups of the rest.

Water Management Areas

GETGet Water Management Area

Gets one water management area by its id, with the publisher's own facts about it and the declared publisher's name for attribution.

GETGet Water Management Areas

Gets a page of the water management areas the platform holds, optionally narrowed by publisher, with each area's publisher facts and the declared publisher's name. The page is ordered by the publisher's own area number rather than by row order, so the page a caller reads is stable across re-fetches that restate an area in place.

Water Management Sub Areas

GETGet Water Management Sub-Area

Gets one water management sub-area by its id, with the publisher's own facts about it, the declared publisher's name for attribution, and the facts of the area it is stated within.

GETGet Water Management Sub-Areas

Gets a page of the water management sub-areas the platform holds, optionally narrowed by publisher and by the area they are stated within, with each sub-area's publisher facts, the declared publisher's name, and the facts of the area it is stated within. The page is ordered by the parent area's own number and then the sub-area's own number rather than by row order, so the page a caller reads is stable across re-fetches that restate a sub-area in place.