@datafire/epa_gov_case
v6.0.0
Published
DataFire integration for U.S. EPA Enforcement and Compliance History Online (ECHO) - Enforcement Case Search
Downloads
3
Readme
@datafire/epa_gov_case
Client library for U.S. EPA Enforcement and Compliance History Online (ECHO) - Enforcement Case Search
Installation and Usage
npm install --save @datafire/epa_gov_caselet epa_gov_case = require('@datafire/epa_gov_case').create();
.then(data => {
console.log(data);
});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.
CASE Rest Services provide multiple service endpoints, each with specific capabilities, to search and retrieve data on civil cases entered into the
Integrated Compliance Information System (ICIS) and criminal cases entered into the Summary of Criminal Prosecutions database.
See Enforcement Case Search Help (https://echo.epa.gov/help/enforcement-case-search-help) for additional information on searching civil and criminal cases.
The 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..
The recommended use scenario for get_cases, get_qid, get_map, and get_downoad is:
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.
2) Use get_qid, with the returned QID, to paginate through arrays of case results.
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.
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.
In 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).
See 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
on then data returned from these two services.
Additional ECHO Resources: Web Services, About ECHO's Data, Data Downloads
Actions
case_rest_services.get_case_info.get
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.
epa_gov_case.case_rest_services.get_case_info.get({}, context)Input
- input
object- output
string(values: JSONP, JSON, XML): Output Format Flag. Enter one of the following keywords: - p_case_category
string: Case Category Filter. Enter one or more case category codes to filter results. Provide multiple values as a comma-delimited list. - p_case_status
string: Case Status Code Filter. Enter one or more case status codes to limit results. Provide multiple values as a comma-delimited list. - p_milestone
string: Administrative or Judicial Milestone Filter. Enter one or milestone values to restrict results. Provide multiple values as a comma-delimited list. - p_from_date
string: 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. - p_to_date
string: 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. - p_milestone_fy
string: Administrative or Judicial Milestone Fiscal Year Limiter. Enter a single fiscal year value to limit milestone searches to a given fiscal year. - p_name
string: 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. - p_name_type
string: Case Name Filter Modifier. - p_case_number
string: Case Number Filter. Enter one or more case numbers to restrict results. Provide multiple values as a comma-delimited list. - p_docket_number
string: DOJ Docket Number Filter. Enter a single docket number or partial docket number to restrict results. Use "%" as a wildcard for more complex filtering. - p_court_docket_number
string - p_activity_number
string: Case Activity Number Filter. Enter a single case activity number to filter results. - p_case_lead
string(values: E, S): Case Lead Limiter. Enter E or S to limit results. - p_case_sens_flg
string: Case Sensitive Data Flag. Enter a Y or N to include or exclude cases with sensitive data. - p_region
string(values: 01, 02, 03, 04, 05, 06, 07, 08, 09, 10): EPA Region Filter. Provide a single value of 01 thru 10 to restrict results to a single EPA region. - p_state
string: Case Location State Filter. Enter one or more state USPS postal codes to filter results. Provide multiple values as a comma-delimited list. - p_district
string: Case Location Court District Limiter. Enter a single state court district code to limit results. - p_sic
string: Standard Industrial Classification (SIC) Code Filter. Enter a single 4-digit SIC Code to filter results. - p_sic_ao_naics
string(values: AND, OR): Case Location SIC/NAICS And/Or Modifier. Enter either AND or OR to govern the search logic of SIC and NAICS codes. - p_sic_primary_flg
string(values: Y, N): Case Location Primary SIC Flag. Enter Y to limit SIC search results to primary SIC codes only. - p_sic_frs_flg
string(values: Y, N): Case Location Extended FRS SIC Search Flag. Enter Y to expand SIC search to include Federal Registry Service datasets. - p_naics
string: 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. - p_naics_primary_flg
string(values: Y, N): Case Location Primary NAICS Flag. Enter Y to limit NAICS search results to primary NAICS codes only. - p_naics_frs_flg
string(values: Y, N): Case Location Extended FRS NAICS Search Flag. Enter Y to expand NAICS search to include Federal Registry Service datasets. - p_enf_type
string: Case Enforcement Type Filter. Enter one or more case enforcement type codes to limit results. Provide multiple values as a comma-delimited list. - p_law
string: Law Statute Code Filter. Enter a single statute code to limit results. - p_section
string: Law Section Code Filter. Enter one or more law section codes to limit results. Provide multiple values as a comma-delimited list. - p_cp_citation
string: 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. - p_rank_order
string(values: 1, 0): Law Status Rank Order Limiter. Enter a single integer rank order to limit results. - p_enf_program
string: Enforcement Program Code Limiter. Enter one or more enforcement program codes to limit results. Provide multiple values as a comma-delimited list. - p_violation
string: Violation Type Code Filter. Enter one or more violation type codes to limit results. Provide multiple values as a comma-delimited list. - p_priority_area
string: Case Priority Area Filter. Enter one or more case priority areas to limit results. Provide multiple values as a comma-delimited list. - p_priority_area_desc
string: 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. - p_tribal
string(values: Y, N): Case Location Tribal Land Flag. Enter Y or N to include or disallow cases on tribal land. - p_oeca_core
string(values: Y, N): OECA Core Program Flag. Enter Y or N to include or exclude core program cases. - p_multimedia
string(values: Y, N): Enforcement Multimedia Case Flag. Enter Y or N to include or exclude multimedia cases. - p_fed_case
string(values: Y, N): Federal Facility Involvement Flag. Enter a Y or N to include or exclude cases involving federal facilities. - p_activity_contact
string: 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. - p_role
string: Activity Contact Role Code Filter. Enter a single role code to restrict results. - p_fed_penalty
string(values: ANY, LE5000, GT5000, GT50000, GT100000, GT500000, GT1000000, GT2500000): Federal Penalty Assessed Amount Filter. Provide one of the following keywords to restrict results. - p_total_fed_penalty
string: Total Federal Penalty Limiter. Enter a keyword value to limit results to cases with given total federal penalties. - p_cost_recovery
string: Cost Recovery Awarded Amount Limiter. Enter a keyword value to limit results to cases with given cost recovery amounts. - p_total_cost_recovery
string: Total Cost Recovery Amount Limiter. Enter a keyword value to limit results to cases with given cost recovery amounts. - p_complying_actions
string: Complying Actions Type Code Limiter. Enter one or more complying action codes to restrict results. Provide multiple values as a comma-delimited list. - p_comp_act_val
string(values: ANY, LE5000, GT5000, GT100000, GT1000000, GT50000000): Compliance Action Cost Limiter. Enter a keyword value to limit results to cases with given compliance cost amounts. - p_total_comp_act_val
string: Total Compliance Action Amount Limiter. Enter a keyword value to limit results to cases with given total compliance action amounts. - p_sep_cats
string: 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. - p_sep_val
string(values: ANY, LE10000, GT10000, GT50000, GT100000, GT500000, GT1000000): Supplemental Environmental Projects Activity Value Limiter. Provide a keyword to limit results. - p_total_sep_val
string: Supplemental Environmental Projects Total Value Limiter. Provide a keyword to limit results. - p_lodged_date
string: Settlement Lodged Date Limiter. Enter a single settlement lodged date in MM/DD/YYYY format to limit results. - p_entered_date
string: Settlement Entered Date Limiter. Enter a single settlement entered date in MM/DD/YYYY format to limit results. - p_facility_id
string: Case Facility Registration Identifier Limiter. Enter a single complete facility identifier to limit results. - p_fac_city
string: Case Facility City Limiter. Enter a single complete city name to filter cases by facility location city. - p_fac_zip
string: Case Facility ZIP Code Limiter. Enter a single 5-digit zip code to filter cases by facility location zip code. - p_fac_county
string: Case Facility County Limiter. Enter a single complete county name to filter cases by facility location county name. - p_case_summary
string: Case Summary Search Limiter. Enter a single case summary to limit results. This parameter accepts partial codes and allows for advanced search modifiers. - p_case_summary_type
string(values: ALL, CONTAINS, WITHIN): 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. - p_usmex
string(values: Y, N): US-Mexico Border Flag. Enter Y/N to restrict searches to facilities located within 100KM of the border. - p_c1lat
number: 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. - p_c1lon
number: 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. - p_c2lat
number: 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. - p_c2lon
number: 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. - p_voluntary
string: Voluntary Self Disclosure Flag. Enter Y or N to include or exclude cases results having voluntary disclosure. - p_fed_indicator
string: Federal Facility/Cross Media Flag. Enter Y or N to limit results to cases with federal facility cross media. - p_fntype
string(values: ALL, CONTAINS, EXACT, BEGINS): Controls type of text search performed on facility name with parameter p_fn. - p_civil_criminal_indicator
string(values: CI, CR, ALL): Civil/Criminal Case Limiter. Provide a keyword to limit results. - queryset
number: Query Limiter. Enter a value to limit the number of records returned for each query. Value cannot exceed 70,000. - responseset
number: Response Set Limiter. Enter a value to limit the number of records per page. Value cannot exceed 1,000. - mapset
string: Identifies the maxium number of case facilities to return from the case_rest_services.get_case_info query. - callback
string: JSONP Callback. For use with JSONP and GEOJSONP output only. Enter a name of the function in which to wrap the JSON response. - qcolumns
string: 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. - p_pretty_print
number: 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. - p_ocmap_fy
string: Fiscal Year to select cases that are displayed in the Office of Complicance Fiscal Year Map Services - p_qs
string: Quick Search. Allows entry for city, state, and/or zip code. - p_has_map
string
- output
Output
- output
object: Root Object- Results required crs0_get_case_info.Results
case_rest_services.get_case_info.post
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.
epa_gov_case.case_rest_services.get_case_info.post({}, context)Input
- input
object- output
string(values: JSONP, JSON, XML): Output Format Flag. Enter one of the following keywords: - p_case_category
string: Case Category Filter. Enter one or more case category codes to filter results. Provide multiple values as a comma-delimited list. - p_case_status
string: Case Status Code Filter. Enter one or more case status codes to limit results. Provide multiple values as a comma-delimited list. - p_milestone
string: Administrative or Judicial Milestone Filter. Enter one or milestone values to restrict results. Provide multiple values as a comma-delimited list. - p_from_date
string: 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. - p_to_date
string: 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. - p_milestone_fy
string: Administrative or Judicial Milestone Fiscal Year Limiter. Enter a single fiscal year value to limit milestone searches to a given fiscal year. - p_name
string: 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. - p_name_type
string: Case Name Filter Modifier. - p_case_number
string: Case Number Filter. Enter one or more case numbers to restrict results. Provide multiple values as a comma-delimited list. - p_docket_number
string: DOJ Docket Number Filter. Enter a single docket number or partial docket number to restrict results. Use "%" as a wildcard for more complex filtering. - p_court_docket_number
string - p_activity_number
string: Case Activity Number Filter. Enter a single case activity number to filter results. - p_case_lead
string(values: E, S): Case Lead Limiter. Enter E or S to limit results. - p_case_sens_flg
string: Case Sensitive Data Flag. Enter a Y or N to include or exclude cases with sensitive data. - p_region
string(values: 01, 02, 03, 04, 05, 06, 07, 08, 09, 10): EPA Region Filter. Provide a single value of 01 thru 10 to restrict results to a single EPA region. - p_state
string: Case Location State Filter. Enter one or more state USPS postal codes to filter results. Provide multiple values as a comma-delimited list. - p_district
string: Case Location Court District Limiter. Enter a single state court district code to limit results. - p_sic
string: Standard Industrial Classification (SIC) Code Filter. Enter a single 4-digit SIC Code to filter results. - p_sic_ao_naics
string(values: AND, OR): Case Location SIC/NAICS And/Or Modifier. Enter either AND or OR to govern the search logic of SIC and NAICS codes. - p_sic_primary_flg
string(values: Y, N): Case Location Primary SIC Flag. Enter Y to limit SIC search results to primary SIC codes only. - p_sic_frs_flg
string(values: Y, N): Case Location Extended FRS SIC Search Flag. Enter Y to expand SIC search to include Federal Registry Service datasets. - p_naics
string: 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. - p_naics_primary_flg
string(values: Y, N): Case Location Primary NAICS Flag. Enter Y to limit NAICS search results to primary NAICS codes only. - p_naics_frs_flg
string(values: Y, N): Case Location Extended FRS NAICS Search Flag. Enter Y to expand NAICS search to include Federal Registry Service datasets. - p_enf_type
string: Case Enforcement Type Filter. Enter one or more case enforcement type codes to limit results. Provide multiple values as a comma-delimited list. - p_law
string: Law Statute Code Filter. Enter a single statute code to limit results. - p_section
string: Law Section Code Filter. Enter one or more law section codes to limit results. Provide multiple values as a comma-delimited list. - p_cp_citation
string: 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. - p_rank_order
string(values: 1, 0): Law Status Rank Order Limiter. Enter a single integer rank order to limit results. - p_enf_program
string: Enforcement Program Code Limiter. Enter one or more enforcement program codes to limit results. Provide multiple values as a comma-delimited list. - p_violation
string: Violation Type Code Filter. Enter one or more violation type codes to limit results. Provide multiple values as a comma-delimited list. - p_priority_area
string: Case Priority Area Filter. Enter one or more case priority areas to limit results. Provide multiple values as a comma-delimited list. - p_priority_area_desc
string: 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. - p_tribal
string(values: Y, N): Case Location Tribal Land Flag. Enter Y or N to include or disallow cases on tribal land. - p_oeca_core
string(values: Y, N): OECA Core Program Flag. Enter Y or N to include or exclude core program cases. - p_multimedia
string(values: Y, N): Enforcement Multimedia Case Flag. Enter Y or N to include or exclude multimedia cases. - p_fed_case
string(values: Y, N): Federal Facility Involvement Flag. Enter a Y or N to include or exclude cases involving federal facilities. - p_activity_contact
string: 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. - p_role
string: Activity Contact Role Code Filter. Enter a single role code to restrict results. - p_fed_penalty
string(values: ANY, LE5000, GT5000, GT50000, GT100000, GT500000, GT1000000, GT2500000): Federal Penalty Assessed Amount Filter. Provide one of the following keywords to restrict results. - p_total_fed_penalty
string: Total Federal Penalty Limiter. Enter a keyword value to limit results to cases with given total federal penalties. - p_cost_recovery
string: Cost Recovery Awarded Amount Limiter. Enter a keyword value to limit results to cases with given cost recovery amounts. - p_total_cost_recovery
string: Total Cost Recovery Amount Limiter. Enter a keyword value to limit results to cases with given cost recovery amounts. - p_complying_actions
string: Complying Actions Type Code Limiter. Enter one or more complying action codes to restrict results. Provide multiple values as a comma-delimited list. - p_comp_act_val
string(values: ANY, LE5000, GT5000, GT100000, GT1000000, GT50000000): Compliance Action Cost Limiter. Enter a keyword value to limit results to cases with given compliance cost amounts. - p_total_comp_act_val
string: Total Compliance Action Amount Limiter. Enter a keyword value to limit results to cases with given total compliance action amounts. - p_sep_cats
string: 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. - p_sep_val
string(values: ANY, LE10000, GT10000, GT50000, GT100000, GT500000, GT1000000): Supplemental Environmental Projects Activity Value Limiter. Provide a keyword to limit results. - p_total_sep_val
string: Supplemental Environmental Projects Total Value Limiter. Provide a keyword to limit results. - p_lodged_date
string: Settlement Lodged Date Limiter. Enter a single settlement lodged date in MM/DD/YYYY format to limit results. - p_entered_date
string: Settlement Entered Date Limiter. Enter a single settlement entered date in MM/DD/YYYY format to limit results. - p_facility_id
string: Case Facility Registration Identifier Limiter. Enter a single complete facility identifier to limit results. - p_fac_city
string: Case Facility City Limiter. Enter a single complete city name to filter cases by facility location city. - p_fac_zip
string: Case Facility ZIP Code Limiter. Enter a single 5-digit zip code to filter cases by facility location zip code. - p_fac_county
string: Case Facility County Limiter. Enter a single complete county name to filter cases by facility location county name. - p_case_summary
string: Case Summary Search Limiter. Enter a single case summary to limit results. This parameter accepts partial codes and allows for advanced search modifiers. - p_case_summary_type
string(values: ALL, CONTAINS, WITHIN): 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. - p_usmex
string(values: Y, N): US-Mexico Border Flag. Enter Y/N to restrict searches to facilities located within 100KM of the border. - p_c1lat
number: 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. - p_c1lon
number: 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. - p_c2lat
number: 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. - p_c2lon
number: 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. - p_voluntary
string: Voluntary Self Disclosure Flag. Enter Y or N to include or exclude cases results having voluntary disclosure. - p_fed_indicator
string: Federal Facility/Cross Media Flag. Enter Y or N to limit results to cases with federal facility cross media. - p_fntype
string(values: ALL, CONTAINS, EXACT, BEGINS): Controls type of text search performed on facility name with parameter p_fn. - p_civil_criminal_indicator
string(values: CI, CR, ALL): Civil/Criminal Case Limiter. Provide a keyword to limit results. - queryset
number: Query Limiter. Enter a value to limit the number of records returned for each query. Value cannot exceed 70,000. - responseset
number: Response Set Limiter. Enter a value to limit the number of records per page. Value cannot exceed 1,000. - mapset
string: Identifies the maxium number of case facilities to return from the case_rest_services.get_case_info query. - callback
string: JSONP Callback. For use with JSONP and GEOJSONP output only. Enter a name of the function in which to wrap the JSON response. - qcolumns
string: 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. - p_pretty_print
number: 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. - p_ocmap_fy
string: Fiscal Year to select cases that are displayed in the Office of Complicance Fiscal Year Map Services - p_qs
string: Quick Search. Allows entry for city, state, and/or zip code. - p_has_map
string
- output
Output
- output
object: Root Object- Results required crs0_get_case_info.Results
case_rest_services.get_case_report.get
The get_case_report service endpoint returns a complex object of civil enforcement case details based on the provided case id.
epa_gov_case.case_rest_services.get_case_report.get({}, context)Input
- input
object- p_id
string: Case Number. Enter the case number identifier to retrieve the case report. - output
string(values: JSONP, JSON, XML): Output Format Flag. Enter one of the following keywords: - callback
string: JSONP Callback. For use with JSONP and GEOJSONP output only. Enter a name of the function in which to wrap the JSON response.
- p_id
Output
- output
object: Service call container.- Results required crs1_Results
case_rest_services.get_case_report.post
The get_case_report service endpoint returns a complex object of civil enforcement case details based on the provided case id.
epa_gov_case.case_rest_services.get_case_report.post({}, context)Input
- input
object- p_id
string: Case Number. Enter the case number identifier to retrieve the case report. - output
string(values: JSONP, JSON, XML): Output Format Flag. Enter one of the following keywords: - callback
string: JSONP Callback. For use with JSONP and GEOJSONP output only. Enter a name of the function in which to wrap the JSON response.
- p_id
Output
- output
object: Service call container.- Results required crs1_Results
case_rest_services.get_cases.get
The get_cases service end point searches for civil enforcement and criminal cases based on the provided selection criteria.
epa_gov_case.case_rest_services.get_cases.get({}, context)Input
- input
object- output
string(values: JSONP, JSON, XML): Output Format Flag. Enter one of the following keywords: - p_case_category
string: Case Category Filter. Enter one or more case category codes to filter results. Provide multiple values as a comma-delimited list. - p_case_status
string: Case Status Code Filter. Enter one or more case status codes to limit results. Provide multiple values as a comma-delimited list. - p_violation
string: Violation Type Code Filter. Enter one or more violation type codes to limit results. Provide multiple values as a comma-delimited list. - p_milestone
string: Administrative or Judicial Milestone Filter. Enter one or milestone values to restrict results. Provide multiple values as a comma-delimited list. - p_from_date
string: 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. - p_to_date
string: 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. - p_milestone_fy
string: Administrative or Judicial Milestone Fiscal Year Limiter. Enter a single fiscal year value to limit milestone searches to a given fiscal year. - p_name
string: 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. - p_name_type
string: Case Name Filter Modifier. - p_case_number
string: Case Number Filter. Enter one or more case numbers to restrict results. Provide multiple values as a comma-delimited list. - p_docket_number
string: DOJ Docket Number Filter. Enter a single docket number or partial docket number to restrict results. Use "%" as a wildcard for more complex filtering. - p_court_docket_number
string - p_activity_number
string: Case Activity Number Filter. Enter a single case activity number to filter results. - p_case_lead
string(values: E, S): Case Lead Limiter. Enter E or S to limit results. - p_case_sens_flg
string: Case Sensitive Data Flag. Enter a Y or N to include or exclude cases with sensitive data. - p_region
string(values: 01, 02, 03, 04, 05, 06, 07, 08, 09, 10): EPA Region Filter. Provide a single value of 01 thru 10 to restrict results to a single EPA region. - p_state
string: Case Location State Filter. Enter one or more state USPS postal codes to filter results. Provide multiple values as a comma-delimited list. - p_district
string: Case Location Court District Limiter. Enter a single state court district code to limit results. - p_sic
string: Standard Industrial Classification (SIC) Code Filter. Enter a single 4-digit SIC Code to filter results. - p_sic_ao_naics
string(values: AND, OR): Case Location SIC/NAICS And/Or Modifier. Enter either AND or OR to govern the search logic of SIC and NAICS codes. - p_sic_primary_flg
string(values: Y, N): Case Location Primary SIC Flag. Enter Y to limit SIC search results to primary SIC codes only. - p_sic_frs_flg
string(values: Y, N): Case Location Extended FRS SIC Search Flag. Enter Y to expand SIC search to include Federal Registry Service datasets. - p_naics
string: 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. - p_naics_primary_flg
string(values: Y, N): Case Location Primary NAICS Flag. Enter Y to limit NAICS search results to primary NAICS codes only. - p_naics_frs_flg
string(values: Y, N): Case Location Extended FRS NAICS Search Flag. Enter Y to expand NAICS search to include Federal Registry Service datasets. - p_enf_type
string: Case Enforcement Type Filter. Enter one or more case enforcement type codes to limit results. Provide multiple values as a comma-delimited list. - p_law
string: Law Statute Code Filter. Enter a single statute code to limit results. - p_section
string: Law Section Code Filter. Enter one or more law section codes to limit results. Provide multiple values as a comma-delimited list. - p_cp_citation
string: 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. - p_rank_order
string(values: 1, 0): Law Status Rank Order Limiter. Enter a single integer rank order to limit results. - p_enf_program
string: Enforcement Program Code Limiter. Enter one or more enforcement program codes to limit results. Provide multiple values as a comma-delimited list. - p_priority_area
string: Case Priority Area Filter. Enter one or more case priority areas to limit results. Provide multiple values as a comma-delimited list. - p_priority_area_desc
string: 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. - p_tribal
string(values: Y, N): Case Location Tribal Land Flag. Enter Y or N to include or disallow cases on tribal land. - p_oeca_core
string(values: Y, N): OECA Core Program Flag. Enter Y or N to include or exclude core program cases. - p_multimedia
string(values: Y, N): Enforcement Multimedia Case Flag. Enter Y or N to include or exclude multimedia cases. - p_fed_case
string(values: Y, N): Federal Facility Involvement Flag. Enter a Y or N to include or exclude cases involving federal facilities. - p_activity_contact
string: 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. - p_role
string: Activity Contact Role Code Filter. Enter a single role code to restrict results. - p_fed_penalty
string(values: ANY, LE5000, GT5000, GT50000, GT100000, GT500000, GT1000000, GT2500000): Federal Penalty Assessed Amount Filter. Provide one of the following keywords to restrict results. - p_total_fed_penalty
string: Total Federal Penalty Limiter. Enter a keyword value to limit results to cases with given total federal penalties. - p_cost_recovery
string: Cost Recovery Awarded Amount Limiter. Enter a keyword value to limit results to cases with given cost recovery amounts. - p_total_cost_recovery
string: Total Cost Recovery Amount Limiter. Enter a keyword value to limit results to cases with given cost recovery amounts. - p_complying_actions
string: Complying Actions Type Code Limiter. Enter one or more complying action codes to restrict results. Provide multiple values as a comma-delimited list. - p_comp_act_val
string(values: ANY, LE5000, GT5000, GT100000, GT1000000, GT50000000): Compliance Action Cost Limiter. Enter a keyword value to limit results to cases with given compliance cost amounts. - p_total_comp_act_val
string: Total Compliance Action Amount Limiter. Enter a keyword value to limit results to cases with given total compliance action amounts. - p_sep_cats
string: 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. - p_sep_val
string(values: ANY, LE10000, GT10000, GT50000, GT100000, GT500000, GT1000000): Supplemental Environmental Projects Activity Value Limiter. Provide a keyword to limit results. - p_total_sep_val
string: Supplemental Environmental Projects Total Value Limiter. Provide a keyword to limit results. - p_lodged_date
string: Settlement Lodged Date Limiter. Enter a single settlement lodged date in MM/DD/YYYY format to limit results. - p_entered_date
string: Settlement Entered Date Limiter. Enter a single settlement entered date in MM/DD/YYYY format to limit results. - p_facility_id
string: Case Facility Registration Identifier Limiter. Enter a single complete facility identifier to limit results. - p_fac_city
string: Case Facility City Limiter. Enter a single complete city name to filter cases by facility location city. - p_fac_zip
string: Case Facility ZIP Code Limiter. Enter a single 5-digit zip code to filter cases by facility location zip code. - p_fac_county
string: Case Facility County Limiter. Enter a single complete county name to filter cases by facility location county name. - p_case_summary
string: Case Summary Search Limiter. Enter a single case summary to limit results. This parameter accepts partial codes and allows for advanced search modifiers. - p_case_summary_type
string(values: ALL, CONTAINS, WITHIN): 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. - p_usmex
string(values: Y, N): US-Mexico Border Flag. Enter Y/N to restrict searches to facilities located within 100KM of the border. - p_c1lat
number: 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. - p_c1lon
number: 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. - p_c2lat
number: 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. - p_c2lon
number: 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. - p_voluntary
string: Voluntary Self Disclosure Flag. Enter Y or N to include or exclude cases results having voluntary disclosure. - p_fed_indicator
string: Federal Facility/Cross Media Flag. Enter Y or N to limit results to cases with federal facility cross media. - p_fntype
string(values: ALL, CONTAINS, EXACT, BEGINS): Controls type of text search performed on facility name with parameter p_fn. - p_civil_criminal_indicator
string(values: CI, CR, ALL): Civil/Criminal Case Limiter. Provide a keyword to limit results. - queryset
number: Query Limiter. Enter a value to limit the number of records returned for each query. Value cannot exceed 70,000. - responseset
number: Response Set Limiter. Enter a value to limit the number of records per page. Value cannot exceed 1,000. - maplist
string(values: Y, N): 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). - tablelist
string(values: Y, N): Table List Flag. Enter a Y to display the first page of facility results. - callback
string: JSONP Callback. For use with JSONP and GEOJSONP output only. Enter a name of the function in which to wrap the JSON response. - qcolumns
string: 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. - p_ocmap_fy
string: Fiscal Year to select cases that are displayed in the Office of Complicance Fiscal Year Map Services - p_qs
string: Quick Search. Allows entry for city, state, and/or zip code. - p_has_map
string
- output
Output
- output
object: Service call container.- Results required crs2_Results
case_rest_services.get_cases.post
The get_cases service end point searches for civil enforcement and criminal cases based on the provided selection criteria.
epa_gov_case.case_rest_services.get_cases.post({}, context)Input
- input
object- output
string(values: JSONP, JSON, XML): Output Format Flag. Enter one of the following keywords: - p_case_category
string: Case Category Filter. Enter one or more case category codes to filter results. Provide multiple values as a comma-delimited list. - p_case_status
string: Case Status Code Filter. Enter one or more case status codes to limit results. Provide multiple values as a comma-delimited list. - p_milestone
string: Administrative or Judicial Milestone Filter. Enter one or milestone values to restrict results. Provide multiple values as a comma-delimited list. - p_from_date
string: 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. - p_to_date
string: 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. - p_milestone_fy
string: Administrative or Judicial Milestone Fiscal Year Limiter. Enter a single fiscal year value to limit milestone searches to a given fiscal year. - p_name
string: 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. - p_name_type
string: Case Name Filter Modifier. - p_case_number
string: Case Number Filter. Enter one or more case numbers to restrict results. Provide multiple values as a comma-delimited list. - p_docket_number
string: DOJ Docket Number Filter. Enter a single docket number or partial docket number to restrict results. Use "%" as a wildcard for more complex filtering. - p_court_docket_number
string - p_activity_number
string: Case Activity Number Filter. Enter a single case activity number to filter results. - p_case_lead
string(values: E, S): Case Lead Limiter. Enter E or S to limit results. - p_case_sens_flg
string: Case Sensitive Data Flag. Enter a Y or N to include or exclude cases with sensitive data. - p_region
string(values: 01, 02, 03, 04, 05, 06, 07, 08, 09, 10): EPA Region Filter. Provide a single value of 01 thru 10 to restrict results to a single EPA region. - p_state
string: Case Location State Filter. Enter one or more state USPS postal codes to filter results. Provide multiple values as a comma-delimited list. - p_district
string: Case Location Court District Limiter. Enter a single state court district code to limit results. - p_sic
string: Standard Industrial Classification (SIC) Code Filter. Enter a single 4-digit SIC Code to filter results. - p_sic_ao_naics
string(values: AND, OR): Case Location SIC/NAICS And/Or Modifier. Enter either AND or OR to govern the search logic of SIC and NAICS codes. - p_sic_primary_flg
string(values: Y, N): Case Location Primary SIC Flag. Enter Y to limit SIC search results to primary SIC codes only. - p_sic_frs_flg
string(values: Y, N): Case Location Extended FRS SIC Search Flag. Enter Y to expand SIC search to include Federal Registry Service datasets. - p_naics
string: 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. - p_naics_primary_flg
string(values: Y, N): Case Location Primary NAICS Flag. Enter Y to limit NAICS search results to primary NAICS codes only. - p_naics_frs_flg
string(values: Y, N): Case Location Extended FRS NAICS Search Flag. Enter Y to expand NAICS search to include Federal Registry Service datasets. - p_enf_type
string: Case Enforcement Type Filter. Enter one or more case enforcement type codes to limit results. Provide multiple values as a comma-delimited list. - p_law
string: Law Statute Code Filter. Enter a single statute code to limit results. - p_section
string: Law Section Code Filter. Enter one or more law section codes to limit results. Provide multiple values as a comma-delimited list. - p_cp_citation
string: 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. - p_rank_order
string(values: 1, 0): Law Status Rank Order Limiter. Enter a single integer rank order to limit results. - p_enf_program
string: Enforcement Program Code Limiter. Enter one or more enforcement program codes to limit results. Provide multiple values as a comma-delimited list. - p_violation
string: Violation Type Code Filter. Enter one or more violation type codes to limit results. Provide multiple values as a comma-delimited list. - p_priority_area
string: Case Priority Area Filter. Enter one or more case priority areas to limit results. Provide multiple values as a comma-delimited list. - p_priority_area_desc
string: 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. - p_tribal
string(values: Y, N): Case Location Tribal Land Flag. Enter Y or N to include or disallow cases on tribal land. - p_oeca_core
string(values: Y, N): OECA Core Program Flag. Enter Y or N to include or exclude core program cases. - p_multimedia
string(values: Y, N): Enforcement Multimedia Case Flag. Enter Y or N to include or exclude multimedia cases. - p_fed_case
string(values: Y, N): Federal Facility Involvement Flag. Enter a Y or N to include or exclude cases involving federal facilities. - p_activity_contact
string: 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. - p_role
string: Activity Contact Role Code Filter. Enter a single role code to restrict results. - p_fed_penalty
string(values: ANY, LE5000, GT5000, GT50000, GT100000, GT500000, GT1000000, GT2500000): Federal Penalty Assessed Amount Filter. Provide one of the following keywords to restrict results. - p_total_fed_penalty
string: Total Federal Penalty Limiter. Enter a keyword value to limit results to cases with given total federal penalties. - p_cost_recovery
string: Cost Recovery Awarded Amount Limiter. Enter a keyword value to limit results to cases with given cost recovery amounts. - p_total_cost_recovery
string: Total Cost Recovery Amount Limiter. Enter a keyword value to limit results to cases with given cost recovery amounts. - p_complying_actions
string: Complying Actions Type Code Limiter. Enter one or more complying action codes to restrict results. Provide multiple values as a comma-delimited list. - p_comp_act_val
string(values: ANY, LE5000, GT5000, GT100000, GT1000000, GT50000000): Compliance Action Cost Limiter. Enter a keyword value to limit results to cases with given compliance cost amounts. - p_total_comp_act_val
string: Total Compliance Action Amount Limiter. Enter a keyword value to limit results to cases with given total compliance action amounts. - p_sep_cats
string: 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. - p_sep_val
string(values: ANY, LE10000, GT10000, GT50000, GT100000, GT500000, GT1000000): Supplemental Environmental Projects Activity Value Limiter. Provide a keyword to limit results. - p_total_sep_val
string: Supplemental Environmental Projects Total Value Limiter. Provide a keyword to limit results. - p_lodged_date
string: Settlement Lodged Date Limiter. Enter a single settlement lodged date in MM/DD/YYYY format to limit results. - p_entered_date
string: Settlement Entered Date Limiter. Enter a single settlement entered date in MM/DD/YYYY format to limit results. - p_facility_id
string: Case Facility Registration Identifier Limiter. Enter a single complete facility identifier to limit results. - p_fac_city
string: Case Facility City Limiter. Enter a single complete city name to filter cases by facility location city. - p_fac_zip
string: Case Facility ZIP Code Limiter. Enter a single 5-digit zip code to filter cases by facility location zip code. - p_fac_county
string: Case Facility County Limiter. Enter a single complete county name to filter cases by facility location county name. - p_case_summary
string: Case Summary Search Limiter. Enter a single case summary to limit results. This parameter accepts partial codes and allows for advanced search modifiers. - p_case_summary_type
string(values: ALL, CONTAINS, WITHIN): 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. - p_usmex
string(values: Y, N): US-Mexico Border Flag. Enter Y/N to restrict searches to facilities located within 100KM of the border. - p_c1lat
number: 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. - p_c1lon
number: 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. - p_c2lat
number: 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. - p_c2lon
number: 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. - p_voluntary
string: Voluntary Self Disclosure Flag. Enter Y or N to include or exclude cases results having voluntary disclosure. - p_fed_indicator
string: Federal Facility/Cross Media Flag. Enter Y or N to limit results to cases with federal facility cross media. - p_fntype
string(values: ALL, CONTAINS, EXACT, BEGINS): Controls type of text search performed on facility name with parameter p_fn. - p_civil_criminal_indicator
string(values: CI, CR, ALL): Civil/Criminal Case Limiter. Provide a keyword to limit results. - queryset
number: Query Limiter. Enter a value to limit the number of records returned for each query. Value cannot exceed 70,000. - responseset
number: Response Set Limiter. Enter a value to limit the number of records per page. Value cannot exceed 1,000. - maplist
string(values: Y, N): 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). - tablelist
string(values: Y, N): Table List Flag. Enter a Y to display the first page of facility results. - callback
string: JSONP Callback. For use with JSONP and GEOJSONP output only. Enter a name of the function in which to wrap the JSON response. - qcolumns
string: 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. - p_ocmap_fy
string: Fiscal Year to select cases that are displayed in the Office of Complicance Fiscal Year Map Services - p_qs
string: Quick Search. Allows entry for city, state, and/or zip code. - p_has_map
string
- output
Output
- output
object: Service call container.- Results required crs2_Results
case_rest_services.get_cases_from_facility.get
Placeholder
epa_gov_case.case_rest_services.get_cases_from_facility.get({
"p_id": ""
}, context)Input
- input
object- p_id required
string: Identifier for the service. - output
string(values: JSONP, JSON, XML): Output Format Flag. Enter one of the following keywords: - callback
string: JSONP Callback. For use with JSONP and GEOJSONP output only. Enter a name of the function in which to wrap the JSON response.
- p_id required
Output
- output
object: Root Object- Results required crs0_get_cases_from_facility.Results
case_rest_services.get_cases_from_facility.post
Placeholder
epa_gov_case.case_rest_services.get_cases_from_facility.post({
"p_id": ""
}, context)Input
- input
object- p_id required
string: Identifier for the service. - output
string(values: JSONP, JSON, XML): Output Format Flag. Enter one of the following keywords: - callback
string: JSONP Callback. For use with JSONP and GEOJSONP output only. Enter a name of the function in which to wrap the JSON response.
- p_id required
Output
- output
object: Root Object- Results required crs0_get_cases_from_facility.Results
case_rest_services.get_crcase_report.get
The get_crcase_report service end point returns a complex object of criminal case detials based on the provided criminal case id.
epa_gov_case.case_rest_services.get_crcase_report.get({}, context)Input
- input
object- p_id
string: Prosecution Summary Identifier. Enter the numeric prosecution summary identifier to retrieve the criminal case report. - output
string(values: JSONP, JSON, XML): Output Format Flag. Enter one of the following keywords: - callback
string: JSONP Callback. For use with JSONP and GEOJSONP output only. Enter a name of the function in which to wrap the JSON response. - mapset
string: Identifies the maxium number of case facilities to return from the case_rest_services.get_case_info query.
- p_id
Output
- output
object: Service call container.- Results required crs3_Results
case_rest_services.get_crcase_report.post
The get_crcase_report service end point returns a complex object of criminal case detials based on the provided criminal case id.
epa_gov_case.case_rest_services.get_crcase_report.post({}, context)Input
- input
object- p_id
string: Prosecution Summary Identifier. Enter the numeric prosecution summary identifier to retrieve the criminal case report. - output
string(values: JSONP, JSON, XML): Output Format Flag. Enter one of the following keywords: - callback
string: JSONP Callback. For use with JSONP and GEOJSONP output only. Enter a name of the function in which to wrap the JSON response.
- p_id
Output
- output
object: Service call container.- Results required crs3_Results
case_rest_services.get_download.get
Based on the QID obtained from a get_cases query, return a comma separated value (CSV) file of the cases found.
epa_gov_case.case_rest_services.get_download.get({
"qid": ""
}, context)Input
- input
object- output
string: Output Format Flag. Enter one of the following keywords: - qid required
string: Query ID Selector. Enter the QueryID number from a previously run query. - qcolumns
string: 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.
- output
Output
- output
file
case_rest_services.get_download.post
Based on the QID obtained from a get_cases query, return a comma separated value (CSV) file of the cases found.
epa_gov_case.case_rest_services.get_download.post({
"qid": ""
}, context)Input
- input
object- output
string: Output Format Flag. Enter one of the following keywords: - qid required
string: Query ID Selector. Enter the QueryID number from a previously run query. - qcolumns
string: 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.
- output
Output
- output
file
case_rest_services.get_facilities_from_case.get
Placeholder
epa_gov_case.case_rest_services.get_facilities_from_case.get({
"p_id": ""
}, context)Input
- input
object- p_id required
string: Identifier for the service. - output
string(values: JSONP, JSON, XML): Output Format Flag. Enter one of the following keywords: - callback
string: JSONP Callback. For use with JSONP and GEOJSONP output only. Enter a name of the function in which to wrap the JSON response.
- p_id required
Output
- output
object: Root Object- Results required crs0_get_facilities_from_case.Results
case_rest_services.get_facilities_from_case.post
Placeholder
epa_gov_case.case_rest_services.get_facilities_from_case.post({
"p_id": ""
}, context)Input
- input
object- p_id required
string: Identifier for the service. - output
string(values: JSONP, JSON, XML): Output Format Flag. Enter one of the following keywords: - callback
string: JSONP Callback. For use with JSONP and GEOJSONP output only. Enter a name of the function in which to wrap the JSON response.
- p_id required
Output
- output
object: Root Object- Results required crs0_get_facilities_from_case.Results
case_rest_services.get_map.get
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.
epa_gov_case.case_rest_services.get_map.get({
"qid": ""
}, context)Input
- input
object- output
string(values: JSONP, JSON, XML): Output Format Flag. Enter one of the following keywords: - qid required
string: Query ID Selector. Enter the QueryID number from a previously run query. - callback
string: JSONP Callback. For use with JSONP and GEOJSONP output only. Enter a name of the function in which to wrap the JSON response. - tablelist
string(values: Y, N): Table List Flag. Enter a Y to display the first page of facility results. - c1_lat
number: 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. - c1_long
number: 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. - c2_lat
number: 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. - c2_long
number: 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.
- output
Output
- output
object: Service call container.- MapOutput required crs0_MapOutput
case_rest_services.get_map.post
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.
epa_gov_case.case_rest_services.get_map.post({
"qid": ""
}, context)Input
- input
object- output
string(values: JSONP, JSON, XML): Output Format Flag. Enter one of the following keywords: - qid required
string: Query ID Selector. Enter the QueryID number from a previously run query. - callback
string: JSONP Callback. For use with JSONP and GEOJSONP output only. Enter a name of the function in which to wrap the JSON response. - tablelist
string(values: Y, N): Table List Flag. Enter a Y to display the first page of facility results. - c1_lat
number: 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. - c1_long
number: 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. - c2_lat
number: 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. - c2_long
number: 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. - mapset
string: Identifies the maxium number of case facilities to return from the case_rest_services.get_case_info query.
- output
Output
- output
object: Service call container.- MapOutput required crs0_MapOutput
case_rest_services.get_qid.get
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.
epa_gov_case.case_rest_services.get_qid.get({
"qid": ""
}, context)Input
- input
object- output
string(values: JSONP, JSON, XML): Output Format Flag. Enter one of the following keywords: - qid required
string: Query ID Selector. Enter the QueryID number from a previously run query. - pageno
number: Indicates the number of the page to display. It is used only when the results are paginated. - callback
string: JSONP Callback. For use with JSONP and GEOJSONP output only. Enter a name of the function in which to wrap the JSON response. - newsort
number: 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. - descending
string(values: Y, N): 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. - qcolumns
string: 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.
- output
Output
- output
object: Service call container.- Results required crs5_Results
case_rest_services.get_qid.post
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.
epa_gov_case.case_rest_services.get_qid.post({
"qid": ""
}, context)Input
- input
object- output
string(values: JSONP, JSON, XML): Output Format Flag. Enter one of the following keywords: - qid required
string: Query ID Selector. Enter the QueryID number from a previously run query. - pageno
number: Indicates the number of the page to display. It is used only when the results are paginated. - callback
string: JSONP Callback. For use with JSONP and GEOJSONP output only. Enter a name of the function in which to wrap the JSON response. - newsort
number: 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. - descending
string(values: Y, N): Output Sort Column Descending Flag. Enter Y to column identified in the newsort parameter descending. Enter N to use ascendi
- output