EPA — U.S. Environmental Protection Agency · Schema

upstreamdownstream_rb

upstreamdownstream_rb schema from CIP-service Indexing API

GovernmentEnvironmentalOpenDataAirQualityWaterQualityHazardousWasteComplianceEmissions

Properties

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

JSON Schema

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