Welcome to Water Restrictions, your go-to source for up-to-date information on water restrictions in your area.Water Restrictions LogoWater Restrictions
EndpointsSearch

Search

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'. Results are ordered by kind in the declared order, then by name, with the id as the tiebreaker, so a page is deterministic across calls. There is no relevance ranking and none is claimed, because the platform holds nothing to rank on. The read is not a read-after-write surface.

GET
/v1/search

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'. Results are ordered by kind in the declared order, then by name, with the id as the tiebreaker, so a page is deterministic across calls. There is no relevance ranking and none is claimed, because the platform holds nothing to rank on. The read is not a read-after-write surface.

Query Parameters

q*string
type?string
pageNumber?|
Match^-?(?:0|[1-9]\d*)$
Formatint32
Default1
pageSize?|
Match^-?(?:0|[1-9]\d*)$
Formatint32
Default10

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/search?q=string"
{  "items": [    {      "type": "area",      "id": "string",      "name": "string",      "context": null    }  ],  "pageNumber": 0,  "pageSize": 0,  "totalCount": 0,  "totalPages": 0,  "hasPreviousPage": true,  "hasNextPage": true}