Generic Service Objects
- ow_catchment
- ow_delineated_basin
- ow_nhd_feature
- ow_nhd_feature_grp
- ow_nhd_reachinfo
- ow_indexed_flowline
- ow_rad_event_feature
- ow_tiger_zcta5
- ow_tiger_zcta5_grp
- ow_tiger_zcta5tohuc12
- ow_wbd_feature
- ow_wbd_feature_grp
ow_catchment
| Property | Datatype | Description |
|---|---|---|
| comid | Number | Optional identification id number for the delineation process. |
| nhdplus_region | String | The NHDPlus region to which the catchment is assigned. See NHDPlus documentation for more information on regions. |
| nhdplus_version | String | The NHDPlus version of the region from which the catchment is derived. The format is XX_YY where XX indicates the major version and YY indicates the minor version. See NHDPlus documentation for more information on versioning. |
| reachcode | String | Common Identifier of an NHD Flowline. |
| grid_code | Number | The value stored in grid cells. A unique identification number for each catchment (compressed numbering system). |
| grid_count | Number | Number of cells with a particular value in the value field. The count equals the number of 30x30 meter grid cells in each catchment. Catchment area can be computed from this field. |
| prod_unit | String | Production unit identifier. |
| areasqkm | Number | Feature area in square kilometers. |
| vertices | Number | Count of vertices comprising the feature geometry. |
| shape | Geometry | Feature geometry. |
ow_delineated_basin
| Property | Datatype | Description |
|---|---|---|
| basin_id | Number | Optional identification id number for the delineation process. |
| basin_name | String | Optional identification name for the delineation process. |
| feature_type | String | Feature type returned |
| output_flag | String | Output flag indicating whether to return features, flowlines or both. |
| aggregation_flag | String | Aggregation flag indicating whether aggregate all returned features. |
| comids | Array of Number | Flowline comids returned from navigation. |
| reachcodes | Array of String | Flowline reach codes returned from navigation. |
| resolution | Number | NHD resolution value. This value must be 3 as navigation is currently only available for medium resolution NHD. |
| flowlines | Array of Object | Array of ow_indexed_flowline |
| catchments | Array of Object | Array of ow_catchment |
| tolerance | Number | Oracle Spatial tolerance to use in geometry functions. Default value is 0.05. |
| total_areasqkm | Number | Depending on aggregation flag, either the total area in square kilometers of the aggregated feature or the sum of area of all feature type geometries. |
| vertices | Number | Count of geometry vertices of all object geometries and subobject geometries. |
| shape | Geometry | Geometry representing the aggregated feature type. |
| status_code | Number | Code indicating success or failure of last object procedure. |
| status_message | String | Message explaining any conditions causing a status code. |
ow_nhd_feature
| Property | Datatype | Description |
|---|---|---|
| feature_type | String | Code indicating the source of the NHD feature:
|
| comid | Number | NHD assigned unique identifier for the feature. |
| fdate | Date | Last modified date of the NHD feature. |
| reachcode | String | The reach code assigned to the NHD feature. Note that only flowlines, waterbodies and points may have reach codes. |
| reachsmdate | Date | The date the reach code was created or last modified. |
| resolution | Number | The NHD resolution code indicating:
|
| gnis_id | String | The USGS Geographic Names Information System (GNIS) code assigned to the NHD feature. |
| gnis_name | String | The accompanying textual GNIS name assigned to NHD features having a gnis_id. Note that not all NHD features have GNIS names. |
| fmeasure | Number | For flowline features with reach codes, the Linear Referencing System start measure for the nhd feature. |
| tmeasure | Number | For flowline features with reach codes, the Linear Referencing System end measure for the nhd feature. |
| shape_length | Number | For flowlines and lines, the length of the feature in KM. |
| shape_area | Number | For waterbodies and areas, the area of the feature in square KM. |
| vertices | Number | Count of vertices comprising the feature geometry. |
| shape | Geometry | Feature geometry. |
ow_nhd_feature_grp
| Property | Datatype | Description |
|---|---|---|
| results | Array of Object | Object Type: ow_nhd_feature |
ow_nhd_reachinfo
| Property | Datatype | Description |
|---|---|---|
| reachtype | String | F/W indicating that record represents a NHD Flowline or Waterbody reach code. |
| reachcode | String | 14-digit NHD reach code. |
| gnis_id | String | 10-digit GNIS identification code for the reach code feature, if any. |
| gnis_name | String | GNIS assigned name for the reach code feature, if any. |
| companion_geom_count | Number | For flowline reach code features, the count of waterbodies that the feature is associated with. Only applies to flowlines with NHD "Artificial Path" FCODEs. For waterbody reach code features, the count of artificial path flowline features associated with the waterbody. |
| reachsmdate | Date | The date the reach feature was last modified. Only a small percentage of NHD features currently have a reachsmdate value. |
ow_indexed_flowline
| Property | Datatype | Description |
|---|---|---|
| comid | Number | NHD assigned unique identifier for the feature. |
| reachcode | String | The reach code assigned to the NHD feature. Note that only flowlines, waterbodies and points may have reach codes. |
| nhdplus_region | String | The NHDPlus region the NHD feature is assigned to. |
| nhdplus_version | String | The NHDPlus version of the region from which the catchment is derived. The format is XX_YY where XX indicates the major version and YY indicates the minor version. See NHDPlus documentation for more information on versioning. |
| reachsmdate | Date | The date the reach code was created or last modified. |
| resolution | Number | The NHD resolution code indicating:
|
| gnis_id | String | The USGS Geographic Names Information System (GNIS) code assigned to the NHD feature. |
| gnis_name | String | The accompanying textual GNIS name assigned to NHD features having a gnis_id. Note that not all NHD features have GNIS names. |
| wbareacomi | Number | The NHD waterbody comid for any waterbody the flowline intersects. |
| fcode | The NHD assigned feature code of the flowline. | |
| offset | Number | The RAD event offset amount. |
| fmeasure | Number | For flowline features with reach codes, the Linear Referencing System start measure for the nhd feature. |
| tmeasure | Number | For flowline features with reach codes, the Linear Referencing System end measure for the nhd feature. |
| wbd_huc12 | String | The WBD HUC 12 unit the flowline is assigned to. |
| wbd_huc12_percent | Number | The percentage amount representing the overlap between the WBD HUC 12 and the flowline. |
| vertices | Number | Count of vertices comprising the feature geometry. |
| shape | Geometry | Feature geometry. |
| waterbodies | Number | The count of unique NHD waterbody features that the flowline crosses. |
ow_rad_event_feature
| Property | Datatype | Description |
|---|---|---|
| program_type | String | RAD program abbreviation indicating program to which this feature belongs. This information is often duplicated in the eventtype and/or source_datadesc fields. However this practice is not standardized across all programs. |
| feature_type | String | A/L/P indicating the geometry type of the RAD feature. |
| archive_flag | String | TRUE/FALSE indicating if this RAD feature originates from the production or archive RAD table. |
| comid | Number | Unique numeric identification number for the event. |
| eventdate | Date | The date the event was created or updated. |
| eventtype | String | Value indicating the program for which the event has been created. |
| reachcode | String | The reach code value of the NHD feature the event occurs upon. |
| reachsmdate | Date | Date that the NHD reach code was assigned thus tying the event to a specific version of the NHD. |
| resolution | Number | Integer value indicating the resolution of the NHD waterbody feature the event occurs upon. All current RAD features have a value of 3 indicating the medium resolution NHD. |
| source_originator | String | Abbreviated name of the organization submitting the event. |
| source_datadesc | String | Descriptive field used to store auxiliary information about the indexing process or other critical data quality measures. |
| source_featureid | String | Foreign key to external program database. |
| featuredetailurl | String | Internet hyperlink to supplemental program information for the event record. |
| offset | Number | Event display offset. |
| measure | Number | Measure value that a point event occurs at upon a reached NHD flowline. |
| fmeasure | Number | Start measure value that a line event occurs at upon a reached NHD flowline. |
| tmeasure | Number | End measure value that a line event occurs at upon a reached NHD flowline. |
| shape_length | Number | The length in meters of a line event. |
| shape_area | Number | The area in square kilometers of an area event. |
| geogstate | String | Abbreviation of the state where the event takes place regardless of the source originator. In most cases this will be the same as source_originator, but they may differ in cases such that tribes, state cooperators, and other non-state specific organizations manage the data. This distinction allows for both state based and management-based analysis |
| cycle_year | String | Optional field indicating a year for which the event is considered to be valid. Only a subset of programs track events via cycle year. |
| start_date | Date | The date by which the event is considered by the source program to be active. |
| end_date | Date | The date by which the event is considered by the source program to be no longer active. Only utilized in RAD archive tables. |
| wbd_huc12 | String | The WBD HUC 12 unit the RAD event is assigned to. |
| wbd_huc12_percent | Number | The percentage amount representing the overlap between the WBD HUC 12 and the RAD event. |
| vertices | Number | Count of vertices in the geometry. |
| shape | Geometry | Geometry of the RAD event. |
ow_tiger_zcta5
| Property | Datatype | Description |
|---|---|---|
| zcta5 | String | Current 5-digit ZIP Code Tabulation Area code. |
| classfp | String | Current Federal Information Processing Standards (FIPS) 55 class code. |
| mtfcc | String | MAF/TIGER feature class code. |
| funcstat | String | Current functional status. |
| vertices | Number | Count of vertices in the geometry. |
| shape | Geometry | Geometry representing the ZIP Code Tabulation Area. |
ow_tiger_zcta5_grp
| Property | Datatype | Description |
|---|---|---|
| results | Array of Object | Object Type: ow_tiger_zcta5 |
ow_tiger_zcta5tohuc12
| Property | Datatype | Description |
|---|---|---|
| zcta5 | String | 5-digit ZIP Code Tabulation Area code. |
| huc12 | String | 12-digit Watershed Boundary Dataset Hydrologic Unit Code. |
| huc12_name | String | WBD-assigned common name for the 12-digit hydrologic unit. |
| overlap_sqkm | Number | The size in square kilometers of the overlap of the ZCTA5 and HUC12. |
| zcta5_percent | Number | The percentage of the ZCTA5 polygon represented by the overlap area. |
| huc12_percent | Number | The percentage of the HUC12 polygon represented by the overlap area. |
ow_wbd_feature
| Property | Datatype | Description |
|---|---|---|
| huc_level | Number | Watershed Boundary Dataset HUC level. Valid values are 2, 4, 6, 8, 10 and 12. |
| huc_2 | String | Two-digit Hydrologic Unit Code |
| hu_2_name | String | Designated name of the HUC 2 unit. |
| huc_4 | String | Four-digit Hydrologic Unit Code |
| hu_4_name | String | Designated name of the HUC 4 unit. |
| huc_6 | String | Six-digit Hydrologic Unit Code |
| hu_6_name | String | Designated name of the HUC 6 unit. |
| huc_8 | String | Eight-digit Hydrologic Unit Code |
| hu_8_name | String | Designated name of the HUC 8 unit. |
| huc_10 | String | Ten-digit Hydrologic Unit Code |
| hu_10_name | String | Designated name of the HUC 10 unit. |
| huc_12 | String | Twelve-digit Hydrologic Unit Code |
| hu_12_name | String | Designated name of the HUC 12 unit. |
| acres | Number | The area of the HUC unit in acres. |
| ncontrb_a | Date | Area of the HUC unit considered to be noncontributing to the watershed basin. |
| hu_10_gnis | String | USGS GNIS identification code for the 10 digit hydrologic unit. |
| hu_12_gnis | String | USGS GNIS identification code for the 12 digit hydrologic unit. |
| hu_10_ds | String | The 10-digit code of the 5th level hydrologic unit that is receiving the majority of the flow from the watershed that the 6th level HU falls within. Outlets created by ditching or other artificial drainage were not considered for this field. |
| hu_10_mod | String | Field identifying interbasin transfers (IT), dams at the outlet (DM), etc. that modify natural overland flow for a HUC10. Modifications are identified from most significant to least significant. Hydrologic units with no modifications are marked with NM. |
| hu_10_type | String | Field identifies the type of HUC10 watershed. |
| hu_12_ds | String | The 12-digit code of the 5th level hydrologic unit that is receiving the majority of the flow from the watershed that the 6th level HU falls within. Outlets created by ditching or other artificial drainage were not considered for this field. |
| hu_12_mod | String | Field identifying interbasin transfers (IT), dams at the outlet (DM), etc. that modify natural overland flow for a HUC12. Modifications are identified from most significant to least significant. Hydrologic units with no modifications are marked with NM. |
| hu_12_type | String | Field identifies the type of HUC12 watershed. |
| meta_id | String | Metadata ID is a code that identifies which metadata file applies to the arc. |
| states | String | Comma-delimited list of states considered by USGS to comprise the hydrologic unit. |
| vertices | Number | Count of vertices comprising the feature geometry. |
| shape | Geometry | Feature geometry. |
ow_wbd_feature_grp
| Property | Datatype | Description |
|---|---|---|
| results | Array of Object | Object Type: ow_wbd_feature |