Permit

EntityDraftv1.0.0-rc.2

A permit: a licence or approval that a regulator gives for a development, with its holder, its dates, its status and its own criteria, such as a site's own noise limit.

https://opendevelopmentstandards.org/schema/1.0.0-rc.2/core/Permit.json

Fields

Every entity also has the fields of the Entity base. The first row lists them.

From the Entity baseidnamedescriptionidentifierslinkscreatedAtupdatedAt
  • idRequired
    textnot empty

    The record's id: unique within the document. Fields that point at the record hold this id.

  • name
    text

    The name people use for the record.

  • description
    text

    What the record is, in words.

  • identifiers
    List ofDatatypeIdentifier

    Ids the record has in other systems.

  • links
    List ofDatatypeLink

    Open-ended links to other records.

  • createdAt
    date-time (RFC 3339)

    When the record was created, in its producer's system.

  • updatedAt
    date-time (RFC 3339)

    When the record last changed, in its producer's system.

  • type
    Code fromcore/permit_types

    What sort of permit it is, such as licence or approval.

  • issuer
    Id ofStakeholder

    The regulator that gave the permit.

  • holder
    Id ofStakeholder

    Who holds the permit.

  • jurisdiction
    Id ofJurisdiction

    The jurisdiction the permit is given under.

  • status
    One ofthe codes below

    Where the permit stands.

    applied
    Asked for and not yet decided.
    active
    In force.
    suspended
    Not in force for now.
    expired
    Past its end date.
    cancelled
    Ended by the regulator or the holder.
  • effective
    DatatypeInterval

    When the permit is in force.

  • features
    List ofId ofFeature

    The features the permit covers.

  • criteria
    List ofPartCriterion

    The permit's own criteria, such as a limit for this site only.

Links

Holds Parts this record embeds, with the field that holds each.

Points at Records whose ids this record holds, with the field that holds each.

Held by Records that embed this one, with their field that holds it.

Examples

An id that another example defines opens that record.

Full example

{
  "id": "permit-wellsite",
  "name": "Well licence 0512345",
  "type": "licence",
  "issuer": "stakeholder-aer",
  "holder": "stakeholder-operator",
  "jurisdiction": "jurisdiction-ab",
  "status": "active",
  "effective": {
    "start": "2026-05-04T00:00:00-06:00"
  },
  "features": [
    "feature-wellsite"
  ],
  "identifiers": [
    {
      "scheme": "ca.ab.aer_licence",
      "value": "0512345"
    }
  ]
}
Show 1 more example

Minimal example: the required fields only

{
  "id": "permit-1"
}

Changes and file

Changes

  1. 0.1.0 First version.

Schema file

Show the JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://opendevelopmentstandards.org/schema/1.0.0-rc.2/core/Permit.json",
  "title": "Permit",
  "description": "A permit: a licence or approval that a regulator gives for a development, with its holder, its dates, its status and its own criteria, such as a site's own noise limit.",
  "$ref": "Entity.json",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "pattern": "^[a-z0-9]+(_[a-z0-9]+)*(\\.[a-z0-9]+(_[a-z0-9]+)*)*$",
      "x-ods-vocabulary": "core/permit_types",
      "description": "What sort of permit it is, such as `licence` or `approval`."
    },
    "issuer": {
      "type": "string",
      "minLength": 1,
      "x-ods-ref": "Stakeholder",
      "description": "The regulator that gave the permit."
    },
    "holder": {
      "type": "string",
      "minLength": 1,
      "x-ods-ref": "Stakeholder",
      "description": "Who holds the permit."
    },
    "jurisdiction": {
      "type": "string",
      "minLength": 1,
      "x-ods-ref": "Jurisdiction",
      "description": "The jurisdiction the permit is given under."
    },
    "status": {
      "type": "string",
      "enum": [
        "applied",
        "active",
        "suspended",
        "expired",
        "cancelled"
      ],
      "description": "Where the permit stands.",
      "x-ods-options": [
        {
          "value": "applied",
          "title": "Applied for",
          "description": "Asked for and not yet decided."
        },
        {
          "value": "active",
          "title": "Active",
          "description": "In force."
        },
        {
          "value": "suspended",
          "title": "Suspended",
          "description": "Not in force for now."
        },
        {
          "value": "expired",
          "title": "Expired",
          "description": "Past its end date."
        },
        {
          "value": "cancelled",
          "title": "Cancelled",
          "description": "Ended by the regulator or the holder."
        }
      ]
    },
    "effective": {
      "$ref": "Interval.json",
      "description": "When the permit is in force."
    },
    "features": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "x-ods-ref": "Feature"
      },
      "description": "The features the permit covers."
    },
    "criteria": {
      "type": "array",
      "items": {
        "$ref": "Criterion.json"
      },
      "description": "The permit's own criteria, such as a limit for this site only."
    }
  },
  "patternProperties": {
    "^x-": {}
  },
  "unevaluatedProperties": false,
  "examples": [
    {
      "id": "permit-1"
    },
    {
      "id": "permit-wellsite",
      "name": "Well licence 0512345",
      "type": "licence",
      "issuer": "stakeholder-aer",
      "holder": "stakeholder-operator",
      "jurisdiction": "jurisdiction-ab",
      "status": "active",
      "effective": {
        "start": "2026-05-04T00:00:00-06:00"
      },
      "features": [
        "feature-wellsite"
      ],
      "identifiers": [
        {
          "scheme": "ca.ab.aer_licence",
          "value": "0512345"
        }
      ]
    }
  ],
  "x-ods-status": "draft",
  "x-ods-kind": "entity",
  "x-ods-module": "core",
  "x-ods-changes": {
    "0.1.0": "First version."
  }
}