navigated_flowline_properties

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/epa/refs/heads/main/json-schema/cip-service-navigated-flowline-properties-schema.json",
  "title": "navigated_flowline_properties",
  "description": "navigated_flowline_properties schema from CIP-service Indexing API",
  "type": "object",
  "properties": {
    "nhdplusid": {
      "$ref": "#/components/schemas/nhdplusid"
    },
    "hydroseq": {
      "$ref": "#/components/schemas/hydroseq"
    },
    "fmeasure": {
      "description": "NHD flowline from measure.",
      "$ref": "#/components/schemas/measure"
    },
    "tmeasure": {
      "description": "NHD flowline to measure.",
      "$ref": "#/components/schemas/measure"
    },
    "levelpathi": {
      "description": "NHDPlus int64 level path identifier.",
      "type": "integer",
      "format": "int64",
      "example": 0
    },
    "terminalpa": {
      "description": "NHDPlus int64 terminal path identifier.",
      "type": "integer",
      "format": "int64",
      "example": 0
    },
    "uphydroseq": {
      "description": "NHDPlus int64 upstream flowline hydro sequence identifier.",
      "type": "integer",
      "format": "int64",
      "example": 0
    },
    "dnhydroseq": {
      "description": "NHDPlus int64 downstream flowline hydro sequence identifier.",
      "type": "integer",
      "format": "int64",
      "example": 0
    },
    "lengthkm": {
      "description": "length of the navigated flowline in kilometers.",
      "type": "number",
      "example": 0.0
    },
    "flowtimeday": {
      "description": "flow time in days of the navigated flowline.",
      "type": "number",
      "example": 0.0
    },
    "network_distancekm": {
      "description": "total length from start to the navigated flowline in kilometers.",
      "type": "number",
      "example": 0.0
    },
    "network_flowtimeday": {
      "description": "total flow time in days from start to the navigated flowline.",
      "type": "number",
      "example": 0.0
    },
    "permanent_identifier": {
      "description": "NHD permanent identifier of the navigated flowline.",
      "type": [
        "string",
        "null"
      ],
      "example": "12345"
    },
    "reachcode": {
      "description": "NHD reach code of the navigated flowline",
      "$ref": "#/components/schemas/reachcode"
    },
    "fcode": {
      "description": "NHD feature type code of the navigated flowline.",
      "type": "integer",
      "format": "int32",
      "example": 0
    },
    "gnis_id": {
      "description": "NHD GNIS identifier of the navigated flowline.",
      "type": "string",
      "example": "12345"
    },
    "gnis_name": {
      "description": "NHD GNIS name of the navigated flowline.",
      "type": "string",
      "example": "EPA Facility"
    },
    "wbarea_permanent_identifier": {
      "description": "NHD permanent identifier of the NHD waterbody feature associated with a flowline artificial path.",
      "type": "string",
      "example": "12345"
    },
    "navtermination_flag": {
      "description": "Integer code providing information about the navigated flowline within the context of the navigation. Valid codes are: 0. no termination 1. full termination 2. partial termination 3. coastal termination 4. headwater termination 5. network end termination (non-coastal)\n",
      "type": "integer",
      "format": "int32",
      "enum": [
        0,
        1,
        2,
        3,
        4,
        5
      ],
      "example": 0
    },
    "nav_order": {
      "description": "rough ordering key placing flowlines in navigated order",
      "type": "integer",
      "format": "int32",
      "example": 0
    }
  }
}