EPA — U.S. Environmental Protection Agency · Schema

MonitorPlanDTO

MonitorPlanDTO schema from Monitor Plan Management OpenAPI Specification

GovernmentEnvironmentalOpenDataAirQualityWaterQualityHazardousWasteComplianceEmissions

Properties

Name	Type	Description
id	string	Unique identifier of a monitoring plan record.
orisCode	number	EIA-assigned identifier or facility ID assigned by CAMD (if EIA number is not applicable).
facilityId	number	The Facility ID code assigned by the Department of Energy's Energy Information Administration. The Energy Information Administration Plant ID code is also referred to as the "ORIS code", "ORISPL code"
name	string	Character codes source assigned to identify a stack, pipe and/or unit.
endReportPeriodId	number	Unique identifier of a reporting period record. This value will be null for active records.
beginReportPeriodId	number	Unique identifier of a reporting period record.
facilityName	string
facilityRegistrySystemId	string
configTypeCode	string
lastUpdated	string
updatedStatusFlag	string
needsEvalFlag	string
checkSessionId	string
endReportPeriodDescription	string
beginReportPeriodDescription	string
active	boolean
monitoringPlanCommentData	array
unitStackConfigurationData	array
reportingFrequencies	array
monitoringLocationData	array
pendingStatusCode	string
evalStatusCode	string
evalStatusCodeDescription	string
severityCode	string
severityDescription	string
userId	string
addDate	string
updateDate	string
submissionId	number
submissionAvailabilityCode	string
submissionAvailabilityCodeDescription	string
lastEvaluatedDate	string
version	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/epa/refs/heads/main/json-schema/cam-monitor-plan-monitor-plan-dto-schema.json",
  "title": "MonitorPlanDTO",
  "description": "MonitorPlanDTO schema from Monitor Plan Management OpenAPI Specification",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier of a monitoring plan record.",
      "example": "TWCORNEL5-C0E3879920A14159BAA98E03F1980A7A"
    },
    "orisCode": {
      "type": "number",
      "description": "EIA-assigned identifier or facility ID assigned by CAMD (if EIA number is not applicable).",
      "example": 3
    },
    "facilityId": {
      "type": "number",
      "description": "The Facility ID code assigned by the Department of Energy's Energy Information Administration. The Energy Information Administration Plant ID code is also referred to as the \"ORIS code\", \"ORISPL code\", \"Facility ID\", or \"Facility code\", among other names. If a Plant ID code has not been assigned by the Department of Energy's Energy Information Administration, then plant code means a code beginning with \"88\" assigned by the EPA's Clean Air Markets Division for electronic reporting.",
      "example": 3
    },
    "name": {
      "type": "string",
      "description": "Character codes source assigned to identify a stack, pipe and/or unit.",
      "example": "1,2,CSA00N"
    },
    "endReportPeriodId": {
      "type": "number",
      "description": "Unique identifier of a reporting period record. This value will be null for active records.",
      "example": null
    },
    "beginReportPeriodId": {
      "type": "number",
      "description": "Unique identifier of a reporting period record.",
      "example": null
    },
    "facilityName": {
      "type": "string",
      "example": "EPA Facility"
    },
    "facilityRegistrySystemId": {
      "type": "string",
      "example": "12345"
    },
    "configTypeCode": {
      "type": "string",
      "example": "string"
    },
    "lastUpdated": {
      "format": "date-time",
      "type": "string",
      "example": "2024-01-15T12:00:00Z"
    },
    "updatedStatusFlag": {
      "type": "string",
      "example": "active"
    },
    "needsEvalFlag": {
      "type": "string",
      "example": "string"
    },
    "checkSessionId": {
      "type": "string",
      "example": "12345"
    },
    "endReportPeriodDescription": {
      "type": "string",
      "example": "string"
    },
    "beginReportPeriodDescription": {
      "type": "string",
      "example": "string"
    },
    "active": {
      "type": "boolean",
      "example": true
    },
    "monitoringPlanCommentData": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/MonitorPlanCommentDTO"
      },
      "example": [
        "string"
      ]
    },
    "unitStackConfigurationData": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/UnitStackConfigurationDTO"
      },
      "example": [
        "string"
      ]
    },
    "reportingFrequencies": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/MonitorPlanReportingFreqDTO"
      },
      "example": [
        "string"
      ]
    },
    "monitoringLocationData": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/MonitorLocationDTO"
      },
      "example": [
        "string"
      ]
    },
    "pendingStatusCode": {
      "type": "string",
      "example": "active"
    },
    "evalStatusCode": {
      "type": "string",
      "example": "active"
    },
    "evalStatusCodeDescription": {
      "type": "string",
      "example": "active"
    },
    "severityCode": {
      "type": "string",
      "example": "string"
    },
    "severityDescription": {
      "type": "string",
      "example": "string"
    },
    "userId": {
      "type": "string",
      "example": "12345"
    },
    "addDate": {
      "type": "string",
      "example": "string"
    },
    "updateDate": {
      "type": "string",
      "example": "string"
    },
    "submissionId": {
      "type": "number",
      "example": 0.0
    },
    "submissionAvailabilityCode": {
      "type": "string",
      "example": "string"
    },
    "submissionAvailabilityCodeDescription": {
      "type": "string",
      "example": "string"
    },
    "lastEvaluatedDate": {
      "format": "date-time",
      "type": "string",
      "example": "2024-01-15T12:00:00Z"
    },
    "version": {
      "type": "string",
      "example": "string"
    }
  },
  "required": [
    "id",
    "orisCode",
    "facilityId",
    "name",
    "endReportPeriodId",
    "beginReportPeriodId",
    "facilityName",
    "facilityRegistrySystemId",
    "configTypeCode",
    "lastUpdated",
    "updatedStatusFlag",
    "needsEvalFlag",
    "checkSessionId",
    "active",
    "monitoringPlanCommentData",
    "unitStackConfigurationData",
    "reportingFrequencies",
    "monitoringLocationData",
    "pendingStatusCode",
    "evalStatusCode",
    "evalStatusCodeDescription",
    "severityCode",
    "severityDescription",
    "userId",
    "addDate",
    "updateDate",
    "submissionId",
    "submissionAvailabilityCode",
    "submissionAvailabilityCodeDescription",
    "lastEvaluatedDate"
  ]
}