Get Monitoring Consent Restrictions
Gets the restrictions a provider's consent states, keyed on the provider'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 providerKey narrows the read to one provider. 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.
Gets the restrictions a provider's consent states, keyed on the provider'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 providerKey narrows the read to one provider. 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.
Path Parameters
Query Parameters
Response Body
application/json
application/problem+json
application/problem+json
curl -X GET "https://example.com/v1/consents/string"{ "consentNumber": "string", "sites": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "providerKey": "string", "siteNumber": "string", "name": "string", "waterManagementSubAreaId": null, "waterManagementSubAreaNumber": null, "waterManagementSubAreaName": null, "waterManagementAreaId": null, "waterManagementAreaNumber": null, "waterManagementAreaName": null, "bands": [ { "bandNumber": 0, "triggerLevel": 0, "unit": null, "thresholdAsAt": "2019-08-24", "thresholdSourceUrl": "string", "restriction": null } ] } ]}Get Area Scheduled Changes GET
Gets the scheduled stage changes for an area, including pending, approved, and cancelled changes.
Get Monitoring Site GET
Gets one monitoring site by its id, with the statuses the provider states for it. A site the platform no longer serves still resolves here, and every row carries its own as-at and freshness state. Its flow readings are served at the site's readings sub-collection.