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

Get Area

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

GET
/v1/areas/{areaId}

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

Path Parameters

areaId*string
Formatuuid

Query Parameters

includeBoundary?boolean
Defaultfalse

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/areas/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "boundary": null,  "scheme": null,  "restrictionZone": null,  "restrictions": [    {      "type": "residential",      "current": {        "scheme": {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "name": "string"        },        "stage": {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "severity": 0,          "name": "string",          "description": null        },        "effectiveFrom": "2019-08-24T14:15:22Z",        "isAutoDetected": true      },      "previous": null    }  ],  "organisations": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "websiteUrl": null    }  ],  "timeZoneId": "string",  "sources": [    {      "url": "string",      "description": "string"    }  ],  "trackingStatus": "tracked"}

Endpoints

Reference for all available API endpoints.

Get Areas GET

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.