TGM Expert provides comprehensive environmental permit and compliance management, enabling energy operators to track permits, compliance obligations, and submissions to regulatory authorities.

Table of Contents¶

• Overview
• Data Model
• Permit Types
• Compliance Obligations
• Submission Workflow
• API Reference
• Environmental Permits API
• Compliance Obligations API
• Compliance Submissions API
• Multi-Tenancy
• Examples

Overview¶

Key Features¶

• Permit Tracking - Track all environmental permits with expiry dates and conditions
• Compliance Calendar - Monitor upcoming and overdue compliance obligations
• Submission Management - Full lifecycle for regulatory submissions
• Permit-Obligation Linking - Each obligation is linked to a specific permit
• Expiry Alerts - Proactively find permits approaching expiry
• Regulatory Authority Tracking - Store issuing authority contact details
• Multi-Frequency Support - Handle daily, weekly, monthly, quarterly, semi-annual, annual, and one-time obligations

Architecture¶

EnvironmentalPermit
  ├── Company (tenant isolation)
  ├── Unit (affected asset)
  └── ComplianceObligation[]
        ├── ResponsibleUser (assigned user)
        └── ComplianceSubmission[]
              ├── SubmittedBy (User)
              └── ReviewedBy (User)

Data Model¶

EnvironmentalPermit Entity¶

ComplianceObligation Entity¶

ComplianceSubmission Entity¶

Database Tables¶

-- Migration: V55__environmental_permits.sql
-- Tables: environmental_permits, compliance_obligations, compliance_submissions

Permit Types¶

Permit Status¶

Compliance Obligations¶

Obligation Types¶

Obligation Frequencies¶

Obligation Status¶

Submission Workflow¶

  ┌───────┐     ┌───────────┐     ┌──────────────┐     ┌──────────┐
  │ DRAFT │ ──> │ SUBMITTED │ ──> │ UNDER_REVIEW │ ──> │ APPROVED │
  └───────┘     └───────────┘     └──────────────┘     └──────────┘
                                         │
                                         ├──────> ┌──────────┐
                                         │        │ REJECTED │
                                         │        └──────────┘
                                         │
                                         └──────> ┌───────────────────┐
                                                  │ REVISION_REQUIRED │
                                                  └───────────────────┘

Submission Status Transitions¶

API Reference¶

Environmental Permits API¶

Base URL¶

/api/permits

Inherited CRUD Endpoints¶

Custom Endpoints¶

Get Expiring Permits¶

GET /api/permits/expiring?daysAhead=90&page=1&pageSize=25

Returns active permits expiring within the specified number of days (default: 90).

Get Permits by Status¶

GET /api/permits/by-status?status=ACTIVE&page=1&pageSize=25

Valid status values: ACTIVE, EXPIRED, SUSPENDED, REVOKED, PENDING_RENEWAL

Compliance Obligations API¶

Base URL¶

/api/compliance-obligations

Inherited CRUD Endpoints¶

Custom Endpoints¶

Get Overdue Obligations¶

GET /api/compliance-obligations/overdue?page=1&pageSize=25

Returns all active obligations past their due date.

Get Upcoming Obligations¶

GET /api/compliance-obligations/upcoming?daysAhead=30&page=1&pageSize=25

Returns obligations due within the specified number of days (default: 30).

Get Obligations by Permit¶

GET /api/compliance-obligations/permit/{permitId}?page=1&pageSize=25

Returns all obligations associated with a specific permit.

Compliance Submissions API¶

Base URL¶

/api/compliance-submissions

Inherited CRUD Endpoints¶

Custom Endpoints¶

Submit a Submission¶

POST /api/compliance-submissions/{id}/submit

Transitions from DRAFT to SUBMITTED and records the submission date.

Review a Submission¶

POST /api/compliance-submissions/{id}/review
Content-Type: application/json

{
  "reviewNotes": "Data looks complete. Forwarding for final approval."
}

Approve a Submission¶

POST /api/compliance-submissions/{id}/approve

Multi-Tenancy¶

All permits, obligations, and submissions are scoped to a company via the company_id foreign key. Users can only access environmental data belonging to their company.

Examples¶

Create an Environmental Permit¶

POST /api/permits
Content-Type: application/json

{
  "permitNumber": "EPA-AIR-2024-001",
  "title": "Air Emissions Permit - Plant Alpha",
  "description": "Annual air emissions permit for natural gas combined cycle plant",
  "permitType": "AIR",
  "issuingAuthority": "Environmental Protection Agency",
  "authorityContact": "Jane Doe",
  "authorityEmail": "jane.doe@epa.gov",
  "issueDate": "2024-01-01T00:00:00",
  "expiryDate": "2025-01-01T00:00:00",
  "unitId": 42,
  "conditions": "NOx emissions not to exceed 25 ppm. CO emissions not to exceed 10 ppm.",
  "emissionLimits": "NOx: 25 ppm, CO: 10 ppm, SO2: 2 ppm",
  "permitFee": 5000.00,
  "annualFee": 2000.00
}

Create a Compliance Obligation¶

POST /api/compliance-obligations
Content-Type: application/json

{
  "title": "Monthly Emissions Report",
  "description": "Submit monthly stack emissions monitoring data to EPA",
  "permitId": 1,
  "obligationType": "REPORTING",
  "frequency": "MONTHLY",
  "nextDueDate": "2024-02-15T17:00:00",
  "responsibleUserId": 10,
  "requirements": "CEMS data in CSV format with daily averages",
  "submissionFormat": "CSV via EPA online portal"
}

Create and Submit a Compliance Submission¶

# Step 1: Create the submission
POST /api/compliance-submissions
Content-Type: application/json

{
  "title": "January 2024 Emissions Report",
  "obligationId": 1,
  "periodStart": "2024-01-01T00:00:00",
  "periodEnd": "2024-01-31T23:59:59",
  "submissionData": "CEMS data attached. All parameters within permit limits."
}

# Step 2: Submit it
POST /api/compliance-submissions/1/submit

# Step 3: Review it
POST /api/compliance-submissions/1/review
{ "reviewNotes": "All data verified against CEMS records." }

# Step 4: Approve it
POST /api/compliance-submissions/1/approve

Permission Resource Names¶

environmental_permits   - for permit CRUD
compliance_obligations  - for obligation CRUD
compliance_submissions  - for submission CRUD