Cip Service Upstreamdownstream Rb Structure

upstreamdownstream_rb schema from CIP-service Indexing API

Type: object Properties: 49
GovernmentEnvironmentalOpenDataAirQualityWaterQualityHazardousWasteComplianceEmissions

upstreamdownstream_rb is a JSON Structure definition published by EPA — U.S. Environmental Protection Agency, describing 49 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

nhdplus_version search_type start_nhdplusid start_permanent_identifier start_reachcode start_hydroseq start_measure start_source_featureid start_source_featureid2 start_source_originator start_source_series start_start_date start_end_date start_permid_joinkey start_source_joinkey start_cip_joinkey start_linked_data_program start_push_rad_for_permid stop_nhdplusid stop_permanent_identifier stop_reachcode stop_hydroseq stop_measure stop_source_featureid stop_source_featureid2 stop_source_originator stop_source_series stop_start_date stop_end_date stop_permid_joinkey stop_source_joinkey stop_cip_joinkey stop_linked_data_program stop_push_rad_for_permid max_distancekm max_flowtimeday linked_data_search_list search_precision return_flowlines return_flowline_details return_flowline_geometry return_catchments return_linked_data_cip return_linked_data_huc12 return_linked_data_source return_linked_data_rad return_linked_data_attributes remove_stop_start_sfids push_source_geometry_as_rad

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/epa/refs/heads/main/json-structure/cip-service-upstreamdownstream-rb-structure.json",
  "name": "upstreamdownstream_rb",
  "description": "upstreamdownstream_rb schema from CIP-service Indexing API",
  "type": "object",
  "properties": {
    "nhdplus_version": {
      "$ref": "#/components/schemas/nhdplus_version",
      "default": "nhdplus_h"
    },
    "search_type": {
      "$ref": "#/components/schemas/search_type"
    },
    "start_nhdplusid": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/start_nhdplusid"
        },
        {
          "type": "string"
        }
      ],
      "example": "12345"
    },
    "start_permanent_identifier": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/start_permanent_identifier"
        },
        {
          "type": "string"
        }
      ],
      "example": "12345"
    },
    "start_reachcode": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/start_reachcode"
        },
        {
          "type": "string"
        }
      ],
      "example": "string"
    },
    "start_hydroseq": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/start_hydroseq"
        },
        {
          "type": "string"
        }
      ],
      "example": "string"
    },
    "start_measure": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/start_measure"
        },
        {
          "type": "string"
        }
      ],
      "example": "string"
    },
    "start_source_featureid": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "example": "12345"
    },
    "start_source_featureid2": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "example": "12345"
    },
    "start_source_originator": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "example": "string"
    },
    "start_source_series": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "example": "string"
    },
    "start_start_date": {
      "oneOf": [
        {
          "type": "date"
        },
        {
          "type": "string"
        }
      ],
      "example": "string"
    },
    "start_end_date": {
      "oneOf": [
        {
          "type": "date"
        },
        {
          "type": "string"
        }
      ],
      "example": "string"
    },
    "start_permid_joinkey": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "example": "12345"
    },
    "start_source_joinkey": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "example": "string"
    },
    "start_cip_joinkey": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "example": "string"
    },
    "start_linked_data_program": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "example": "string"
    },
    "start_push_rad_for_permid": {
      "oneOf": [
        {
          "type": "boolean"
        },
        {
          "type": "string"
        }
      ],
      "example": "12345"
    },
    "stop_nhdplusid": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/stop_nhdplusid"
        },
        {
          "type": "string"
        }
      ],
      "example": "12345"
    },
    "stop_permanent_identifier": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/stop_permanent_identifier"
        },
        {
          "type": "string"
        }
      ],
      "example": "12345"
    },
    "stop_reachcode": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/stop_reachcode"
        },
        {
          "type": "string"
        }
      ],
      "example": "string"
    },
    "stop_hydroseq": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/stop_hydroseq"
        },
        {
          "type": "string"
        }
      ],
      "example": "string"
    },
    "stop_measure": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/stop_measure"
        },
        {
          "type": "string"
        }
      ],
      "example": "string"
    },
    "stop_source_featureid": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "example": "12345"
    },
    "stop_source_featureid2": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "example": "12345"
    },
    "stop_source_originator": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "example": "string"
    },
    "stop_source_series": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "example": "string"
    },
    "stop_start_date": {
      "oneOf": [
        {
          "type": "date"
        },
        {
          "type": "string"
        }
      ],
      "example": "string"
    },
    "stop_end_date": {
      "oneOf": [
        {
          "type": "date"
        },
        {
          "type": "string"
        }
      ],
      "example": "string"
    },
    "stop_permid_joinkey": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "example": "12345"
    },
    "stop_source_joinkey": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "example": "string"
    },
    "stop_cip_joinkey": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "example": "string"
    },
    "stop_linked_data_program": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "example": "string"
    },
    "stop_push_rad_for_permid": {
      "oneOf": [
        {
          "type": "boolean"
        },
        {
          "type": "string"
        }
      ],
      "example": "12345"
    },
    "max_distancekm": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/max_distancekm"
        },
        {
          "type": "string"
        }
      ],
      "example": "string"
    },
    "max_flowtimeday": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/max_flowtimeday"
        },
        {
          "type": "string"
        }
      ],
      "example": "string"
    },
    "linked_data_search_list": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "string"
      ]
    },
    "search_precision": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "example": "string"
    },
    "return_flowlines": {
      "oneOf": [
        {
          "type": "boolean"
        },
        {
          "type": "string"
        }
      ],
      "example": "string"
    },
    "return_flowline_details": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/return_flowline_details"
        },
        {
          "type": "string"
        }
      ],
      "example": "string"
    },
    "return_flowline_geometry": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/return_flowline_geometry"
        },
        {
          "type": "string"
        }
      ],
      "example": "string"
    },
    "return_catchments": {
      "oneOf": [
        {
          "type": "boolean"
        },
        {
          "type": "string"
        }
      ],
      "example": "string"
    },
    "return_linked_data_cip": {
      "oneOf": [
        {
          "type": "boolean"
        },
        {
          "type": "string"
        }
      ],
      "example": "string"
    },
    "return_linked_data_huc12": {
      "oneOf": [
        {
          "type": "boolean"
        },
        {
          "type": "string"
        }
      ],
      "example": "string"
    },
    "return_linked_data_source": {
      "oneOf": [
        {
          "type": "boolean"
        },
        {
          "type": "string"
        }
      ],
      "example": "string"
    },
    "return_linked_data_rad": {
      "oneOf": [
        {
          "type": "boolean"
        },
        {
          "type": "string"
        }
      ],
      "example": "string"
    },
    "return_linked_data_attributes": {
      "oneOf": [
        {
          "type": "boolean"
        },
        {
          "type": "string"
        }
      ],
      "example": "string"
    },
    "remove_stop_start_sfids": {
      "oneOf": [
        {
          "type": "boolean"
        },
        {
          "type": "string"
        }
      ],
      "example": "12345"
    },
    "push_source_geometry_as_rad": {
      "oneOf": [
        {
          "type": "boolean"
        },
        {
          "type": "string"
        }
      ],
      "example": "string"
    }
  }
}