Jump to main content.

Get Program Waters Entities Service

Description

Query for identifying details of a given list of entities for specific WATERS programs.

Input

Parameters

Parameter Datatype Description
program_entities_list Array of Object Object Type: program_entities

program_entities

Parameter Datatype Description
program_name String Program abbreviation. See Appendix A for a complete list of program abbreviations.
entities Array of String List of entity IDs for each program.

SOAP Service Notes

None at this time.

Output

UML Diagram

Water Object UML

Return Object

water_data

Property Datatype Description
water_application Object Object Type: water_application

Supporting Objects

water_application

Property 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

Property Datatype Description
entity_id String The key identifier of the water entity. This value is used to relate the RAD information back to the program system.
entity_organization String The name of the 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

Property 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

Property 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

Property Datatype Description
huc String The HUC8 subbasin code.
huc_name String The subbasin name associated with the HUC8 subbasin code

water_highlight

Property 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://iaspub.epa.gov/WATERSWebServices/SpatialServices
WSDL Endpoint http://iaspub.epa.gov/WATERSWebServices/SpatialServices?WSDL

Sample SOAP Request (Oracle 10.2.0.2 OC4J):

 <SOAP-ENV:Envelope
   xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
   xmlns:ns1="http://iaspub.epa.gov/WATERSWebServices/OWServices"
   xmlns:xsd="http://www.w3.org/2001/XMLSchema"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
>
  <SOAP-ENV:Body>
    <ns1:getProgramWaterEntities>
      <programEntityData
         xmlns:ns1="http://waters9i-waters/SpatialServices.xsd"
         xmlns:xsd="http://www.w3.org/2001/XMLSchema"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:type="ns1:waters9i_waters_ProgramEntityDataUser">
        <programsEntities
           xsi:type="ns1:waters9i_waters_ProgramEntitiesList"
        >
          <array
             xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
             xsi:type="SOAP-ENC:Array"
             SOAP-ENC:arrayType="ns1:waters9i_waters_ProgramEntitiesUser[2]"
          >
            <waters9i_waters_ProgramEntitiesUser xsi:type="ns1:waters9i_waters_ProgramEntitiesUser">
              <programName xsi:type="xsd:string">303D</programName>
              <entities xsi:type="ns1:waters9i_waters_EntityList">
                 <array xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="xsd:string[2]">
                   <string xsi:type="xsd:string">NJ_17-0002_ALLOWAY_CREEK_ESTUARY</string>
                   <string xsi:type="xsd:string">GA-R030701020501</string>
                 </array>
              </entities>
            </waters9i_waters_ProgramEntitiesUser>
            <waters9i_waters_ProgramEntitiesUser xsi:type="ns1:waters9i_waters_ProgramEntitiesUser">
              <programName xsi:type="xsd:string">FISH</programName>
              <entities xsi:type="ns1:waters9i_waters_EntityList">
                <array xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="xsd:string[2]">
                  <string xsi:type="xsd:string">104608</string>
                  <string xsi:type="xsd:string">4148</string>
                </array>
               </entities>
             </waters9i_waters_ProgramEntitiesUser>
           </array>
         </programsEntities>
       </programEntityData>
     </ns1:getProgramWaterEntities>
   </SOAP-ENV:Body>
 </SOAP-ENV:Envelope>

Sample Soap Response:

   <?xml version="1.0" encoding="UTF-8"?>
 <SOAP-ENV:Envelope
   xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 >
  <SOAP-ENV:Body>
    <ns1:getProgramWaterEntitiesResponse
       xmlns:ns1="http://iaspub.epa.gov/WATERSWebServices/OWServices"
       SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
    >
      <return
         xmlns:ns2="http://waters9i-waters/SpatialServices.xsd"
         xsi:type="ns2:waters9i_waters_WaterDataUser"
      >
        <watersApplications xsi:type="ns2:waters9i_waters_WaterApplications">
          <array
             xmlns:ns3="http://schemas.xmlsoap.org/soap/encoding/"
             xsi:type="ns3:Array"
             ns3:arrayType="ns2:waters9i_waters_WaterApplicationUser[2]"
          >
            <item xsi:type="ns2:waters9i_waters_WaterApplicationUser">
              <waterApplicationDescription xsi:type="xsd:string">The National Total Maximum Daily Load (TMDL) Tracking System (NTTS)
              contains information on waters that are Not Supporting their designated uses. These waters are listed by the state as impaired
              under Section 303(d) of the Clean Water Act. The status of TMDLs are also tracked. TMDLs are pollution control measures that
              reduce the discharge of pollutants into impaired waters.  For further information on TMDLs please click
<a href="http://www.epa.gov/waters/tmdl/">here</a>.</waterApplicationDescription>
              <waterApplicationName xsi:type="xsd:string">Total Maximum Daily Load (TMDL) / NTTS / 303(d)</waterApplicationName>
              <watersEntities xsi:type="ns2:waters9i_waters_WaterEntities">
                <array xsi:type="ns3:Array" ns3:arrayType="ns2:waters9i_waters_WaterEntityUser[1]">
                  <item xsi:type="ns2:waters9i_waters_WaterEntityUser">
                    <endDateDescription xsi:type="xsd:string">2006-APR-01</endDateDescription>
                    <entityId xsi:type="xsd:string">ILD20 _D   20</entityId>
                    <entityName xsi:type="xsd:string">ILLINOIS RIVER</entityName>
                    <entityOrganization xsi:type="xsd:string">IL</entityOrganization>
                    <entityTypeDescription xsi:type="xsd:string">303(d) Impaired Water</entityTypeDescription>
                    <startDateDescription xsi:type="xsd:string">2004-APR-01</startDateDescription>
                    <stateLocationUspsCode xsi:type="xsd:string">IL</stateLocationUspsCode>
                    <watersFeatureTypes xsi:type="ns2:waters9i_waters_WaterFeatureTypes">
                      <array xsi:type="ns3:Array" ns3:arrayType="ns2:waters9i_waters_WaterFeatureTypeUser[0]"></array>
                    </watersFeatureTypes>
                    <watersHightlights xsi:type="ns2:waters9i_waters_WaterHighlights">
                      <array xsi:type="ns3:Array" ns3:arrayType="ns2:waters9i_waters_WaterHighlightUser[2]">
                        <item xsi:type="ns2:waters9i_waters_WaterHighlightUser">
                          <highlightName xsi:type="xsd:string">Miles to Search Location</highlightName>
                          <highlightValue xsi:type="xsd:string">4.9837</highlightValue>
                        </item>
                        <item xsi:type="ns2:waters9i_waters_WaterHighlightUser">
                          <highlightName xsi:type="xsd:string">Water TMDL Status</highlightName>
                          <highlightValue xsi:type="xsd:string">TMDL Needed</highlightValue>
                        </item>
                      </array>
                    </watersHightlights>
                    <watersHucs xsi:type="ns2:waters9i_waters_WaterHucs">
                      <array xsi:type="ns3:Array" ns3:arrayType="ns2:waters9i_waters_WaterHucUser[0]"></array>
                    </watersHucs>
                    <watersUrls xsi:type="ns2:waters9i_waters_WaterUrls">
                      <array xsi:type="ns3:Array" ns3:arrayType="ns2:waters9i_waters_WaterUrlUser[1]">
                        <item xsi:type="ns2:waters9i_waters_WaterUrlUser">
                          <urlAddress xsi:type="xsd:string">http://iaspub.epa.gov/waters/enviro.control?p_list_id=ILD20 _D   20</urlAddress>
                          <urlDescription xsi:type="xsd:string">National TMDL Tracking System Listed Water Report</urlDescription>
                        </item>
                      </array>
                    </watersUrls>
                  </item>
                </array>
              </watersEntities>
            </item>
            <item xsi:type="ns2:waters9i_waters_WaterApplicationUser">
              <waterApplicationDescription xsi:type="xsd:string">The National Listing of Fish and Wildlife Advisories (NLFWA) database includes
              all available information describing state-, tribal-, and federally-issued fish consumption advisories in the United States and
              Canada.</waterApplicationDescription>
              <waterApplicationName xsi:type="xsd:string">Fish Consumption Advisories /  NLFWA</waterApplicationName>
              <watersEntities xsi:type="ns2:waters9i_waters_WaterEntities">
                <array xsi:type="ns3:Array" ns3:arrayType="ns2:waters9i_waters_WaterEntityUser[0]"></array>
              </watersEntities>
            </item>
          </array>
        </watersApplications>
      </return>
    </ns1:getProgramWaterEntitiesResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Database Service

Database Instance Schema Resource
WATERS10 ow_service waters.spatial_services.get_program_water_entities

Changelog

Version: 1.0 - Released: 2006

 

Local Navigation

Jump to main content.