Get Schemes
Get a page of schemes. Includes detailed information about each scheme, summary information about their stages, and pagination metadata.
Get a page of schemes. Includes detailed information about each scheme, summary information about their stages, and pagination metadata.
Query Parameters
^-?(?:0|[1-9]\d*)$int32^-?(?:0|[1-9]\d*)$int32Response Body
application/json
application/problem+json
curl -X GET "https://example.com/v1/schemes"{ "items": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "description": null, "stages": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "severity": 0, "name": "string", "description": null } ] } ], "pageNumber": 0, "pageSize": 0, "totalCount": 0, "totalPages": 0, "hasPreviousPage": true, "hasNextPage": true}Get Scheme GET
Gets a scheme by its ID. Includes detailed information about its stages.
Search GET
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.