Identify Service

The identify service answers the question, What information exists in EPA program data systems for this point in the surface water network? The service returns all or a selected subset of EPA programs’ source feature IDs as well as the NHD feature information.

Gather Reporting Information

Parameters

HTTP Service Notes

Additional parameters specific to HTTP services are listed in the WATERS HTTP Services documentation.

SOAP Service Notes

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. 

UML Diagram

Return Object

identify_service_output

Supporting Objects

identify_service_evt_results

identify_service_nhd_results

HTTP Service Notes

User must expressly add an optOutGeomFormat parameter to service requests to receive back geometries.

SOAP Service Notes

The SOAP service does not return any geometries with results.

EPA hosted Oracle Application Servers currently utilize an older version of Oracle Containers for J2EE (OC4J). The SOAP endpoints generated for OC4J by Oracle Jdeveloper have several limitations that service users should be aware of. While many service parameters take a NULL value to indicate that a particular parameter is not applicable or not to used, the service endpoint may report an error if any numeric parameters are left empty. Users may choose to either utilize the "simple" service interfaces whereby all parameters are accepted as strings or users may enter numeric values of -9999 to indicate NULL.

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:identifyService>
         <pReachType xsi:type="xsd:string">L</pReachType>
         <pReachCode xsi:type="xsd:string">03070101000376</pReachCode>
         <pReachMeasure xsi:type="xsd:decimal">40</pReachMeasure>
         <pPrograms
          xmlns:ns1="http://waters-waters/OWServices.xsd"
          xmlns:xsd="http://www.w3.org/2001/XMLSchema"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:type="ns1:waters_waters_OwStringVry"
         >
            <array
             xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
             xsi:type="SOAP-ENC:Array"
             SOAP-ENC:arrayType="xsd:string[2]"
            >
               <string xsi:type="xsd:string">303D</string>
               <string xsi:type="xsd:string">FISH</string>
            </array>
         </pPrograms>
      </ns1:identifyService>
   </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:identifyServiceResponse
       xmlns:ns1="http://epadev.induscorp.com/WATERSWebServices/OWServices"
       SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
      >
         <return
          xmlns:ns2="http://waters-waters/OWServices.xsd"
          xsi:type="ns2:waters_waters_IdentifyServiceOutputUser"
         >
            <nhdResults xsi:type="ns2:waters_waters_IdentifyServiceNhdList">
               <array
                xmlns:ns3="http://schemas.xmlsoap.org/soap/encoding/"
                xsi:type="ns3:Array"
                ns3:arrayType="ns2:waters_waters_IdentifyServiceNhdResultsUser[1]"
               >
                  <item xsi:type="ns2:waters_waters_IdentifyServiceNhdResultsUser">
                     <areasqkm xsi:type="xsd:decimal" xsi:nil="true"></areasqkm>
                     <tableFormat xsi:type="xsd:string">fl</tableFormat>
                     <TMeas xsi:type="xsd:decimal">100</TMeas>
                     <reachcode xsi:type="xsd:string">03070101000376</reachcode>
                     <comid xsi:type="xsd:decimal">1047533</comid>
                     <fcode xsi:type="xsd:decimal">46006</fcode>
                     <resolution xsi:type="xsd:string">Medium</resolution>
                     <FMeas xsi:type="xsd:decimal">0</FMeas>
                     <elevation xsi:type="xsd:decimal" xsi:nil="true"></elevation>
                     <gnisId xsi:type="xsd:string">00328761</gnisId>
                     <flowdir xsi:type="xsd:string">With Digitized</flowdir>
                     <gnisName xsi:type="xsd:string">Middle Oconee River</gnisName>
                     <enabled xsi:type="xsd:string" xsi:nil="true"></enabled>
                     <wbareacomi xsi:type="xsd:decimal">0</wbareacomi>
                     <lengthkm xsi:type="xsd:decimal">0.025</lengthkm>
                     <ftype xsi:type="xsd:string">StreamRiver</ftype>
                     <fdate xsi:type="xsd:dateTime">2004-08-01T04:00:00.000Z</fdate>
                 </item>
               </array>
            </nhdResults>
            <evtResults xsi:type="ns2:waters_waters_IdentifyServiceEvtList">
               <array
                xmlns:ns4="http://schemas.xmlsoap.org/soap/encoding/"
                xsi:type="ns4:Array"
                ns4:arrayType="ns2:waters_waters_IdentifyServiceEvtResultsUser[1]"
               >
                  <item xsi:type="ns2:waters_waters_IdentifyServiceEvtResultsUser">
                     <startDate xsi:type="xsd:dateTime">2004-04-01T05:00:00.000Z</startDate>
                     <tableFormat xsi:type="xsd:string">L</tableFormat>
                     <shapeArea xsi:type="xsd:decimal" xsi:nil="true"></shapeArea>
                     <reachcode xsi:type="xsd:string">03070101000376</reachcode>
                     <comid xsi:type="xsd:decimal">958128</comid>
                     <cycle xsi:type="xsd:dateTime">2004-04-01T05:00:00.000Z</cycle>
                     <offset xsi:type="xsd:decimal">0</offset>
                     <sourceDatadesc xsi:type="xsd:string">303D</sourceDatadesc>
                     <sourceOriginator xsi:type="xsd:string">GA</sourceOriginator>
                     <tmeasure xsi:type="xsd:decimal">100</tmeasure>
                     <sourceFeatureid xsi:type="xsd:string">GA-R030701010103</sourceFeatureid>
                     <eventdate xsi:type="xsd:dateTime" xsi:nil="true"></eventdate>
                     <shapeLength xsi:type="xsd:decimal">25</shapeLength>
                     <featuredetailurl xsi:type="xsd:string" xsi:nil="true"></featuredetailurl>
                     <fmeasure xsi:type="xsd:decimal">0</fmeasure>
                     <reachresolution xsi:type="xsd:string" xsi:nil="true"></reachresolution>
                     <geogstate xsi:type="xsd:string">GA</geogstate>
                     <reachsmdate xsi:type="xsd:dateTime" xsi:nil="true"></reachsmdate>
                     <eventtype xsi:type="xsd:string">303D</eventtype>
                     <measure xsi:type="xsd:decimal" xsi:nil="true"></measure>
                  </item>
               </array>
            </evtResults>
         </return>
      </ns1:identifyServiceResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

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