openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 173 kB

JSON

{"openapi":"3.0.0","info":{"contact":{"name":"US EPA, OECA Integration, Targeting and Access Branch"},"description":"Enforcement and Compliance History Online (ECHO) is a tool developed and maintained by EPA's Office of Enforcement and Compliance Assurance for public use. ECHO provides integrated compliance and enforcement information for over 1 million regulated facilities nationwide.\n CASE Rest Services provide multiple service endpoints, each with specific capabilities, to search and retrieve data on civil cases entered into the \nIntegrated Compliance Information System (ICIS) and criminal cases entered into the Summary of Criminal Prosecutions database. \nSee Enforcement Case Search Help (https://echo.epa.gov/help/enforcement-case-search-help) for additional information on searching civil and criminal cases. \n\\\nThe get_cases, get_map, get_qid, and get_download end points are meant to be used together, while the enhanced get_case_info end point is self contained.. \nThe recommended use scenario for get_cases, get_qid, get_map, and get_downoad is:\n\\\n 1) Use get_cases to validate passed query parameters, obtain summary statistics and to obtain a query_id (QID). QIDs are time sensitive and will be valid for approximately 30 minutes.\n 2) Use get_qid, with the returned QID, to paginate through arrays of case results.\n 3) Use get_map, with the returned QID, to zoom in/out and pan on the clustered and individual facility coordinates, related to the returned cases, that meet the QID query criteria.\n 4) Use get_download, with the returned QID, to generate a Comma Separated Value (CSV) file of facility information that meets the QID query criteria.\n\\\nIn addition to the service endpoints listed above there are two detailed case report services, one for civil cases (get_case_report) and one for criminal cases (get_crcase_report). \nSee the Civil Enforcement Case Report Help (https://echo.epa.gov/help/reports/enforcement-case-report-help) and the Criminal Case Report Help (https://echo.epa.gov/help/reports/criminal-case-report-help) for additional information \non then data returned from these two services. \n\\\nAdditional ECHO Resources: <a href=\"https://echo.epa.gov/tools/web-services\">Web Services</a>, <a href=\"https://echo.epa.gov/resources/echo-data/about-the-data\">About ECHO's Data</a>, <a href=\"https://echo.epa.gov/tools/data-downloads\">Data Downloads</a>\n ","license":{"name":"This page was built with the Swagger API.","url":"https://swagger.io"},"title":"U.S. EPA Enforcement and Compliance History Online (ECHO) - Enforcement Case Search","version":"1.0.0","x-apisguru-categories":["open_data"],"x-logo":{"backgroundColor":"#FFFFFF","url":"https://pbs.twimg.com/profile_images/632233890594299904/DgRDU6dx_400x400.png"},"x-origin":[{"format":"swagger","url":"https://ofmpub.epa.gov/echo/swaggerx.swagger_json?p_prefix=CASE","version":"2.0"}],"x-providerName":"epa.gov","x-serviceName":"case"},"paths":{"/case_rest_services.get_case_info":{"get":{"description":"The get_case_info service end point searches for civil enforcement and criminal cases based on the provided selection criteria and returns either individual cases or clusters of case facility locations.","parameters":[{"description":"Output Format Flag. Enter one of the following keywords:\n- JSON = Data model formatted as Javascript Object Notation (default).\n- JSONP = Data model formatted as Javascript Object Notation with Padding. \n- XML = Data model formatted as Extensible Markup Language.","in":"query","name":"output","required":false,"schema":{"type":"string","enum":["JSONP","JSON","XML"]}},{"$ref":"#/components/parameters/q.p_case_category"},{"$ref":"#/components/parameters/q.p_case_status"},{"$ref":"#/components/parameters/q.p_milestone"},{"$ref":"#/components/parameters/q.p_from_date"},{"$ref":"#/components/parameters/q.p_to_date"},{"$ref":"#/components/parameters/q.p_milestone_fy"},{"$ref":"#/components/parameters/q.p_name"},{"$ref":"#/components/parameters/q.p_name_type"},{"$ref":"#/components/parameters/q.p_case_number"},{"$ref":"#/components/parameters/q.p_docket_number"},{"$ref":"#/components/parameters/q.p_court_docket_number"},{"$ref":"#/components/parameters/q.p_activity_number"},{"$ref":"#/components/parameters/q.p_case_lead"},{"$ref":"#/components/parameters/q.p_case_sens_flg"},{"$ref":"#/components/parameters/q.p_region"},{"$ref":"#/components/parameters/q.p_state"},{"$ref":"#/components/parameters/q.p_district"},{"$ref":"#/components/parameters/q.p_sic"},{"$ref":"#/components/parameters/q.p_sic_ao_naics"},{"$ref":"#/components/parameters/q.p_sic_primary_flg"},{"$ref":"#/components/parameters/q.p_sic_frs_flg"},{"$ref":"#/components/parameters/q.p_naics"},{"$ref":"#/components/parameters/q.p_naics_primary_flg"},{"$ref":"#/components/parameters/q.p_naics_frs_flg"},{"$ref":"#/components/parameters/q.p_enf_type"},{"$ref":"#/components/parameters/q.p_law"},{"$ref":"#/components/parameters/q.p_section"},{"$ref":"#/components/parameters/q.p_cp_citation"},{"$ref":"#/components/parameters/q.p_rank_order"},{"$ref":"#/components/parameters/q.p_enf_program"},{"$ref":"#/components/parameters/q.p_violation"},{"$ref":"#/components/parameters/q.p_priority_area"},{"$ref":"#/components/parameters/q.p_priority_area_desc"},{"$ref":"#/components/parameters/q.p_tribal"},{"$ref":"#/components/parameters/q.p_oeca_core"},{"$ref":"#/components/parameters/q.p_multimedia"},{"$ref":"#/components/parameters/q.p_fed_case"},{"$ref":"#/components/parameters/q.p_activity_contact"},{"$ref":"#/components/parameters/q.p_role"},{"$ref":"#/components/parameters/q.p_fed_penalty"},{"$ref":"#/components/parameters/q.p_total_fed_penalty"},{"$ref":"#/components/parameters/q.p_cost_recovery"},{"$ref":"#/components/parameters/q.p_total_cost_recovery"},{"$ref":"#/components/parameters/q.p_complying_actions"},{"$ref":"#/components/parameters/q.p_comp_act_val"},{"$ref":"#/components/parameters/q.p_total_comp_act_val"},{"$ref":"#/components/parameters/q.p_sep_cats"},{"$ref":"#/components/parameters/q.p_sep_val"},{"$ref":"#/components/parameters/q.p_total_sep_val"},{"$ref":"#/components/parameters/q.p_lodged_date"},{"$ref":"#/components/parameters/q.p_entered_date"},{"$ref":"#/components/parameters/q.p_facility_id"},{"$ref":"#/components/parameters/q.p_fac_city"},{"$ref":"#/components/parameters/q.p_fac_zip"},{"$ref":"#/components/parameters/q.p_fac_county"},{"$ref":"#/components/parameters/q.p_case_summary"},{"$ref":"#/components/parameters/q.p_case_summary_type"},{"$ref":"#/components/parameters/q.p_usmex"},{"$ref":"#/components/parameters/q.p_c1lat"},{"$ref":"#/components/parameters/q.p_c1lon"},{"$ref":"#/components/parameters/q.p_c2lat"},{"$ref":"#/components/parameters/q.p_c2lon"},{"$ref":"#/components/parameters/q.p_voluntary"},{"$ref":"#/components/parameters/q.p_fed_indicator"},{"$ref":"#/components/parameters/q.p_fntype"},{"$ref":"#/components/parameters/q.p_civil_criminal_indicator"},{"$ref":"#/components/parameters/q.queryset"},{"$ref":"#/components/parameters/q.responseset"},{"$ref":"#/components/parameters/q.mapset"},{"$ref":"#/components/parameters/q.callback"},{"$ref":"#/components/parameters/q.qcolumns"},{"$ref":"#/components/parameters/q.p_pretty_print"},{"$ref":"#/components/parameters/q.p_ocmap_fy"},{"$ref":"#/components/parameters/q.p_qs"},{"$ref":"#/components/parameters/q.p_has_map"}],"responses":{"200":{"description":"Returns an array of cases that meet the selection criteria.","content":{"application/json":{"schema":{"description":"Root Object","properties":{"Results":{"$ref":"#/components/schemas/crs0_get_case_info.Results"}},"required":["Results"],"type":"object","xml":{"name":"Case"}}},"application/xml":{"schema":{"description":"Root Object","properties":{"Results":{"$ref":"#/components/schemas/crs0_get_case_info.Results"}},"required":["Results"],"type":"object","xml":{"name":"Case"}}}}}},"summary":"Enforcement Case Search (new version)","tags":["Case Enforcement"]},"post":{"description":"The get_case_info service end point searches for civil enforcement and criminal cases based on the provided selection criteria and returns either individual cases or clusters of case facility locations.","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"output":{"description":"Output Format Flag. Enter one of the following keywords:\n- JSON = Data model formatted as Javascript Object Notation (default).\n- JSONP = Data model formatted as Javascript Object Notation with Padding. \n- XML = Data model formatted as Extensible Markup Language.","type":"string","enum":["JSONP","JSON","XML"]},"p_case_category":{"description":"Case Category Filter. Enter one or more case category codes to filter results. Provide multiple values as a comma-delimited list.\n- AFR = Administrative - Formal\n- AIF = Administrative - Informal\n- JDC = Judicial","type":"string"},"p_case_status":{"description":"Case Status Code Filter. Enter one or more case status codes to limit results. Provide multiple values as a comma-delimited list.","type":"string"},"p_milestone":{"description":"Administrative or Judicial Milestone Filter. Enter one or milestone values to restrict results. Provide multiple values as a comma-delimited list.","type":"string"},"p_from_date":{"description":"Administrative or Judicial Milestone Date Range Start Limiter. Enter a date value in MM/DD/YYYY format to limit milestone results. Parameter p_to_date must also be populated when using this parameter option.","type":"string"},"p_to_date":{"description":"Administrative or Judicial Milestone Date Range End Limiter. Enter a date value in MM/DD/YYYY format to limit milestone results. Parameter p_from_date must also be populated when using this parameter option.","type":"string"},"p_milestone_fy":{"description":"Administrative or Judicial Milestone Fiscal Year Limiter. Enter a single fiscal year value to limit milestone searches to a given fiscal year.","type":"string"},"p_name":{"description":"Case Name Filter. Enter one or more case names to restrict results. Provide multiple values as a comma-delimited list. When using this parameter the p_name_type parameter is required.","type":"string"},"p_name_type":{"description":"Case Name Filter Modifier.","type":"string"},"p_case_number":{"description":"Case Number Filter. Enter one or more case numbers to restrict results. Provide multiple values as a comma-delimited list.","type":"string"},"p_docket_number":{"description":"DOJ Docket Number Filter. Enter a single docket number or partial docket number to restrict results. Use \"%\" as a wildcard for more complex filtering.","type":"string"},"p_court_docket_number":{"type":"string"},"p_activity_number":{"description":"Case Activity Number Filter. Enter a single case activity number to filter results.","type":"string"},"p_case_lead":{"description":"Case Lead Limiter. Enter E or S to limit results.\n- E = EPA is the case lead.\n- S = The state is the case lead.","type":"string","enum":["E","S"]},"p_case_sens_flg":{"description":"Case Sensitive Data Flag. Enter a Y or N to include or exclude cases with sensitive data.","type":"string"},"p_region":{"description":"EPA Region Filter. Provide a single value of 01 thru 10 to restrict results to a single EPA region.","type":"string","enum":["01","02","03","04","05","06","07","08","09","10"]},"p_state":{"description":"Case Location State Filter. Enter one or more state USPS postal codes to filter results. Provide multiple values as a comma-delimited list.","type":"string"},"p_district":{"description":"Case Location Court District Limiter. Enter a single state court district code to limit results.","type":"string"},"p_sic":{"description":"Standard Industrial Classification (SIC) Code Filter. Enter a single 4-digit SIC Code to filter results.","type":"string"},"p_sic_ao_naics":{"description":"Case Location SIC/NAICS And/Or Modifier. Enter either AND or OR to govern the search logic of SIC and NAICS codes.\n- AND = Search will return results having both the provided SIC code(s) and provided NAICS code(s).\n- OR = Search will return results having either the provided SIC code(s) or the provided NAICS code(s).","type":"string","enum":["AND","OR"]},"p_sic_primary_flg":{"description":"Case Location Primary SIC Flag. Enter Y to limit SIC search results to primary SIC codes only.","type":"string","enum":["Y","N"]},"p_sic_frs_flg":{"description":"Case Location Extended FRS SIC Search Flag. Enter Y to expand SIC search to include Federal Registry Service datasets.","type":"string","enum":["Y","N"]},"p_naics":{"description":"North American Industry Classification System Filter. Enter two to six digits to filter results to facilities having matching NAICS codes. Digits less than six will match to all codes beginning with the provided values.","type":"string"},"p_naics_primary_flg":{"description":"Case Location Primary NAICS Flag. Enter Y to limit NAICS search results to primary NAICS codes only.","type":"string","enum":["Y","N"]},"p_naics_frs_flg":{"description":"Case Location Extended FRS NAICS Search Flag. Enter Y to expand NAICS search to include Federal Registry Service datasets.","type":"string","enum":["Y","N"]},"p_enf_type":{"description":"Case Enforcement Type Filter. Enter one or more case enforcement type codes to limit results. Provide multiple values as a comma-delimited list.","type":"string"},"p_law":{"description":"Law Statute Code Filter. Enter a single statute code to limit results.","type":"string"},"p_section":{"description":"Law Section Code Filter. Enter one or more law section codes to limit results. Provide multiple values as a comma-delimited list.","type":"string"},"p_cp_citation":{"description":"Law Section Code Filter Alternative. Enter a single law section code to limit results. This parameter accepts partial codes and allows for advanced search modifiers.","type":"string"},"p_rank_order":{"description":"Law Status Rank Order Limiter. Enter a single integer rank order to limit results.","type":"string","enum":["1","0"]},"p_enf_program":{"description":"Enforcement Program Code Limiter. Enter one or more enforcement program codes to limit results. Provide multiple values as a comma-delimited list. ","type":"string"},"p_violation":{"description":"Violation Type Code Filter. Enter one or more violation type codes to limit results. Provide multiple values as a comma-delimited list.","type":"string"},"p_priority_area":{"description":"Case Priority Area Filter. Enter one or more case priority areas to limit results. Provide multiple values as a comma-delimited list.","type":"string"},"p_priority_area_desc":{"description":"Case Priority Area Description Filter. Enter a single case priority area description or partial case priority area description to limit results. Use \"%\" as a wild-card match for more complex searches.","type":"string"},"p_tribal":{"description":"Case Location Tribal Land Flag. Enter Y or N to include or disallow cases on tribal land.","type":"string","enum":["Y","N"]},"p_oeca_core":{"description":"OECA Core Program Flag. Enter Y or N to include or exclude core program cases.","type":"string","enum":["Y","N"]},"p_multimedia":{"description":"Enforcement Multimedia Case Flag. Enter Y or N to include or exclude multimedia cases.","type":"string","enum":["Y","N"]},"p_fed_case":{"description":"Federal Facility Involvement Flag. Enter a Y or N to include or exclude cases involving federal facilities.","type":"string","enum":["Y","N"]},"p_activity_contact":{"description":"Activity Contact Last Name Filter. Enter a single last name or partial last name to filter results. Use \"%\" as a wild-card for advanced searching.","type":"string"},"p_role":{"description":"Activity Contact Role Code Filter. Enter a single role code to restrict results.","type":"string"},"p_fed_penalty":{"description":"Federal Penalty Assessed Amount Filter. Provide one of the following keywords to restrict results.\n- ANY = cases with any penalty amount.\n- LE5000 = cases with penalty amount less than or equal to $5,000.\n- GT5000 = cases with penalty amount more than $5,000.\n- GT50000 = cases with penalty amount more than $50,000.\n- GT100000 = cases with penalty amount more than $100,000.\n- GT500000 = cases with penalty amount more than $500,000.\n- GT1000000 = cases with penalty amount more than $1,000,000.\n- GT2500000 = cases with penalty amount more than $2,500,000.","type":"string","enum":["ANY","LE5000","GT5000","GT50000","GT100000","GT500000","GT1000000","GT2500000"]},"p_total_fed_penalty":{"description":"Total Federal Penalty Limiter. Enter a keyword value to limit results to cases with given total federal penalties.\n- ANY = Cases with any federal penalty greater than zero.\n- LEXX = Replacing XX with a dollar value, return cases with federal penalty less than or equal to the given amount.\n- GTXX = Replacing XX with a dollar value, return cases with federal penalty greater than the given amount.","type":"string"},"p_cost_recovery":{"description":"Cost Recovery Awarded Amount Limiter. Enter a keyword value to limit results to cases with given cost recovery amounts.\n- ANY = Cases with any cost recovery amount greater than zero.\n- LEXX = Replacing XX with a dollar value, return cases with cost recovery amount less than or equal to the given amount.\n- GTXX = Replacing XX with a dollar value, return cases with cost recovery amount greater than the given amount.","type":"string"},"p_total_cost_recovery":{"description":"Total Cost Recovery Amount Limiter. Enter a keyword value to limit results to cases with given cost recovery amounts.\n- ANY = Cases with any cost recovery amount greater than zero.\n- LEXX = Replacing XX with a dollar value, return cases with cost recovery amount less than or equal to the given amount.\n- GTXX = Replacing XX with a dollar value, return cases with cost recovery amount greater than the given amount.","type":"string"},"p_complying_actions":{"description":"Complying Actions Type Code Limiter. Enter one or more complying action codes to restrict results. Provide multiple values as a comma-delimited list.","type":"string"},"p_comp_act_val":{"description":"Compliance Action Cost Limiter. Enter a keyword value to limit results to cases with given compliance cost amounts.\n- ANY = Cases with any compliance cost amount greater than zero.\n- LEXX = Replacing XX with a dollar value, return cases with compliance cost amount less than or equal to the given amount.\n- GTXX = Replacing XX with a dollar value, return cases with compliance cost amount greater than the given amount.","type":"string","enum":["ANY","LE5000","GT5000","GT100000","GT1000000","GT50000000"]},"p_total_comp_act_val":{"description":"Total Compliance Action Amount Limiter. Enter a keyword value to limit results to cases with given total compliance action amounts.\n- ANY = Cases with any total compliance action amount greater than zero.\n- LEXX = Replacing XX with a dollar value, return cases with total compliance action amount less than or equal to the given amount.\n- GTXX = Replacing XX with a dollar value, return cases with total compliance action amount greater than the given amount.","type":"string"},"p_sep_cats":{"description":"Supplemental Environmental Projects Activity Category Code Limiter. Provide one or more SEP activity category codes to limit results. Provide multiple values as a comma-delimited list.","type":"string"},"p_sep_val":{"description":"Supplemental Environmental Projects Activity Value Limiter. Provide a keyword to limit results.\n- ANY = return cases with any SEP activity amount.\n- LE10000 = return cases with SEP activity amount less than or equal to $10,000.\n- GT10000 = return cases with SEP activity amount greater than $10,000.\n- GT50000 = return cases with SEP activity amount greater than $50,000.\n- GT100000 = return cases with SEP activity amount greater than $100,000.\n- GT500000 = return cases with SEP activity amount greater than $500,000.\n- GT1000000 = return cases with SEP activity amount greater than $1,000,000.","type":"string","enum":["ANY","LE10000","GT10000","GT50000","GT100000","GT500000","GT1000000"]},"p_total_sep_val":{"description":"Supplemental Environmental Projects Total Value Limiter. Provide a keyword to limit results.\n- ANY = return cases with any SEP total amount.\n- LE10000 = return cases with SEP total amount less than or equal to $10,000.\n- GT10000 = return cases with SEP total amount greater than $10,000.\n- GT50000 = return cases with SEP total amount greater than $50,000.\n- GT100000 = return cases with SEP total amount greater than $100,000.\n- GT500000 = return cases with SEP total amount greater than $500,000.\n- GT1000000 = return cases with SEP total amount greater than $1,000,000.","type":"string"},"p_lodged_date":{"description":"Settlement Lodged Date Limiter. Enter a single settlement lodged date in MM/DD/YYYY format to limit results.","type":"string"},"p_entered_date":{"description":"Settlement Entered Date Limiter. Enter a single settlement entered date in MM/DD/YYYY format to limit results.","type":"string"},"p_facility_id":{"description":"Case Facility Registration Identifier Limiter. Enter a single complete facility identifier to limit results.","type":"string"},"p_fac_city":{"description":"Case Facility City Limiter. Enter a single complete city name to filter cases by facility location city.","type":"string"},"p_fac_zip":{"description":"Case Facility ZIP Code Limiter. Enter a single 5-digit zip code to filter cases by facility location zip code.","type":"string"},"p_fac_county":{"description":"Case Facility County Limiter. Enter a single complete county name to filter cases by facility location county name.","type":"string"},"p_case_summary":{"description":"Case Summary Search Limiter. Enter a single case summary to limit results. This parameter accepts partial codes and allows for advanced search modifiers.","type":"string"},"p_case_summary_type":{"description":"Identifies how the the search terms enterened in p_case_summary are searched. Valid values are ALL (Default), WITHIN, and CONTAINS. Must be used with p_case_summary.","type":"string","enum":["ALL","CONTAINS","WITHIN"]},"p_usmex":{"description":"US-Mexico Border Flag. Enter Y/N to restrict searches to facilities located within 100KM of the border.","type":"string","enum":["Y","N"]},"p_c1lat":{"description":"In decimal degrees. Latitude of 1st corner of box that bounds the resulting facilities. The latitude and longitude of both corners of the bounding box must be provided.","type":"number"},"p_c1lon":{"description":"In decimal degrees. Longitude of 1st corner of box that bounds the resulting facilities. The latitude and longitude of both corners of the bounding box must be provided.","type":"number"},"p_c2lat":{"description":"In decimal degrees. Latitude of 2nd corner of box that bounds the resulting facilities. The latitude and longitude of both corners of the bounding box must be provided.","type":"number"},"p_c2lon":{"description":"In decimal degrees. Longitude of 2nd corner of box that bounds the resulting facilities. The latitude and longitude of both corners of the bounding box must be provided.","type":"number"},"p_voluntary":{"description":"Voluntary Self Disclosure Flag. Enter Y or N to include or exclude cases results having voluntary disclosure.","type":"string"},"p_fed_indicator":{"description":"Federal Facility/Cross Media Flag. Enter Y or N to limit results to cases with federal facility cross media.","type":"string"},"p_fntype":{"description":"Controls type of text search performed on facility name with parameter p_fn.\n- EXACT = Find facilities having the exact provided name(s).\n- BEGINS = Find facilities with names starting with the provided term(s).\n- ALL = Find facilities using Oracle text search terms.\n- CONTAINS = ","type":"string","enum":["ALL","CONTAINS","EXACT","BEGINS"]},"p_civil_criminal_indicator":{"description":"Civil/Criminal Case Limiter. Provide a keyword to limit results.\n- ANY = return both civil and criminal cases.\n- CI = return only civil cases.\n- CR = return only criminal cases.","type":"string","enum":["CI","CR","ALL"]},"queryset":{"description":"Query Limiter. Enter a value to limit the number of records returned for each query. Value cannot exceed 70,000.","type":"number"},"responseset":{"description":"Response Set Limiter. Enter a value to limit the number of records per page. Value cannot exceed 1,000.","type":"number"},"mapset":{"description":"Identifies the maxium number of case facilities to return from the case_rest_services.get_case_info query.","type":"string","default":"1400"},"callback":{"description":"JSONP Callback. For use with JSONP and GEOJSONP output only. Enter a name of the function in which to wrap the JSON response.","type":"string"},"qcolumns":{"description":"Used to customize service output. A list of comma-separated column IDs of output objects that will be returned in the service query object or download. Use the metadata service endpoint for a complete list of Ids and definitions.","type":"string"},"p_pretty_print":{"description":"Optional flag to request GeoJSON formatted results to be pretty printed. Only provide a numeric value when the output needs to be human readable as pretty printing has a performance cost.","type":"number"},"p_ocmap_fy":{"description":"Fiscal Year to select cases that are displayed in the Office of Complicance Fiscal Year Map Services","type":"string"},"p_qs":{"description":"Quick Search. Allows entry for city, state, and/or zip code.","type":"string"},"p_has_map":{"type":"string"}}}}}},"responses":{"200":{"description":"Returns an array of cases that meet the selection criteria.","content":{"application/json":{"schema":{"description":"Root Object","properties":{"Results":{"$ref":"#/components/schemas/crs0_get_case_info.Results"}},"required":["Results"],"type":"object","xml":{"name":"Case"}}},"application/xml":{"schema":{"description":"Root Object","properties":{"Results":{"$ref":"#/components/schemas/crs0_get_case_info.Results"}},"required":["Results"],"type":"object","xml":{"name":"Case"}}}}}},"summary":"Enforcement Case Search (new version)","tags":["Case Enforcement"]}},"/case_rest_services.get_case_report":{"get":{"description":"The get_case_report service endpoint returns a complex object of civil enforcement case details based on the provided case id.","parameters":[{"description":"Case Number. Enter the case number identifier to retrieve the case report.","in":"query","name":"p_id","required":false,"schema":{"type":"string"}},{"description":"Output Format Flag. Enter one of the following keywords:\n- JSON = Data model formatted as Javascript Object Notation (default).\n- JSONP = Data model formatted as Javascript Object Notation with Padding. \n- XML = Data model formatted as Extensible Markup Language.","in":"query","name":"output","required":false,"schema":{"type":"string","enum":["JSONP","JSON","XML"]}},{"$ref":"#/components/parameters/q.callback"}],"responses":{"200":{"description":"Returns a complex object containing detailed case information for the provided Case Identifier.","content":{"application/json":{"schema":{"description":"Service call container.","properties":{"Results":{"$ref":"#/components/schemas/crs1_Results"}},"required":["Results"],"type":"object","xml":{"name":"Root"}}},"application/xml":{"schema":{"description":"Service call container.","properties":{"Results":{"$ref":"#/components/schemas/crs1_Results"}},"required":["Results"],"type":"object","xml":{"name":"Root"}}}}}},"summary":"Enforcement Case Summary Report Search","tags":["Case Enforcement"]},"post":{"description":"The get_case_report service endpoint returns a complex object of civil enforcement case details based on the provided case id.","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"p_id":{"description":"Case Number. Enter the case number identifier to retrieve the case report.","type":"string"},"output":{"description":"Output Format Flag. Enter one of the following keywords:\n- JSON = Data model formatted as Javascript Object Notation (default).\n- JSONP = Data model formatted as Javascript Object Notation with Padding. \n- XML = Data model formatted as Extensible Markup Language.","type":"string","enum":["JSONP","JSON","XML"]},"callback":{"description":"JSONP Callback. For use with JSONP and GEOJSONP output only. Enter a name of the function in which to wrap the JSON response.","type":"string"}}}}}},"responses":{"200":{"description":"Returns a complex object containing detailed case information for the provided Case Identifier.","content":{"application/json":{"schema":{"description":"Service call container.","properties":{"Results":{"$ref":"#/components/schemas/crs1_Results"}},"required":["Results"],"type":"object","xml":{"name":"Root"}}},"application/xml":{"schema":{"description":"Service call container.","properties":{"Results":{"$ref":"#/components/schemas/crs1_Results"}},"required":["Results"],"type":"object","xml":{"name":"Root"}}}}}},"summary":"Enforcement Case Summary Report Search","tags":["Case Enforcement"]}},"/case_rest_services.get_cases":{"get":{"description":"The get_cases service end point searches for civil enforcement and criminal cases based on the provided selection criteria.","parameters":[{"description":"Output Format Flag. Enter one of the following keywords:\n- JSON = Data model formatted as Javascript Object Notation (default).\n- JSONP = Data model formatted as Javascript Object Notation with Padding. \n- XML = Data model formatted as Extensible Markup Language.","in":"query","name":"output","required":false,"schema":{"type":"string","enum":["JSONP","JSON","XML"]}},{"$ref":"#/components/parameters/q.p_case_category"},{"$ref":"#/components/parameters/q.p_case_status"},{"$ref":"#/components/parameters/q.p_violation"},{"$ref":"#/components/parameters/q.p_milestone"},{"$ref":"#/components/parameters/q.p_from_date"},{"$ref":"#/components/parameters/q.p_to_date"},{"$ref":"#/components/parameters/q.p_milestone_fy"},{"$ref":"#/components/parameters/q.p_name"},{"$ref":"#/components/parameters/q.p_name_type"},{"$ref":"#/components/parameters/q.p_case_number"},{"$ref":"#/components/parameters/q.p_docket_number"},{"$ref":"#/components/parameters/q.p_court_docket_number"},{"$ref":"#/components/parameters/q.p_activity_number"},{"$ref":"#/components/parameters/q.p_case_lead"},{"$ref":"#/components/parameters/q.p_case_sens_flg"},{"$ref":"#/components/parameters/q.p_region"},{"$ref":"#/components/parameters/q.p_state"},{"$ref":"#/components/parameters/q.p_district"},{"$ref":"#/components/parameters/q.p_sic"},{"$ref":"#/components/parameters/q.p_sic_ao_naics"},{"$ref":"#/components/parameters/q.p_sic_primary_flg"},{"$ref":"#/components/parameters/q.p_sic_frs_flg"},{"$ref":"#/components/parameters/q.p_naics"},{"$ref":"#/components/parameters/q.p_naics_primary_flg"},{"$ref":"#/components/parameters/q.p_naics_frs_flg"},{"$ref":"#/components/parameters/q.p_enf_type"},{"$ref":"#/components/parameters/q.p_law"},{"$ref":"#/components/parameters/q.p_section"},{"$ref":"#/components/parameters/q.p_cp_citation"},{"$ref":"#/components/parameters/q.p_rank_order"},{"$ref":"#/components/parameters/q.p_enf_program"},{"$ref":"#/components/parameters/q.p_priority_area"},{"$ref":"#/components/parameters/q.p_priority_area_desc"},{"$ref":"#/components/parameters/q.p_tribal"},{"$ref":"#/components/parameters/q.p_oeca_core"},{"$ref":"#/components/parameters/q.p_multimedia"},{"$ref":"#/components/parameters/q.p_fed_case"},{"$ref":"#/components/parameters/q.p_activity_contact"},{"$ref":"#/components/parameters/q.p_role"},{"$ref":"#/components/parameters/q.p_fed_penalty"},{"$ref":"#/components/parameters/q.p_total_fed_penalty"},{"$ref":"#/components/parameters/q.p_cost_recovery"},{"$ref":"#/components/parameters/q.p_total_cost_recovery"},{"$ref":"#/components/parameters/q.p_complying_actions"},{"$ref":"#/components/parameters/q.p_comp_act_val"},{"$ref":"#/components/parameters/q.p_total_comp_act_val"},{"$ref":"#/components/parameters/q.p_sep_cats"},{"$ref":"#/components/parameters/q.p_sep_val"},{"$ref":"#/components/parameters/q.p_total_sep_val"},{"$ref":"#/components/parameters/q.p_lodged_date"},{"$ref":"#/components/parameters/q.p_entered_date"},{"$ref":"#/components/parameters/q.p_facility_id"},{"$ref":"#/components/parameters/q.p_fac_city"},{"$ref":"#/components/parameters/q.p_fac_zip"},{"$ref":"#/components/parameters/q.p_fac_county"},{"$ref":"#/components/parameters/q.p_case_summary"},{"$ref":"#/components/parameters/q.p_case_summary_type"},{"$ref":"#/components/parameters/q.p_usmex"},{"$ref":"#/components/parameters/q.p_c1lat"},{"$ref":"#/components/parameters/q.p_c1lon"},{"$ref":"#/components/parameters/q.p_c2lat"},{"$ref":"#/components/parameters/q.p_c2lon"},{"$ref":"#/components/parameters/q.p_voluntary"},{"$ref":"#/components/parameters/q.p_fed_indicator"},{"$ref":"#/components/parameters/q.p_fntype"},{"$ref":"#/components/parameters/q.p_civil_criminal_indicator"},{"$ref":"#/components/parameters/q.queryset"},{"$ref":"#/components/parameters/q.responseset"},{"$ref":"#/components/parameters/q.maplist"},{"$ref":"#/components/parameters/q.tablelist"},{"$ref":"#/components/parameters/q.callback"},{"$ref":"#/components/parameters/q.qcolumns"},{"$ref":"#/components/parameters/q.p_ocmap_fy"},{"$ref":"#/components/parameters/q.p_qs"},{"$ref":"#/components/parameters/q.p_has_map"}],"responses":{"200":{"description":"Returns an array of cases that meet the selection criteria.","content":{"application/json":{"schema":{"description":"Service call container.","properties":{"Results":{"$ref":"#/components/schemas/crs2_Results"}},"required":["Results"],"type":"object","xml":{"name":"Root"}}},"application/xml":{"schema":{"description":"Service call container.","properties":{"Results":{"$ref":"#/components/schemas/crs2_Results"}},"required":["Results"],"type":"object","xml":{"name":"Root"}}}}}},"summary":"Enforcement Case Search","tags":["Case Enforcement"]},"post":{"description":"The get_cases service end point searches for civil enforcement and criminal cases based on the provided selection criteria.","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"output":{"description":"Output Format Flag. Enter one of the following keywords:\n- JSON = Data model formatted as Javascript Object Notation (default).\n- JSONP = Data model formatted as Javascript Object Notation with Padding. \n- XML = Data model formatted as Extensible Markup Language.","type":"string","enum":["JSONP","JSON","XML"]},"p_case_category":{"description":"Case Category Filter. Enter one or more case category codes to filter results. Provide multiple values as a comma-delimited list.\n- AFR = Administrative - Formal\n- AIF = Administrative - Informal\n- JDC = Judicial","type":"string"},"p_case_status":{"description":"Case Status Code Filter. Enter one or more case status codes to limit results. Provide multiple values as a comma-delimited list.","type":"string"},"p_milestone":{"description":"Administrative or Judicial Milestone Filter. Enter one or milestone values to restrict results. Provide multiple values as a comma-delimited list.","type":"string"},"p_from_date":{"description":"Administrative or Judicial Milestone Date Range Start Limiter. Enter a date value in MM/DD/YYYY format to limit milestone results. Parameter p_to_date must also be populated when using this parameter option.","type":"string"},"p_to_date":{"description":"Administrative or Judicial Milestone Date Range End Limiter. Enter a date value in MM/DD/YYYY format to limit milestone results. Parameter p_from_date must also be populated when using this parameter option.","type":"string"},"p_milestone_fy":{"description":"Administrative or Judicial Milestone Fiscal Year Limiter. Enter a single fiscal year value to limit milestone searches to a given fiscal year.","type":"string"},"p_name":{"description":"Case Name Filter. Enter one or more case names to restrict results. Provide multiple values as a comma-delimited list. When using this parameter the p_name_type parameter is required.","type":"string"},"p_name_type":{"description":"Case Name Filter Modifier.","type":"string"},"p_case_number":{"description":"Case Number Filter. Enter one or more case numbers to restrict results. Provide multiple values as a comma-delimited list.","type":"string"},"p_docket_number":{"description":"DOJ Docket Number Filter. Enter a single docket number or partial docket number to restrict results. Use \"%\" as a wildcard for more complex filtering.","type":"string"},"p_court_docket_number":{"type":"string"},"p_activity_number":{"description":"Case Activity Number Filter. Enter a single case activity number to filter results.","type":"string"},"p_case_lead":{"description":"Case Lead Limiter. Enter E or S to limit results.\n- E = EPA is the case lead.\n- S = The state is the case lead.","type":"string","enum":["E","S"]},"p_case_sens_flg":{"description":"Case Sensitive Data Flag. Enter a Y or N to include or exclude cases with sensitive data.","type":"string"},"p_region":{"description":"EPA Region Filter. Provide a single value of 01 thru 10 to restrict results to a single EPA region.","type":"string","enum":["01","02","03","04","05","06","07","08","09","10"]},"p_state":{"description":"Case Location State Filter. Enter one or more state USPS postal codes to filter results. Provide multiple values as a comma-delimited list.","type":"string"},"p_district":{"description":"Case Location Court District Limiter. Enter a single state court district code to limit results.","type":"string"},"p_sic":{"description":"Standard Industrial Classification (SIC) Code Filter. Enter a single 4-digit SIC Code to filter results.","type":"string"},"p_sic_ao_naics":{"description":"Case Location SIC/NAICS And/Or Modifier. Enter either AND or OR to govern the search logic of SIC and NAICS codes.\n- AND = Search will return results having both the provided SIC code(s) and provided NAICS code(s).\n- OR = Search will return results having either the provided SIC code(s) or the provided NAICS code(s).","type":"string","enum":["AND","OR"]},"p_sic_primary_flg":{"description":"Case Location Primary SIC Flag. Enter Y to limit SIC search results to primary SIC codes only.","type":"string","enum":["Y","N"]},"p_sic_frs_flg":{"description":"Case Location Extended FRS SIC Search Flag. Enter Y to expand SIC search to include Federal Registry Service datasets.","type":"string","enum":["Y","N"]},"p_naics":{"description":"North American Industry Classification System Filter. Enter two to six digits to filter results to facilities having matching NAICS codes. Digits less than six will match to all codes beginning with the provided values.","type":"string"},"p_naics_primary_flg":{"description":"Case Location Primary NAICS Flag. Enter Y to limit NAICS search results to primary NAICS codes only.","type":"string","enum":["Y","N"]},"p_naics_frs_flg":{"description":"Case Location Extended FRS NAICS Search Flag. Enter Y to expand NAICS search to include Federal Registry Service datasets.","type":"string","enum":["Y","N"]},"p_enf_type":{"description":"Case Enforcement Type Filter. Enter one or more case enforcement type codes to limit results. Provide multiple values as a comma-delimited list.","type":"string"},"p_law":{"description":"Law Statute Code Filter. Enter a single statute code to limit results.","type":"string"},"p_section":{"description":"Law Section Code Filter. Enter one or more law section codes to limit results. Provide multiple values as a comma-delimited list.","type":"string"},"p_cp_citation":{"description":"Law Section Code Filter Alternative. Enter a single law section code to limit results. This parameter accepts partial codes and allows for advanced search modifiers.","type":"string"},"p_rank_order":{"description":"Law Status Rank Order Limiter. Enter a single integer rank order to limit results.","type":"string","enum":["1","0"]},"p_enf_program":{"description":"Enforcement Program Code Limiter. Enter one or more enforcement program codes to limit results. Provide multiple values as a comma-delimited list. ","type":"string"},"p_violation":{"description":"Violation Type Code Filter. Enter one or more violation type codes to limit results. Provide multiple values as a comma-delimited list.","type":"string"},"p_priority_area":{"description":"Case Priority Area Filter. Enter one or more case priority areas to limit results. Provide multiple values as a comma-delimited list.","type":"string"},"p_priority_area_desc":{"description":"Case Priority Area Description Filter. Enter a single case priority area description or partial case priority area description to limit results. Use \"%\" as a wild-card match for more complex searches.","type":"string"},"p_tribal":{"description":"Case Location Tribal Land Flag. Enter Y or N to include or disallow cases on tribal land.","type":"string","enum":["Y","N"]},"p_oeca_core":{"description":"OECA Core Program Flag. Enter Y or N to include or exclude core program cases.","type":"string","enum":["Y","N"]},"p_multimedia":{"description":"Enforcement Multimedia Case Flag. Enter Y or N to include or exclude multimedia cases.","type":"string","enum":["Y","N"]},"p_fed_case":{"description":"Federal Facility Involvement Flag. Enter a Y or N to include or exclude cases involving federal facilities.","type":"string","enum":["Y","N"]},"p_activity_contact":{"description":"Activity Contact Last Name Filter. Enter a single last name or partial last name to filter results. Use \"%\" as a wild-card for advanced searching.","type":"string"},"p_role":{"description":"Activity Contact Role Code Filter. Enter a single role code to restrict results.","type":"string"},"p_fed_penalty":{"description":"Federal Penalty Assessed Amount Filter. Provide one of the following keywords to restrict results.\n- ANY = cases with any penalty amount.\n- LE5000 = cases with penalty amount less than or equal to $5,000.\n- GT5000 = cases with penalty amount more than $5,000.\n- GT50000 = cases with penalty amount more than $50,000.\n- GT100000 = cases with penalty amount more than $100,000.\n- GT500000 = cases with penalty amount more than $500,000.\n- GT1000000 = cases with penalty amount more than $1,000,000.\n- GT2500000 = cases with penalty amount more than $2,500,000.","type":"string","enum":["ANY","LE5000","GT5000","GT50000","GT100000","GT500000","GT1000000","GT2500000"]},"p_total_fed_penalty":{"description":"Total Federal Penalty Limiter. Enter a keyword value to limit results to cases with given total federal penalties.\n- ANY = Cases with any federal penalty greater than zero.\n- LEXX = Replacing XX with a dollar value, return cases with federal penalty less than or equal to the given amount.\n- GTXX = Replacing XX with a dollar value, return cases with federal penalty greater than the given amount.","type":"string"},"p_cost_recovery":{"description":"Cost Recovery Awarded Amount Limiter. Enter a keyword value to limit results to cases with given cost recovery amounts.\n- ANY = Cases with any cost recovery amount greater than zero.\n- LEXX = Replacing XX with a dollar value, return cases with cost recovery amount less than or equal to the given amount.\n- GTXX = Replacing XX with a dollar value, return cases with cost recovery amount greater than the given amount.","type":"string"},"p_total_cost_recovery":{"description":"Total Cost Recovery Amount Limiter. Enter a keyword value to limit results to cases with given cost recovery amounts.\n- ANY = Cases with any cost recovery amount greater than zero.\n- LEXX = Replacing XX with a dollar value, return cases with cost recovery amount less than or equal to the given amount.\n- GTXX = Replacing XX with a dollar value, return cases with cost recovery amount greater than the given amount.","type":"string"},"p_complying_actions":{"description":"Complying Actions Type Code Limiter. Enter one or more complying action codes to restrict results. Provide multiple values as a comma-delimited list.","type":"string"},"p_comp_act_val":{"description":"Compliance Action Cost Limiter. Enter a keyword value to limit results to cases with given compliance cost amounts.\n- ANY = Cases with any compliance cost amount greater than zero.\n- LEXX = Replacing XX with a dollar value, return cases with compliance cost amount less than or equal to the given amount.\n- GTXX = Replacing XX with a dollar value, return cases with compliance cost amount greater than the given amount.","type":"string","enum":["ANY","LE5000","GT5000","GT100000","GT1000000","GT50000000"]},"p_total_comp_act_val":{"description":"Total Compliance Action Amount Limiter. Enter a keyword value to limit results to cases with given total compliance action amounts.\n- ANY = Cases with any total compliance action amount greater than zero.\n- LEXX = Replacing XX with a dollar value, return cases with total compliance action amount less than or equal to the given amount.\n- GTXX = Replacing XX with a dollar value, return cases with total compliance action amount greater than the given amount.","type":"string"},"p_sep_cats":{"description":"Supplemental Environmental Projects Activity Category Code Limiter. Provide one or more SEP activity category codes to limit results. Provide multiple values as a comma-delimited list.","type":"string"},"p_sep_val":{"description":"Supplemental Environmental Projects Activity Value Limiter. Provide a keyword to limit results.\n- ANY = return cases with any SEP activity amount.\n- LE10000 = return cases with SEP activity amount less than or equal to $10,000.\n- GT10000 = return cases with SEP activity amount greater than $10,000.\n- GT50000 = return cases with SEP activity amount greater than $50,000.\n- GT100000 = return cases with SEP activity amount greater than $100,000.\n- GT500000 = return cases with SEP activity amount greater than $500,000.\n- GT1000000 = return cases with SEP activity amount greater than $1,000,000.","type":"string","enum":["ANY","LE10000","GT10000","GT50000","GT100000","GT500000","GT1000000"]},"p_total_sep_val":{"description":"Supplemental Environmental Projects Total Value Limiter. Provide a keyword to limit results.\n- ANY = return cases with any SEP total amount.\n- LE10000 = return cases with SEP total amount less than or equal to $10,000.\n- GT10000 = return cases with SEP total amount greater than $10,000.\n- GT50000 = return cases with SEP total amount greater than $50,000.\n- GT100000 = return cases with SEP total amount greater than $100,000.\n- GT500000 = return cases with SEP total amount greater than $500,000.\n- GT1000000 = return cases with SEP total amount greater than $1,000,000.","type":"string"},"p_lodged_date":{"description":"Settlement Lodged Date Limiter. Enter a single settlement lodged date in MM/DD/YYYY format to limit results.","type":"string"},"p_entered_date":{"description":"Settlement Entered Date Limiter. Enter a single settlement entered date in MM/DD/YYYY format to limit results.","type":"string"},"p_facility_id":{"description":"Case Facility Registration Identifier Limiter. Enter a single complete facility identifier to limit results.","type":"string"},"p_fac_city":{"description":"Case Facility City Limiter. Enter a single complete city name to filter cases by facility location city.","type":"string"},"p_fac_zip":{"description":"Case Facility ZIP Code Limiter. Enter a single 5-digit zip code to filter cases by facility location zip code.","type":"string"},"p_fac_county":{"description":"Case Facility County Limiter. Enter a single complete county name to filter cases by facility location county name.","type":"string"},"p_case_summary":{"description":"Case Summary Search Limiter. Enter a single case summary to limit results. This parameter accepts partial codes and allows for advanced search modifiers.","type":"string"},"p_case_summary_type":{"description":"Identifies how the the search terms enterened in p_case_summary are searched. Valid values are ALL (Default), WITHIN, and CONTAINS. Must be used with p_case_summary.","type":"string","enum":["ALL","CONTAINS","WITHIN"]},"p_usmex":{"description":"US-Mexico Border Flag. Enter Y/N to restrict searches to facilities located within 100KM of the border.","type":"string","enum":["Y","N"]},"p_c1lat":{"description":"In decimal degrees. Latitude of 1st corner of box that bounds the resulting facilities. The latitude and longitude of both corners of the bounding box must be provided.","type":"number"},"p_c1lon":{"description":"In decimal degrees. Longitude of 1st corner of box that bounds the resulting facilities. The latitude and longitude of both corners of the bounding box must be provided.","type":"number"},"p_c2lat":{"description":"In decimal degrees. Latitude of 2nd corner of box that bounds the resulting facilities. The latitude and longitude of both corners of the bounding box must be provided.","type":"number"},"p_c2lon":{"description":"In decimal degrees. Longitude of 2nd corner of box that bounds the resulting facilities. The latitude and longitude of both corners of the bounding box must be provided.","type":"number"},"p_voluntary":{"description":"Voluntary Self Disclosure Flag. Enter Y or N to include or exclude cases results having voluntary disclosure.","type":"string"},"p_fed_indicator":{"description":"Federal Facility/Cross Media Flag. Enter Y or N to limit results to cases with federal facility cross media.","type":"string"},"p_fntype":{"description":"Controls type of text search performed on facility name with parameter p_fn.\n- EXACT = Fi