{ "opencollection": "1.0.0", "info": { "name": "EPA Air Quality System (AQS) Account Type Codes Case Enforcement API", "version": "1.0" }, "request": { "auth": { "type": "apikey", "key": "key", "value": "{{key}}", "placement": "query" } }, "items": [ { "info": { "name": "Case Enforcement", "type": "folder" }, "items": [ { "info": { "name": "Enforcement Case Search (new Version)", "type": "http" }, "http": { "method": "GET", "url": "https://aqs.epa.gov/data/api/case_rest_services.get_case_info", "params": [ { "name": "output", "value": "string", "type": "query", "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." }, { "name": "p_case_category", "value": "", "type": "query", "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" }, { "name": "p_case_status", "value": "", "type": "query", "description": "Case Status Code Filter. Enter one or more case status codes to limit results. Provide multiple values as a comma-delimited list." }, { "name": "p_milestone", "value": "", "type": "query", "description": "Administrative or Judicial Milestone Filter. Enter one or milestone values to restrict results. Provide multiple values as a comma-delimited list." }, { "name": "p_from_date", "value": "", "type": "query", "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." }, { "name": "p_to_date", "value": "", "type": "query", "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." }, { "name": "p_milestone_fy", "value": "", "type": "query", "description": "Administrative or Judicial Milestone Fiscal Year Limiter. Enter a single fiscal year value to limit milestone searches to a given fiscal year." }, { "name": "p_name", "value": "", "type": "query", "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." }, { "name": "p_name_type", "value": "", "type": "query", "description": "Case Name Filter Modifier." }, { "name": "p_case_number", "value": "", "type": "query", "description": "Case Number Filter. Enter one or more case numbers to restrict results. Provide multiple values as a comma-delimited list." }, { "name": "p_docket_number", "value": "", "type": "query", "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." }, { "name": "p_court_docket_number", "value": "", "type": "query" }, { "name": "p_activity_number", "value": "", "type": "query", "description": "Case Activity Number Filter. Enter a single case activity number to filter results." }, { "name": "p_case_lead", "value": "", "type": "query", "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." }, { "name": "p_case_sens_flg", "value": "", "type": "query", "description": "Case Sensitive Data Flag. Enter a Y or N to include or exclude cases with sensitive data." }, { "name": "p_region", "value": "", "type": "query", "description": "EPA Region Filter. Provide a single value of 01 thru 10 to restrict results to a single EPA region." }, { "name": "p_state", "value": "", "type": "query", "description": "Case Location State Filter. Enter one or more state USPS postal codes to filter results. Provide multiple values as a comma-delimited list." }, { "name": "p_district", "value": "", "type": "query", "description": "Case Location Court District Limiter. Enter a single state court district code to limit results." }, { "name": "p_sic", "value": "", "type": "query", "description": "Standard Industrial Classification (SIC) Code Filter. Enter a single 4-digit SIC Code to filter results." }, { "name": "p_sic_ao_naics", "value": "", "type": "query", "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)." }, { "name": "p_sic_primary_flg", "value": "", "type": "query", "description": "Case Location Primary SIC Flag. Enter Y to limit SIC search results to primary SIC codes only." }, { "name": "p_sic_frs_flg", "value": "", "type": "query", "description": "Case Location Extended FRS SIC Search Flag. Enter Y to expand SIC search to include Federal Registry Service datasets." }, { "name": "p_naics", "value": "", "type": "query", "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." }, { "name": "p_naics_primary_flg", "value": "", "type": "query", "description": "Case Location Primary NAICS Flag. Enter Y to limit NAICS search results to primary NAICS codes only." }, { "name": "p_naics_frs_flg", "value": "", "type": "query", "description": "Case Location Extended FRS NAICS Search Flag. Enter Y to expand NAICS search to include Federal Registry Service datasets." }, { "name": "p_enf_type", "value": "", "type": "query", "description": "Case Enforcement Type Filter. Enter one or more case enforcement type codes to limit results. Provide multiple values as a comma-delimited list." }, { "name": "p_law", "value": "", "type": "query", "description": "Law Statute Code Filter. Enter a single statute code to limit results." }, { "name": "p_section", "value": "", "type": "query", "description": "Law Section Code Filter. Enter one or more law section codes to limit results. Provide multiple values as a comma-delimited list." }, { "name": "p_cp_citation", "value": "", "type": "query", "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." }, { "name": "p_rank_order", "value": "", "type": "query", "description": "Law Status Rank Order Limiter. Enter a single integer rank order to limit results." }, { "name": "p_enf_program", "value": "", "type": "query", "description": "Enforcement Program Code Limiter. Enter one or more enforcement program codes to limit results. Provide multiple values as a comma-delimited list. " }, { "name": "p_violation", "value": "", "type": "query", "description": "Violation Type Code Filter. Enter one or more violation type codes to limit results. Provide multiple values as a comma-delimited list." }, { "name": "p_priority_area", "value": "", "type": "query", "description": "Case Priority Area Filter. Enter one or more case priority areas to limit results. Provide multiple values as a comma-delimited list." }, { "name": "p_priority_area_desc", "value": "", "type": "query", "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." }, { "name": "p_tribal", "value": "", "type": "query", "description": "Case Location Tribal Land Flag. Enter Y or N to include or disallow cases on tribal land." }, { "name": "p_oeca_core", "value": "", "type": "query", "description": "OECA Core Program Flag. Enter Y or N to include or exclude core program cases." }, { "name": "p_multimedia", "value": "", "type": "query", "description": "Enforcement Multimedia Case Flag. Enter Y or N to include or exclude multimedia cases." }, { "name": "p_fed_case", "value": "", "type": "query", "description": "Federal Facility Involvement Flag. Enter a Y or N to include or exclude cases involving federal facilities." }, { "name": "p_activity_contact", "value": "", "type": "query", "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." }, { "name": "p_role", "value": "", "type": "query", "description": "Activity Contact Role Code Filter. Enter a single role code to restrict results." }, { "name": "p_fed_penalty", "value": "", "type": "query", "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." }, { "name": "p_total_fed_penalty", "value": "", "type": "query", "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." }, { "name": "p_cost_recovery", "value": "", "type": "query", "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." }, { "name": "p_total_cost_recovery", "value": "", "type": "query", "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." }, { "name": "p_complying_actions", "value": "", "type": "query", "description": "Complying Actions Type Code Limiter. Enter one or more complying action codes to restrict results. Provide multiple values as a comma-delimited list." }, { "name": "p_comp_act_val", "value": "", "type": "query", "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." }, { "name": "p_total_comp_act_val", "value": "", "type": "query", "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." }, { "name": "p_sep_cats", "value": "", "type": "query", "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." }, { "name": "p_sep_val", "value": "", "type": "query", "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." }, { "name": "p_total_sep_val", "value": "", "type": "query", "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." }, { "name": "p_lodged_date", "value": "", "type": "query", "description": "Settlement Lodged Date Limiter. Enter a single settlement lodged date in MM/DD/YYYY format to limit results." }, { "name": "p_entered_date", "value": "", "type": "query", "description": "Settlement Entered Date Limiter. Enter a single settlement entered date in MM/DD/YYYY format to limit results." }, { "name": "p_facility_id", "value": "", "type": "query", "description": "Case Facility Registration Identifier Limiter. Enter a single complete facility identifier to limit results." }, { "name": "p_fac_city", "value": "", "type": "query", "description": "Case Facility City Limiter. Enter a single complete city name to filter cases by facility location city." }, { "name": "p_fac_zip", "value": "", "type": "query", "description": "Case Facility ZIP Code Limiter. Enter a single 5-digit zip code to filter cases by facility location zip code." }, { "name": "p_fac_county", "value": "", "type": "query", "description": "Case Facility County Limiter. Enter a single complete county name to filter cases by facility location county name." }, { "name": "p_case_summary", "value": "", "type": "query", "description": "Case Summary Search Limiter. Enter a single case summary to limit results. This parameter accepts partial codes and allows for advanced search modifiers." }, { "name": "p_case_summary_type", "value": "", "type": "query", "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." }, { "name": "p_usmex", "value": "", "type": "query", "description": "US-Mexico Border Flag. Enter Y/N to restrict searches to facilities located within 100KM of the border." }, { "name": "p_c1lat", "value": "", "type": "query", "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." }, { "name": "p_c1lon", "value": "", "type": "query", "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." }, { "name": "p_c2lat", "value": "", "type": "query", "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." }, { "name": "p_c2lon", "value": "", "type": "query", "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." }, { "name": "p_voluntary", "value": "", "type": "query", "description": "Voluntary Self Disclosure Flag. Enter Y or N to include or exclude cases results having voluntary disclosure." }, { "name": "p_fed_indicator", "value": "", "type": "query", "description": "Federal Facility/Cross Media Flag. Enter Y or N to limit results to cases with federal facility cross media." }, { "name": "p_fntype", "value": "", "type": "query", "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 = " }, { "name": "p_civil_criminal_indicator", "value": "", "type": "query", "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." }, { "name": "queryset", "value": "", "type": "query", "description": "Query Limiter. Enter a value to limit the number of records returned for each query. Value cannot exceed 70,000." }, { "name": "responseset", "value": "", "type": "query", "description": "Response Set Limiter. Enter a value to limit the number of records per page. Value cannot exceed 1,000." }, { "name": "mapset", "value": "", "type": "query", "description": "Identifies the maxium number of case facilities to return from the case_rest_services.get_case_info query." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP Callback. For use with JSONP and GEOJSONP output only. Enter a name of the function in which to wrap the JSON response." }, { "name": "qcolumns", "value": "", "type": "query", "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." }, { "name": "p_pretty_print", "value": "", "type": "query", "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." }, { "name": "p_ocmap_fy", "value": "", "type": "query", "description": "Fiscal Year to select cases that are displayed in the Office of Complicance Fiscal Year Map Services" }, { "name": "p_qs", "value": "", "type": "query", "description": "Quick Search. Allows entry for city, state, and/or zip code." }, { "name": "p_has_map", "value": "", "type": "query" } ] }, "docs": "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." }, { "info": { "name": "Enforcement Case Search (new Version)", "type": "http" }, "http": { "method": "POST", "url": "https://aqs.epa.gov/data/api/case_rest_services.get_case_info" }, "docs": "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." }, { "info": { "name": "Enforcement Case Summary Report Search", "type": "http" }, "http": { "method": "GET", "url": "https://aqs.epa.gov/data/api/case_rest_services.get_case_report", "params": [ { "name": "p_id", "value": "12345", "type": "query", "description": "Case Number. Enter the case number identifier to retrieve the case report." }, { "name": "output", "value": "string", "type": "query", "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." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP Callback. For use with JSONP and GEOJSONP output only. Enter a name of the function in which to wrap the JSON response." } ] }, "docs": "The get_case_report service endpoint returns a complex object of civil enforcement case details based on the provided case id." }, { "info": { "name": "Enforcement Case Summary Report Search", "type": "http" }, "http": { "method": "POST", "url": "https://aqs.epa.gov/data/api/case_rest_services.get_case_report" }, "docs": "The get_case_report service endpoint returns a complex object of civil enforcement case details based on the provided case id." }, { "info": { "name": "Enforcement Case Search", "type": "http" }, "http": { "method": "GET", "url": "https://aqs.epa.gov/data/api/case_rest_services.get_cases", "params": [ { "name": "output", "value": "string", "type": "query", "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." }, { "name": "p_case_category", "value": "", "type": "query", "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" }, { "name": "p_case_status", "value": "", "type": "query", "description": "Case Status Code Filter. Enter one or more case status codes to limit results. Provide multiple values as a comma-delimited list." }, { "name": "p_violation", "value": "", "type": "query", "description": "Violation Type Code Filter. Enter one or more violation type codes to limit results. Provide multiple values as a comma-delimited list." }, { "name": "p_milestone", "value": "", "type": "query", "description": "Administrative or Judicial Milestone Filter. Enter one or milestone values to restrict results. Provide multiple values as a comma-delimited list." }, { "name": "p_from_date", "value": "", "type": "query", "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." }, { "name": "p_to_date", "value": "", "type": "query", "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." }, { "name": "p_milestone_fy", "value": "", "type": "query", "description": "Administrative or Judicial Milestone Fiscal Year Limiter. Enter a single fiscal year value to limit milestone searches to a given fiscal year." }, { "name": "p_name", "value": "", "type": "query", "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." }, { "name": "p_name_type", "value": "", "type": "query", "description": "Case Name Filter Modifier." }, { "name": "p_case_number", "value": "", "type": "query", "description": "Case Number Filter. Enter one or more case numbers to restrict results. Provide multiple values as a comma-delimited list." }, { "name": "p_docket_number", "value": "", "type": "query", "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." }, { "name": "p_court_docket_number", "value": "", "type": "query" }, { "name": "p_activity_number", "value": "", "type": "query", "description": "Case Activity Number Filter. Enter a single case activity number to filter results." }, { "name": "p_case_lead", "value": "", "type": "query", "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." }, { "name": "p_case_sens_flg", "value": "", "type": "query", "description": "Case Sensitive Data Flag. Enter a Y or N to include or exclude cases with sensitive data." }, { "name": "p_region", "value": "", "type": "query", "description": "EPA Region Filter. Provide a single value of 01 thru 10 to restrict results to a single EPA region." }, { "name": "p_state", "value": "", "type": "query", "description": "Case Location State Filter. Enter one or more state USPS postal codes to filter results. Provide multiple values as a comma-delimited list." }, { "name": "p_district", "value": "", "type": "query", "description": "Case Location Court District Limiter. Enter a single state court district code to limit results." }, { "name": "p_sic", "value": "", "type": "query", "description": "Standard Industrial Classification (SIC) Code Filter. Enter a single 4-digit SIC Code to filter results." }, { "name": "p_sic_ao_naics", "value": "", "type": "query", "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)." }, { "name": "p_sic_primary_flg", "value": "", "type": "query", "description": "Case Location Primary SIC Flag. Enter Y to limit SIC search results to primary SIC codes only." }, { "name": "p_sic_frs_flg", "value": "", "type": "query", "description": "Case Location Extended FRS SIC Search Flag. Enter Y to expand SIC search to include Federal Registry Service datasets." }, { "name": "p_naics", "value": "", "type": "query", "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." }, { "name": "p_naics_primary_flg", "value": "", "type": "query", "description": "Case Location Primary NAICS Flag. Enter Y to limit NAICS search results to primary NAICS codes only." }, { "name": "p_naics_frs_flg", "value": "", "type": "query", "description": "Case Location Extended FRS NAICS Search Flag. Enter Y to expand NAICS search to include Federal Registry Service datasets." }, { "name": "p_enf_type", "value": "", "type": "query", "description": "Case Enforcement Type Filter. Enter one or more case enforcement type codes to limit results. Provide multiple values as a comma-delimited list." }, { "name": "p_law", "value": "", "type": "query", "description": "Law Statute Code Filter. Enter a single statute code to limit results." }, { "name": "p_section", "value": "", "type": "query", "description": "Law Section Code Filter. Enter one or more law section codes to limit results. Provide multiple values as a comma-delimited list." }, { "name": "p_cp_citation", "value": "", "type": "query", "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." }, { "name": "p_rank_order", "value": "", "type": "query", "description": "Law Status Rank Order Limiter. Enter a single integer rank order to limit results." }, { "name": "p_enf_program", "value": "", "type": "query", "description": "Enforcement Program Code Limiter. Enter one or more enforcement program codes to limit results. Provide multiple values as a comma-delimited list. " }, { "name": "p_priority_area", "value": "", "type": "query", "description": "Case Priority Area Filter. Enter one or more case priority areas to limit results. Provide multiple values as a comma-delimited list." }, { "name": "p_priority_area_desc", "value": "", "type": "query", "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." }, { "name": "p_tribal", "value": "", "type": "query", "description": "Case Location Tribal Land Flag. Enter Y or N to include or disallow cases on tribal land." }, { "name": "p_oeca_core", "value": "", "type": "query", "description": "OECA Core Program Flag. Enter Y or N to include or exclude core program cases." }, { "name": "p_multimedia", "value": "", "type": "query", "description": "Enforcement Multimedia Case Flag. Enter Y or N to include or exclude multimedia cases." }, { "name": "p_fed_case", "value": "", "type": "query", "description": "Federal Facility Involvement Flag. Enter a Y or N to include or exclude cases involving federal facilities." }, { "name": "p_activity_contact", "value": "", "type": "query", "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." }, { "name": "p_role", "value": "", "type": "query", "description": "Activity Contact Role Code Filter. Enter a single role code to restrict results." }, { "name": "p_fed_penalty", "value": "", "type": "query", "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." }, { "name": "p_total_fed_penalty", "value": "", "type": "query", "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." }, { "name": "p_cost_recovery", "value": "", "type": "query", "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." }, { "name": "p_total_cost_recovery", "value": "", "type": "query", "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." }, { "name": "p_complying_actions", "value": "", "type": "query", "description": "Complying Actions Type Code Limiter. Enter one or more complying action codes to restrict results. Provide multiple values as a comma-delimited list." }, { "name": "p_comp_act_val", "value": "", "type": "query", "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." }, { "name": "p_total_comp_act_val", "value": "", "type": "query", "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." }, { "name": "p_sep_cats", "value": "", "type": "query", "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." }, { "name": "p_sep_val", "value": "", "type": "query", "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." }, { "name": "p_total_sep_val", "value": "", "type": "query", "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." }, { "name": "p_lodged_date", "value": "", "type": "query", "description": "Settlement Lodged Date Limiter. Enter a single settlement lodged date in MM/DD/YYYY format to limit results." }, { "name": "p_entered_date", "value": "", "type": "query", "description": "Settlement Entered Date Limiter. Enter a single settlement entered date in MM/DD/YYYY format to limit results." }, { "name": "p_facility_id", "value": "", "type": "query", "description": "Case Facility Registration Identifier Limiter. Enter a single complete facility identifier to limit results." }, { "name": "p_fac_city", "value": "", "type": "query", "description": "Case Facility City Limiter. Enter a single complete city name to filter cases by facility location city." }, { "name": "p_fac_zip", "value": "", "type": "query", "description": "Case Facility ZIP Code Limiter. Enter a single 5-digit zip code to filter cases by facility location zip code." }, { "name": "p_fac_county", "value": "", "type": "query", "description": "Case Facility County Limiter. Enter a single complete county name to filter cases by facility location county name." }, { "name": "p_case_summary", "value": "", "type": "query", "description": "Case Summary Search Limiter. Enter a single case summary to limit results. This parameter accepts partial codes and allows for advanced search modifiers." }, { "name": "p_case_summary_type", "value": "", "type": "query", "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." }, { "name": "p_usmex", "value": "", "type": "query", "description": "US-Mexico Border Flag. Enter Y/N to restrict searches to facilities located within 100KM of the border." }, { "name": "p_c1lat", "value": "", "type": "query", "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." }, { "name": "p_c1lon", "value": "", "type": "query", "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." }, { "name": "p_c2lat", "value": "", "type": "query", "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." }, { "name": "p_c2lon", "value": "", "type": "query", "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." }, { "name": "p_voluntary", "value": "", "type": "query", "description": "Voluntary Self Disclosure Flag. Enter Y or N to include or exclude cases results having voluntary disclosure." }, { "name": "p_fed_indicator", "value": "", "type": "query", "description": "Federal Facility/Cross Media Flag. Enter Y or N to limit results to cases with federal facility cross media." }, { "name": "p_fntype", "value": "", "type": "query", "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 = " }, { "name": "p_civil_criminal_indicator", "value": "", "type": "query", "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." }, { "name": "queryset", "value": "", "type": "query", "description": "Query Limiter. Enter a value to limit the number of records returned for each query. Value cannot exceed 70,000." }, { "name": "responseset", "value": "", "type": "query", "description": "Response Set Limiter. Enter a value to limit the number of records per page. Value cannot exceed 1,000." }, { "name": "maplist", "value": "", "type": "query", "description": "Map List Flag. Provide a Y to return mappable coordinates representing the full geographic extent of the queryset (all facilities that met the selection criteria)." }, { "name": "tablelist", "value": "", "type": "query", "description": "Table List Flag. Enter a Y to display the first page of facility results." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP Callback. For use with JSONP and GEOJSONP output only. Enter a name of the function in which to wrap the JSON response." }, { "name": "qcolumns", "value": "", "type": "query", "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." }, { "name": "p_ocmap_fy", "value": "", "type": "query", "description": "Fiscal Year to select cases that are displayed in the Office of Complicance Fiscal Year Map Services" }, { "name": "p_qs", "value": "", "type": "query", "description": "Quick Search. Allows entry for city, state, and/or zip code." }, { "name": "p_has_map", "value": "", "type": "query" } ] }, "docs": "The get_cases service end point searches for civil enforcement and criminal cases based on the provided selection criteria." }, { "info": { "name": "Enforcement Case Search", "type": "http" }, "http": { "method": "POST", "url": "https://aqs.epa.gov/data/api/case_rest_services.get_cases" }, "docs": "The get_cases service end point searches for civil enforcement and criminal cases based on the provided selection criteria." }, { "info": { "name": "Placeholder", "type": "http" }, "http": { "method": "GET", "url": "https://aqs.epa.gov/data/api/case_rest_services.get_cases_from_facility", "params": [ { "name": "p_id", "value": "12345", "type": "query", "description": "Identifier for the service." }, { "name": "output", "value": "string", "type": "query", "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." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP Callback. For use with JSONP and GEOJSONP output only. Enter a name of the function in which to wrap the JSON response." } ] }, "docs": "Placeholder" }, { "info": { "name": "Placeholder", "type": "http" }, "http": { "method": "POST", "url": "https://aqs.epa.gov/data/api/case_rest_services.get_cases_from_facility", "params": [ { "name": "p_id", "value": "12345", "type": "query", "description": "Identifier for the service." }, { "name": "output", "value": "string", "type": "query", "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." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP Callback. For use with JSONP and GEOJSONP output only. Enter a name of the function in which to wrap the JSON response." } ] }, "docs": "Placeholder" }, { "info": { "name": "Enforcement Criminal Case Summary Report Search", "type": "http" }, "http": { "method": "GET", "url": "https://aqs.epa.gov/data/api/case_rest_services.get_crcase_report", "params": [ { "name": "p_id", "value": "12345", "type": "query", "description": "Prosecution Summary Identifier. Enter the numeric prosecution summary identifier to retrieve the criminal case report." }, { "name": "output", "value": "string", "type": "query", "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." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP Callback. For use with JSONP and GEOJSONP output only. Enter a name of the function in which to wrap the JSON response." }, { "name": "mapset", "value": "", "type": "query", "description": "Identifies the maxium number of case facilities to return from the case_rest_services.get_case_info query." } ] }, "docs": "The get_crcase_report service end point returns a complex object of criminal case detials based on the provided criminal case id." }, { "info": { "name": "Enforcement Criminal Case Summary Report Search", "type": "http" }, "http": { "method": "POST", "url": "https://aqs.epa.gov/data/api/case_rest_services.get_crcase_report" }, "docs": "The get_crcase_report service end point returns a complex object of criminal case detials based on the provided criminal case id." }, { "info": { "name": "Enforcement Case Download Data Service", "type": "http" }, "http": { "method": "GET", "url": "https://aqs.epa.gov/data/api/case_rest_services.get_download", "params": [ { "name": "output", "value": "string", "type": "query", "description": "Output Format Flag. Enter one of the following keywords:\n- CSV = Facility results formatted as comma delimited file download (default)." }, { "name": "qid", "value": "", "type": "query", "description": "Query ID Selector. Enter the QueryID number from a previously run query." }, { "name": "qcolumns", "value": "", "type": "query", "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." } ] }, "docs": "Based on the QID obtained from a get_cases query, return a comma separated value (CSV) file of the cases found." }, { "info": { "name": "Enforcement Case Download Data Service", "type": "http" }, "http": { "method": "POST", "url": "https://aqs.epa.gov/data/api/case_rest_services.get_download" }, "docs": "Based on the QID obtained from a get_cases query, return a comma separated value (CSV) file of the cases found." }, { "info": { "name": "Placeholder", "type": "http" }, "http": { "method": "GET", "url": "https://aqs.epa.gov/data/api/case_rest_services.get_facilities_from_case", "params": [ { "name": "p_id", "value": "12345", "type": "query", "description": "Identifier for the service." }, { "name": "output", "value": "string", "type": "query", "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." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP Callback. For use with JSONP and GEOJSONP output only. Enter a name of the function in which to wrap the JSON response." } ] }, "docs": "Placeholder" }, { "info": { "name": "Placeholder", "type": "http" }, "http": { "method": "POST", "url": "https://aqs.epa.gov/data/api/case_rest_services.get_facilities_from_case", "params": [ { "name": "p_id", "value": "12345", "type": "query", "description": "Identifier for the service." }, { "name": "output", "value": "string", "type": "query", "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." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP Callback. For use with JSONP and GEOJSONP output only. Enter a name of the function in which to wrap the JSON response." } ] }, "docs": "Placeholder" }, { "info": { "name": "Enforcement Case Map Service", "type": "http" }, "http": { "method": "GET", "url": "https://aqs.epa.gov/data/api/case_rest_services.get_map", "params": [ { "name": "output", "value": "string", "type": "query", "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." }, { "name": "qid", "value": "", "type": "query", "description": "Query ID Selector. Enter the QueryID number from a previously run query." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP Callback. For use with JSONP and GEOJSONP output only. Enter a name of the function in which to wrap the JSON response." }, { "name": "tablelist", "value": "", "type": "query", "description": "Table List Flag. Enter a Y to display the first page of facility results." }, { "name": "c1_lat", "value": "", "type": "query", "description": "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." }, { "name": "c1_long", "value": "", "type": "query", "description": "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." }, { "name": "c2_lat", "value": "", "type": "query", "description": "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." }, { "name": "c2_long", "value": "", "type": "query", "description": "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." } ] }, "docs": "The purpose of the GET_MAP service is to display facility coordinates and facility clusters related to a get_cases query. Currently, the maximum number of coordinates returned is 500. GET_MAP performs automatic clustering at the state, county, and zip code levels to maximize the number of coordinates returned." }, { "info": { "name": "Enforcement Case Map Service", "type": "http" }, "http": { "method": "POST", "url": "https://aqs.epa.gov/data/api/case_rest_services.get_map" }, "docs": "The purpose of the GET_MAP service is to display facility coordinates and facility clusters related to a get_cases query. Currently, the maximum number of coordinates returned is 500. GET_MAP performs automatic clustering at the state, county, and zip code levels to maximize the number of coordinates returned." }, { "info": { "name": "Enforcement Case Paginated Results Service", "type": "http" }, "http": { "method": "GET", "url": "https://aqs.epa.gov/data/api/case_rest_services.get_qid", "params": [ { "name": "output", "value": "string", "type": "query", "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." }, { "name": "qid", "value": "", "type": "query", "description": "Query ID Selector. Enter the QueryID number from a previously run query." }, { "name": "pageno", "value": "", "type": "query", "description": "Indicates the number of the page to display. It is used only when the results are paginated." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP Callback. For use with JSONP and GEOJSONP output only. Enter a name of the function in which to wrap the JSON response." }, { "name": "newsort", "value": "", "type": "query", "description": "Output Sort Column. Enter the number of the column on which the data will be sorted. If unpopulated results will sort on the first column." }, { "name": "descending", "value": "", "type": "query", "description": "Output Sort Column Descending Flag. Enter Y to column identified in the newsort parameter descending. Enter N to use ascending sort order. Used only when newsort parameter is populated." }, { "name": "qcolumns", "value": "", "type": "query", "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." } ] }, "docs": "GET_QID is passed with a query ID corresponding to a previously run get_cases query. It then returns a CASES object containing all matching cases. The main purpose of GET_QID is for large querysets that contain multiple pages (responsesets) of output. GET_QID allows for pagination and for the selection and sorting of columns. " }, { "info": { "name": "Enforcement Case Paginated Results Service", "type": "http" }, "http": { "method": "POST", "url": "https://aqs.epa.gov/data/api/case_rest_services.get_qid" }, "docs": "GET_QID is passed with a query ID corresponding to a previously run get_cases query. It then returns a CASES object containing all matching cases. The main purpose of GET_QID is for large querysets that contain multiple pages (responsesets) of output. GET_QID allows for pagination and for the selection and sorting of columns. " } ] } ], "bundled": true }