{"openapi": "3.0.1", "info": {"title": "HMS REST API", "description": "Swagger documentation for HMS REST API with example requests and responses.", "version": "v1"}, "paths": {"/api/aquatox/input-builder/base-json/flags": {"get": {"tags": ["WSAquatoxInputBuilder"], "summary": "GET method for returning the Aquatox base json flags.", "responses": {"200": {"description": "OK"}}}, "post": {"tags": ["WSAquatoxInputBuilder"], "summary": "POST method for returning the Aquatox workflow base json based on set flags.", "requestBody": {"description": "A dictionary of [flag_name : bool]", "content": {"application/json-patch+json": {"schema": {"type": "object", "additionalProperties": {"type": "boolean"}}, "example": {"Nitrogen": true, "Phosphorus": false, "Organic Matter": false}}, "application/json": {"schema": {"type": "object", "additionalProperties": {"type": "boolean"}}, "example": {"Nitrogen": true, "Phosphorus": false, "Organic Matter": false}}, "text/json": {"schema": {"type": "object", "additionalProperties": {"type": "boolean"}}, "example": {"Nitrogen": true, "Phosphorus": false, "Organic Matter": false}}, "application/*+json": {"schema": {"type": "object", "additionalProperties": {"type": "boolean"}}, "example": {"Nitrogen": true, "Phosphorus": false, "Organic Matter": false}}}}, "responses": {"200": {"description": "OK"}}}}, "/api/aquatox/input-builder/loadings/types": {"get": {"tags": ["WSAquatoxInputBuilder"], "summary": "GET method that returns dictionary of loading types and values", "responses": {"200": {"description": "OK"}}}}, "/api/aquatox/input-builder/loadings/insert": {"post": {"tags": ["WSAquatoxInputBuilder"], "summary": "POST method for inserting state variable loadings into Aquatox base json.", "requestBody": {"description": "Object of flags and list of LoadingsObjects", "content": {"application/json-patch+json": {"schema": {"$ref": "#/components/schemas/LoadingsInput"}, "example": {"flags": {"Nitrogen": true, "Phosphorus": true, "Organic Matter": true}, "loadings": [{"param": "TNO3Obj", "loadingType": -1, "useConstant": true, "constant": 0.1, "timeSeries": {"2019-01-01T00:00:00": 0.1}, "multiplier": 1.0, "metadata": {"TN_NPS": "true"}}]}}, "application/json": {"schema": {"$ref": "#/components/schemas/LoadingsInput"}, "example": {"flags": {"Nitrogen": true, "Phosphorus": true, "Organic Matter": true}, "loadings": [{"param": "TNO3Obj", "loadingType": -1, "useConstant": true, "constant": 0.1, "timeSeries": {"2019-01-01T00:00:00": 0.1}, "multiplier": 1.0, "metadata": {"TN_NPS": "true"}}]}}, "text/json": {"schema": {"$ref": "#/components/schemas/LoadingsInput"}, "example": {"flags": {"Nitrogen": true, "Phosphorus": true, "Organic Matter": true}, "loadings": [{"param": "TNO3Obj", "loadingType": -1, "useConstant": true, "constant": 0.1, "timeSeries": {"2019-01-01T00:00:00": 0.1}, "multiplier": 1.0, "metadata": {"TN_NPS": "true"}}]}}, "application/*+json": {"schema": {"$ref": "#/components/schemas/LoadingsInput"}, "example": {"flags": {"Nitrogen": true, "Phosphorus": true, "Organic Matter": true}, "loadings": [{"param": "TNO3Obj", "loadingType": -1, "useConstant": true, "constant": 0.1, "timeSeries": {"2019-01-01T00:00:00": 0.1}, "multiplier": 1.0, "metadata": {"TN_NPS": "true"}}]}}}}, "responses": {"200": {"description": "OK"}}}}, "/api/aquatox/workflow": {"get": {"tags": ["WSAquatoxWorkflow"], "summary": "GET method for calling the AQUATOX workflow.", "parameters": [{"name": "task_id", "in": "query", "description": "", "schema": {"type": "string"}}], "responses": {"200": {"description": "OK"}}}}, "/api/aquatox/workflow/archive-results": {"get": {"tags": ["WSAquatoxWorkflow"], "summary": "Given the task_id for a single comid, returns the archived results of \r\nthe state variables outputs.", "parameters": [{"name": "task_id", "in": "query", "description": "", "schema": {"type": "string"}}], "responses": {"200": {"description": "OK"}}}}, "/api/info/catchment": {"get": {"tags": ["WSCatchment"], "summary": "", "parameters": [{"name": "comid", "in": "query", "schema": {"type": "string"}}, {"name": "streamcat", "in": "query", "schema": {"type": "boolean", "default": false}}, {"name": "geometry", "in": "query", "schema": {"type": "boolean", "default": false}}, {"name": "nwis", "in": "query", "schema": {"type": "boolean", "default": false}}, {"name": "streamGeometry", "in": "query", "schema": {"type": "boolean", "default": false}}, {"name": "cn", "in": "query", "schema": {"type": "boolean", "default": false}}, {"name": "network", "in": "query", "schema": {"type": "boolean", "default": false}}], "responses": {"200": {"description": "OK"}}}}, "/api/coastal": {"post": {"tags": ["WSCoastal"], "requestBody": {"content": {"application/json-patch+json": {"schema": {"$ref": "#/components/schemas/TimeSeriesInput"}, "example": {"source": "noaa_coastal", "dateTimeSpan": {"startDate": "01/01/2013 00:00:00", "endDate": "01/02/2013 00:00:00", "dateTimeFormat": "yyyy-MM-dd HH"}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": "8454000", "point": null, "geometryMetadata": {"product": "water_level", "datum": "mllw", "application": "web_services"}, "timezone": {"name": "GMT", "offset": 0.0, "dls": false}}, "dataValueFormat": "E3", "temporalResolution": "default", "timeLocalized": false, "units": "metric", "outputFormat": "json", "baseURL": null, "inputTimeSeries": null}}, "application/json": {"schema": {"$ref": "#/components/schemas/TimeSeriesInput"}, "example": {"source": "noaa_coastal", "dateTimeSpan": {"startDate": "01/01/2013 00:00:00", "endDate": "01/02/2013 00:00:00", "dateTimeFormat": "yyyy-MM-dd HH"}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": "8454000", "point": null, "geometryMetadata": {"product": "water_level", "datum": "mllw", "application": "web_services"}, "timezone": {"name": "GMT", "offset": 0.0, "dls": false}}, "dataValueFormat": "E3", "temporalResolution": "default", "timeLocalized": false, "units": "metric", "outputFormat": "json", "baseURL": null, "inputTimeSeries": null}}, "text/json": {"schema": {"$ref": "#/components/schemas/TimeSeriesInput"}, "example": {"source": "noaa_coastal", "dateTimeSpan": {"startDate": "01/01/2013 00:00:00", "endDate": "01/02/2013 00:00:00", "dateTimeFormat": "yyyy-MM-dd HH"}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": "8454000", "point": null, "geometryMetadata": {"product": "water_level", "datum": "mllw", "application": "web_services"}, "timezone": {"name": "GMT", "offset": 0.0, "dls": false}}, "dataValueFormat": "E3", "temporalResolution": "default", "timeLocalized": false, "units": "metric", "outputFormat": "json", "baseURL": null, "inputTimeSeries": null}}, "application/*+json": {"schema": {"$ref": "#/components/schemas/TimeSeriesInput"}, "example": {"source": "noaa_coastal", "dateTimeSpan": {"startDate": "01/01/2013 00:00:00", "endDate": "01/02/2013 00:00:00", "dateTimeFormat": "yyyy-MM-dd HH"}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": "8454000", "point": null, "geometryMetadata": {"product": "water_level", "datum": "mllw", "application": "web_services"}, "timezone": {"name": "GMT", "offset": 0.0, "dls": false}}, "dataValueFormat": "E3", "temporalResolution": "default", "timeLocalized": false, "units": "metric", "outputFormat": "json", "baseURL": null, "inputTimeSeries": null}}}}, "responses": {"200": {"description": "OK"}}}}, "/api/contaminantloader": {"post": {"tags": ["WSContaminantLoader"], "requestBody": {"content": {"application/json-patch+json": {"schema": {"$ref": "#/components/schemas/ContaminantLoaderInput"}, "example": {"contaminantType": "generic", "contaminantInputType": "csv", "contaminantInput": "Date-Time, TestValues\n2010-01-01 00, 1.0\n2010-01-01 01, 1.5\n2010-01-01 02, 2.0\n2010-01-01 03, 2.5\n2010-01-01 04, 3.0\n2010-01-01 05, 3.5\n2010-01-01 06, 4.0\n2010-01-01 07, 4.5\n2010-01-01 08, 5.0\n2010-01-01 09, 5.5\n2010-01-01 10, 6.0\n2010-01-01 11, 6.5\n2010-01-01 12, 6.0\n2010-01-01 13, 5.5\n2010-01-01 14, 5.0\n2010-01-01 15, 4.5\n2010-01-01 16, 4.0\n2010-01-01 17, 3.5\n2010-01-01 18, 3.0\n2010-01-01 19, 2.5\n2010-01-01 20, 2.0\n2010-01-01 21, 1.5\n2010-01-01 22, 1.0\n2010-01-01 23, 1.0"}}, "application/json": {"schema": {"$ref": "#/components/schemas/ContaminantLoaderInput"}, "example": {"contaminantType": "generic", "contaminantInputType": "csv", "contaminantInput": "Date-Time, TestValues\n2010-01-01 00, 1.0\n2010-01-01 01, 1.5\n2010-01-01 02, 2.0\n2010-01-01 03, 2.5\n2010-01-01 04, 3.0\n2010-01-01 05, 3.5\n2010-01-01 06, 4.0\n2010-01-01 07, 4.5\n2010-01-01 08, 5.0\n2010-01-01 09, 5.5\n2010-01-01 10, 6.0\n2010-01-01 11, 6.5\n2010-01-01 12, 6.0\n2010-01-01 13, 5.5\n2010-01-01 14, 5.0\n2010-01-01 15, 4.5\n2010-01-01 16, 4.0\n2010-01-01 17, 3.5\n2010-01-01 18, 3.0\n2010-01-01 19, 2.5\n2010-01-01 20, 2.0\n2010-01-01 21, 1.5\n2010-01-01 22, 1.0\n2010-01-01 23, 1.0"}}, "text/json": {"schema": {"$ref": "#/components/schemas/ContaminantLoaderInput"}, "example": {"contaminantType": "generic", "contaminantInputType": "csv", "contaminantInput": "Date-Time, TestValues\n2010-01-01 00, 1.0\n2010-01-01 01, 1.5\n2010-01-01 02, 2.0\n2010-01-01 03, 2.5\n2010-01-01 04, 3.0\n2010-01-01 05, 3.5\n2010-01-01 06, 4.0\n2010-01-01 07, 4.5\n2010-01-01 08, 5.0\n2010-01-01 09, 5.5\n2010-01-01 10, 6.0\n2010-01-01 11, 6.5\n2010-01-01 12, 6.0\n2010-01-01 13, 5.5\n2010-01-01 14, 5.0\n2010-01-01 15, 4.5\n2010-01-01 16, 4.0\n2010-01-01 17, 3.5\n2010-01-01 18, 3.0\n2010-01-01 19, 2.5\n2010-01-01 20, 2.0\n2010-01-01 21, 1.5\n2010-01-01 22, 1.0\n2010-01-01 23, 1.0"}}, "application/*+json": {"schema": {"$ref": "#/components/schemas/ContaminantLoaderInput"}, "example": {"contaminantType": "generic", "contaminantInputType": "csv", "contaminantInput": "Date-Time, TestValues\n2010-01-01 00, 1.0\n2010-01-01 01, 1.5\n2010-01-01 02, 2.0\n2010-01-01 03, 2.5\n2010-01-01 04, 3.0\n2010-01-01 05, 3.5\n2010-01-01 06, 4.0\n2010-01-01 07, 4.5\n2010-01-01 08, 5.0\n2010-01-01 09, 5.5\n2010-01-01 10, 6.0\n2010-01-01 11, 6.5\n2010-01-01 12, 6.0\n2010-01-01 13, 5.5\n2010-01-01 14, 5.0\n2010-01-01 15, 4.5\n2010-01-01 16, 4.0\n2010-01-01 17, 3.5\n2010-01-01 18, 3.0\n2010-01-01 19, 2.5\n2010-01-01 20, 2.0\n2010-01-01 21, 1.5\n2010-01-01 22, 1.0\n2010-01-01 23, 1.0"}}}}, "responses": {"200": {"description": "OK"}}}}, "/api/meteorology/dewpoint": {"post": {"tags": ["WSDewPoint"], "summary": "POST method for submitting a request for dew point temperature data.", "requestBody": {"content": {"application/json-patch+json": {"schema": {"$ref": "#/components/schemas/DewPointInput"}, "example": {"source": "prism", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": null}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": {"latitude": 33.925673, "longitude": -83.355723}, "geometryMetadata": null, "timezone": null}, "dataValueFormat": null, "temporalResolution": null, "timeLocalized": false, "units": null, "outputFormat": null, "baseURL": null, "inputTimeSeries": null}}, "application/json": {"schema": {"$ref": "#/components/schemas/DewPointInput"}, "example": {"source": "prism", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": null}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": {"latitude": 33.925673, "longitude": -83.355723}, "geometryMetadata": null, "timezone": null}, "dataValueFormat": null, "temporalResolution": null, "timeLocalized": false, "units": null, "outputFormat": null, "baseURL": null, "inputTimeSeries": null}}, "text/json": {"schema": {"$ref": "#/components/schemas/DewPointInput"}, "example": {"source": "prism", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": null}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": {"latitude": 33.925673, "longitude": -83.355723}, "geometryMetadata": null, "timezone": null}, "dataValueFormat": null, "temporalResolution": null, "timeLocalized": false, "units": null, "outputFormat": null, "baseURL": null, "inputTimeSeries": null}}, "application/*+json": {"schema": {"$ref": "#/components/schemas/DewPointInput"}, "example": {"source": "prism", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": null}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": {"latitude": 33.925673, "longitude": -83.355723}, "geometryMetadata": null, "timezone": null}, "dataValueFormat": null, "temporalResolution": null, "timeLocalized": false, "units": null, "outputFormat": null, "baseURL": null, "inputTimeSeries": null}}}}, "responses": {"200": {"description": "OK"}}}}, "/api/hydrology/evapotranspiration": {"post": {"tags": ["WSEvapotranspiration"], "summary": "POST method for submitting a request for evapotranspiration data.", "requestBody": {"description": "Parameters for retrieving evapotranspiration data. Required fields: DateTimeSpan.StartDate, DateTimeSpan.EndDate, Geometry.Point.Latitude, Geometry.Point.Longitude, Source", "content": {"application/json-patch+json": {"schema": {"$ref": "#/components/schemas/EvapotranspirationInput"}, "example": {"algorithm": "nldas", "albedo": 0.23, "centralLongitude": 75.0, "sunAngle": 17.2, "emissivity": 0.92, "model": "ETP", "zenith": 0.05, "lakeSurfaceArea": 0.005, "lakeDepth": 0.2, "subsurfaceResistance": 500.0, "stomatalResistance": 400.0, "leafWidth": 0.02, "roughnessLength": 0.02, "vegetationHeight": 0.12, "leafAreaIndices": {"12": 2.51, "11": 2.51, "10": 2.51, "9": 2.51, "8": 2.51, "7": 2.51, "6": 2.51, "5": 2.51, "4": 2.51, "3": 2.51, "2": 2.51, "1": 2.51}, "airTemperature": {"12": 1.0, "11": 1.0, "10": 1.0, "9": 1.0, "8": 1.0, "7": 1.0, "6": 1.0, "5": 1.0, "4": 1.0, "3": 1.0, "2": 1.0, "1": 1.0}, "userData": "2015-01-01 00Z -2.7000E-03\n2015 - 01 - 01 01Z - 1.9000E-03\n2015 - 01 - 01 02Z - 1.3000E-03\n2015 - 01 - 01 03Z - 9.0000E-04\n2015 - 01 - 01 04Z - 3.0000E-04", "source": "nldas", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": null}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": {"latitude": 33.925673, "longitude": -83.355723}, "geometryMetadata": null, "timezone": null}, "dataValueFormat": "E3", "temporalResolution": "default", "timeLocalized": true, "units": "default", "outputFormat": "json", "baseURL": null, "inputTimeSeries": null}}, "application/json": {"schema": {"$ref": "#/components/schemas/EvapotranspirationInput"}, "example": {"algorithm": "nldas", "albedo": 0.23, "centralLongitude": 75.0, "sunAngle": 17.2, "emissivity": 0.92, "model": "ETP", "zenith": 0.05, "lakeSurfaceArea": 0.005, "lakeDepth": 0.2, "subsurfaceResistance": 500.0, "stomatalResistance": 400.0, "leafWidth": 0.02, "roughnessLength": 0.02, "vegetationHeight": 0.12, "leafAreaIndices": {"12": 2.51, "11": 2.51, "10": 2.51, "9": 2.51, "8": 2.51, "7": 2.51, "6": 2.51, "5": 2.51, "4": 2.51, "3": 2.51, "2": 2.51, "1": 2.51}, "airTemperature": {"12": 1.0, "11": 1.0, "10": 1.0, "9": 1.0, "8": 1.0, "7": 1.0, "6": 1.0, "5": 1.0, "4": 1.0, "3": 1.0, "2": 1.0, "1": 1.0}, "userData": "2015-01-01 00Z -2.7000E-03\n2015 - 01 - 01 01Z - 1.9000E-03\n2015 - 01 - 01 02Z - 1.3000E-03\n2015 - 01 - 01 03Z - 9.0000E-04\n2015 - 01 - 01 04Z - 3.0000E-04", "source": "nldas", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": null}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": {"latitude": 33.925673, "longitude": -83.355723}, "geometryMetadata": null, "timezone": null}, "dataValueFormat": "E3", "temporalResolution": "default", "timeLocalized": true, "units": "default", "outputFormat": "json", "baseURL": null, "inputTimeSeries": null}}, "text/json": {"schema": {"$ref": "#/components/schemas/EvapotranspirationInput"}, "example": {"algorithm": "nldas", "albedo": 0.23, "centralLongitude": 75.0, "sunAngle": 17.2, "emissivity": 0.92, "model": "ETP", "zenith": 0.05, "lakeSurfaceArea": 0.005, "lakeDepth": 0.2, "subsurfaceResistance": 500.0, "stomatalResistance": 400.0, "leafWidth": 0.02, "roughnessLength": 0.02, "vegetationHeight": 0.12, "leafAreaIndices": {"12": 2.51, "11": 2.51, "10": 2.51, "9": 2.51, "8": 2.51, "7": 2.51, "6": 2.51, "5": 2.51, "4": 2.51, "3": 2.51, "2": 2.51, "1": 2.51}, "airTemperature": {"12": 1.0, "11": 1.0, "10": 1.0, "9": 1.0, "8": 1.0, "7": 1.0, "6": 1.0, "5": 1.0, "4": 1.0, "3": 1.0, "2": 1.0, "1": 1.0}, "userData": "2015-01-01 00Z -2.7000E-03\n2015 - 01 - 01 01Z - 1.9000E-03\n2015 - 01 - 01 02Z - 1.3000E-03\n2015 - 01 - 01 03Z - 9.0000E-04\n2015 - 01 - 01 04Z - 3.0000E-04", "source": "nldas", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": null}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": {"latitude": 33.925673, "longitude": -83.355723}, "geometryMetadata": null, "timezone": null}, "dataValueFormat": "E3", "temporalResolution": "default", "timeLocalized": true, "units": "default", "outputFormat": "json", "baseURL": null, "inputTimeSeries": null}}, "application/*+json": {"schema": {"$ref": "#/components/schemas/EvapotranspirationInput"}, "example": {"algorithm": "nldas", "albedo": 0.23, "centralLongitude": 75.0, "sunAngle": 17.2, "emissivity": 0.92, "model": "ETP", "zenith": 0.05, "lakeSurfaceArea": 0.005, "lakeDepth": 0.2, "subsurfaceResistance": 500.0, "stomatalResistance": 400.0, "leafWidth": 0.02, "roughnessLength": 0.02, "vegetationHeight": 0.12, "leafAreaIndices": {"12": 2.51, "11": 2.51, "10": 2.51, "9": 2.51, "8": 2.51, "7": 2.51, "6": 2.51, "5": 2.51, "4": 2.51, "3": 2.51, "2": 2.51, "1": 2.51}, "airTemperature": {"12": 1.0, "11": 1.0, "10": 1.0, "9": 1.0, "8": 1.0, "7": 1.0, "6": 1.0, "5": 1.0, "4": 1.0, "3": 1.0, "2": 1.0, "1": 1.0}, "userData": "2015-01-01 00Z -2.7000E-03\n2015 - 01 - 01 01Z - 1.9000E-03\n2015 - 01 - 01 02Z - 1.3000E-03\n2015 - 01 - 01 03Z - 9.0000E-04\n2015 - 01 - 01 04Z - 3.0000E-04", "source": "nldas", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": null}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": {"latitude": 33.925673, "longitude": -83.355723}, "geometryMetadata": null, "timezone": null}, "dataValueFormat": "E3", "temporalResolution": "default", "timeLocalized": true, "units": "default", "outputFormat": "json", "baseURL": null, "inputTimeSeries": null}}}}, "responses": {"200": {"description": "OK"}}}}, "/api/meteorology/humidity": {"post": {"tags": ["WSHumidity"], "summary": "POST method for submitting a request for humidity data.", "requestBody": {"content": {"application/json-patch+json": {"schema": {"$ref": "#/components/schemas/HumidityInput"}, "example": {"relative": true, "source": "prism", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": null}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": {"latitude": 33.925673, "longitude": -83.355723}, "geometryMetadata": null, "timezone": null}, "dataValueFormat": null, "temporalResolution": null, "timeLocalized": false, "units": null, "outputFormat": null, "baseURL": null, "inputTimeSeries": null}}, "application/json": {"schema": {"$ref": "#/components/schemas/HumidityInput"}, "example": {"relative": true, "source": "prism", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": null}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": {"latitude": 33.925673, "longitude": -83.355723}, "geometryMetadata": null, "timezone": null}, "dataValueFormat": null, "temporalResolution": null, "timeLocalized": false, "units": null, "outputFormat": null, "baseURL": null, "inputTimeSeries": null}}, "text/json": {"schema": {"$ref": "#/components/schemas/HumidityInput"}, "example": {"relative": true, "source": "prism", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": null}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": {"latitude": 33.925673, "longitude": -83.355723}, "geometryMetadata": null, "timezone": null}, "dataValueFormat": null, "temporalResolution": null, "timeLocalized": false, "units": null, "outputFormat": null, "baseURL": null, "inputTimeSeries": null}}, "application/*+json": {"schema": {"$ref": "#/components/schemas/HumidityInput"}, "example": {"relative": true, "source": "prism", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": null}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": {"latitude": 33.925673, "longitude": -83.355723}, "geometryMetadata": null, "timezone": null}, "dataValueFormat": null, "temporalResolution": null, "timeLocalized": false, "units": null, "outputFormat": null, "baseURL": null, "inputTimeSeries": null}}}}, "responses": {"200": {"description": "OK"}}}}, "/api/meteorology/solar": {"post": {"tags": ["WSMeteorologySolar"], "summary": "NOAA Solar Calculator", "requestBody": {"description": "", "content": {"application/json-patch+json": {"schema": {"$ref": "#/components/schemas/SolarCalculatorInput"}, "example": {"model": "year", "localTime": "12:00:00", "source": null, "dateTimeSpan": {"startDate": "01/01/2010 00:00:00", "endDate": "12/31/2010 00:00:00", "dateTimeFormat": null}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": {"latitude": 40.0, "longitude": -105.0}, "geometryMetadata": null, "timezone": {"name": null, "offset": -7.0, "dls": false}}, "dataValueFormat": null, "temporalResolution": null, "timeLocalized": false, "units": null, "outputFormat": null, "baseURL": null, "inputTimeSeries": null}}, "application/json": {"schema": {"$ref": "#/components/schemas/SolarCalculatorInput"}, "example": {"model": "year", "localTime": "12:00:00", "source": null, "dateTimeSpan": {"startDate": "01/01/2010 00:00:00", "endDate": "12/31/2010 00:00:00", "dateTimeFormat": null}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": {"latitude": 40.0, "longitude": -105.0}, "geometryMetadata": null, "timezone": {"name": null, "offset": -7.0, "dls": false}}, "dataValueFormat": null, "temporalResolution": null, "timeLocalized": false, "units": null, "outputFormat": null, "baseURL": null, "inputTimeSeries": null}}, "text/json": {"schema": {"$ref": "#/components/schemas/SolarCalculatorInput"}, "example": {"model": "year", "localTime": "12:00:00", "source": null, "dateTimeSpan": {"startDate": "01/01/2010 00:00:00", "endDate": "12/31/2010 00:00:00", "dateTimeFormat": null}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": {"latitude": 40.0, "longitude": -105.0}, "geometryMetadata": null, "timezone": {"name": null, "offset": -7.0, "dls": false}}, "dataValueFormat": null, "temporalResolution": null, "timeLocalized": false, "units": null, "outputFormat": null, "baseURL": null, "inputTimeSeries": null}}, "application/*+json": {"schema": {"$ref": "#/components/schemas/SolarCalculatorInput"}, "example": {"model": "year", "localTime": "12:00:00", "source": null, "dateTimeSpan": {"startDate": "01/01/2010 00:00:00", "endDate": "12/31/2010 00:00:00", "dateTimeFormat": null}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": {"latitude": 40.0, "longitude": -105.0}, "geometryMetadata": null, "timezone": {"name": null, "offset": -7.0, "dls": false}}, "dataValueFormat": null, "temporalResolution": null, "timeLocalized": false, "units": null, "outputFormat": null, "baseURL": null, "inputTimeSeries": null}}}}, "responses": {"200": {"description": "OK"}}}}, "/api/meteorology/precipitation": {"post": {"tags": ["WSPrecipitation"], "summary": "POST method for submitting a request for precipitation data.", "requestBody": {"description": "Parameters for retrieving precipitation data. Required fields: DateTimeSpan.StartDate, DateTimeSpan.EndDate, Geometry.Point.Latitude, Geometry.Point.Longitude, Source", "content": {"application/json-patch+json": {"schema": {"$ref": "#/components/schemas/PrecipitationInput"}, "example": {"source": "nldas", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": "yyyy-MM-dd HH"}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": {"latitude": 33.925673, "longitude": -83.355723}, "geometryMetadata": null, "timezone": null}, "dataValueFormat": "E3", "temporalResolution": "default", "timeLocalized": false, "units": "metric", "outputFormat": "json", "baseURL": null, "inputTimeSeries": null}}, "application/json": {"schema": {"$ref": "#/components/schemas/PrecipitationInput"}, "example": {"source": "nldas", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": "yyyy-MM-dd HH"}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": {"latitude": 33.925673, "longitude": -83.355723}, "geometryMetadata": null, "timezone": null}, "dataValueFormat": "E3", "temporalResolution": "default", "timeLocalized": false, "units": "metric", "outputFormat": "json", "baseURL": null, "inputTimeSeries": null}}, "text/json": {"schema": {"$ref": "#/components/schemas/PrecipitationInput"}, "example": {"source": "nldas", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": "yyyy-MM-dd HH"}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": {"latitude": 33.925673, "longitude": -83.355723}, "geometryMetadata": null, "timezone": null}, "dataValueFormat": "E3", "temporalResolution": "default", "timeLocalized": false, "units": "metric", "outputFormat": "json", "baseURL": null, "inputTimeSeries": null}}, "application/*+json": {"schema": {"$ref": "#/components/schemas/PrecipitationInput"}, "example": {"source": "nldas", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": "yyyy-MM-dd HH"}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": {"latitude": 33.925673, "longitude": -83.355723}, "geometryMetadata": null, "timezone": null}, "dataValueFormat": "E3", "temporalResolution": "default", "timeLocalized": false, "units": "metric", "outputFormat": "json", "baseURL": null, "inputTimeSeries": null}}}}, "responses": {"200": {"description": "OK"}}}}, "/api/meteorology/pressure": {"post": {"tags": ["WSPressure"], "summary": "POST method for submitting a request for pressure data.", "requestBody": {"content": {"application/json-patch+json": {"schema": {"$ref": "#/components/schemas/PressureInput"}, "example": {"source": "gldas", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": null}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": {"latitude": 33.925673, "longitude": -83.355723}, "geometryMetadata": null, "timezone": null}, "dataValueFormat": null, "temporalResolution": null, "timeLocalized": false, "units": null, "outputFormat": null, "baseURL": null, "inputTimeSeries": null}}, "application/json": {"schema": {"$ref": "#/components/schemas/PressureInput"}, "example": {"source": "gldas", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": null}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": {"latitude": 33.925673, "longitude": -83.355723}, "geometryMetadata": null, "timezone": null}, "dataValueFormat": null, "temporalResolution": null, "timeLocalized": false, "units": null, "outputFormat": null, "baseURL": null, "inputTimeSeries": null}}, "text/json": {"schema": {"$ref": "#/components/schemas/PressureInput"}, "example": {"source": "gldas", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": null}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": {"latitude": 33.925673, "longitude": -83.355723}, "geometryMetadata": null, "timezone": null}, "dataValueFormat": null, "temporalResolution": null, "timeLocalized": false, "units": null, "outputFormat": null, "baseURL": null, "inputTimeSeries": null}}, "application/*+json": {"schema": {"$ref": "#/components/schemas/PressureInput"}, "example": {"source": "gldas", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": null}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": {"latitude": 33.925673, "longitude": -83.355723}, "geometryMetadata": null, "timezone": null}, "dataValueFormat": null, "temporalResolution": null, "timeLocalized": false, "units": null, "outputFormat": null, "baseURL": null, "inputTimeSeries": null}}}}, "responses": {"200": {"description": "OK"}}}}, "/api/meteorology/radiation": {"post": {"tags": ["WSRadiation"], "summary": "POST method for submitting a request for radiation data.", "requestBody": {"description": "Parameters for retrieving radiation data. Required fields: DateTimeSpan.StartDate, DateTimeSpan.EndDate, Geometry.Point.Latitude, Geometry.Point.Longitude, Source", "content": {"application/json-patch+json": {"schema": {"$ref": "#/components/schemas/RadiationInput"}, "example": {"source": "nldas", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": null}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": {"latitude": 33.925673, "longitude": -83.355723}, "geometryMetadata": null, "timezone": null}, "dataValueFormat": null, "temporalResolution": null, "timeLocalized": false, "units": null, "outputFormat": null, "baseURL": null, "inputTimeSeries": null}}, "application/json": {"schema": {"$ref": "#/components/schemas/RadiationInput"}, "example": {"source": "nldas", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": null}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": {"latitude": 33.925673, "longitude": -83.355723}, "geometryMetadata": null, "timezone": null}, "dataValueFormat": null, "temporalResolution": null, "timeLocalized": false, "units": null, "outputFormat": null, "baseURL": null, "inputTimeSeries": null}}, "text/json": {"schema": {"$ref": "#/components/schemas/RadiationInput"}, "example": {"source": "nldas", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": null}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": {"latitude": 33.925673, "longitude": -83.355723}, "geometryMetadata": null, "timezone": null}, "dataValueFormat": null, "temporalResolution": null, "timeLocalized": false, "units": null, "outputFormat": null, "baseURL": null, "inputTimeSeries": null}}, "application/*+json": {"schema": {"$ref": "#/components/schemas/RadiationInput"}, "example": {"source": "nldas", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": null}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": {"latitude": 33.925673, "longitude": -83.355723}, "geometryMetadata": null, "timezone": null}, "dataValueFormat": null, "temporalResolution": null, "timeLocalized": false, "units": null, "outputFormat": null, "baseURL": null, "inputTimeSeries": null}}}}, "responses": {"200": {"description": "OK"}}}}, "/api/hydrology/soilmoisture": {"post": {"tags": ["WSSoilMoisture"], "summary": "POST method for submitting a request for soil moisture data.", "requestBody": {"description": "Parameters for retrieving SoilMoisture data. Required fields: DateTimeSpan.StartDate, DateTimeSpan.EndDate, Geometry.Point.Latitude, Geometry.Point.Longitude, Source", "content": {"application/json-patch+json": {"schema": {"$ref": "#/components/schemas/SoilMoistureInput"}, "example": {"layers": ["0-10", "10-40"], "source": "nldas", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": null}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": {"latitude": 33.925673, "longitude": -83.355723}, "geometryMetadata": null, "timezone": null}, "dataValueFormat": null, "temporalResolution": null, "timeLocalized": false, "units": null, "outputFormat": null, "baseURL": null, "inputTimeSeries": null}}, "application/json": {"schema": {"$ref": "#/components/schemas/SoilMoistureInput"}, "example": {"layers": ["0-10", "10-40"], "source": "nldas", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": null}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": {"latitude": 33.925673, "longitude": -83.355723}, "geometryMetadata": null, "timezone": null}, "dataValueFormat": null, "temporalResolution": null, "timeLocalized": false, "units": null, "outputFormat": null, "baseURL": null, "inputTimeSeries": null}}, "text/json": {"schema": {"$ref": "#/components/schemas/SoilMoistureInput"}, "example": {"layers": ["0-10", "10-40"], "source": "nldas", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": null}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": {"latitude": 33.925673, "longitude": -83.355723}, "geometryMetadata": null, "timezone": null}, "dataValueFormat": null, "temporalResolution": null, "timeLocalized": false, "units": null, "outputFormat": null, "baseURL": null, "inputTimeSeries": null}}, "application/*+json": {"schema": {"$ref": "#/components/schemas/SoilMoistureInput"}, "example": {"layers": ["0-10", "10-40"], "source": "nldas", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": null}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": {"latitude": 33.925673, "longitude": -83.355723}, "geometryMetadata": null, "timezone": null}, "dataValueFormat": null, "temporalResolution": null, "timeLocalized": false, "units": null, "outputFormat": null, "baseURL": null, "inputTimeSeries": null}}}}, "responses": {"200": {"description": "OK"}}}}, "/api/water-quality/solar/run": {"get": {"tags": ["WSSolar"], "summary": "GET request for retrieving the default output values for the GCSolar module, \r\nthis is equivalent to selecting the third option from the start menu of the desktop application.", "responses": {"200": {"description": "OK"}}}, "post": {"tags": ["WSSolar"], "summary": "POST request for retrieving solar data using custom values from the GCSolar module,\r\nthis is equivalent to selecting the second option from the start menu of the desktop application.", "requestBody": {"description": "", "content": {"application/json-patch+json": {"schema": {"$ref": "#/components/schemas/SolarInput"}, "example": {"input": {"contaminant name": "Methoxyclor", "contaminant type": "Chemical", "water type name": "Pure Water", "min wavelength": 297.5, "max wavelength": 330, "longitude": "83.2", "latitude(s)": [40, -99, -99, -99, -99, -99, -99, -99, -99, -99], "season(s)": ["Spring", " ", " ", " "], "atmospheric ozone layer": 0.3, "initial depth (cm)": "0.001", "final depth (cm)": "5", "depth increment (cm)": "10", "quantum yield": "0.32", "refractive index": "1.34", "elevation": "0", "wavelength table": {"297.50": {"water attenuation coefficients (m**-1)": "0.069000", "chemical absorption coefficients (L/(mole cm))": "11.100000"}, "300.00": {"water attenuation coefficients (m**-1)": "0.061000", "chemical absorption coefficients (L/(mole cm))": "4.6700000"}, "302.50": {"water attenuation coefficients (m**-1)": "0.057000", "chemical absorption coefficients (L/(mole cm))": "1.900000"}, "305.00": {"water attenuation coefficients (m**-1)": "0.053000", "chemical absorption coefficients (L/(mole cm))": "1.100000"}, "307.50": {"water attenuation coefficients (m**-1)": "0.049000", "chemical absorption coefficients (L/(mole cm))": "0.800000"}, "310.00": {"water attenuation coefficients (m**-1)": "0.045000", "chemical absorption coefficients (L/(mole cm))": "0.5300000"}, "312.50": {"water attenuation coefficients (m**-1)": "0.043000", "chemical absorption coefficients (L/(mole cm))": "0.330000"}, "315.00": {"water attenuation coefficients (m**-1)": "0.041000", "chemical absorption coefficients (L/(mole cm))": "0.270000"}, "317.50": {"water attenuation coefficients (m**-1)": "0.039000", "chemical absorption coefficients (L/(mole cm))": "0.1600000"}, "320.00": {"water attenuation coefficients (m**-1)": "0.037000", "chemical absorption coefficients (L/(mole cm))": "0.100000"}, "323.10": {"water attenuation coefficients (m**-1)": "0.035000", "chemical absorption coefficients (L/(mole cm))": "0.060000"}, "330.00": {"water attenuation coefficients (m**-1)": "0.029000", "chemical absorption coefficients (L/(mole cm))": "0.020000"}}}}}, "application/json": {"schema": {"$ref": "#/components/schemas/SolarInput"}, "example": {"input": {"contaminant name": "Methoxyclor", "contaminant type": "Chemical", "water type name": "Pure Water", "min wavelength": 297.5, "max wavelength": 330, "longitude": "83.2", "latitude(s)": [40, -99, -99, -99, -99, -99, -99, -99, -99, -99], "season(s)": ["Spring", " ", " ", " "], "atmospheric ozone layer": 0.3, "initial depth (cm)": "0.001", "final depth (cm)": "5", "depth increment (cm)": "10", "quantum yield": "0.32", "refractive index": "1.34", "elevation": "0", "wavelength table": {"297.50": {"water attenuation coefficients (m**-1)": "0.069000", "chemical absorption coefficients (L/(mole cm))": "11.100000"}, "300.00": {"water attenuation coefficients (m**-1)": "0.061000", "chemical absorption coefficients (L/(mole cm))": "4.6700000"}, "302.50": {"water attenuation coefficients (m**-1)": "0.057000", "chemical absorption coefficients (L/(mole cm))": "1.900000"}, "305.00": {"water attenuation coefficients (m**-1)": "0.053000", "chemical absorption coefficients (L/(mole cm))": "1.100000"}, "307.50": {"water attenuation coefficients (m**-1)": "0.049000", "chemical absorption coefficients (L/(mole cm))": "0.800000"}, "310.00": {"water attenuation coefficients (m**-1)": "0.045000", "chemical absorption coefficients (L/(mole cm))": "0.5300000"}, "312.50": {"water attenuation coefficients (m**-1)": "0.043000", "chemical absorption coefficients (L/(mole cm))": "0.330000"}, "315.00": {"water attenuation coefficients (m**-1)": "0.041000", "chemical absorption coefficients (L/(mole cm))": "0.270000"}, "317.50": {"water attenuation coefficients (m**-1)": "0.039000", "chemical absorption coefficients (L/(mole cm))": "0.1600000"}, "320.00": {"water attenuation coefficients (m**-1)": "0.037000", "chemical absorption coefficients (L/(mole cm))": "0.100000"}, "323.10": {"water attenuation coefficients (m**-1)": "0.035000", "chemical absorption coefficients (L/(mole cm))": "0.060000"}, "330.00": {"water attenuation coefficients (m**-1)": "0.029000", "chemical absorption coefficients (L/(mole cm))": "0.020000"}}}}}, "text/json": {"schema": {"$ref": "#/components/schemas/SolarInput"}, "example": {"input": {"contaminant name": "Methoxyclor", "contaminant type": "Chemical", "water type name": "Pure Water", "min wavelength": 297.5, "max wavelength": 330, "longitude": "83.2", "latitude(s)": [40, -99, -99, -99, -99, -99, -99, -99, -99, -99], "season(s)": ["Spring", " ", " ", " "], "atmospheric ozone layer": 0.3, "initial depth (cm)": "0.001", "final depth (cm)": "5", "depth increment (cm)": "10", "quantum yield": "0.32", "refractive index": "1.34", "elevation": "0", "wavelength table": {"297.50": {"water attenuation coefficients (m**-1)": "0.069000", "chemical absorption coefficients (L/(mole cm))": "11.100000"}, "300.00": {"water attenuation coefficients (m**-1)": "0.061000", "chemical absorption coefficients (L/(mole cm))": "4.6700000"}, "302.50": {"water attenuation coefficients (m**-1)": "0.057000", "chemical absorption coefficients (L/(mole cm))": "1.900000"}, "305.00": {"water attenuation coefficients (m**-1)": "0.053000", "chemical absorption coefficients (L/(mole cm))": "1.100000"}, "307.50": {"water attenuation coefficients (m**-1)": "0.049000", "chemical absorption coefficients (L/(mole cm))": "0.800000"}, "310.00": {"water attenuation coefficients (m**-1)": "0.045000", "chemical absorption coefficients (L/(mole cm))": "0.5300000"}, "312.50": {"water attenuation coefficients (m**-1)": "0.043000", "chemical absorption coefficients (L/(mole cm))": "0.330000"}, "315.00": {"water attenuation coefficients (m**-1)": "0.041000", "chemical absorption coefficients (L/(mole cm))": "0.270000"}, "317.50": {"water attenuation coefficients (m**-1)": "0.039000", "chemical absorption coefficients (L/(mole cm))": "0.1600000"}, "320.00": {"water attenuation coefficients (m**-1)": "0.037000", "chemical absorption coefficients (L/(mole cm))": "0.100000"}, "323.10": {"water attenuation coefficients (m**-1)": "0.035000", "chemical absorption coefficients (L/(mole cm))": "0.060000"}, "330.00": {"water attenuation coefficients (m**-1)": "0.029000", "chemical absorption coefficients (L/(mole cm))": "0.020000"}}}}}, "application/*+json": {"schema": {"$ref": "#/components/schemas/SolarInput"}, "example": {"input": {"contaminant name": "Methoxyclor", "contaminant type": "Chemical", "water type name": "Pure Water", "min wavelength": 297.5, "max wavelength": 330, "longitude": "83.2", "latitude(s)": [40, -99, -99, -99, -99, -99, -99, -99, -99, -99], "season(s)": ["Spring", " ", " ", " "], "atmospheric ozone layer": 0.3, "initial depth (cm)": "0.001", "final depth (cm)": "5", "depth increment (cm)": "10", "quantum yield": "0.32", "refractive index": "1.34", "elevation": "0", "wavelength table": {"297.50": {"water attenuation coefficients (m**-1)": "0.069000", "chemical absorption coefficients (L/(mole cm))": "11.100000"}, "300.00": {"water attenuation coefficients (m**-1)": "0.061000", "chemical absorption coefficients (L/(mole cm))": "4.6700000"}, "302.50": {"water attenuation coefficients (m**-1)": "0.057000", "chemical absorption coefficients (L/(mole cm))": "1.900000"}, "305.00": {"water attenuation coefficients (m**-1)": "0.053000", "chemical absorption coefficients (L/(mole cm))": "1.100000"}, "307.50": {"water attenuation coefficients (m**-1)": "0.049000", "chemical absorption coefficients (L/(mole cm))": "0.800000"}, "310.00": {"water attenuation coefficients (m**-1)": "0.045000", "chemical absorption coefficients (L/(mole cm))": "0.5300000"}, "312.50": {"water attenuation coefficients (m**-1)": "0.043000", "chemical absorption coefficients (L/(mole cm))": "0.330000"}, "315.00": {"water attenuation coefficients (m**-1)": "0.041000", "chemical absorption coefficients (L/(mole cm))": "0.270000"}, "317.50": {"water attenuation coefficients (m**-1)": "0.039000", "chemical absorption coefficients (L/(mole cm))": "0.1600000"}, "320.00": {"water attenuation coefficients (m**-1)": "0.037000", "chemical absorption coefficients (L/(mole cm))": "0.100000"}, "323.10": {"water attenuation coefficients (m**-1)": "0.035000", "chemical absorption coefficients (L/(mole cm))": "0.060000"}, "330.00": {"water attenuation coefficients (m**-1)": "0.029000", "chemical absorption coefficients (L/(mole cm))": "0.020000"}}}}}}}, "responses": {"200": {"description": "OK"}}}}, "/api/water-quality/solar/inputs": {"get": {"tags": ["WSSolar"], "summary": "GET request for retrieving the default input values for the GCSolar module,\r\nthis is equivalent to selecting the first option from the start menu of the desktop application.", "responses": {"200": {"description": "OK"}}}}, "/api/water-quality/solar/inputs/metadata": {"get": {"tags": ["WSSolar"], "summary": "GET request for metadata on the inputs for the GCSolar module.", "responses": {"200": {"description": "OK"}}}}, "/api/info/streamnetwork": {"get": {"tags": ["WSStream"], "summary": "", "parameters": [{"name": "comid", "in": "query", "schema": {"type": "string"}}, {"name": "endComid", "in": "query", "schema": {"type": "string"}}, {"name": "maxDistance", "in": "query", "schema": {"type": "number", "format": "double", "default": 15}}, {"name": "mainstem", "in": "query", "schema": {"type": "string", "default": "false"}}, {"name": "huc", "in": "query", "schema": {"type": "string"}}], "responses": {"200": {"description": "OK"}}}}, "/api/hydrology/streamflow": {"post": {"tags": ["WSStreamflow"], "summary": "POST method for submitting a request for precipitation data.", "requestBody": {"description": "Parameters for retrieving streamflow data. Required fields: DateTimeSpan.StartDate, DateTimeSpan.EndDate, Geometry.GeometryMetadata.gaugestation, Source", "content": {"application/json-patch+json": {"schema": {"$ref": "#/components/schemas/StreamflowInput"}, "example": {"source": "nwis", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "12/31/2015 00:00:00", "dateTimeFormat": "yyyy-MM-dd HH"}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": null, "geometryMetadata": {"gaugestation": "02191300"}, "timezone": null}, "dataValueFormat": "E3", "temporalResolution": "hourly", "timeLocalized": false, "units": "metric", "outputFormat": "json", "baseURL": null, "inputTimeSeries": null}}, "application/json": {"schema": {"$ref": "#/components/schemas/StreamflowInput"}, "example": {"source": "nwis", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "12/31/2015 00:00:00", "dateTimeFormat": "yyyy-MM-dd HH"}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": null, "geometryMetadata": {"gaugestation": "02191300"}, "timezone": null}, "dataValueFormat": "E3", "temporalResolution": "hourly", "timeLocalized": false, "units": "metric", "outputFormat": "json", "baseURL": null, "inputTimeSeries": null}}, "text/json": {"schema": {"$ref": "#/components/schemas/StreamflowInput"}, "example": {"source": "nwis", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "12/31/2015 00:00:00", "dateTimeFormat": "yyyy-MM-dd HH"}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": null, "geometryMetadata": {"gaugestation": "02191300"}, "timezone": null}, "dataValueFormat": "E3", "temporalResolution": "hourly", "timeLocalized": false, "units": "metric", "outputFormat": "json", "baseURL": null, "inputTimeSeries": null}}, "application/*+json": {"schema": {"$ref": "#/components/schemas/StreamflowInput"}, "example": {"source": "nwis", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "12/31/2015 00:00:00", "dateTimeFormat": "yyyy-MM-dd HH"}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": null, "geometryMetadata": {"gaugestation": "02191300"}, "timezone": null}, "dataValueFormat": "E3", "temporalResolution": "hourly", "timeLocalized": false, "units": "metric", "outputFormat": "json", "baseURL": null, "inputTimeSeries": null}}}}, "responses": {"200": {"description": "OK"}}}}, "/api/hydrology/subsurfaceflow": {"post": {"tags": ["WSSubSurfaceFlow"], "summary": "POST method for submitting a request for subsurface flow data.", "requestBody": {"description": "Parameters for retrieving SubSurfaceFlow data. Required fields: DateTimeSpan.StartDate, DateTimeSpan.EndDate, Geometry.Point.Latitude, Geometry.Point.Longitude, Source", "content": {"application/json-patch+json": {"schema": {"$ref": "#/components/schemas/SubSurfaceFlowInput"}, "example": {"source": "nldas", "precipSource": null, "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": null}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": {"latitude": 33.925673, "longitude": -83.355723}, "geometryMetadata": null, "timezone": null}, "dataValueFormat": null, "temporalResolution": null, "timeLocalized": false, "units": null, "outputFormat": null, "baseURL": null, "inputTimeSeries": null}}, "application/json": {"schema": {"$ref": "#/components/schemas/SubSurfaceFlowInput"}, "example": {"source": "nldas", "precipSource": null, "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": null}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": {"latitude": 33.925673, "longitude": -83.355723}, "geometryMetadata": null, "timezone": null}, "dataValueFormat": null, "temporalResolution": null, "timeLocalized": false, "units": null, "outputFormat": null, "baseURL": null, "inputTimeSeries": null}}, "text/json": {"schema": {"$ref": "#/components/schemas/SubSurfaceFlowInput"}, "example": {"source": "nldas", "precipSource": null, "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": null}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": {"latitude": 33.925673, "longitude": -83.355723}, "geometryMetadata": null, "timezone": null}, "dataValueFormat": null, "temporalResolution": null, "timeLocalized": false, "units": null, "outputFormat": null, "baseURL": null, "inputTimeSeries": null}}, "application/*+json": {"schema": {"$ref": "#/components/schemas/SubSurfaceFlowInput"}, "example": {"source": "nldas", "precipSource": null, "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": null}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": {"latitude": 33.925673, "longitude": -83.355723}, "geometryMetadata": null, "timezone": null}, "dataValueFormat": null, "temporalResolution": null, "timeLocalized": false, "units": null, "outputFormat": null, "baseURL": null, "inputTimeSeries": null}}}}, "responses": {"200": {"description": "OK"}}}}, "/api/hydrology/surfacerunoff": {"post": {"tags": ["WSSurfaceRunoff"], "summary": "POST method for submitting a request for surface runoff data.", "requestBody": {"description": "Parameters for retrieving SurfaceRunoff data. Required fields: DateTimeSpan.StartDate, DateTimeSpan.EndDate, Geometry.Point.Latitude, Geometry.Point.Longitude, Source", "content": {"application/json-patch+json": {"schema": {"$ref": "#/components/schemas/SurfaceRunoffInput"}, "example": {"source": "nldas", "precipSource": null, "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": null}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": {"latitude": 33.925673, "longitude": -83.355723}, "geometryMetadata": null, "timezone": null}, "dataValueFormat": null, "temporalResolution": null, "timeLocalized": false, "units": null, "outputFormat": null, "baseURL": null, "inputTimeSeries": null}}, "application/json": {"schema": {"$ref": "#/components/schemas/SurfaceRunoffInput"}, "example": {"source": "nldas", "precipSource": null, "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": null}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": {"latitude": 33.925673, "longitude": -83.355723}, "geometryMetadata": null, "timezone": null}, "dataValueFormat": null, "temporalResolution": null, "timeLocalized": false, "units": null, "outputFormat": null, "baseURL": null, "inputTimeSeries": null}}, "text/json": {"schema": {"$ref": "#/components/schemas/SurfaceRunoffInput"}, "example": {"source": "nldas", "precipSource": null, "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": null}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": {"latitude": 33.925673, "longitude": -83.355723}, "geometryMetadata": null, "timezone": null}, "dataValueFormat": null, "temporalResolution": null, "timeLocalized": false, "units": null, "outputFormat": null, "baseURL": null, "inputTimeSeries": null}}, "application/*+json": {"schema": {"$ref": "#/components/schemas/SurfaceRunoffInput"}, "example": {"source": "nldas", "precipSource": null, "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": null}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": {"latitude": 33.925673, "longitude": -83.355723}, "geometryMetadata": null, "timezone": null}, "dataValueFormat": null, "temporalResolution": null, "timeLocalized": false, "units": null, "outputFormat": null, "baseURL": null, "inputTimeSeries": null}}}}, "responses": {"200": {"description": "OK"}}}}, "/api/hydrology/temperature": {"post": {"tags": ["WSTemperature"], "summary": "POST method for submitting a request for evapotranspiration data.", "requestBody": {"description": "Parameters for retrieving evapotranspiration data. Required fields: DateTimeSpan.StartDate, DateTimeSpan.EndDate, Geometry.Point.Latitude, Geometry.Point.Longitude, Source", "content": {"application/json-patch+json": {"schema": {"$ref": "#/components/schemas/TemperatureInput"}, "example": {"source": "nldas", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": null}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": {"latitude": 33.925673, "longitude": -83.355723}, "geometryMetadata": null, "timezone": null}, "dataValueFormat": null, "temporalResolution": null, "timeLocalized": false, "units": null, "outputFormat": null, "baseURL": null, "inputTimeSeries": null}}, "application/json": {"schema": {"$ref": "#/components/schemas/TemperatureInput"}, "example": {"source": "nldas", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": null}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": {"latitude": 33.925673, "longitude": -83.355723}, "geometryMetadata": null, "timezone": null}, "dataValueFormat": null, "temporalResolution": null, "timeLocalized": false, "units": null, "outputFormat": null, "baseURL": null, "inputTimeSeries": null}}, "text/json": {"schema": {"$ref": "#/components/schemas/TemperatureInput"}, "example": {"source": "nldas", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": null}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": {"latitude": 33.925673, "longitude": -83.355723}, "geometryMetadata": null, "timezone": null}, "dataValueFormat": null, "temporalResolution": null, "timeLocalized": false, "units": null, "outputFormat": null, "baseURL": null, "inputTimeSeries": null}}, "application/*+json": {"schema": {"$ref": "#/components/schemas/TemperatureInput"}, "example": {"source": "nldas", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": null}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": {"latitude": 33.925673, "longitude": -83.355723}, "geometryMetadata": null, "timezone": null}, "dataValueFormat": null, "temporalResolution": null, "timeLocalized": false, "units": null, "outputFormat": null, "baseURL": null, "inputTimeSeries": null}}}}, "responses": {"200": {"description": "OK"}}}}, "/api/hydrology/totalflow": {"post": {"tags": ["WSTotalFlow"], "summary": "POST method for submitting a request for total flow data.", "requestBody": {"description": "", "content": {"application/json-patch+json": {"schema": {"$ref": "#/components/schemas/TotalFlowInput"}, "example": {"geometryType": "comid", "geometryInput": "1049831", "geometryInputs": null, "source": "nldas", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "12/31/2015 00:00:00", "dateTimeFormat": null}, "geometry": null, "dataValueFormat": null, "temporalResolution": null, "timeLocalized": false, "units": null, "outputFormat": null, "baseURL": null, "inputTimeSeries": null}}, "application/json": {"schema": {"$ref": "#/components/schemas/TotalFlowInput"}, "example": {"geometryType": "comid", "geometryInput": "1049831", "geometryInputs": null, "source": "nldas", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "12/31/2015 00:00:00", "dateTimeFormat": null}, "geometry": null, "dataValueFormat": null, "temporalResolution": null, "timeLocalized": false, "units": null, "outputFormat": null, "baseURL": null, "inputTimeSeries": null}}, "text/json": {"schema": {"$ref": "#/components/schemas/TotalFlowInput"}, "example": {"geometryType": "comid", "geometryInput": "1049831", "geometryInputs": null, "source": "nldas", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "12/31/2015 00:00:00", "dateTimeFormat": null}, "geometry": null, "dataValueFormat": null, "temporalResolution": null, "timeLocalized": false, "units": null, "outputFormat": null, "baseURL": null, "inputTimeSeries": null}}, "application/*+json": {"schema": {"$ref": "#/components/schemas/TotalFlowInput"}, "example": {"geometryType": "comid", "geometryInput": "1049831", "geometryInputs": null, "source": "nldas", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "12/31/2015 00:00:00", "dateTimeFormat": null}, "geometry": null, "dataValueFormat": null, "temporalResolution": null, "timeLocalized": false, "units": null, "outputFormat": null, "baseURL": null, "inputTimeSeries": null}}}}, "responses": {"200": {"description": "OK"}}}}, "/api/utilities/status": {"get": {"tags": ["WSUtilities"], "summary": "Checks endpoints for all datasets.", "responses": {"200": {"description": "OK"}}}}, "/api/workflow/timeoftravel": {"post": {"tags": ["WSWatershedDelineation"], "summary": "POST method for submitting a request for delineation compare data.\r\nSource parameter must contain a value, but value is not used.", "requestBody": {"description": "Parameters for retrieving DelineationCompare data. Required fields: Dataset, SourceList", "content": {"application/json-patch+json": {"schema": {"$ref": "#/components/schemas/WatershedDelineationInput"}, "example": {"contaminantInflow": null, "inflowSource": "National Water Model", "source": null, "dateTimeSpan": null, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": null, "geometryMetadata": {"startCOMID": "6277141", "endCOMID": "6275977"}, "timezone": null}, "dataValueFormat": "E3", "temporalResolution": "default", "timeLocalized": true, "units": "default", "outputFormat": "json", "baseURL": null, "inputTimeSeries": null}}, "application/json": {"schema": {"$ref": "#/components/schemas/WatershedDelineationInput"}, "example": {"contaminantInflow": null, "inflowSource": "National Water Model", "source": null, "dateTimeSpan": null, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": null, "geometryMetadata": {"startCOMID": "6277141", "endCOMID": "6275977"}, "timezone": null}, "dataValueFormat": "E3", "temporalResolution": "default", "timeLocalized": true, "units": "default", "outputFormat": "json", "baseURL": null, "inputTimeSeries": null}}, "text/json": {"schema": {"$ref": "#/components/schemas/WatershedDelineationInput"}, "example": {"contaminantInflow": null, "inflowSource": "National Water Model", "source": null, "dateTimeSpan": null, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": null, "geometryMetadata": {"startCOMID": "6277141", "endCOMID": "6275977"}, "timezone": null}, "dataValueFormat": "E3", "temporalResolution": "default", "timeLocalized": true, "units": "default", "outputFormat": "json", "baseURL": null, "inputTimeSeries": null}}, "application/*+json": {"schema": {"$ref": "#/components/schemas/WatershedDelineationInput"}, "example": {"contaminantInflow": null, "inflowSource": "National Water Model", "source": null, "dateTimeSpan": null, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": null, "geometryMetadata": {"startCOMID": "6277141", "endCOMID": "6275977"}, "timezone": null}, "dataValueFormat": "E3", "temporalResolution": "default", "timeLocalized": true, "units": "default", "outputFormat": "json", "baseURL": null, "inputTimeSeries": null}}}}, "responses": {"200": {"description": "OK"}}}}, "/api/workflow/watershed": {"post": {"tags": ["WSWatershedWorkflow"], "summary": "POST method for submitting a request for getting workflow compare data.\r\nSource parameter must contain a value, but value is not used.", "requestBody": {"description": "Parameters for retrieving WorkFlowCompare data. Required fields: Dataset, SourceList", "content": {"application/json-patch+json": {"schema": {"$ref": "#/components/schemas/WatershedWorkflowInput"}, "example": {"runoffSource": "curvenumber", "streamHydrology": "constant", "aggregation": false, "source": "streamflow", "dateTimeSpan": {"startDate": "07/01/2014 00:00:00", "endDate": "07/31/2014 00:00:00", "dateTimeFormat": "yyyy-MM-dd HH"}, "geometry": {"description": null, "comID": 0, "hucID": "030502040102", "stationID": null, "point": null, "geometryMetadata": {"precipSource": "daymet"}, "timezone": null}, "dataValueFormat": "E3", "temporalResolution": "default", "timeLocalized": true, "units": "default", "outputFormat": "json", "baseURL": null, "inputTimeSeries": null}}, "application/json": {"schema": {"$ref": "#/components/schemas/WatershedWorkflowInput"}, "example": {"runoffSource": "curvenumber", "streamHydrology": "constant", "aggregation": false, "source": "streamflow", "dateTimeSpan": {"startDate": "07/01/2014 00:00:00", "endDate": "07/31/2014 00:00:00", "dateTimeFormat": "yyyy-MM-dd HH"}, "geometry": {"description": null, "comID": 0, "hucID": "030502040102", "stationID": null, "point": null, "geometryMetadata": {"precipSource": "daymet"}, "timezone": null}, "dataValueFormat": "E3", "temporalResolution": "default", "timeLocalized": true, "units": "default", "outputFormat": "json", "baseURL": null, "inputTimeSeries": null}}, "text/json": {"schema": {"$ref": "#/components/schemas/WatershedWorkflowInput"}, "example": {"runoffSource": "curvenumber", "streamHydrology": "constant", "aggregation": false, "source": "streamflow", "dateTimeSpan": {"startDate": "07/01/2014 00:00:00", "endDate": "07/31/2014 00:00:00", "dateTimeFormat": "yyyy-MM-dd HH"}, "geometry": {"description": null, "comID": 0, "hucID": "030502040102", "stationID": null, "point": null, "geometryMetadata": {"precipSource": "daymet"}, "timezone": null}, "dataValueFormat": "E3", "temporalResolution": "default", "timeLocalized": true, "units": "default", "outputFormat": "json", "baseURL": null, "inputTimeSeries": null}}, "application/*+json": {"schema": {"$ref": "#/components/schemas/WatershedWorkflowInput"}, "example": {"runoffSource": "curvenumber", "streamHydrology": "constant", "aggregation": false, "source": "streamflow", "dateTimeSpan": {"startDate": "07/01/2014 00:00:00", "endDate": "07/31/2014 00:00:00", "dateTimeFormat": "yyyy-MM-dd HH"}, "geometry": {"description": null, "comID": 0, "hucID": "030502040102", "stationID": null, "point": null, "geometryMetadata": {"precipSource": "daymet"}, "timezone": null}, "dataValueFormat": "E3", "temporalResolution": "default", "timeLocalized": true, "units": "default", "outputFormat": "json", "baseURL": null, "inputTimeSeries": null}}}}, "responses": {"200": {"description": "OK"}}}}, "/api/meteorology/wind": {"post": {"tags": ["WSWind"], "summary": "POST method for submitting a request for wind data.", "requestBody": {"description": "Parameters for retrieving wind data. Required fields: DateTimeSpan.StartDate, DateTimeSpan.EndDate, Geometry.Point.Latitude, Geometry.Point.Longitude, Source", "content": {"application/json-patch+json": {"schema": {"$ref": "#/components/schemas/WindInput"}, "example": {"component": "all", "source": "nldas", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": null}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": {"latitude": 33.925673, "longitude": -83.355723}, "geometryMetadata": null, "timezone": null}, "dataValueFormat": null, "temporalResolution": null, "timeLocalized": false, "units": null, "outputFormat": null, "baseURL": null, "inputTimeSeries": null}}, "application/json": {"schema": {"$ref": "#/components/schemas/WindInput"}, "example": {"component": "all", "source": "nldas", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": null}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": {"latitude": 33.925673, "longitude": -83.355723}, "geometryMetadata": null, "timezone": null}, "dataValueFormat": null, "temporalResolution": null, "timeLocalized": false, "units": null, "outputFormat": null, "baseURL": null, "inputTimeSeries": null}}, "text/json": {"schema": {"$ref": "#/components/schemas/WindInput"}, "example": {"component": "all", "source": "nldas", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": null}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": {"latitude": 33.925673, "longitude": -83.355723}, "geometryMetadata": null, "timezone": null}, "dataValueFormat": null, "temporalResolution": null, "timeLocalized": false, "units": null, "outputFormat": null, "baseURL": null, "inputTimeSeries": null}}, "application/*+json": {"schema": {"$ref": "#/components/schemas/WindInput"}, "example": {"component": "all", "source": "nldas", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": null}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": null, "point": {"latitude": 33.925673, "longitude": -83.355723}, "geometryMetadata": null, "timezone": null}, "dataValueFormat": null, "temporalResolution": null, "timeLocalized": false, "units": null, "outputFormat": null, "baseURL": null, "inputTimeSeries": null}}}}, "responses": {"200": {"description": "OK"}}}}, "/api/workflow/precip_compare": {"post": {"tags": ["WSWorkflowPrecip"], "summary": "POST method for submitting a request for precip comparison data.\r\nSource parameter must contain a value, but value is not used.", "requestBody": {"content": {"application/json-patch+json": {"schema": {"$ref": "#/components/schemas/PrecipitationCompareInput"}, "example": {"dataset": "Precipitation", "sourceList": ["nldas", "gldas"], "weighted": true, "extremeDaily": 0.0, "extremeTotal": 0.0, "source": "compare", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": "yyyy-MM-dd HH"}, "geometry": {"description": null, "comID": 1053791, "hucID": null, "stationID": null, "point": null, "geometryMetadata": null, "timezone": null}, "dataValueFormat": "E3", "temporalResolution": "default", "timeLocalized": false, "units": "metric", "outputFormat": "json", "baseURL": null, "inputTimeSeries": null}}, "application/json": {"schema": {"$ref": "#/components/schemas/PrecipitationCompareInput"}, "example": {"dataset": "Precipitation", "sourceList": ["nldas", "gldas"], "weighted": true, "extremeDaily": 0.0, "extremeTotal": 0.0, "source": "compare", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": "yyyy-MM-dd HH"}, "geometry": {"description": null, "comID": 1053791, "hucID": null, "stationID": null, "point": null, "geometryMetadata": null, "timezone": null}, "dataValueFormat": "E3", "temporalResolution": "default", "timeLocalized": false, "units": "metric", "outputFormat": "json", "baseURL": null, "inputTimeSeries": null}}, "text/json": {"schema": {"$ref": "#/components/schemas/PrecipitationCompareInput"}, "example": {"dataset": "Precipitation", "sourceList": ["nldas", "gldas"], "weighted": true, "extremeDaily": 0.0, "extremeTotal": 0.0, "source": "compare", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": "yyyy-MM-dd HH"}, "geometry": {"description": null, "comID": 1053791, "hucID": null, "stationID": null, "point": null, "geometryMetadata": null, "timezone": null}, "dataValueFormat": "E3", "temporalResolution": "default", "timeLocalized": false, "units": "metric", "outputFormat": "json", "baseURL": null, "inputTimeSeries": null}}, "application/*+json": {"schema": {"$ref": "#/components/schemas/PrecipitationCompareInput"}, "example": {"dataset": "Precipitation", "sourceList": ["nldas", "gldas"], "weighted": true, "extremeDaily": 0.0, "extremeTotal": 0.0, "source": "compare", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": "yyyy-MM-dd HH"}, "geometry": {"description": null, "comID": 1053791, "hucID": null, "stationID": null, "point": null, "geometryMetadata": null, "timezone": null}, "dataValueFormat": "E3", "temporalResolution": "default", "timeLocalized": false, "units": "metric", "outputFormat": "json", "baseURL": null, "inputTimeSeries": null}}}}, "responses": {"200": {"description": "OK"}}}}, "/api/workflow/precip_data_extraction": {"post": {"tags": ["WSWorkflowPrecip"], "summary": "POST method for submitting a request for precip extraction data.\r\nSource parameter must contain a value, but value is not used.", "requestBody": {"content": {"application/json-patch+json": {"schema": {"$ref": "#/components/schemas/PrecipitationExtractionInput"}, "example": {"dataset": "Precipitation", "sourceList": ["ncei", "nldas"], "source": "extraction", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": "yyyy-MM-dd HH"}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": "GHCND:USW00013874", "point": null, "geometryMetadata": null, "timezone": null}, "dataValueFormat": "E3", "temporalResolution": "default", "timeLocalized": false, "units": "metric", "outputFormat": "json", "baseURL": null, "inputTimeSeries": null}}, "application/json": {"schema": {"$ref": "#/components/schemas/PrecipitationExtractionInput"}, "example": {"dataset": "Precipitation", "sourceList": ["ncei", "nldas"], "source": "extraction", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": "yyyy-MM-dd HH"}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": "GHCND:USW00013874", "point": null, "geometryMetadata": null, "timezone": null}, "dataValueFormat": "E3", "temporalResolution": "default", "timeLocalized": false, "units": "metric", "outputFormat": "json", "baseURL": null, "inputTimeSeries": null}}, "text/json": {"schema": {"$ref": "#/components/schemas/PrecipitationExtractionInput"}, "example": {"dataset": "Precipitation", "sourceList": ["ncei", "nldas"], "source": "extraction", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": "yyyy-MM-dd HH"}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": "GHCND:USW00013874", "point": null, "geometryMetadata": null, "timezone": null}, "dataValueFormat": "E3", "temporalResolution": "default", "timeLocalized": false, "units": "metric", "outputFormat": "json", "baseURL": null, "inputTimeSeries": null}}, "application/*+json": {"schema": {"$ref": "#/components/schemas/PrecipitationExtractionInput"}, "example": {"dataset": "Precipitation", "sourceList": ["ncei", "nldas"], "source": "extraction", "dateTimeSpan": {"startDate": "01/01/2015 00:00:00", "endDate": "01/08/2015 00:00:00", "dateTimeFormat": "yyyy-MM-dd HH"}, "geometry": {"description": null, "comID": 0, "hucID": null, "stationID": "GHCND:USW00013874", "point": null, "geometryMetadata": null, "timezone": null}, "dataValueFormat": "E3", "temporalResolution": "default", "timeLocalized": false, "units": "metric", "outputFormat": "json", "baseURL": null, "inputTimeSeries": null}}}}, "responses": {"200": {"description": "OK"}}}}, "/api/workflow/waterquality": {"post": {"tags": ["WSWorkflowWaterQuality"], "summary": "POST method to submit a request for water quality data.\r\ndataSource can be 'nldas' or 'ncei', which will pull data from GHCND:US1NCCM0006", "requestBody": {"description": "", "content": {"application/json-patch+json": {"schema": {"$ref": "#/components/schemas/WaterQualityInput"}, "example": {"taskID": null, "dataSource": "nldas", "minNitrate": 1000, "maxNitrate": 10000, "minAmmonia": 100000, "maxAmmonia": 750000}}, "application/json": {"schema": {"$ref": "#/components/schemas/WaterQualityInput"}, "example": {"taskID": null, "dataSource": "nldas", "minNitrate": 1000, "maxNitrate": 10000, "minAmmonia": 100000, "maxAmmonia": 750000}}, "text/json": {"schema": {"$ref": "#/components/schemas/WaterQualityInput"}, "example": {"taskID": null, "dataSource": "nldas", "minNitrate": 1000, "maxNitrate": 10000, "minAmmonia": 100000, "maxAmmonia": 750000}}, "application/*+json": {"schema": {"$ref": "#/components/schemas/WaterQualityInput"}, "example": {"taskID": null, "dataSource": "nldas", "minNitrate": 1000, "maxNitrate": 10000, "minAmmonia": 100000, "maxAmmonia": 750000}}}}, "responses": {"200": {"description": "OK"}}}}}, "components": {"schemas": {"ContaminantLoaderInput": {"type": "object", "properties": {"contaminantType": {"type": "string", "nullable": true}, "contaminantInputType": {"type": "string", "nullable": true}, "contaminantInput": {"type": "string", "nullable": true}}, "additionalProperties": false, "description": "ContaminantLoader Input that implements TimeSeriesInput object"}, "DateTimeSpan": {"type": "object", "properties": {"startDate": {"type": "string", "description": "Description: The start date for the requested time-series.;\r\nDefault: None;\r\nOptions: None;\r\nRequired: True;", "format": "date-time"}, "endDate": {"type": "string", "description": "Description: The end date for the requested time-series.;\r\nDefault: None;\r\nOptions: None;\r\nRequired: True;", "format": "date-time"}, "dateTimeFormat": {"type": "string", "description": "Description: Format for the output of DateTime values.;\r\nDefault: \"yyyy-MM-dd HH;\r\nOptions: https://msdn.microsoft.com/en-us/library/8kb3ddd4(v=vs.110).aspx;\r\nRequired: False;", "nullable": true}}, "additionalProperties": false, "description": "DateTimeSpan object for specifying the temporal timespan of the returned timeseries data."}, "DewPointInput": {"required": ["dateTimeSpan", "geometry"], "type": "object", "properties": {"dateTimeSpan": {"$ref": "#/components/schemas/DateTimeSpan"}, "geometry": {"$ref": "#/components/schemas/TimeSeriesGeometry"}, "dataValueFormat": {"type": "string", "description": "Description: Specifies the output format for the data values in the timeseries;\r\nDefault: \"E3\";\r\nOptions: https://msdn.microsoft.com/en-us/library/kfsatb94(v=vs.110).aspx ;\r\nRequired: False;", "nullable": true}, "temporalResolution": {"type": "string", "description": "Description: The temporal resolution of the time series to be returned. Valid options dependent on the dataset and source of the timeseries.;\r\nDefault: \"default\";\r\nOptions: [\"default\", \"hourly\", \"3hourly\", \"daily\", \"monthly\"];\r\nRequired: False;", "nullable": true}, "timeLocalized": {"type": "boolean", "description": "Description: Indicates if the timezone of the geometry is used for the date/time values of the returned timeseries.;\r\nDefault: True;\r\nOptions: [True, False];\r\nRequired: False;"}, "units": {"type": "string", "description": "Description: Unit system of the output values.;\r\nDefault: \"metric\";\r\nOptions: [\"metric\", \"imperial\"];\r\nRequired: False;", "nullable": true}, "outputFormat": {"type": "string", "description": "Description: Specifies output format type.;\r\nDefault: \"json\";\r\nOptions: \"json\";\r\nRequired: False;", "nullable": true}, "baseURL": {"type": "array", "items": {"type": "string"}, "description": "Internal: Holds base url for data retrieval depending on the specified source and dataset.", "nullable": true}, "inputTimeSeries": {"type": "object", "additionalProperties": {"$ref": "#/components/schemas/TimeSeriesOutput"}, "description": "Description: A dictionary for utilizing an ITimeSeriesOutput as an input variable, where the key is a provided identifier of the ITimeSeriesOutput.;\r\nDefault: None;\r\nOptions: None;\r\nRequired: False;", "nullable": true}, "source": {"type": "string", "description": "Description: DewPoint data source;\r\nDefault: \"prism\";\r\nOptions: [\"prism\"];\r\nRequired: True;", "nullable": true}}, "additionalProperties": false, "description": "Label: Dew Point\r\nDescription: Dew Point Input that implements TimeSeriesInput object;"}, "EvapotranspirationInput": {"required": ["dateTimeSpan", "geometry", "source"], "type": "object", "properties": {"source": {"minLength": 1, "type": "string", "description": "Description: Time-series data source;\r\nDefault: \"nldas\";\r\nOptions: [\"nldas\", \"gldas\", \"ncei\", \"daymet\", \"prism\", \"trmm\", \"nwm\", \"nwis\"];\r\nRequired: True;"}, "dateTimeSpan": {"$ref": "#/components/schemas/DateTimeSpan"}, "geometry": {"$ref": "#/components/schemas/TimeSeriesGeometry"}, "dataValueFormat": {"type": "string", "description": "Description: Specifies the output format for the data values in the timeseries;\r\nDefault: \"E3\";\r\nOptions: https://msdn.microsoft.com/en-us/library/kfsatb94(v=vs.110).aspx ;\r\nRequired: False;", "nullable": true}, "temporalResolution": {"type": "string", "description": "Description: The temporal resolution of the time series to be returned. Valid options dependent on the dataset and source of the timeseries.;\r\nDefault: \"default\";\r\nOptions: [\"default\", \"hourly\", \"3hourly\", \"daily\", \"monthly\"];\r\nRequired: False;", "nullable": true}, "timeLocalized": {"type": "boolean", "description": "Description: Indicates if the timezone of the geometry is used for the date/time values of the returned timeseries.;\r\nDefault: True;\r\nOptions: [True, False];\r\nRequired: False;"}, "units": {"type": "string", "description": "Description: Unit system of the output values.;\r\nDefault: \"metric\";\r\nOptions: [\"metric\", \"imperial\"];\r\nRequired: False;", "nullable": true}, "outputFormat": {"type": "string", "description": "Description: Specifies output format type.;\r\nDefault: \"json\";\r\nOptions: \"json\";\r\nRequired: False;", "nullable": true}, "baseURL": {"type": "array", "items": {"type": "string"}, "description": "Internal: Holds base url for data retrieval depending on the specified source and dataset.", "nullable": true}, "inputTimeSeries": {"type": "object", "additionalProperties": {"$ref": "#/components/schemas/TimeSeriesOutput"}, "description": "Description: A dictionary for utilizing an ITimeSeriesOutput as an input variable, where the key is a provided identifier of the ITimeSeriesOutput.;\r\nDefault: None;\r\nOptions: None;\r\nRequired: False;", "nullable": true}, "algorithm": {"type": "string", "description": "REQUIRED: Algorithm used for Evapotranspiration.", "nullable": true}, "albedo": {"type": "number", "description": "REQUIRED: Albedo coefficient.", "format": "double"}, "centralLongitude": {"type": "number", "description": "REQUIRED: Central Longitude of Time Zone in degrees.", "format": "double"}, "sunAngle": {"type": "number", "description": "REQUIRED: Angle of the sun in degrees.", "format": "double"}, "emissivity": {"type": "number", "description": "REQUIRED: The ability of a surface to emit radiant energy.", "format": "double"}, "model": {"type": "string", "description": "REQUIRED: Specifies if potential, actual, or wet environment evaporation are used.", "nullable": true}, "zenith": {"type": "number", "description": "REQUIRED: Zenith Albedo coefficient.", "format": "double"}, "lakeSurfaceArea": {"type": "number", "description": "REQUIRED: Surface area of lake in square kilometers.", "format": "double"}, "lakeDepth": {"type": "number", "description": "REQUIRED: Average depth of lake in meters.", "format": "double"}, "subsurfaceResistance": {"type": "number", "description": "REQUIRED: Subsurface Resistance.", "format": "double"}, "stomatalResistance": {"type": "number", "description": "REQUIRED: Stomatal Resistance.", "format": "double"}, "leafWidth": {"type": "number", "description": "REQUIRED: Leaf Width in meters.", "format": "double"}, "roughnessLength": {"type": "number", "description": "REQUIRED: Roughness Length in meters.", "format": "double"}, "vegetationHeight": {"type": "number", "description": "REQUIRED: Vegetation Height in meters.", "format": "double"}, "leafAreaIndices": {"type": "object", "additionalProperties": {}, "description": "REQUIRED: Monthly leaf area indices.", "nullable": true}, "airTemperature": {"type": "object", "additionalProperties": {}, "description": "REQUIRED: Monthly air temperature coefficients.", "nullable": true}, "userData": {"type": "string", "description": "OPTIONAL: Data file provided by the user.", "nullable": true}}, "additionalProperties": false, "description": "Evapotranspiration Input that implements TimeSeriesInput object"}, "HumidityInput": {"required": ["dateTimeSpan", "geometry"], "type": "object", "properties": {"dateTimeSpan": {"$ref": "#/components/schemas/DateTimeSpan"}, "geometry": {"$ref": "#/components/schemas/TimeSeriesGeometry"}, "dataValueFormat": {"type": "string", "description": "Description: Specifies the output format for the data values in the timeseries;\r\nDefault: \"E3\";\r\nOptions: https://msdn.microsoft.com/en-us/library/kfsatb94(v=vs.110).aspx ;\r\nRequired: False;", "nullable": true}, "temporalResolution": {"type": "string", "description": "Description: The temporal resolution of the time series to be returned. Valid options dependent on the dataset and source of the timeseries.;\r\nDefault: \"default\";\r\nOptions: [\"default\", \"hourly\", \"3hourly\", \"daily\", \"monthly\"];\r\nRequired: False;", "nullable": true}, "timeLocalized": {"type": "boolean", "description": "Description: Indicates if the timezone of the geometry is used for the date/time values of the returned timeseries.;\r\nDefault: True;\r\nOptions: [True, False];\r\nRequired: False;"}, "units": {"type": "string", "description": "Description: Unit system of the output values.;\r\nDefault: \"metric\";\r\nOptions: [\"metric\", \"imperial\"];\r\nRequired: False;", "nullable": true}, "outputFormat": {"type": "string", "description": "Description: Specifies output format type.;\r\nDefault: \"json\";\r\nOptions: \"json\";\r\nRequired: False;", "nullable": true}, "baseURL": {"type": "array", "items": {"type": "string"}, "description": "Internal: Holds base url for data retrieval depending on the specified source and dataset.", "nullable": true}, "inputTimeSeries": {"type": "object", "additionalProperties": {"$ref": "#/components/schemas/TimeSeriesOutput"}, "description": "Description: A dictionary for utilizing an ITimeSeriesOutput as an input variable, where the key is a provided identifier of the ITimeSeriesOutput.;\r\nDefault: None;\r\nOptions: None;\r\nRequired: False;", "nullable": true}, "relative": {"type": "boolean", "description": "Description: Relative or Specific Humidity. Only relative humidity implemented.;\r\nDefault: True;\r\nOptions: True;\r\nRequired: True;"}, "source": {"type": "string", "description": "Description: Humidity data source;\r\nDefault: \"prism\";\r\nOptions: [\"prism\"];\r\nRequired: True;", "nullable": true}}, "additionalProperties": false, "description": "Label: Humidity;\r\nDescription: Humidity input;"}, "LoadingsInput": {"type": "object", "properties": {"flags": {"type": "object", "additionalProperties": {"type": "boolean"}, "nullable": true}, "loadings": {"type": "array", "items": {"$ref": "#/components/schemas/LoadingsObject"}, "nullable": true}}, "additionalProperties": false}, "LoadingsObject": {"type": "object", "properties": {"param": {"type": "string", "nullable": true}, "loadingType": {"type": "integer", "format": "int32"}, "useConstant": {"type": "boolean"}, "constant": {"type": "number", "format": "double"}, "timeSeries": {"type": "object", "additionalProperties": {"type": "number", "format": "double"}, "nullable": true}, "multiplier": {"type": "number", "format": "double"}, "metadata": {"type": "object", "additionalProperties": {"type": "string", "nullable": true}, "nullable": true}}, "additionalProperties": false}, "PointCoordinate": {"type": "object", "properties": {"latitude": {"type": "number", "description": "Description: Latitude value of point geometry.;\r\nDefault: None;\r\nOptions: [-90.0,90.0];\r\nRequired: False;", "format": "double"}, "longitude": {"type": "number", "description": "Description: Longitude value of point geometry.;\r\nDefault: None;\r\nOptions: [-180.0, 180.0];\r\nRequired: False;", "format": "double"}}, "additionalProperties": false, "description": "Point geometry object for specifying a point geospatial area of interest."}, "PrecipitationCompareInput": {"required": ["dataset", "dateTimeSpan", "geometry", "source", "sourceList", "weighted"], "type": "object", "properties": {"source": {"minLength": 1, "type": "string", "description": "Description: Time-series data source;\r\nDefault: \"nldas\";\r\nOptions: [\"nldas\", \"gldas\", \"ncei\", \"daymet\", \"prism\", \"trmm\", \"nwm\", \"nwis\"];\r\nRequired: True;"}, "dateTimeSpan": {"$ref": "#/components/schemas/DateTimeSpan"}, "geometry": {"$ref": "#/components/schemas/TimeSeriesGeometry"}, "dataValueFormat": {"type": "string", "description": "Description: Specifies the output format for the data values in the timeseries;\r\nDefault: \"E3\";\r\nOptions: https://msdn.microsoft.com/en-us/library/kfsatb94(v=vs.110).aspx ;\r\nRequired: False;", "nullable": true}, "temporalResolution": {"type": "string", "description": "Description: The temporal resolution of the time series to be returned. Valid options dependent on the dataset and source of the timeseries.;\r\nDefault: \"default\";\r\nOptions: [\"default\", \"hourly\", \"3hourly\", \"daily\", \"monthly\"];\r\nRequired: False;", "nullable": true}, "timeLocalized": {"type": "boolean", "description": "Description: Indicates if the timezone of the geometry is used for the date/time values of the returned timeseries.;\r\nDefault: True;\r\nOptions: [True, False];\r\nRequired: False;"}, "units": {"type": "string", "description": "Description: Unit system of the output values.;\r\nDefault: \"metric\";\r\nOptions: [\"metric\", \"imperial\"];\r\nRequired: False;", "nullable": true}, "outputFormat": {"type": "string", "description": "Description: Specifies output format type.;\r\nDefault: \"json\";\r\nOptions: \"json\";\r\nRequired: False;", "nullable": true}, "baseURL": {"type": "array", "items": {"type": "string"}, "description": "Internal: Holds base url for data retrieval depending on the specified source and dataset.", "nullable": true}, "inputTimeSeries": {"type": "object", "additionalProperties": {"$ref": "#/components/schemas/TimeSeriesOutput"}, "description": "Description: A dictionary for utilizing an ITimeSeriesOutput as an input variable, where the key is a provided identifier of the ITimeSeriesOutput.;\r\nDefault: None;\r\nOptions: None;\r\nRequired: False;", "nullable": true}, "dataset": {"minLength": 1, "type": "string", "description": "Specified dataset for the workflow"}, "sourceList": {"type": "array", "items": {"type": "string"}, "description": "List of sources for the workflow."}, "weighted": {"type": "boolean", "description": "States whether or not precip should be aggregated by grid cells (weighted spatial average)."}, "extremeDaily": {"type": "number", "description": "Daily precip threshold in mm.", "format": "double"}, "extremeTotal": {"type": "number", "description": "Five day total precip threshold in mm.", "format": "double"}}, "additionalProperties": false, "description": "PrecipitationCompare Input that implements TimeSeriesInput object."}, "PrecipitationExtractionInput": {"required": ["dateTimeSpan", "geometry", "source"], "type": "object", "properties": {"source": {"minLength": 1, "type": "string", "description": "Description: Time-series data source;\r\nDefault: \"nldas\";\r\nOptions: [\"nldas\", \"gldas\", \"ncei\", \"daymet\", \"prism\", \"trmm\", \"nwm\", \"nwis\"];\r\nRequired: True;"}, "dateTimeSpan": {"$ref": "#/components/schemas/DateTimeSpan"}, "geometry": {"$ref": "#/components/schemas/TimeSeriesGeometry"}, "dataValueFormat": {"type": "string", "description": "Description: Specifies the output format for the data values in the timeseries;\r\nDefault: \"E3\";\r\nOptions: https://msdn.microsoft.com/en-us/library/kfsatb94(v=vs.110).aspx ;\r\nRequired: False;", "nullable": true}, "temporalResolution": {"type": "string", "description": "Description: The temporal resolution of the time series to be returned. Valid options dependent on the dataset and source of the timeseries.;\r\nDefault: \"default\";\r\nOptions: [\"default\", \"hourly\", \"3hourly\", \"daily\", \"monthly\"];\r\nRequired: False;", "nullable": true}, "timeLocalized": {"type": "boolean", "description": "Description: Indicates if the timezone of the geometry is used for the date/time values of the returned timeseries.;\r\nDefault: True;\r\nOptions: [True, False];\r\nRequired: False;"}, "units": {"type": "string", "description": "Description: Unit system of the output values.;\r\nDefault: \"metric\";\r\nOptions: [\"metric\", \"imperial\"];\r\nRequired: False;", "nullable": true}, "outputFormat": {"type": "string", "description": "Description: Specifies output format type.;\r\nDefault: \"json\";\r\nOptions: \"json\";\r\nRequired: False;", "nullable": true}, "baseURL": {"type": "array", "items": {"type": "string"}, "description": "Internal: Holds base url for data retrieval depending on the specified source and dataset.", "nullable": true}, "inputTimeSeries": {"type": "object", "additionalProperties": {"$ref": "#/components/schemas/TimeSeriesOutput"}, "description": "Description: A dictionary for utilizing an ITimeSeriesOutput as an input variable, where the key is a provided identifier of the ITimeSeriesOutput.;\r\nDefault: None;\r\nOptions: None;\r\nRequired: False;", "nullable": true}, "dataset": {"type": "string", "description": "Specified dataset for the workflow", "nullable": true}, "sourceList": {"type": "array", "items": {"type": "string"}, "description": "List of sources for the workflow.", "nullable": true}}, "additionalProperties": false, "description": "PrecipitationExtraction Input that implements TimeSeriesInput object."}, "PrecipitationInput": {"required": ["dateTimeSpan", "geometry"], "type": "object", "properties": {"dateTimeSpan": {"$ref": "#/components/schemas/DateTimeSpan"}, "geometry": {"$ref": "#/components/schemas/TimeSeriesGeometry"}, "dataValueFormat": {"type": "string", "description": "Description: Specifies the output format for the data values in the timeseries;\r\nDefault: \"E3\";\r\nOptions: https://msdn.microsoft.com/en-us/library/kfsatb94(v=vs.110).aspx ;\r\nRequired: False;", "nullable": true}, "temporalResolution": {"type": "string", "description": "Description: The temporal resolution of the time series to be returned. Valid options dependent on the dataset and source of the timeseries.;\r\nDefault: \"default\";\r\nOptions: [\"default\", \"hourly\", \"3hourly\", \"daily\", \"monthly\"];\r\nRequired: False;", "nullable": true}, "timeLocalized": {"type": "boolean", "description": "Description: Indicates if the timezone of the geometry is used for the date/time values of the returned timeseries.;\r\nDefault: True;\r\nOptions: [True, False];\r\nRequired: False;"}, "units": {"type": "string", "description": "Description: Unit system of the output values.;\r\nDefault: \"metric\";\r\nOptions: [\"metric\", \"imperial\"];\r\nRequired: False;", "nullable": true}, "outputFormat": {"type": "string", "description": "Description: Specifies output format type.;\r\nDefault: \"json\";\r\nOptions: \"json\";\r\nRequired: False;", "nullable": true}, "baseURL": {"type": "array", "items": {"type": "string"}, "description": "Internal: Holds base url for data retrieval depending on the specified source and dataset.", "nullable": true}, "inputTimeSeries": {"type": "object", "additionalProperties": {"$ref": "#/components/schemas/TimeSeriesOutput"}, "description": "Description: A dictionary for utilizing an ITimeSeriesOutput as an input variable, where the key is a provided identifier of the ITimeSeriesOutput.;\r\nDefault: None;\r\nOptions: None;\r\nRequired: False;", "nullable": true}, "source": {"type": "string", "description": "Description: Precipitation data source;\r\nDefault: \"nldas\";\r\nOptions: [\"nldas\", \"gldas\", \"ncei\", \"daymet\", \"prism\", \"trmm\"];\r\nRequired: True;", "nullable": true}}, "additionalProperties": false, "description": "Label: Precipitation;\r\nDescription: Precipitation Input that implements TimeSeriesInput object.;"}, "PressureInput": {"required": ["dateTimeSpan", "geometry"], "type": "object", "properties": {"dateTimeSpan": {"$ref": "#/components/schemas/DateTimeSpan"}, "geometry": {"$ref": "#/components/schemas/TimeSeriesGeometry"}, "dataValueFormat": {"type": "string", "description": "Description: Specifies the output format for the data values in the timeseries;\r\nDefault: \"E3\";\r\nOptions: https://msdn.microsoft.com/en-us/library/kfsatb94(v=vs.110).aspx ;\r\nRequired: False;", "nullable": true}, "temporalResolution": {"type": "string", "description": "Description: The temporal resolution of the time series to be returned. Valid options dependent on the dataset and source of the timeseries.;\r\nDefault: \"default\";\r\nOptions: [\"default\", \"hourly\", \"3hourly\", \"daily\", \"monthly\"];\r\nRequired: False;", "nullable": true}, "timeLocalized": {"type": "boolean", "description": "Description: Indicates if the timezone of the geometry is used for the date/time values of the returned timeseries.;\r\nDefault: True;\r\nOptions: [True, False];\r\nRequired: False;"}, "units": {"type": "string", "description": "Description: Unit system of the output values.;\r\nDefault: \"metric\";\r\nOptions: [\"metric\", \"imperial\"];\r\nRequired: False;", "nullable": true}, "outputFormat": {"type": "string", "description": "Description: Specifies output format type.;\r\nDefault: \"json\";\r\nOptions: \"json\";\r\nRequired: False;", "nullable": true}, "baseURL": {"type": "array", "items": {"type": "string"}, "description": "Internal: Holds base url for data retrieval depending on the specified source and dataset.", "nullable": true}, "inputTimeSeries": {"type": "object", "additionalProperties": {"$ref": "#/components/schemas/TimeSeriesOutput"}, "description": "Description: A dictionary for utilizing an ITimeSeriesOutput as an input variable, where the key is a provided identifier of the ITimeSeriesOutput.;\r\nDefault: None;\r\nOptions: None;\r\nRequired: False;", "nullable": true}, "source": {"type": "string", "description": "Description: Pressue data source;\r\nDefault: \"gldas\";\r\nOptions: [\"gldas\"];\r\nRequired: True;", "nullable": true}}, "additionalProperties": false, "description": "Label: Pressue\r\nDescription: Surface air pressure input that implements TimeSeriesInput object"}, "RadiationInput": {"required": ["dateTimeSpan", "geometry"], "type": "object", "properties": {"dateTimeSpan": {"$ref": "#/components/schemas/DateTimeSpan"}, "geometry": {"$ref": "#/components/schemas/TimeSeriesGeometry"}, "dataValueFormat": {"type": "string", "description": "Description: Specifies the output format for the data values in the timeseries;\r\nDefault: \"E3\";\r\nOptions: https://msdn.microsoft.com/en-us/library/kfsatb94(v=vs.110).aspx ;\r\nRequired: False;", "nullable": true}, "temporalResolution": {"type": "string", "description": "Description: The temporal resolution of the time series to be returned. Valid options dependent on the dataset and source of the timeseries.;\r\nDefault: \"default\";\r\nOptions: [\"default\", \"hourly\", \"3hourly\", \"daily\", \"monthly\"];\r\nRequired: False;", "nullable": true}, "timeLocalized": {"type": "boolean", "description": "Description: Indicates if the timezone of the geometry is used for the date/time values of the returned timeseries.;\r\nDefault: True;\r\nOptions: [True, False];\r\nRequired: False;"}, "units": {"type": "string", "description": "Description: Unit system of the output values.;\r\nDefault: \"metric\";\r\nOptions: [\"metric\", \"imperial\"];\r\nRequired: False;", "nullable": true}, "outputFormat": {"type": "string", "description": "Description: Specifies output format type.;\r\nDefault: \"json\";\r\nOptions: \"json\";\r\nRequired: False;", "nullable": true}, "baseURL": {"type": "array", "items": {"type": "string"}, "description": "Internal: Holds base url for data retrieval depending on the specified source and dataset.", "nullable": true}, "inputTimeSeries": {"type": "object", "additionalProperties": {"$ref": "#/components/schemas/TimeSeriesOutput"}, "description": "Description: A dictionary for utilizing an ITimeSeriesOutput as an input variable, where the key is a provided identifier of the ITimeSeriesOutput.;\r\nDefault: None;\r\nOptions: None;\r\nRequired: False;", "nullable": true}, "source": {"type": "string", "description": "Description: Radiation data source;\r\nDefault: \"nldas\";\r\nOptions: [\"nldas\", \"gldas\", \"daymet\"];\r\nRequired: True;", "nullable": true}}, "additionalProperties": false, "description": "Label: Solar Radiation;\r\nDescription: High and short wave radiation that reaches the ground."}, "SoilMoistureInput": {"required": ["dateTimeSpan", "geometry"], "type": "object", "properties": {"dateTimeSpan": {"$ref": "#/components/schemas/DateTimeSpan"}, "geometry": {"$ref": "#/components/schemas/TimeSeriesGeometry"}, "dataValueFormat": {"type": "string", "description": "Description: Specifies the output format for the data values in the timeseries;\r\nDefault: \"E3\";\r\nOptions: https://msdn.microsoft.com/en-us/library/kfsatb94(v=vs.110).aspx ;\r\nRequired: False;", "nullable": true}, "temporalResolution": {"type": "string", "description": "Description: The temporal resolution of the time series to be returned. Valid options dependent on the dataset and source of the timeseries.;\r\nDefault: \"default\";\r\nOptions: [\"default\", \"hourly\", \"3hourly\", \"daily\", \"monthly\"];\r\nRequired: False;", "nullable": true}, "timeLocalized": {"type": "boolean", "description": "Description: Indicates if the timezone of the geometry is used for the date/time values of the returned timeseries.;\r\nDefault: True;\r\nOptions: [True, False];\r\nRequired: False;"}, "units": {"type": "string", "description": "Description: Unit system of the output values.;\r\nDefault: \"metric\";\r\nOptions: [\"metric\", \"imperial\"];\r\nRequired: False;", "nullable": true}, "outputFormat": {"type": "string", "description": "Description: Specifies output format type.;\r\nDefault: \"json\";\r\nOptions: \"json\";\r\nRequired: False;", "nullable": true}, "baseURL": {"type": "array", "items": {"type": "string"}, "description": "Internal: Holds base url for data retrieval depending on the specified source and dataset.", "nullable": true}, "inputTimeSeries": {"type": "object", "additionalProperties": {"$ref": "#/components/schemas/TimeSeriesOutput"}, "description": "Description: A dictionary for utilizing an ITimeSeriesOutput as an input variable, where the key is a provided identifier of the ITimeSeriesOutput.;\r\nDefault: None;\r\nOptions: None;\r\nRequired: False;", "nullable": true}, "layers": {"type": "array", "items": {"type": "string"}, "description": "Description: List of requested soil moisture layers;\r\nDefault: None;\r\nOptions: [\"0-10\", \"10-40\", \"40-100\", \"100-200\", \"0-100\", \"0-200\"];\r\nRequired: True;", "nullable": true}, "source": {"type": "string", "description": "Description: Soil moisture data source;\r\nDefault: \"nldas\";\r\nOptions: [\"nldas\", \"gldas\"];\r\nRequired: True;", "nullable": true}}, "additionalProperties": false, "description": "Label: Soil Moiture;\r\nDescription: Soil moisture content for specified layer depths;"}, "SolarCalculatorInput": {"required": ["dateTimeSpan", "geometry", "source"], "type": "object", "properties": {"source": {"minLength": 1, "type": "string", "description": "Description: Time-series data source;\r\nDefault: \"nldas\";\r\nOptions: [\"nldas\", \"gldas\", \"ncei\", \"daymet\", \"prism\", \"trmm\", \"nwm\", \"nwis\"];\r\nRequired: True;"}, "dateTimeSpan": {"$ref": "#/components/schemas/DateTimeSpan"}, "geometry": {"$ref": "#/components/schemas/TimeSeriesGeometry"}, "dataValueFormat": {"type": "string", "description": "Description: Specifies the output format for the data values in the timeseries;\r\nDefault: \"E3\";\r\nOptions: https://msdn.microsoft.com/en-us/library/kfsatb94(v=vs.110).aspx ;\r\nRequired: False;", "nullable": true}, "temporalResolution": {"type": "string", "description": "Description: The temporal resolution of the time series to be returned. Valid options dependent on the dataset and source of the timeseries.;\r\nDefault: \"default\";\r\nOptions: [\"default\", \"hourly\", \"3hourly\", \"daily\", \"monthly\"];\r\nRequired: False;", "nullable": true}, "timeLocalized": {"type": "boolean", "description": "Description: Indicates if the timezone of the geometry is used for the date/time values of the returned timeseries.;\r\nDefault: True;\r\nOptions: [True, False];\r\nRequired: False;"}, "units": {"type": "string", "description": "Description: Unit system of the output values.;\r\nDefault: \"metric\";\r\nOptions: [\"metric\", \"imperial\"];\r\nRequired: False;", "nullable": true}, "outputFormat": {"type": "string", "description": "Description: Specifies output format type.;\r\nDefault: \"json\";\r\nOptions: \"json\";\r\nRequired: False;", "nullable": true}, "baseURL": {"type": "array", "items": {"type": "string"}, "description": "Internal: Holds base url for data retrieval depending on the specified source and dataset.", "nullable": true}, "inputTimeSeries": {"type": "object", "additionalProperties": {"$ref": "#/components/schemas/TimeSeriesOutput"}, "description": "Description: A dictionary for utilizing an ITimeSeriesOutput as an input variable, where the key is a provided identifier of the ITimeSeriesOutput.;\r\nDefault: None;\r\nOptions: None;\r\nRequired: False;", "nullable": true}, "model": {"type": "string", "description": "Calculator model: 'Day' or 'Year'", "nullable": true}, "localTime": {"type": "string", "description": "Calculation localtime for when model='year', default='12:00:00'", "nullable": true}}, "additionalProperties": false, "description": "Solar Calculator Input object"}, "SolarInput": {"type": "object", "properties": {"input": {"type": "object", "additionalProperties": {"nullable": true}, "description": "Input Dictionary, containing unknown values.", "nullable": true}}, "additionalProperties": false, "description": "Solar Data input object"}, "StreamflowInput": {"required": ["dateTimeSpan", "geometry", "source"], "type": "object", "properties": {"source": {"minLength": 1, "type": "string", "description": "Description: Time-series data source;\r\nDefault: \"nldas\";\r\nOptions: [\"nldas\", \"gldas\", \"ncei\", \"daymet\", \"prism\", \"trmm\", \"nwm\", \"nwis\"];\r\nRequired: True;"}, "dateTimeSpan": {"$ref": "#/components/schemas/DateTimeSpan"}, "geometry": {"$ref": "#/components/schemas/TimeSeriesGeometry"}, "dataValueFormat": {"type": "string", "description": "Description: Specifies the output format for the data values in the timeseries;\r\nDefault: \"E3\";\r\nOptions: https://msdn.microsoft.com/en-us/library/kfsatb94(v=vs.110).aspx ;\r\nRequired: False;", "nullable": true}, "temporalResolution": {"type": "string", "description": "Description: The temporal resolution of the time series to be returned. Valid options dependent on the dataset and source of the timeseries.;\r\nDefault: \"default\";\r\nOptions: [\"default\", \"hourly\", \"3hourly\", \"daily\", \"monthly\"];\r\nRequired: False;", "nullable": true}, "timeLocalized": {"type": "boolean", "description": "Description: Indicates if the timezone of the geometry is used for the date/time values of the returned timeseries.;\r\nDefault: True;\r\nOptions: [True, False];\r\nRequired: False;"}, "units": {"type": "string", "description": "Description: Unit system of the output values.;\r\nDefault: \"metric\";\r\nOptions: [\"metric\", \"imperial\"];\r\nRequired: False;", "nullable": true}, "outputFormat": {"type": "string", "description": "Description: Specifies output format type.;\r\nDefault: \"json\";\r\nOptions: \"json\";\r\nRequired: False;", "nullable": true}, "baseURL": {"type": "array", "items": {"type": "string"}, "description": "Internal: Holds base url for data retrieval depending on the specified source and dataset.", "nullable": true}, "inputTimeSeries": {"type": "object", "additionalProperties": {"$ref": "#/components/schemas/TimeSeriesOutput"}, "description": "Description: A dictionary for utilizing an ITimeSeriesOutput as an input variable, where the key is a provided identifier of the ITimeSeriesOutput.;\r\nDefault: None;\r\nOptions: None;\r\nRequired: False;", "nullable": true}}, "additionalProperties": false, "description": "Streamflow Input that implements TimeSeriesInput object."}, "SubSurfaceFlowInput": {"required": ["dateTimeSpan", "geometry"], "type": "object", "properties": {"dateTimeSpan": {"$ref": "#/components/schemas/DateTimeSpan"}, "geometry": {"$ref": "#/components/schemas/TimeSeriesGeometry"}, "dataValueFormat": {"type": "string", "description": "Description: Specifies the output format for the data values in the timeseries;\r\nDefault: \"E3\";\r\nOptions: https://msdn.microsoft.com/en-us/library/kfsatb94(v=vs.110).aspx ;\r\nRequired: False;", "nullable": true}, "temporalResolution": {"type": "string", "description": "Description: The temporal resolution of the time series to be returned. Valid options dependent on the dataset and source of the timeseries.;\r\nDefault: \"default\";\r\nOptions: [\"default\", \"hourly\", \"3hourly\", \"daily\", \"monthly\"];\r\nRequired: False;", "nullable": true}, "timeLocalized": {"type": "boolean", "description": "Description: Indicates if the timezone of the geometry is used for the date/time values of the returned timeseries.;\r\nDefault: True;\r\nOptions: [True, False];\r\nRequired: False;"}, "units": {"type": "string", "description": "Description: Unit system of the output values.;\r\nDefault: \"metric\";\r\nOptions: [\"metric\", \"imperial\"];\r\nRequired: False;", "nullable": true}, "outputFormat": {"type": "string", "description": "Description: Specifies output format type.;\r\nDefault: \"json\";\r\nOptions: \"json\";\r\nRequired: False;", "nullable": true}, "baseURL": {"type": "array", "items": {"type": "string"}, "description": "Internal: Holds base url for data retrieval depending on the specified source and dataset.", "nullable": true}, "inputTimeSeries": {"type": "object", "additionalProperties": {"$ref": "#/components/schemas/TimeSeriesOutput"}, "description": "Description: A dictionary for utilizing an ITimeSeriesOutput as an input variable, where the key is a provided identifier of the ITimeSeriesOutput.;\r\nDefault: None;\r\nOptions: None;\r\nRequired: False;", "nullable": true}, "source": {"type": "string", "description": "Description: Subsurface flow data source;\r\nDefault: \"nldas\";\r\nOptions: [\"nldas\", \"gldas\", \"curvenumber\"];\r\nRequired: True;", "nullable": true}, "precipSource": {"type": "string", "description": "Description: Precipitation data source for Curve Number.;\r\nDefault: \"nldas\";\r\nOptions: [\"nldas\", \"gldas\", \"ncei\", \"daymet\", \"prism\", \"trmm\"];\r\nRequired: False;", "nullable": true}}, "additionalProperties": false, "description": "Label: Sub-Surface Flow;\r\nDescription: Sub-surface water flow (baseflow).;"}, "SurfaceRunoffInput": {"required": ["dateTimeSpan", "geometry"], "type": "object", "properties": {"dateTimeSpan": {"$ref": "#/components/schemas/DateTimeSpan"}, "geometry": {"$ref": "#/components/schemas/TimeSeriesGeometry"}, "dataValueFormat": {"type": "string", "description": "Description: Specifies the output format for the data values in the timeseries;\r\nDefault: \"E3\";\r\nOptions: https://msdn.microsoft.com/en-us/library/kfsatb94(v=vs.110).aspx ;\r\nRequired: False;", "nullable": true}, "temporalResolution": {"type": "string", "description": "Description: The temporal resolution of the time series to be returned. Valid options dependent on the dataset and source of the timeseries.;\r\nDefault: \"default\";\r\nOptions: [\"default\", \"hourly\", \"3hourly\", \"daily\", \"monthly\"];\r\nRequired: False;", "nullable": true}, "timeLocalized": {"type": "boolean", "description": "Description: Indicates if the timezone of the geometry is used for the date/time values of the returned timeseries.;\r\nDefault: True;\r\nOptions: [True, False];\r\nRequired: False;"}, "units": {"type": "string", "description": "Description: Unit system of the output values.;\r\nDefault: \"metric\";\r\nOptions: [\"metric\", \"imperial\"];\r\nRequired: False;", "nullable": true}, "outputFormat": {"type": "string", "description": "Description: Specifies output format type.;\r\nDefault: \"json\";\r\nOptions: \"json\";\r\nRequired: False;", "nullable": true}, "baseURL": {"type": "array", "items": {"type": "string"}, "description": "Internal: Holds base url for data retrieval depending on the specified source and dataset.", "nullable": true}, "inputTimeSeries": {"type": "object", "additionalProperties": {"$ref": "#/components/schemas/TimeSeriesOutput"}, "description": "Description: A dictionary for utilizing an ITimeSeriesOutput as an input variable, where the key is a provided identifier of the ITimeSeriesOutput.;\r\nDefault: None;\r\nOptions: None;\r\nRequired: False;", "nullable": true}, "source": {"type": "string", "description": "Description: Surface runoff data source;\r\nDefault: \"nldas\";\r\nOptions: [\"nldas\", \"gldas\", \"curvenumber\"];\r\nRequired: True;", "nullable": true}, "precipSource": {"type": "string", "description": "Description: Precipitation data source for Curve Number.;\r\nDefault: \"nldas\";\r\nOptions: [\"nldas\", \"gldas\", \"ncei\", \"daymet\", \"prism\", \"trmm\"];\r\nRequired: False;", "nullable": true}}, "additionalProperties": false, "description": "Label: Surface Runoff;\r\nDescription: Surface rainfall runoff.;"}, "TemperatureInput": {"required": ["dateTimeSpan", "geometry"], "type": "object", "properties": {"dateTimeSpan": {"$ref": "#/components/schemas/DateTimeSpan"}, "geometry": {"$ref": "#/components/schemas/TimeSeriesGeometry"}, "dataValueFormat": {"type": "string", "description": "Description: Specifies the output format for the data values in the timeseries;\r\nDefault: \"E3\";\r\nOptions: https://msdn.microsoft.com/en-us/library/kfsatb94(v=vs.110).aspx ;\r\nRequired: False;", "nullable": true}, "temporalResolution": {"type": "string", "description": "Description: The temporal resolution of the time series to be returned. Valid options dependent on the dataset and source of the timeseries.;\r\nDefault: \"default\";\r\nOptions: [\"default\", \"hourly\", \"3hourly\", \"daily\", \"monthly\"];\r\nRequired: False;", "nullable": true}, "timeLocalized": {"type": "boolean", "description": "Description: Indicates if the timezone of the geometry is used for the date/time values of the returned timeseries.;\r\nDefault: True;\r\nOptions: [True, False];\r\nRequired: False;"}, "units": {"type": "string", "description": "Description: Unit system of the output values.;\r\nDefault: \"metric\";\r\nOptions: [\"metric\", \"imperial\"];\r\nRequired: False;", "nullable": true}, "outputFormat": {"type": "string", "description": "Description: Specifies output format type.;\r\nDefault: \"json\";\r\nOptions: \"json\";\r\nRequired: False;", "nullable": true}, "baseURL": {"type": "array", "items": {"type": "string"}, "description": "Internal: Holds base url for data retrieval depending on the specified source and dataset.", "nullable": true}, "inputTimeSeries": {"type": "object", "additionalProperties": {"$ref": "#/components/schemas/TimeSeriesOutput"}, "description": "Description: A dictionary for utilizing an ITimeSeriesOutput as an input variable, where the key is a provided identifier of the ITimeSeriesOutput.;\r\nDefault: None;\r\nOptions: None;\r\nRequired: False;", "nullable": true}, "source": {"type": "string", "description": "Description: Temperature data source;\r\nDefault: \"nldas\";\r\nOptions: [\"nldas\", \"gldas\", \"ncei\", \"daymet\", \"prism\"];\r\nRequired: True;", "nullable": true}}, "additionalProperties": false, "description": "Label: Temperature;\r\nDescription: Near-ground air temperature.;"}, "TimeSeriesGeometry": {"type": "object", "properties": {"description": {"type": "string", "description": "Description: Description of the geometry, used to indicate details about the type of location the point represents.;\r\nDefault: None;\r\nOptions: None;\r\nRequired: False;", "nullable": true}, "comID": {"type": "integer", "description": "Description: NHDPlus v2 catchment identifier.;\r\nDefault: None;\r\nOptions: None;\r\nRequired: False;", "format": "int32"}, "hucID": {"type": "string", "description": "Description: NHDPlus v2 Hydrologic Unit Code idendifier, specifically a HUC8 or HUC12 ID.;\r\nDefault: None;\r\nOptions: None;\r\nRequired: False;", "nullable": true}, "stationID": {"type": "string", "description": "Description: NCEI weather station ID, supports GHCND and COOP stations. If station type is not prepended to the ID, assumed to be GHCND.;\r\nDefault: None;\r\nOptions: None;\r\nRequired: False;", "nullable": true}, "point": {"$ref": "#/components/schemas/PointCoordinate"}, "geometryMetadata": {"type": "object", "additionalProperties": {"type": "string", "nullable": true}, "description": "Description: Dictionary for holding metadata and additional information about the provided geometry. ;\r\nDefault: None;\r\nOptions: None;\r\nRequired: False;", "nullable": true}, "timezone": {"$ref": "#/components/schemas/Timezone"}}, "additionalProperties": false, "description": "The geospatial area of interest object for the returned time series data."}, "TimeSeriesInput": {"required": ["dateTimeSpan", "geometry", "source"], "type": "object", "properties": {"source": {"minLength": 1, "type": "string", "description": "Description: Time-series data source;\r\nDefault: \"nldas\";\r\nOptions: [\"nldas\", \"gldas\", \"ncei\", \"daymet\", \"prism\", \"trmm\", \"nwm\", \"nwis\"];\r\nRequired: True;"}, "dateTimeSpan": {"$ref": "#/components/schemas/DateTimeSpan"}, "geometry": {"$ref": "#/components/schemas/TimeSeriesGeometry"}, "dataValueFormat": {"type": "string", "description": "Description: Specifies the output format for the data values in the timeseries;\r\nDefault: \"E3\";\r\nOptions: https://msdn.microsoft.com/en-us/library/kfsatb94(v=vs.110).aspx ;\r\nRequired: False;", "nullable": true}, "temporalResolution": {"type": "string", "description": "Description: The temporal resolution of the time series to be returned. Valid options dependent on the dataset and source of the timeseries.;\r\nDefault: \"default\";\r\nOptions: [\"default\", \"hourly\", \"3hourly\", \"daily\", \"monthly\"];\r\nRequired: False;", "nullable": true}, "timeLocalized": {"type": "boolean", "description": "Description: Indicates if the timezone of the geometry is used for the date/time values of the returned timeseries.;\r\nDefault: True;\r\nOptions: [True, False];\r\nRequired: False;"}, "units": {"type": "string", "description": "Description: Unit system of the output values.;\r\nDefault: \"metric\";\r\nOptions: [\"metric\", \"imperial\"];\r\nRequired: False;", "nullable": true}, "outputFormat": {"type": "string", "description": "Description: Specifies output format type.;\r\nDefault: \"json\";\r\nOptions: \"json\";\r\nRequired: False;", "nullable": true}, "baseURL": {"type": "array", "items": {"type": "string"}, "description": "Internal: Holds base url for data retrieval depending on the specified source and dataset.", "nullable": true}, "inputTimeSeries": {"type": "object", "additionalProperties": {"$ref": "#/components/schemas/TimeSeriesOutput"}, "description": "Description: A dictionary for utilizing an ITimeSeriesOutput as an input variable, where the key is a provided identifier of the ITimeSeriesOutput.;\r\nDefault: None;\r\nOptions: None;\r\nRequired: False;", "nullable": true}}, "additionalProperties": false, "description": "Concrete class for timeseries inputs."}, "TimeSeriesOutput": {"type": "object", "properties": {"dataset": {"type": "string", "description": "Dataset for the time series.", "nullable": true}, "dataSource": {"type": "string", "description": "Source of the dataset.", "nullable": true}, "metadata": {"type": "object", "additionalProperties": {"type": "string", "nullable": true}, "description": "Metadata dictionary providing details for the time series.", "nullable": true}, "data": {"type": "object", "additionalProperties": {"type": "array", "items": {"type": "string"}, "nullable": true}, "description": "Time series data.", "nullable": true}}, "additionalProperties": false, "description": "Concrete TimeSeriesOutput class"}, "Timezone": {"type": "object", "properties": {"name": {"type": "string", "description": "Description: Time zone.;\r\nDefault: None;\r\nOptions: None;\r\nRequired: False;", "nullable": true}, "offset": {"type": "number", "description": "Description: Timezone offset from GMT.;\r\nDefault: None;\r\nOptions: None;\r\nRequired: False;", "format": "double"}, "dls": {"type": "boolean", "description": "Description: Indicates if day light savings is active or not. Not currently used.;\r\nDefault: None;\r\nOptions: None;\r\nRequired: False;"}}, "additionalProperties": false, "description": "Timezone information corresponding to the geospatial area of interest, specified within the Geometry object."}, "TotalFlowInput": {"required": ["dateTimeSpan", "geometry", "source"], "type": "object", "properties": {"source": {"minLength": 1, "type": "string", "description": "Description: Time-series data source;\r\nDefault: \"nldas\";\r\nOptions: [\"nldas\", \"gldas\", \"ncei\", \"daymet\", \"prism\", \"trmm\", \"nwm\", \"nwis\"];\r\nRequired: True;"}, "dateTimeSpan": {"$ref": "#/components/schemas/DateTimeSpan"}, "geometry": {"$ref": "#/components/schemas/TimeSeriesGeometry"}, "dataValueFormat": {"type": "string", "description": "Description: Specifies the output format for the data values in the timeseries;\r\nDefault: \"E3\";\r\nOptions: https://msdn.microsoft.com/en-us/library/kfsatb94(v=vs.110).aspx ;\r\nRequired: False;", "nullable": true}, "temporalResolution": {"type": "string", "description": "Description: The temporal resolution of the time series to be returned. Valid options dependent on the dataset and source of the timeseries.;\r\nDefault: \"default\";\r\nOptions: [\"default\", \"hourly\", \"3hourly\", \"daily\", \"monthly\"];\r\nRequired: False;", "nullable": true}, "timeLocalized": {"type": "boolean", "description": "Description: Indicates if the timezone of the geometry is used for the date/time values of the returned timeseries.;\r\nDefault: True;\r\nOptions: [True, False];\r\nRequired: False;"}, "units": {"type": "string", "description": "Description: Unit system of the output values.;\r\nDefault: \"metric\";\r\nOptions: [\"metric\", \"imperial\"];\r\nRequired: False;", "nullable": true}, "outputFormat": {"type": "string", "description": "Description: Specifies output format type.;\r\nDefault: \"json\";\r\nOptions: \"json\";\r\nRequired: False;", "nullable": true}, "baseURL": {"type": "array", "items": {"type": "string"}, "description": "Internal: Holds base url for data retrieval depending on the specified source and dataset.", "nullable": true}, "inputTimeSeries": {"type": "object", "additionalProperties": {"$ref": "#/components/schemas/TimeSeriesOutput"}, "description": "Description: A dictionary for utilizing an ITimeSeriesOutput as an input variable, where the key is a provided identifier of the ITimeSeriesOutput.;\r\nDefault: None;\r\nOptions: None;\r\nRequired: False;", "nullable": true}, "geometryType": {"type": "string", "description": "Specifies the type of geometry provided\r\nValid values: \"huc\", \"commid\", \"catchmentid\", \"catchment\", \"flowline\", \"points\"", "nullable": true}, "geometryInput": {"type": "string", "description": "Contains the geometry data, type specified by geometry Type. \r\nValid formats are: an ID for type huc, commid, and catchmentid; geojson for types catchment and flowline; and points for type points", "nullable": true}, "geometryInputs": {"type": "object", "additionalProperties": {"type": "string", "nullable": true}, "description": "Contains the type as key and input as value, used when multiple inputs are needed for a request", "nullable": true}}, "additionalProperties": false, "description": "Input class for Total Flow (subsurface flow and surface flow)"}, "WaterQualityInput": {"type": "object", "properties": {"taskID": {"type": "string", "description": "TaskID required for data storage in mongodb", "nullable": true}, "dataSource": {"type": "string", "description": "Data source for data retrieval\r\nIf value is 'nldas': surface runoff and subsurface flow will be from nldas (no precip will be downloaded); \r\nIf value is 'ncei', precip data will be downloaded from the closest station to the catchment and curvenumber will be used for surface runoff/subsurface flow.", "nullable": true}, "minNitrate": {"type": "integer", "format": "int32"}, "maxNitrate": {"type": "integer", "format": "int32"}, "minAmmonia": {"type": "integer", "format": "int32"}, "maxAmmonia": {"type": "integer", "format": "int32"}}, "additionalProperties": false, "description": "WaterQuality Input that implements TimeSeriesInput object."}, "WatershedDelineationInput": {"required": ["dateTimeSpan", "geometry", "source"], "type": "object", "properties": {"source": {"minLength": 1, "type": "string", "description": "Description: Time-series data source;\r\nDefault: \"nldas\";\r\nOptions: [\"nldas\", \"gldas\", \"ncei\", \"daymet\", \"prism\", \"trmm\", \"nwm\", \"nwis\"];\r\nRequired: True;"}, "dateTimeSpan": {"$ref": "#/components/schemas/DateTimeSpan"}, "geometry": {"$ref": "#/components/schemas/TimeSeriesGeometry"}, "dataValueFormat": {"type": "string", "description": "Description: Specifies the output format for the data values in the timeseries;\r\nDefault: \"E3\";\r\nOptions: https://msdn.microsoft.com/en-us/library/kfsatb94(v=vs.110).aspx ;\r\nRequired: False;", "nullable": true}, "temporalResolution": {"type": "string", "description": "Description: The temporal resolution of the time series to be returned. Valid options dependent on the dataset and source of the timeseries.;\r\nDefault: \"default\";\r\nOptions: [\"default\", \"hourly\", \"3hourly\", \"daily\", \"monthly\"];\r\nRequired: False;", "nullable": true}, "timeLocalized": {"type": "boolean", "description": "Description: Indicates if the timezone of the geometry is used for the date/time values of the returned timeseries.;\r\nDefault: True;\r\nOptions: [True, False];\r\nRequired: False;"}, "units": {"type": "string", "description": "Description: Unit system of the output values.;\r\nDefault: \"metric\";\r\nOptions: [\"metric\", \"imperial\"];\r\nRequired: False;", "nullable": true}, "outputFormat": {"type": "string", "description": "Description: Specifies output format type.;\r\nDefault: \"json\";\r\nOptions: \"json\";\r\nRequired: False;", "nullable": true}, "baseURL": {"type": "array", "items": {"type": "string"}, "description": "Internal: Holds base url for data retrieval depending on the specified source and dataset.", "nullable": true}, "inputTimeSeries": {"type": "object", "additionalProperties": {"$ref": "#/components/schemas/TimeSeriesOutput"}, "description": "Description: A dictionary for utilizing an ITimeSeriesOutput as an input variable, where the key is a provided identifier of the ITimeSeriesOutput.;\r\nDefault: None;\r\nOptions: None;\r\nRequired: False;", "nullable": true}, "contaminantInflow": {"type": "array", "items": {"type": "array", "items": {}}, "nullable": true}, "inflowSource": {"type": "string", "nullable": true}}, "additionalProperties": false, "description": "Delineation Input that implements TimeSeriesInput object."}, "WatershedWorkflowInput": {"required": ["dateTimeSpan", "geometry", "source"], "type": "object", "properties": {"source": {"minLength": 1, "type": "string", "description": "Description: Time-series data source;\r\nDefault: \"nldas\";\r\nOptions: [\"nldas\", \"gldas\", \"ncei\", \"daymet\", \"prism\", \"trmm\", \"nwm\", \"nwis\"];\r\nRequired: True;"}, "dateTimeSpan": {"$ref": "#/components/schemas/DateTimeSpan"}, "geometry": {"$ref": "#/components/schemas/TimeSeriesGeometry"}, "dataValueFormat": {"type": "string", "description": "Description: Specifies the output format for the data values in the timeseries;\r\nDefault: \"E3\";\r\nOptions: https://msdn.microsoft.com/en-us/library/kfsatb94(v=vs.110).aspx ;\r\nRequired: False;", "nullable": true}, "temporalResolution": {"type": "string", "description": "Description: The temporal resolution of the time series to be returned. Valid options dependent on the dataset and source of the timeseries.;\r\nDefault: \"default\";\r\nOptions: [\"default\", \"hourly\", \"3hourly\", \"daily\", \"monthly\"];\r\nRequired: False;", "nullable": true}, "timeLocalized": {"type": "boolean", "description": "Description: Indicates if the timezone of the geometry is used for the date/time values of the returned timeseries.;\r\nDefault: True;\r\nOptions: [True, False];\r\nRequired: False;"}, "units": {"type": "string", "description": "Description: Unit system of the output values.;\r\nDefault: \"metric\";\r\nOptions: [\"metric\", \"imperial\"];\r\nRequired: False;", "nullable": true}, "outputFormat": {"type": "string", "description": "Description: Specifies output format type.;\r\nDefault: \"json\";\r\nOptions: \"json\";\r\nRequired: False;", "nullable": true}, "baseURL": {"type": "array", "items": {"type": "string"}, "description": "Internal: Holds base url for data retrieval depending on the specified source and dataset.", "nullable": true}, "inputTimeSeries": {"type": "object", "additionalProperties": {"$ref": "#/components/schemas/TimeSeriesOutput"}, "description": "Description: A dictionary for utilizing an ITimeSeriesOutput as an input variable, where the key is a provided identifier of the ITimeSeriesOutput.;\r\nDefault: None;\r\nOptions: None;\r\nRequired: False;", "nullable": true}, "runoffSource": {"type": "string", "description": "OPTIONAL: Specifies the requested source for Runoff Data", "nullable": true}, "streamHydrology": {"type": "string", "description": "OPTIONAL: Specifies the requested Stream Hydrology Algorithm to use", "nullable": true}, "aggregation": {"type": "boolean", "description": "OPTIONAL: States whether or not runoff should be aggregated by catchments"}}, "additionalProperties": false, "description": "WorkFlow Input that implements TimeSeriesInput object."}, "WindInput": {"required": ["dateTimeSpan", "geometry"], "type": "object", "properties": {"dateTimeSpan": {"$ref": "#/components/schemas/DateTimeSpan"}, "geometry": {"$ref": "#/components/schemas/TimeSeriesGeometry"}, "dataValueFormat": {"type": "string", "description": "Description: Specifies the output format for the data values in the timeseries;\r\nDefault: \"E3\";\r\nOptions: https://msdn.microsoft.com/en-us/library/kfsatb94(v=vs.110).aspx ;\r\nRequired: False;", "nullable": true}, "temporalResolution": {"type": "string", "description": "Description: The temporal resolution of the time series to be returned. Valid options dependent on the dataset and source of the timeseries.;\r\nDefault: \"default\";\r\nOptions: [\"default\", \"hourly\", \"3hourly\", \"daily\", \"monthly\"];\r\nRequired: False;", "nullable": true}, "timeLocalized": {"type": "boolean", "description": "Description: Indicates if the timezone of the geometry is used for the date/time values of the returned timeseries.;\r\nDefault: True;\r\nOptions: [True, False];\r\nRequired: False;"}, "units": {"type": "string", "description": "Description: Unit system of the output values.;\r\nDefault: \"metric\";\r\nOptions: [\"metric\", \"imperial\"];\r\nRequired: False;", "nullable": true}, "outputFormat": {"type": "string", "description": "Description: Specifies output format type.;\r\nDefault: \"json\";\r\nOptions: \"json\";\r\nRequired: False;", "nullable": true}, "baseURL": {"type": "array", "items": {"type": "string"}, "description": "Internal: Holds base url for data retrieval depending on the specified source and dataset.", "nullable": true}, "inputTimeSeries": {"type": "object", "additionalProperties": {"$ref": "#/components/schemas/TimeSeriesOutput"}, "description": "Description: A dictionary for utilizing an ITimeSeriesOutput as an input variable, where the key is a provided identifier of the ITimeSeriesOutput.;\r\nDefault: None;\r\nOptions: None;\r\nRequired: False;", "nullable": true}, "source": {"type": "string", "description": "Description: Wind data source;\r\nDefault: \"nldas\";\r\nOptions: [\"nldas\", \"gldas\"];\r\nRequired: True;", "nullable": true}}, "additionalProperties": false, "description": "Label: Wind;\r\nDescription: Near-ground wind.;"}}}, "servers": [{"url": "https://qed.epa.gov/hms/rest", "description": "HMS Frontend"}]}