UnitDTO

UnitDTO schema from Monitor Plan Management OpenAPI Specification

GovernmentEnvironmentalOpenDataAirQualityWaterQualityHazardousWasteComplianceEmissions

Properties

Name Type Description
nonLoadBasedIndicator number Indicator that represents whether the unit is non-load based.
id number Unique identifier for the unit.
unitid string ID of the unit.
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"
beginDate string Date on which information became effective or activity started.
endDate string Last date in which information was effective. This date will be null for active records.
sourceCategoryCd string Category code for the source of the unit.
commOpDate string The date when the unit began commercial operation.
comrOpDate string The date when the unit began compliance operation.
userId string The ID of the user who created or updated the record.
addDate string The date when the unit record was added.
updateDate string The date when the unit record was last updated.
opStatusCd string The operational status code of the unit.
statusBeginDate string The date when the current operational status of the unit began.
unitTypeCd string The type code of the unit.
auditUser string The user ID of the person who performed the last audit on the unit record.
auditDate string The date and time when the last audit was performed on the unit record.
active boolean Indicates whether the unit is currently active.
View JSON Schema on GitHub

JSON Schema

cam-monitor-plan-unit-dto-schema.json Raw ↑
{
  "$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-unit-dto-schema.json",
  "title": "UnitDTO",
  "description": "UnitDTO schema from Monitor Plan Management OpenAPI Specification",
  "type": "object",
  "properties": {
    "nonLoadBasedIndicator": {
      "type": "number",
      "description": "Indicator that represents whether the unit is non-load based.",
      "example": "1"
    },
    "id": {
      "type": "number",
      "description": "Unique identifier for the unit.",
      "example": "1001"
    },
    "unitid": {
      "type": "string",
      "description": "ID of the unit.",
      "example": "UNIT_123"
    },
    "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
    },
    "beginDate": {
      "format": "date-time",
      "type": "string",
      "description": "Date on which information became effective or activity started.",
      "example": "2018-05-01"
    },
    "endDate": {
      "format": "date-time",
      "type": "string",
      "description": "Last date in which information was effective.  This date will be null for active records.",
      "example": null
    },
    "sourceCategoryCd": {
      "type": "string",
      "description": "Category code for the source of the unit.",
      "example": "SRC123"
    },
    "commOpDate": {
      "type": "string",
      "description": "The date when the unit began commercial operation.",
      "example": "01/01/2020"
    },
    "comrOpDate": {
      "type": "string",
      "description": "The date when the unit began compliance operation.",
      "example": "01/01/2020"
    },
    "userId": {
      "type": "string",
      "description": "The ID of the user who created or updated the record.",
      "example": "jdoe"
    },
    "addDate": {
      "type": "string",
      "description": "The date when the unit record was added.",
      "example": "2024-08-29"
    },
    "updateDate": {
      "type": "string",
      "description": "The date when the unit record was last updated.",
      "example": "2024-08-30"
    },
    "opStatusCd": {
      "type": "string",
      "description": "The operational status code of the unit.",
      "example": "OP"
    },
    "statusBeginDate": {
      "type": "string",
      "description": "The date when the current operational status of the unit began.",
      "example": "01/01/2020"
    },
    "unitTypeCd": {
      "type": "string",
      "description": "The type code of the unit.",
      "example": "UBT"
    },
    "auditUser": {
      "type": "string",
      "description": "The user ID of the person who performed the last audit on the unit record.",
      "example": "[email protected]"
    },
    "auditDate": {
      "type": "string",
      "description": "The date and time when the last audit was performed on the unit record.",
      "example": "2023-01-01T00:00:00Z"
    },
    "active": {
      "type": "boolean",
      "description": "Indicates whether the unit is currently active.",
      "example": true
    }
  },
  "required": [
    "nonLoadBasedIndicator",
    "id",
    "unitid",
    "facilityId",
    "beginDate",
    "endDate",
    "userId",
    "addDate"
  ]
}