EPA — U.S. Environmental Protection Agency · JSON Structure

Cip Service Upstreamdownstream Resp Structure

upstreamdownstream_resp schema from CIP-service Indexing API

Type: object Properties: 27

GovernmentEnvironmentalOpenDataAirQualityWaterQualityHazardousWasteComplianceEmissions

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

Properties

flowlines flowline_count catchments catchment_count linked_data_sfid_found linked_data_sfid_count linked_data_cip_found linked_data_cip_count linked_data_huc12_found linked_data_huc12_count linked_data_source_points linked_data_source_lines linked_data_source_areas linked_data_source_count linked_data_reached_points linked_data_reached_lines linked_data_reached_areas linked_data_reached_count linked_data_attributes start_nhdplusid start_measure start_linked_data_program stop_nhdplusid stop_measure stop_linked_data_program return_code status_message

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

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/epa/refs/heads/main/json-structure/cip-service-upstreamdownstream-resp-structure.json",
  "name": "upstreamdownstream_resp",
  "description": "upstreamdownstream_resp schema from CIP-service Indexing API",
  "type": "object",
  "properties": {
    "flowlines": {
      "$ref": "#/components/schemas/geojson_featurecollection"
    },
    "flowline_count": {
      "type": "int32",
      "description": "Total flowlines navigated by the search."
    },
    "catchments": {
      "$ref": "#/components/schemas/geojson_featurecollection"
    },
    "catchment_count": {
      "type": "int32",
      "description": "Total catchments returned by the search."
    },
    "linked_data_sfid_found": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string"
        },
        "rows": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "eventtype": {
                "type": "int32"
              },
              "source_originator": {
                "type": "string"
              },
              "source_featureid": {
                "type": "string"
              },
              "source_featureid2": {
                "type": "string"
              },
              "source_series": {
                "type": "string"
              },
              "source_subdivision": {
                "type": "string"
              },
              "source_joinkey": {
                "type": "string"
              },
              "start_date": {
                "type": "date"
              },
              "end_date": {
                "type": "date"
              },
              "sfiddetailurl": {
                "type": "string"
              },
              "src_event_count": {
                "type": "int32"
              },
              "rad_event_count": {
                "type": "int32"
              },
              "src_cat_joinkey_count": {
                "type": "int32"
              },
              "nearest_cip_distancekm_permid": {
                "type": "double"
              },
              "nearest_cip_distancekm_cat": {
                "type": "double"
              },
              "nearest_cip_network_distancekm": {
                "type": "double"
              },
              "nearest_rad_distancekm_permid": {
                "type": "string"
              },
              "nearest_rad_network_distancekm": {
                "type": "double"
              },
              "nearest_cip_flowtimeday_permid": {
                "type": "string"
              },
              "nearest_cip_flowtimeday_cat": {
                "type": "double"
              },
              "nearest_cip_network_flowtimeday": {
                "type": "double"
              },
              "nearest_rad_flowtimeday_permid": {
                "type": "string"
              },
              "nearest_rad_network_flowtimeday": {
                "type": "double"
              }
            }
          }
        }
      },
      "example": {}
    },
    "linked_data_sfid_count": {
      "type": "int32",
      "description": "Total sfids discovered by the search."
    },
    "linked_data_cip_found": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string"
        },
        "rows": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "eventtype": {
                "type": "int32"
              },
              "permid_joinkey": {
                "type": "string"
              },
              "source_originator": {
                "type": "string"
              },
              "source_featureid": {
                "type": "string"
              },
              "source_featureid2": {
                "type": "string"
              },
              "source_series": {
                "type": "string"
              },
              "source_subdivision": {
                "type": "string"
              },
              "source_joinkey": {
                "type": "string"
              },
              "start_date": {
                "type": "date"
              },
              "end_date": {
                "type": "date"
              },
              "cat_joinkey": {
                "type": "string"
              },
              "catchmentstatecode": {
                "type": "string"
              },
              "nhdplusid": {
                "type": "int64"
              },
              "xwalk_huc12": {
                "type": "string"
              },
              "network_distancekm": {
                "type": "double"
              },
              "network_flowtimeday": {
                "type": "double"
              }
            }
          }
        }
      },
      "example": {}
    },
    "linked_data_cip_count": {
      "type": "int32",
      "description": "Total CIP indexed catchments discovered by the search."
    },
    "linked_data_huc12_found": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string"
        },
        "rows": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "eventtype": {
                "type": "int32"
              },
              "permid_joinkey": {
                "type": "string"
              },
              "source_originator": {
                "type": "string"
              },
              "source_featureid": {
                "type": "string"
              },
              "source_featureid2": {
                "type": "string"
              },
              "source_series": {
                "type": "string"
              },
              "source_subdivision": {
                "type": "string"
              },
              "source_joinkey": {
                "type": "string"
              },
              "start_date": {
                "type": "date"
              },
              "end_date": {
                "type": "date"
              },
              "xwalk_huc12": {
                "type": "string"
              },
              "network_distancekm": {
                "type": "double"
              },
              "network_flowtimeday": {
                "type": "double"
              }
            }
          }
        }
      },
      "example": {}
    },
    "linked_data_huc12_count": {
      "type": "int32",
      "description": "Total CIP indexed xwalk HUC12s discovered by the search."
    },
    "linked_data_source_points": {
      "$ref": "#/components/schemas/geojson_feature"
    },
    "linked_data_source_lines": {
      "$ref": "#/components/schemas/geojson_feature"
    },
    "linked_data_source_areas": {
      "$ref": "#/components/schemas/geojson_feature"
    },
    "linked_data_source_count": {
      "type": "int32",
      "description": "Total source events discovered by the search."
    },
    "linked_data_reached_points": {
      "$ref": "#/components/schemas/geojson_feature"
    },
    "linked_data_reached_lines": {
      "$ref": "#/components/schemas/geojson_feature"
    },
    "linked_data_reached_areas": {
      "$ref": "#/components/schemas/geojson_feature"
    },
    "linked_data_reached_count": {
      "type": "int32",
      "description": "Total reach indexed events discovered by the search."
    },
    "linked_data_attributes": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string"
        },
        "rows": {
          "type": "array",
          "items": {
            "oneOf": [
              {
                "$ref": "#/components/schemas/linked_data_wqp"
              }
            ]
          }
        }
      },
      "example": {}
    },
    "start_nhdplusid": {
      "$ref": "#/components/schemas/nhdplusid"
    },
    "start_measure": {
      "$ref": "#/components/schemas/measure"
    },
    "start_linked_data_program": {
      "$ref": "#/components/schemas/linked_data_program"
    },
    "stop_nhdplusid": {
      "$ref": "#/components/schemas/nhdplusid"
    },
    "stop_measure": {
      "$ref": "#/components/schemas/measure"
    },
    "stop_linked_data_program": {
      "$ref": "#/components/schemas/linked_data_program"
    },
    "return_code": {
      "$ref": "#/components/schemas/return_code"
    },
    "status_message": {
      "$ref": "#/components/schemas/status_message"
    }
  }
}