Total Waters Geometry Service
- Usage Scenarios
- HTTP Service
- Web Service (SOAP)
- Database Service
Returns summary information about the surface water and the EPA water quality and other information within an arbitrary geometry.
Summary for Current Map
Examining a local area for impaired waters on intermittent water features – need a summary of total surface water and listed waters information for the current map window broken out by intermittent and perennial classifications.
Length and area of surface water and listed waters by NHD FTYPE shown on the current map.
Information Returned from Service
Table elements of surface water and impaired waters broken down by surface water NHD FTYPE classification clipped to the bounding box of the map canvas.
Congressional District Query for Congressperson
As part of a "state of my district" report for a congressional office, show a table of water quality information for a congressional district.
Table showing impaired waters, assessed waters, beaches, clean watershed needs, nonpoint source projects, water discharges, TMDLs, and surface water miles and acres for a congressional district.
Information Returned from Service
Table elements of surface water and water quality data for the selected congressional district.
|pPrograms||String||Array of program abbreviations to be examined. See Appendix B for a list of current RAD programs.|
|pProgramsMod||String||Modifier explaining the array format used in pPrograms. See the complex object modifier descriptions for more information.|
|pGeometry||String||Input polygon geometry.|
|pGeometryMod||String||Modifier explaining the input geometry. See the complex object modifier descriptions for more information.|
|pBorderPolicy||String||TRUE/FALSE - TRUE indicates to group state results out by border water codes while FALSE indicates to use full state codes only.|
|pGroupingName||String||FCODE/BASE_MAP/INT_PEREN/ALL - Parameter indicating whether to group results into predefined fcode categories. See Appendix C for list of FCODE groupings.|
|pNHDCustom||String||TRUE/FALSE - Indicates whether to include custom or nonstandard events in results.|
|pStGrouping||String||TRUE/FALSE - Indicates whether to group by the state type indicated by the p_border_policy flag.|
|pHucGrouping||String||TRUE/FALSE - Indicates whether to group by HUC values (results may be extensive).|
Additional parameters specific to HTTP services are listed in the WATERS HTTP Services documentation.
The parameter listing for SOAP services is slightly different. Array parameters are not followed by a "mod" parameter as the array format is specified by the WSDL documentation. For SOAP services, the input geometry parameter is always OGC Well-Known Text (WKT) and thus the secondary "mod" parameter is simply a numeric value of the Oracle Spatial Reference ID.
|total_waters_service_results||Object||Object Type: total_waters_service_results|
|st||String||State code for NHD or event records including border waters codes if state grouping and border waters flags have been chosen. See Appendix D for a complete list of border waters codes.|
|nhdSt||String||State code for NHD or event records if state grouping flag has been chosen. All border waters are allocated to the state best covering the NHD or event record.|
|huc||String||Huc 8 (subbasin) values for NHD or events records if huc grouping flag has been chosen.|
|pgmSys||String||'NHD' or program abbreviation. See Appendix B for a complete list of program abbreviations.|
|fcodeGroup||String||Fcode group chosen in p_grouping_name parameter.|
|borderFlag||String||1/0 equaling Y/N values in p_border_policy parameter.|
|nhdFlag||String||1/0 equaling Y/N values in p_nhd_custom parameter.|
|featureClass||String||A/L/P value indicating area, line or point records.|
|featureTotal||Number||Sum of area record area, line record length or count of point records. For point records, this is the count of total records, for line records this the sum of records in kilometers, for area records, this is the sum of records in square kilometers.|
|shape||Geometry||Geometry representing the feature summarized|
The output format for this service is JSON with GEOJSON formatted geometries.
The SOAP service does not return any geometries with results.
Database service users will require the RAD_PUBLIC role for accessing unprotected RAD program results. Accessing protected RAD program data requires additional roles which must be may only be obtained through proper EPA channels.
Version: 2.0 - Released: August 31, 2009
- Initial Release of HTTP Services and updated web page content