Project Bundle

A set of one or more permits related to an activity.

A project is defined by an activity with one or more permits. Grouping of a primary authorization with secondary or associated authorizations that are triggered or required by the primary authorization. For example: major mine permit (primary) and associated auxiliary (secondary) permits such as License to Cut, Water Use, and or Road Use.

Scope

This data type is intended to represent a grouping of related permits that are related to a specific activity.

Structure

Name	Cardinality	Type	Description & Constraints
project_id	1..1	uuid	A unique key to track all permits related to a project or activity across all permitting systems.
project_name	1..1	string	Short name of the project.
project_description	0..1	string	Full description of the project. This may contain information to better understand a project.

Specification

Schema

Loading ....

Source

{
  "$id": "https://raw.githubusercontent.com/bcgov/nr-pies/refs/heads/main/docs/spec/data/project_bundle.schema.json",
  "$schema": "https://json-schema.org/draft-07/schema",
  "title": "Project Bundle",
  "description": "An identifier for a specific area with clear boundaries.",
  "type": "object",
  "properties": {
    "project_id": {
      "type": "string",
      "description": "A unique key to track all permits related to a project or activity across all permitting systems.",
      "pattern": "/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i"
    },
    "project_name": {
      "type": "string",
      "description": "Short name of the project."
    },
    "project_description": {
      "type": "string",
      "description": "Full description of the project. This may contain information to better understand a project."
    }
  },
  "required": [
    "project_id",
    "project_name"
  ]
}

Example

{
  "project_id": "c09d5aab-0f10-4727-a520-adbd57db084f",
  "project_name": "The Hudson, Capitol Park",
  "project_description": "project_description"
}

Implementation Notes

TBD

References

TBD