upstreamdownstream_resp
upstreamdownstream_resp schema from CIP-service Indexing API
GovernmentEnvironmentalOpenDataAirQualityWaterQualityHazardousWasteComplianceEmissions
Properties
| Name | Type | Description |
|---|---|---|
| flowlines | object | |
| flowline_count | integer | Total flowlines navigated by the search. |
| catchments | object | |
| catchment_count | integer | Total catchments returned by the search. |
| linked_data_sfid_found | object | |
| linked_data_sfid_count | integer | Total sfids discovered by the search. |
| linked_data_cip_found | object | |
| linked_data_cip_count | integer | Total CIP indexed catchments discovered by the search. |
| linked_data_huc12_found | object | |
| linked_data_huc12_count | integer | Total CIP indexed xwalk HUC12s discovered by the search. |
| linked_data_source_points | object | |
| linked_data_source_lines | object | |
| linked_data_source_areas | object | |
| linked_data_source_count | integer | Total source events discovered by the search. |
| linked_data_reached_points | object | |
| linked_data_reached_lines | object | |
| linked_data_reached_areas | object | |
| linked_data_reached_count | integer | Total reach indexed events discovered by the search. |
| linked_data_attributes | object | |
| start_nhdplusid | object | |
| start_measure | object | |
| start_linked_data_program | object | |
| stop_nhdplusid | object | |
| stop_measure | object | |
| stop_linked_data_program | object | |
| return_code | object | |
| status_message | object |
JSON Schema
{
"$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-resp-schema.json",
"title": "upstreamdownstream_resp",
"description": "upstreamdownstream_resp schema from CIP-service Indexing API",
"type": "object",
"properties": {
"flowlines": {
"$ref": "#/components/schemas/geojson_featurecollection"
},
"flowline_count": {
"description": "Total flowlines navigated by the search.",
"type": "integer",
"format": "int32",
"examples": [
0
]
},
"catchments": {
"$ref": "#/components/schemas/geojson_featurecollection"
},
"catchment_count": {
"description": "Total catchments returned by the search.",
"type": "integer",
"format": "int32",
"examples": [
0
]
},
"linked_data_sfid_found": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"rows": {
"type": "array",
"items": {
"type": "object",
"properties": {
"eventtype": {
"type": "integer"
},
"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": "string",
"format": "date"
},
"end_date": {
"type": "string",
"format": "date"
},
"sfiddetailurl": {
"type": "string"
},
"src_event_count": {
"type": "integer"
},
"rad_event_count": {
"type": "integer"
},
"src_cat_joinkey_count": {
"type": "integer"
},
"nearest_cip_distancekm_permid": {
"type": "number"
},
"nearest_cip_distancekm_cat": {
"type": "number"
},
"nearest_cip_network_distancekm": {
"type": "number"
},
"nearest_rad_distancekm_permid": {
"type": "string"
},
"nearest_rad_network_distancekm": {
"type": "number"
},
"nearest_cip_flowtimeday_permid": {
"type": "string"
},
"nearest_cip_flowtimeday_cat": {
"type": "number"
},
"nearest_cip_network_flowtimeday": {
"type": "number"
},
"nearest_rad_flowtimeday_permid": {
"type": "string"
},
"nearest_rad_network_flowtimeday": {
"type": "number"
}
}
}
}
},
"example": {}
},
"linked_data_sfid_count": {
"description": "Total sfids discovered by the search.",
"type": "integer",
"format": "int32",
"examples": [
0
]
},
"linked_data_cip_found": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"rows": {
"type": "array",
"items": {
"type": "object",
"properties": {
"eventtype": {
"type": "integer"
},
"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": "string",
"format": "date"
},
"end_date": {
"type": "string",
"format": "date"
},
"cat_joinkey": {
"type": "string"
},
"catchmentstatecode": {
"type": "string"
},
"nhdplusid": {
"type": "integer",
"format": "int64"
},
"xwalk_huc12": {
"type": "string"
},
"network_distancekm": {
"type": "number"
},
"network_flowtimeday": {
"type": "number"
}
}
}
}
},
"example": {}
},
"linked_data_cip_count": {
"description": "Total CIP indexed catchments discovered by the search.",
"type": "integer",
"format": "int32",
"examples": [
0
]
},
"linked_data_huc12_found": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"rows": {
"type": "array",
"items": {
"type": "object",
"properties": {
"eventtype": {
"type": "integer"
},
"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": "string",
"format": "date"
},
"end_date": {
"type": "string",
"format": "date"
},
"xwalk_huc12": {
"type": "string"
},
"network_distancekm": {
"type": "number"
},
"network_flowtimeday": {
"type": "number"
}
}
}
}
},
"example": {}
},
"linked_data_huc12_count": {
"description": "Total CIP indexed xwalk HUC12s discovered by the search.",
"type": "integer",
"format": "int32",
"examples": [
0
]
},
"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": {
"description": "Total source events discovered by the search.",
"type": "integer",
"format": "int32",
"examples": [
0
]
},
"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": {
"description": "Total reach indexed events discovered by the search.",
"type": "integer",
"format": "int32",
"examples": [
0
]
},
"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"
}
}
}