@welldot/core

Permit

One legal instrument governing abstraction from the well (outorga, dispensa, cadastro), from its request on. A mutable record: the attached document is authoritative. The administrative status is stored; the validity status and condition deadlines are derived. A renewal is a new permit whose superse

Permit = object

One legal instrument governing abstraction from the well (outorga, dispensa, cadastro), from its request on. A mutable record: the attached document is authoritative. The administrative status is stored; the validity status and condition deadlines are derived. A renewal is a new permit whose supersedes points to the previous one. Since v2.3.

Properties

attachments?

optional attachments?: Attachment

The legal document.


authority

authority: string

Issuing body, e.g. ANA, SEMAS-PA. Same semantics as well_id.authority.


conditions?

optional conditions?: PermitCondition

Obligations (condicionantes).


daily_operating_time?

optional daily_operating_time?: number

Maximum granted daily operating time in hours. A value above 24 is stored as written; derivations read it as 24.


flow_rate?

optional flow_rate?: number

Maximum granted flow in m³/h.


history?

optional history?: PermitHistoryEntry

Administrative steps (process, notifications, fees).


id

id: string

Unique within permits. UUID v4 recommended.


identifier?

optional identifier?: string

Identifier of the granted instrument (portaria, license code), preserved verbatim. Absent while the permit is only requested.


issued_at?

optional issued_at?: string

Calendar date (YYYY-MM-DD) of issuance.


monthly_schedule?

optional monthly_schedule?: MonthlyGrant

Month-by-month grant.


notes?

optional notes?: string


renewal_requested_at?

optional renewal_requested_at?: string

Calendar date (YYYY-MM-DD) a renewal request was filed.


request_identifier?

optional request_identifier?: string

Identifier of the request or administrative process (protocolo), preserved verbatim.


status?

optional status?: PermitAdministrativeStatus

Administrative situation. Closed vocabulary. Absent means granted.


supersedes?

optional supersedes?: string

permits[].id of the instrument this one legally replaces.


type

type: OpenVocab<PermitType>

Recommended values: PERMIT_TYPES. Non-canonical values SHOULD use the x- prefix.


updated_at?

optional updated_at?: string

RFC 3339 instant of the last edit of this record.


valid_from?

optional valid_from?: string

Calendar date (YYYY-MM-DD). Absent means valid from issued_at.


valid_until?

optional valid_until?: string

Calendar date (YYYY-MM-DD). Absent means no fixed expiry.


volume_limits?

optional volume_limits?: VolumeLimit

Volumes stated in the document.


water_use?

optional water_use?: OpenVocab<WaterUse>

What the abstracted water is for. Recommended values: WATER_USES.