CAM — Emissions Management

{
  "openapi": "3.0.0",
  "paths": {
    "/emissions-mgmt/health": {
      "get": {
        "operationId": "HealthController_check",
        "parameters": [],
        "responses": {
          "200": {
            "description": "The Health Check is successful",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "example": "ok"
                    },
                    "info": {
                      "type": "object",
                      "example": {
                        "database": {
                          "status": "up"
                        }
                      },
                      "additionalProperties": {
                        "type": "object",
                        "required": [
                          "status"
                        ],
                        "properties": {
                          "status": {
                            "type": "string"
                          }
                        },
                        "additionalProperties": true
                      },
                      "nullable": true
                    },
                    "error": {
                      "type": "object",
                      "example": {},
                      "additionalProperties": {
                        "type": "object",
                        "required": [
                          "status"
                        ],
                        "properties": {
                          "status": {
                            "type": "string"
                          }
                        },
                        "additionalProperties": true
                      },
                      "nullable": true
                    },
                    "details": {
                      "type": "object",
                      "example": {
                        "database": {
                          "status": "up"
                        }
                      },
                      "additionalProperties": {
                        "type": "object",
                        "required": [
                          "status"
                        ],
                        "properties": {
                          "status": {
                            "type": "string"
                          }
                        },
                        "additionalProperties": true
                      }
                    }
                  }
                },
                "examples": {
                  "HealthController_check200Example": {
                    "summary": "Default HealthController_check 200 response",
                    "x-microcks-default": true,
                    "value": {
                      "status": "ok",
                      "message": "Example response"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "The Health Check is not successful",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "example": "error"
                    },
                    "info": {
                      "type": "object",
                      "example": {
                        "database": {
                          "status": "up"
                        }
                      },
                      "additionalProperties": {
                        "type": "object",
                        "required": [
                          "status"
                        ],
                        "properties": {
                          "status": {
                            "type": "string"
                          }
                        },
                        "additionalProperties": true
                      },
                      "nullable": true
                    },
                    "error": {
                      "type": "object",
                      "example": {
                        "redis": {
                          "status": "down",
                          "message": "Could not connect"
                        }
                      },
                      "additionalProperties": {
                        "type": "object",
                        "required": [
                          "status"
                        ],
                        "properties": {
                          "status": {
                            "type": "string"
                          }
                        },
                        "additionalProperties": true
                      },
                      "nullable": true
                    },
                    "details": {
                      "type": "object",
                      "example": {
                        "database": {
                          "status": "up"
                        },
                        "redis": {
                          "status": "down",
                          "message": "Could not connect"
                        }
                      },
                      "additionalProperties": {
                        "type": "object",
                        "required": [
                          "status"
                        ],
                        "properties": {
                          "status": {
                            "type": "string"
                          }
                        },
                        "additionalProperties": true
                      }
                    }
                  }
                },
                "examples": {
                  "HealthController_check503Example": {
                    "summary": "Default HealthController_check 503 response",
                    "x-microcks-default": true,
                    "value": {
                      "status": "ok",
                      "message": "Example response"
                    }
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Health"
        ],
        "x-microcks-operation": {
          "delay": 0,
          "dispatcher": "FALLBACK"
        }
      }
    },
    "/emissions-mgmt/emissions/export": {
      "get": {
        "operationId": "EmissionsController_export",
        "parameters": [
          {
            "name": "monitorPlanId",
            "required": true,
            "in": "query",
            "schema": {
              "type": "string"
            },
            "example": "12345"
          },
          {
            "name": "year",
            "required": true,
            "in": "query",
            "schema": {
              "type": "number"
            },
            "example": 2024
          },
          {
            "name": "quarter",
            "required": true,
            "in": "query",
            "schema": {
              "type": "number"
            },
            "example": 0.0
          },
          {
            "name": "reportedValuesOnly",
            "required": false,
            "in": "query",
            "schema": {
              "type": "boolean"
            },
            "example": true
          }
        ],
        "responses": {
          "200": {
            "description": "Successfull export of emissions data",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/EmissionsDTO"
                    },
                    {
                      "$ref": "#/components/schemas/EmissionsImportDTO"
                    }
                  ]
                },
                "examples": {
                  "fullExport": {
                    "summary": "Full Export",
                    "description": "Full export of all data including database primary keys, calculated values, & audit properties",
                    "value": "Reference EmissionsDTO schema for definition"
                  },
                  "reportedValuesExport": {
                    "summary": "Reported Values Export",
                    "description": "Export of reported values only matching import schema",
                    "value": "Reference EmissionsImportDTO schema for definition"
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "APIKey": []
          }
        ],
        "summary": "Exports Emissions Data for the Specified Monitor Plan & Reporting Period",
        "tags": [
          "Emissions"
        ],
        "x-microcks-operation": {
          "delay": 0,
          "dispatcher": "FALLBACK"
        }
      }
    },
    "/emissions-mgmt/emissions/submission-progress": {
      "get": {
        "operationId": "EmissionsController_submissionProgress",
        "parameters": [
          {
            "name": "submissionPeriod",
            "required": true,
            "in": "query",
            "description": "Date on which activity occurred.",
            "schema": {
              "format": "date",
              "example": "2019-01-01",
              "type": "string"
            },
            "example": "2019-01-01"
          }
        ],
        "responses": {
          "200": {
            "description": "Retrieve submissions for current time period"
          }
        },
        "security": [
          {
            "APIKey": []
          }
        ],
        "tags": [
          "Emissions"
        ],
        "x-microcks-operation": {
          "delay": 0,
          "dispatcher": "FALLBACK"
        }
      }
    },
    "/emissions-mgmt/emissions": {
      "get": {
        "operationId": "EmissionsController_getEmissions",
        "parameters": [
          {
            "name": "orisCodes",
            "required": true,
            "in": "query",
            "description": "Array of oris codes",
            "style": "pipeDelimited",
            "explode": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "number"
              }
            },
            "example": [
              0.0
            ]
          },
          {
            "name": "monPlanIds",
            "required": false,
            "in": "query",
            "description": "Array of configurations",
            "style": "pipeDelimited",
            "explode": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "example": [
              "12345"
            ]
          },
          {
            "name": "quarters",
            "required": true,
            "in": "query",
            "description": "Array of quarter abbreviations",
            "style": "pipeDelimited",
            "explode": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "example": [
              "string"
            ]
          },
          {
            "name": "mode",
            "required": false,
            "in": "query",
            "description": "Flag to indicate the mode of operation",
            "schema": {
              "type": "string",
              "enum": [
                "report",
                "evaluate",
                "submit"
              ]
            },
            "example": "report"
          }
        ],
        "responses": {
          "200": {
            "description": "Retrieves emissions review and submit records",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "items": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/EmissionsReviewDTO"
                      }
                    }
                  }
                },
                "examples": {
                  "EmissionsController_getEmissions200Example": {
                    "summary": "Default EmissionsController_getEmissions 200 response",
                    "x-microcks-default": true,
                    "value": {
                      "status": "ok",
                      "message": "Example response"
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "APIKey": []
          }
        ],
        "tags": [
          "Emissions"
        ],
        "x-microcks-operation": {
          "delay": 0,
          "dispatcher": "FALLBACK"
        }
      }
    },
    "/emissions-mgmt/emissions/views": {
      "get": {
        "operationId": "EmissionsViewController_getAvailableViews",
        "parameters": [],
        "responses": {
          "200": {
            "description": "Retrieves a list of official Emissions data views that are available",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "items": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/EmissionsViewDTO"
                      }
                    }
                  }
                },
                "examples": {
                  "EmissionsViewController_getAvailableViews200Example": {
                    "summary": "Default EmissionsViewController_getAvailableViews 200 response",
                    "x-microcks-default": true,
                    "value": {
                      "status": "ok",
                      "message": "Example response"
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "APIKey": []
          }
        ],
        "tags": [
          "Emissions Views"
        ],
        "x-microcks-operation": {
          "delay": 0,
          "dispatcher": "FALLBACK"
        }
      }
    },
    "/emissions-mgmt/emissions/views/{viewCode}": {
      "get": {
        "operationId": "EmissionsViewController_getView",
        "parameters": [
          {
            "name": "viewCode",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            },
            "example": "string"
          },
          {
            "name": "monitorPlanId",
            "required": true,
            "in": "query",
            "schema": {
              "type": "string"
            },
            "example": "12345"
          },
          {
            "name": "unitIds",
            "required": false,
            "in": "query",
            "description": "Unique identifier for each unit at a facility.",
            "style": "pipeDelimited",
            "explode": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "example": [
              "12345"
            ]
          },
          {
            "name": "stackPipeIds",
            "required": false,
            "in": "query",
            "description": "This is the alphanumeric code assigned by a source to identify a multiple or common stack or pipe at which emissions are determined.",
            "style": "pipeDelimited",
            "explode": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "example": [
              "12345"
            ]
          },
          {
            "name": "reportingPeriod",
            "required": true,
            "in": "query",
            "style": "pipeDelimited",
            "explode": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "example": [
              "string"
            ]
          },
          {
            "name": "attachFile",
            "required": false,
            "in": "query",
            "description": "Attaches a file with data in the format specified by the Accept header",
            "schema": {
              "default": false,
              "type": "boolean"
            },
            "example": true
          }
        ],
        "responses": {
          "200": {
            "description": "Retrieves the specified view of official Emissions data for the provided Monitor Plan & Reporting Period",
            "content": {
              "application/json": {
                "examples": {
                  "EmissionsViewController_getView200Example": {
                    "summary": "Default EmissionsViewController_getView 200 response",
                    "x-microcks-default": true,
                    "value": {
                      "status": "ok",
                      "message": "Example response"
                    }
                  }
                }
              },
              "text/csv": {
                "examples": {
                  "EmissionsViewController_getView200Example": {
                    "summary": "Default EmissionsViewController_getView 200 response",
                    "x-microcks-default": true,
                    "value": {
                      "status": "ok",
                      "message": "Example response"
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "APIKey": []
          }
        ],
        "tags": [
          "Emissions Views"
        ],
        "x-microcks-operation": {
          "delay": 0,
          "dispatcher": "FALLBACK"
        }
      }
    },
    "/emissions-mgmt/emissions/apportioned/attributes/applicable": {
      "get": {
        "operationId": "ApportionedEmissionsController_getApplicableApportionedEmissionsAttributes",
        "parameters": [
          {
            "name": "year",
            "required": true,
            "in": "query",
            "description": "The calendar year during which activity occurred.",
            "style": "pipeDelimited",
            "explode": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "number"
              }
            },
            "example": [
              2024
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Retrieves Applicable Emissions Attributes",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "items": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/ApplicableApportionedEmissionsAttributesDTO"
                      }
                    }
                  }
                },
                "examples": {
                  "ApportionedEmissionsController_getApplicableApportionedEmissionsAttributes200Example": {
                    "summary": "Default ApportionedEmissionsController_getApplicableApportionedEmissionsAttributes 200 response",
                    "x-microcks-default": true,
                    "value": {
                      "status": "ok",
                      "message": "Example response"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Invalid Request"
          },
          "404": {
            "description": "Resource Not Found"
          }
        },
        "security": [
          {
            "APIKey": []
          }
        ],
        "tags": [
          "Apportioned Emissions"
        ],
        "x-microcks-operation": {
          "delay": 0,
          "dispatcher": "FALLBACK"
        }
      }
    },
    "/emissions-mgmt/emissions/apportioned/hourly": {
      "get": {
        "operationId": "HourlyApportionedEmissionsController_getEmissions",
        "parameters": [
          {
            "name": "stateCode",
            "required": false,
            "in": "query",
            "description": "Two letter abbreviation for the State.",
            "style": "pipeDelimited",
            "explode": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "AL",
                  "AK",
                  "AS",
                  "AZ",
                  "AR",
                  "CA",
                  "CO",
                  "CT",
                  "DE",
                  "DC",
                  "FM",
                  "FL",
                  "GA",
                  "GU",
                  "HI",
                  "ID",
                  "IL",
                  "IN",
                  "IA",
                  "KS",
                  "KY",
                  "LA",
                  "ME",
                  "MH",
                  "MD",
                  "MA",
                  "MI",
                  "MN",
                  "MS",
                  "MO",
                  "MT",
                  "NE",
                  "NV",
                  "NH",
                  "NJ",
                  "NM",
                  "NY",
                  "NC",
                  "ND",
                  "MP",
                  "OH",
                  "OK",
                  "OR",
                  "PW",
                  "PA",
                  "PR",
                  "RI",
                  "SC",
                  "SD",
                  "TN",
                  "TX",
                  "UT",
                  "VT",
                  "VI",
                  "VA",
                  "WA",
                  "WV",
                  "WI",
                  "WY"
                ]
              }
            },
            "example": [
              "AL"
            ]
          },
          {
            "name": "facilityId",
            "required": false,
            "in": "query",
            "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.",
            "style": "pipeDelimited",
            "explode": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "number"
              }
            },
            "example": [
              0.0
            ]
          },
          {
            "name": "unitType",
            "required": false,
            "in": "query",
            "description": "Type of unit or boiler.",
            "style": "pipeDelimited",
            "explode": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "Arch-fired boiler",
                  "Bubbling fluidized bed boiler",
                  "Cyclone boiler",
                  "Cell burner boiler",
                  "Combined cycle",
                  "Circulating fluidized bed boiler",
                  "Combustion turbine",
                  "Dry bottom wall-fired boiler",
                  "Dry bottom turbo-fired boiler",
                  "Dry bottom vertically-fired boiler",
                  "Internal combustion engine",
                  "Integrated gasification combined cycle",
                  "Cement Kiln",
                  "Other boiler",
                  "Other turbine",
                  "Pressurized fluidized bed boiler",
                  "Process Heater",
                  "Stoker",
                  "Tangentially-fired",
                  "Wet bottom wall-fired boiler",
                  "Wet bottom turbo-fired boiler",
                  "Wet bottom vertically-fired boiler"
                ]
              }
            },
            "example": [
              "Arch-fired boiler"
            ]
          },
          {
            "name": "unitFuelType",
            "required": false,
            "in": "query",
            "description": "Primary or Secondary fuel types combusted by the unit.",
            "style": "pipeDelimited",
            "explode": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "Coal",
                  "Coal Refuse",
                  "Diesel Oil",
                  "Liquified Petroleum Gas",
                  "Natural Gas",
                  "Other Gas",
                  "Other Oil",
                  "Other Solid Fuel",
                  "Petroleum Coke",
                  "Pipeline Natural Gas",
                  "Process Gas",
                  "Process Sludge",
                  "Refuse",
                  "Residual Oil",
                  "Tire Derived Fuel",
                  "Waste Liquid",
                  "Wood"
                ]
              }
            },
            "example": [
              "Coal"
            ]
          },
          {
            "name": "controlTechnologies",
            "required": false,
            "in": "query",
            "description": "Method or equipment used by the combustion unit to minimize Hg, NOx, PM, or SO2 emissions.",
            "style": "pipeDelimited",
            "explode": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "Additives to Enhance PAC and Existing Equipment Performance",
                  "Ammonia Injection",
                  "Baghouse",
                  "Catalyst (gold, palladium, or other) used to oxidize mercury",
                  "Combustion Modification/Fuel Reburning",
                  "Cyclone",
                  "Dry Lime FGD",
                  "Dry Low NOx Burners",
                  "Dry Sorbent Injection",
                  "Dual Alkali",
                  "Electrostatic Precipitator",
                  "Fluidized Bed Limestone Injection",
                  "Halogenated PAC Sorbent Injection",
                  "Hybrid ESP",
                  "Low NOx Burner Technology (Dry Bottom only)",
                  "Low NOx Burner Technology w/ Closed-coupled OFA",
                  "Low NOx Burner Technology w/ Closed-coupled/Separated OFA",
                  "Low NOx Burner Technology w/ Overfire Air",
                  "Low NOx Burner Technology w/ Separated OFA",
                  "Low NOx Cell Burner",
                  "Magnesium Oxide",
                  "Other",
                  "Other (Non PAC) Sorbent Injection",
                  "Overfire Air",
                  "Regenerative Activated Coke Technology",
                  "Selective Catalytic Reduction",
                  "Selective Non-catalytic Reduction",
                  "Sodium Based",
                  "Steam Injection",
                  "Untreated PAC Sorbent Injection",
                  "Water Injection",
                  "Wet ESP",
                  "Wet Lime FGD",
                  "Wet Limestone",
                  "Wet Scrubber"
                ]
              }
            },
            "example": [
              "Additives to Enhance PAC and Existing Equipment Performance"
            ]
          },
          {
            "name": "programCodeInfo",
            "required": false,
            "in": "query",
            "description": "Statutory or regulatory based options for tracking and reducing air pollution emissions.",
            "style": "pipeDelimited",
            "explode": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "ARP",
                  "CAIRNOX",
                  "CAIROS",
                  "CAIRSO2",
                  "CSNOX",
                  "CSNOXOS",
                  "CSOSG1",
                  "CSOSG2",
                  "CSOSG2E",
                  "CSOSG3",
                  "CSSO2G1",
                  "CSSO2G2",
                  "NBP",
                  "NHNOX",
                  "NSPS4T",
                  "OTC",
                  "RGGI",
                  "SIPNOX",
                  "TXSO2"
                ]
              }
            },
            "example": [
              "ARP"
            ]
          },
          {
            "name": "beginDate",
            "required": true,
            "in": "query",
            "description": "Begin date for a given period of a unit's emissions.",
            "schema": {
              "format": "date-time",
              "type": "string"
            },
            "example": "2024-01-15T12:00:00Z"
          },
          {
            "name": "endDate",
            "required": true,
            "in": "query",
            "description": "End date for a given period of a unit's emissions.",
            "schema": {
              "format": "date-time",
              "type": "string"
            },
            "example": "2024-01-15T12:00:00Z"
          },
          {
            "name": "operatingHoursOnly",
            "required": false,
            "in": "query",
            "description": "Indicator of whether or not a request should return only data for hours where a unit operated.",
            "schema": {
              "type": "boolean"
            },
            "example": true
          },
          {
            "name": "locationName",
            "required": false,
            "in": "query",
            "style": "pipeDelimited",
            "explode": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "example": [
              "EPA Facility"
            ]
          },
          {
            "name": "page",
            "required": true,
            "in": "query",
            "description": "Page number of data being requested.",
            "schema": {
              "type": "number"
            },
            "example": 0.0
          },
          {
            "name": "perPage",
            "required": true,
            "in": "query",
            "description": "Number of results per page.",
            "schema": {
              "type": "number"
            },
            "example": 0.0
          }
        ],
        "responses": {
          "200": {
            "description": "Retrieves Hourly Apportioned Emissions per filter criteria",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "items": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/HourUnitDataView"
                      }
                    }
                  }
                },
                "examples": {
                  "HourlyApportionedEmissionsController_getEmissions200Example": {
                    "summary": "Default HourlyApportionedEmissionsController_getEmissions 200 response",
                    "x-microcks-default": true,
                    "value": {
                      "status": "ok",
                      "message": "Example response"
                    }
                  }
                }
              },
              "text/csv": {
                "schema": {
                  "type": "string",
                  "example": "State,Facility Name,Facility ID,Unit ID,unit_id,Associated Stacks,Date,Hour,Operating Time,Gross Load (MW),Steam Load (1000 lb/hr),SO2 Mass (lbs),SO2 Mass Meas

# --- truncated at 32 KB (410 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/epa/refs/heads/main/openapi/cam-emissions-openapi.json