- Usage Scenarios
- HTTP Service
- Web Service (SOAP)
- Database Service
Drinking Water Designated Use Evaluation
Determine if the waters upstream from a drinking water intake have the proper designated use assigned to them.
List of all waters within 50 miles upstream of all drinking water intakes that have a designated use different from drinking water supply.
Information Returned from Service
Event tables of waters 50 miles upstream of each drinking water intake. NOTE: The results of this service will need to be overlaid with the assessed waters layer and joined to the ATTAINS database to complete the analysis.
|pNavigationType||String||'UM' for upstream mainstem navigation|
'UT' for upstream with tributaries navigation
'DM' for downstream mainstream navigation
'DD' for downstream with divergences navigation
'PP' for point-to-point navigation
|pStartComid||Number||NHD flowline comid to begin navigating from. Must be greater than 0 and less than 999999999.|
|pStartReachcode||String||NHD reach code to begin navigating from. User must provide either a comid or a reach code. If both are provided, then the comid takes precedence.|
|pStartMeasure||Number||Measure on the NHD reach code to begin navigating from. Must be between 0 and 100 inclusive, or NULL. A value of null means that a measure will be calculated to be either the bottom or the top of the NHD flowline. (depending on whether the navigation type is upstream or downstream and whether it is a start or stop measure).|
|pStopComid||Number||NHD flowline comid to stop navigating at. Must be greater than 0 and less than 999999999.|
|pStopReachcode||String||NHD reach code to stop navigating at. User must provide either a comid or a reach code. If both are provided, then the comid parameter takes precedence.|
|pStopMeasure||Number||Measure on the NHD reach code to stop navigating at. Must be between 0 and 100 inclusive, or NULL.|
|pMaxDistance||Number||Distance in KM to navigate. If neither pMaxDistance or pMaxTime are provided, then distance to travel defaults to 50 km.|
|pMaxTime||Number||Time of travel in hours to navigate.|
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.
|return_code||Number||Return Code indicate success or failure of the navigation process. |
0 = Up/Down Service completed as requested
1nn= Interpreter errors
2nn= Resolver errors
|status_message||String||Status message provides text details for return codes 1nn thru 5nn.|
|Object Type: updn_nttypenavresultsstandard|
|comid||Number||NHD flowline comid.|
|reachcode||String||NHD reach code.|
|frommeas||Number||NHD reach code beginning measure.|
|tomeas||Number||NHD reach code ending measure.|
|totaldist||Number||Total distance of the flowline in KM for the traversal.|
|totaltime||Number||Total navigation time of the flowline in hours for the traversal.|
|hydroseq||Number||The hydrologic sequence of the flowline in the total traversal.|
|shape||Geometry||Geometry of the feature.|
The output format for this service is JSON with GEOJSON formatted geometries.
The SOAP service does not return any geometries with results.
Database Service Example
Users with schema accounts on the EPA waters10 database instance may directly access the upstream/downstream service via a stored procedure interface. Input and output is managed via the objects described below. Callers need to create, submit, receive and interpret these objects for their own needs. Note that the upstream/downstream service code utilizes internal DDL statements such that the indexing service must be called as a PL/SQL procedure rather than embedded as a function within SQL.
- Initial Release of SOAP and HTTP Service for this component