Jump to main content or area navigation.

Contact Us

Water: Services

Get Entities By Huc Service

Description

Query for identifying details of all water entities within a given HUC8 subbasin for specific WATERS programs.

Input

Parameters

Parameters Datatype Description
huc8 String HUC8 subbasin designation.
programs_list Array of
String
List of program name abbreviations.                                     

SOAP Service Notes

None at this time.

Output

UML Diagram

Water Object UML

Return Object

water_data

Parameters Datatype Description
water_application Object Object Type: water_application
water_entity Object Object Type: water_entity
water_feature_type Object Object Type: water_feature_type                                            
water_url Object Object Type: water_url
water_huc Object Object Type: water_huc
water_highlight Object Object Type: water_highlight

Supporting Objects

water_application

Parameters Datatype Description
water_application_name String Name of the water application
water_application_description String

Description of the water application                                         

water_entities Array of
Object
Object Type: water_entity

water_entity

Parameters Datatype Description
entity_id

String

The key identifier of the water entity. This value is used to relate the RAD information back to the WATEERS program system. 
entity_organization String The name of the WATERS program system organization.
entity_name String A description of the entity type. Examples: facility, impaired water, assessed water, etc..
entity_type_description String A description of the entity type. Examples: facility, impaired water, assessed water, etc..
state_location_usps_code String The 2 character USPS code for the state or territory that the facility is located in.
start_date_description String A description of the RAD start date or the actual start of the date range that this entity was of current interest to EPA.
end_date_description String A description of the RAD end date or the actual end of the date range that this entity was of current interest to EPA.
waters_feature_types Array of
Object
Object Type: water_feature_type
waters_urls Array of
Object
Object Type: water_url
waters_hucs Array of
Object
Object Type: water_huc
waters_highlights Array of
Object
Object Type: water_highlight

water_feature_type

Parameters Datatype Description
nhd_water_type String The water type, e.g. (LAKE/POND, STREAM/RIVER, ...) from the NHD for the water entity.
nhd_water_size Number The calculated size from the NHD indexing of the water entity for this feature type.
water_size_unit String The unit of measure of the water size. Examples: miles, acres

water_url

Parameters Datatype Description
url_description String A description of the URL. Example: ECHO PCS Facility Report
url_address String The hypertext link for the entity web report given in http format.

water_huc

Parameters Datatype Description
huc String The HUC8 value
huc_name String The subbasin name associated with the HUC8

water_highlight

Parameters Datatype Description
highlight_name String The name of the specific water entity feature of interest (highlight). Examples: 305(b) Water Assessment Status, 303(d) Causes of Impairment, PCS Facility Type, etc. See Appendix A for a list of current water highlight values. 
highlight_value String The value of the water entity feature of interest.

SOAP Service Notes

None at this time.

Web Service (SOAP)

Resource Location
Runtime
Endpoint
 http://ofmpub.epa.gov/WATERSWebServices/SpatialServices
WSDL
Endpoint
 http://ofmpub.epa.gov/WATERSWebServices/SpatialServices?WSDL

Database Service

Database
Instance
Schema Resource
WATERS10 ow_service waters.spatial_services.get_entities_by_huc

Changelog

Version: 1.0 - Released: 2006


Jump to main content.