CAM — Account Management

{
  "openapi": "3.0.0",
  "paths": {
    "/account-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"
        }
      }
    },
    "/account-mgmt/allowance-holdings": {
      "get": {
        "operationId": "AllowanceHoldingsController_getAllowanceHoldings",
        "parameters": [
          {
            "name": "accountType",
            "required": false,
            "in": "query",
            "description": "Type of allowance account (Facility, General, etc.).",
            "style": "pipeDelimited",
            "explode": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "Compliance Assurance Surrender Account",
                  "Enforcement Surrender Account",
                  "Facility Account",
                  "General Account",
                  "Overdraft Account",
                  "EPA Reserve Account",
                  "State Early Reduction Reserve Account",
                  "State General Reserve Account",
                  "State Holding Account",
                  "New Unit Set Aside Reserve Account",
                  "State Opt-In Reserve Account",
                  "State Other Reserve Account",
                  "State Primary Reserve Account",
                  "State Retirement Account",
                  "Surrender Account",
                  "Unit Account",
                  "Voluntary Surrender Account"
                ]
              }
            },
            "example": [
              "Compliance Assurance Surrender Account"
            ]
          },
          {
            "name": "accountNumber",
            "required": false,
            "in": "query",
            "description": "The unique identification number of an account.",
            "style": "pipeDelimited",
            "explode": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "example": [
              "string"
            ]
          },
          {
            "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": "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": "vintageYear",
            "required": false,
            "in": "query",
            "description": "Year allowance becomes eligible for use in compliance.",
            "style": "pipeDelimited",
            "explode": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "number"
              }
            },
            "example": [
              2024
            ]
          },
          {
            "name": "ownerOperator",
            "required": false,
            "in": "query",
            "description": "The name of any company that owns an allowance account or an affected unit.The name of any company that operates an affected unit.",
            "style": "pipeDelimited",
            "explode": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "example": [
              "string"
            ]
          },
          {
            "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",
                  "CSNOX",
                  "CSOSG1",
                  "CSOSG2",
                  "CSOSG2E",
                  "CSOSG3",
                  "CSSO2G1",
                  "CSSO2G2",
                  "TXSO2"
                ]
              }
            },
            "example": [
              "ARP"
            ]
          },
          {
            "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": "Retrieve Allowance Holdings per filter criteria",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "items": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/AllowanceHoldingsDTO"
                      }
                    }
                  }
                },
                "examples": {
                  "AllowanceHoldingsController_getAllowanceHoldings200Example": {
                    "summary": "Default AllowanceHoldingsController_getAllowanceHoldings 200 response",
                    "x-microcks-default": true,
                    "value": {
                      "status": "ok",
                      "message": "Example response"
                    }
                  }
                }
              },
              "text/csv": {
                "schema": {
                  "type": "string",
                  "example": "Account Number,Account Name,Facility ID,Program Code,Allowance Vintage Year,Allowance Block Total,Serial Number Start,Serial Number End,State,EPA Region,Owner/Operator,Account Type"
                },
                "examples": {
                  "AllowanceHoldingsController_getAllowanceHoldings200Example": {
                    "summary": "Default AllowanceHoldingsController_getAllowanceHoldings 200 response",
                    "x-microcks-default": true,
                    "value": {
                      "status": "ok",
                      "message": "Example response"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Invalid Request"
          },
          "404": {
            "description": "Resource Not Found"
          }
        },
        "security": [
          {
            "APIKey": []
          }
        ],
        "tags": [
          "Allowance Holdings"
        ],
        "x-microcks-operation": {
          "delay": 0,
          "dispatcher": "FALLBACK"
        }
      }
    },
    "/account-mgmt/allowance-holdings/attributes/applicable": {
      "get": {
        "operationId": "AllowanceHoldingsController_getAllApplicableAllowanceHoldingsAttributes",
        "parameters": [],
        "responses": {
          "200": {
            "description": "Retrieved All Applicable Allowance Holdings Attributes",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "items": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/ApplicableAllowanceHoldingsAttributesDTO"
                      }
                    }
                  }
                },
                "examples": {
                  "AllowanceHoldingsController_getAllApplicableAllowanceHoldingsAttributes200Example": {
                    "summary": "Default AllowanceHoldingsController_getAllApplicableAllowanceHoldingsAttributes 200 response",
                    "x-microcks-default": true,
                    "value": {
                      "status": "ok",
                      "message": "Example response"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Invalid Request"
          },
          "404": {
            "description": "Resource Not Found"
          }
        },
        "security": [
          {
            "APIKey": []
          }
        ],
        "tags": [
          "Allowance Holdings"
        ],
        "x-microcks-operation": {
          "delay": 0,
          "dispatcher": "FALLBACK"
        }
      }
    },
    "/account-mgmt/allowance-holdings/owner-operators": {
      "get": {
        "operationId": "AllowanceHoldingsController_getAllOwnerOperators",
        "parameters": [],
        "responses": {
          "200": {
            "description": "Retrieved All Valid Owner Operators",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "items": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/OwnerOperatorsDTO"
                      }
                    }
                  }
                },
                "examples": {
                  "AllowanceHoldingsController_getAllOwnerOperators200Example": {
                    "summary": "Default AllowanceHoldingsController_getAllOwnerOperators 200 response",
                    "x-microcks-default": true,
                    "value": {
                      "status": "ok",
                      "message": "Example response"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Invalid Request"
          },
          "404": {
            "description": "Resource Not Found"
          }
        },
        "security": [
          {
            "APIKey": []
          }
        ],
        "tags": [
          "Allowance Holdings"
        ],
        "x-microcks-operation": {
          "delay": 0,
          "dispatcher": "FALLBACK"
        }
      }
    },
    "/account-mgmt/allowance-transactions": {
      "get": {
        "operationId": "AllowanceTransactionsController_getAllowanceTransactions",
        "parameters": [
          {
            "name": "accountType",
            "required": false,
            "in": "query",
            "description": "Type of allowance account (Facility, General, etc.).",
            "style": "pipeDelimited",
            "explode": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "Compliance Assurance Surrender Account",
                  "Enforcement Surrender Account",
                  "Facility Account",
                  "General Account",
                  "Overdraft Account",
                  "EPA Reserve Account",
                  "State Early Reduction Reserve Account",
                  "State General Reserve Account",
                  "State Holding Account",
                  "New Unit Set Aside Reserve Account",
                  "State Opt-In Reserve Account",
                  "State Other Reserve Account",
                  "State Primary Reserve Account",
                  "State Retirement Account",
                  "Surrender Account",
                  "Unit Account",
                  "Voluntary Surrender Account"
                ]
              }
            },
            "example": [
              "Compliance Assurance Surrender Account"
            ]
          },
          {
            "name": "accountNumber",
            "required": false,
            "in": "query",
            "description": "The unique identification number of an account.",
            "style": "pipeDelimited",
            "explode": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "example": [
              "string"
            ]
          },
          {
            "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": "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": "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",
                  "OTC",
                  "TXSO2"
                ]
              }
            },
            "example": [
              "ARP"
            ]
          },
          {
            "name": "ownerOperator",
            "required": false,
            "in": "query",
            "description": "The name of any company that owns an allowance account or an affected unit.The name of any company that operates an affected unit.",
            "style": "pipeDelimited",
            "explode": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "example": [
              "string"
            ]
          },
          {
            "name": "transactionBeginDate",
            "required": true,
            "in": "query",
            "description": "Begin date for a given period of an account's allowance transaction history.",
            "schema": {
              "format": "date-time",
              "type": "string"
            },
            "example": "2024-01-15T12:00:00Z"
          },
          {
            "name": "transactionEndDate",
            "required": true,
            "in": "query",
            "description": "End date for a given period of an account's allowance transaction history.",
            "schema": {
              "format": "date-time",
              "type": "string"
            },
            "example": "2024-01-15T12:00:00Z"
          },
          {
            "name": "transactionType",
            "required": false,
            "in": "query",
            "description": "The type of allowance transaction (e.g. initial allocation, private transaction, etc.).",
            "style": "pipeDelimited",
            "explode": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "Activate Conditional Allowances",
                  "CAIROS Transfer from NBP",
                  "Compliance Assurance Surrender",
                  "Conservation Issuance",
                  "Contribute to Auction",
                  "Conversion of NBP allowances into CAIROS",
                  "CSAPR Ozone Season Emissions Adjustment Deduction",
                  "CSAPR Ozone Season Offset/Penalty Deduction",
                  "Deduction of Loaned Allowances",
                  "Distribute Allowances for New Program",
                  "Distribute Allowances for Revised CSAPR Update",
                  "Distribute Revintaged Allowances",
                  "Distribute Revintaged Allowances for Revised CSAPR Update",
                  "Early Reduction Issuance",
                  "Emissions Adjustment Deduction",
                  "Emissions Deduction",
                  "Energy Biomass Issuance",
                  "Energy Geothermal Issuance",
                  "Energy Solar Issuance",
                  "Energy Wind Issuance",
                  "Enforcement Surrender",
                  "Error Correction",
                  "Error Reversal",
                  "Initial Allocation",
                  "Internal Transfer to Reduce Offset",
                  "July Confirmation Credit",
                  "July Confirmation Deduction",
                  "NBP Additional Emissions Deduction from CAIROS Account",
                  "NBP Penalty Deduction From CAIROS Account",
                  "New Unit Set Aside Allocation",
                  "Offset/Penalty Deduction",
                  "Opt-In Allocation",
                  "Opt-in Transfer to Replacement Unit",
                  "Other Reserve Allocation",
                  "Phase 1 Extension Control Failure Deduction",
                  "Phase 1 Extension Issuance",
                  "Phase 1 Extension Projected Emission Deduction",
                  "Phase 2 Early Reduction Payback",
                  "Private Transfer",
                  "Purchase at EPA Auction",
                  "Purchase at Private Auction",
                  "Reallocation Surrender",
                  "Reallocation Transfer",
                  "Recall State Program Allowances",
                  "Reduced Utilization Issuance",
                  "Reduced Utilization Payback",
                  "Reduced Utilization Termination",
                  "Remove for Reissuance",
                  "Remove for Revised CSAPR Update Reissuance",
                  "Return Contributed Allowances",
                  "Return of CAIR Allowances",
                  "Return of Unsold Allowances from EPA Auction Reserve",
                  "Return of unused allowances from the Conservation and Renewable Energy Reserve",
                  "Reverse Reduced Utilization Payback",
                  "Reverse Substitution Payback",
                  "Small Diesel Issuance",
                  "State Cap Deduction",
                  "State Cap Issuance",
                  "State Cap Payback",
                  "State Reallocation",
                  "Substitution Control by Contract Deduction",
                  "Substitution Distribution",
                  "Substitution Issuance",
                  "Substitution Payback",
                  "Substitution Termination",
                  "Takeback for Underutilization",
                  "Terminate NOx Budget Programs Allowances",
                  "Terminate State Program Allowances",
                  "Terminate to CAIROS",
                  "Termination of NBP allowances into CAIROS",
                  "Transfer Due to Corrected Energy Conservation",
                  "Transfer from Direct Sale to Auction",
                  "Transfer from Legacy System",
                  "Underutilization Deduction",
                  "Voluntary Surrender"
                ]
              }
            },
            "example": [
              "Activate Conditional Allowances"
            ]
          },
          {
            "name": "vintageYear",
            "required": false,
            "in": "query",
            "description": "Year allowance becomes eligible for use in compliance.",
            "style": "pipeDelimited",
            "explode": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "number"
              }
            },
            "example": [
              2024
            ]
          },
          {
            "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 Allowance Transactions per filter criteria",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "items": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/AllowanceTransactionsDTO"
                      }
                    }
                  }
                },
                "examples": {
                  "AllowanceTransactionsController_getAllowanceTransactions200Example": {
                    "summary": "Default AllowanceTransactionsController_getAllowanceTransactions 200 response",
                    "x-microcks-default": true,
                    "value": {
             

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