{ "components":{ "parameters":{ "bbox":{ "description":"Only features that have a geometry that intersects the bounding box are selected.The bounding box is provided as four or six numbers, depending on whether the coordinate reference system includes a vertical axis (height or depth).", "explode":false, "in":"query", "name":"bbox", "required":false, "schema":{ "items":{ "type":"number" }, "maxItems":6, "minItems":4, "type":"array" }, "style":"form" }, "bbox-crs":{ "description":"Indicates the coordinate reference system for the given bbox coordinates.", "explode":false, "in":"query", "name":"bbox-crs", "required":false, "schema":{ "format":"uri", "type":"string" }, "style":"form" }, "bbox-crs-epsg":{ "description":"Indicates the EPSG for the given bbox coordinates.", "explode":false, "in":"query", "name":"bbox-crs", "required":false, "schema":{ "default":4326, "type":"integer" }, "style":"form" }, "crs":{ "description":"Indicates the coordinate reference system for the results.", "explode":false, "in":"query", "name":"crs", "required":false, "schema":{ "format":"uri", "type":"string" }, "style":"form" }, "f":{ "description":"The optional f parameter indicates the output format which the server shall provide as part of the response document. The default format is GeoJSON. CSV is also available.", "explode":false, "in":"query", "name":"f", "required":false, "schema":{ "default":"json", "enum":[ "json", "html", "jsonld", "csv" ], "type":"string" }, "style":"form" }, "filter":{ "description":"CQL Text filter expression. CQL JSON cannot be used here, only in the body. \nSee also: https://docs.pygeoapi.io/en/latest/cql.html \n\nExample: time_series_id IN ('64ee32f5350a4ec4967435dcd2e364ea', '3e55d9c2d8a54bec9ca5e292b07d5a96')", "in":"query", "name":"filter", "required":false, "schema":{ "type":"string" } }, "filter-lang":{ "description":"CQL language used (e.g., cql-text, cql-json)", "in":"query", "name":"filter-lang", "required":false, "schema":{ "enum":[ "cql-text", "cql-json" ], "type":"string" } }, "lang":{ "description":"The optional lang parameter instructs the server return a response in a certain language, if supported. If the language is not among the available values, the Accept-Language header language will be used if it is supported. If the header is missing, the default server language is used. Note that providers may only support a single language (or often no language at all), that can be different from the server language. Language strings can be written in a complex (e.g. \"fr-CA,fr;q=0.9,en-US;q=0.8,en;q=0.7\"), simple (e.g. \"de\") or locale-like (e.g. \"de-CH\" or \"fr_BE\") fashion.", "in":"query", "name":"lang", "required":false, "schema":{ "default":"en-US", "enum":[ "en-US" ], "type":"string" } }, "limit":{ "description":"The optional limit parameter limits the number of items that are presented in the response document", "explode":false, "in":"query", "name":"limit", "required":false, "schema":{ "default":100, "maximum":10000, "minimum":1, "type":"integer" }, "style":"form" }, "offset":{ "description":"The optional offset parameter indicates the index within the result set from which the server shall begin presenting results in the response document. The first element has an index of 0 (default).", "explode":false, "in":"query", "name":"offset", "required":false, "schema":{ "default":0, "minimum":0, "type":"integer" }, "style":"form" }, "resourceId":{ "description":"Configuration resource identifier", "in":"path", "name":"resourceId", "required":true, "schema":{ "default":"latest-continuous", "type":"string" } }, "skipGeometry":{ "description":"This option can be used to skip response geometries for each feature.", "explode":false, "in":"query", "name":"skipGeometry", "required":false, "schema":{ "default":false, "type":"boolean" }, "style":"form" }, "statistic_id":{ "description":"A code corresponding to the statistic an observation represents. Example codes include 00001 (max), 00002 (min), and 00003 (mean). A complete list of codes and their descriptions can be found at [https://help.waterdata.usgs.gov/code/stat_cd_nm_query?stat_nm_cd=%25&fmt=html](https://help.waterdata.usgs.gov/code/stat_cd_nm_query?stat_nm_cd=%25&fmt=html).", "explode":false, "in":"query", "name":"statistic_id", "required":false, "schema":{ "description":"A code corresponding to the statistic an observation represents. Example codes include 00001 (max), 00002 (min), and 00003 (mean). A complete list of codes and their descriptions can be found at [https://help.waterdata.usgs.gov/code/stat_cd_nm_query?stat_nm_cd=%25&fmt=html](https://help.waterdata.usgs.gov/code/stat_cd_nm_query?stat_nm_cd=%25&fmt=html).", "title":"Statistic ID", "type":"string" }, "style":"form" }, "time":{ "description":"The date an observation represents. You can query this field using date-times or intervals, adhering to RFC 3339, or using ISO 8601 duration objects. Intervals may be bounded or half-bounded (double-dots at start or end).\nExamples:\n\n - A date-time: \"2018-02-12T23:20:50Z\"\n - A bounded interval: \"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z\"\n - Half-bounded intervals: \"2018-02-12T00:00:00Z/..\" or \"../2018-03-18T12:31:12Z\"\n - Duration objects: \"P1M\" for data from the past month or \"PT36H\" for the last 36 hours\n\nOnly features that have a `time` that intersects the value of datetime are selected. If a feature has multiple temporal properties, it is the decision of the server whether only a single temporal property is used to determine the extent or all relevant temporal properties.\n", "explode":false, "in":"query", "name":"time", "required":false, "schema":{ "description":"The date an observation represents. You can query this field using date-times or intervals, adhering to RFC 3339, or using ISO 8601 duration objects. Intervals may be bounded or half-bounded (double-dots at start or end).\nExamples:\n\n - A date-time: \"2018-02-12T23:20:50Z\"\n - A bounded interval: \"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z\"\n - Half-bounded intervals: \"2018-02-12T00:00:00Z/..\" or \"../2018-03-18T12:31:12Z\"\n - Duration objects: \"P1M\" for data from the past month or \"PT36H\" for the last 36 hours\n\nOnly features that have a `time` that intersects the value of datetime are selected. If a feature has multiple temporal properties, it is the decision of the server whether only a single temporal property is used to determine the extent or all relevant temporal properties.\n", "title":"Time", "type":"string" }, "style":"form" }, "vendorSpecificParameters":{ "description":"Additional \"free-form\" parameters that are not explicitly defined", "in":"query", "name":"vendorSpecificParameters", "schema":{ "additionalProperties":true, "type":"object" }, "style":"form" }, "wda_sortby":{ "description":"Specifies a comma-separated list of property names by which the response shall be sorted. If the property name is preceded by a plus (+) sign it indicates an ascending sort for that property. If the property name is preceded by a minus (-) sign it indicates a descending sort for that property. If the property is not preceded by a plus or minus, then the default sort order implied is ascending (+). \n\nOnly a single page of data can be returned when specifying sortby. If you need more than a single page of data, don't specify a sortby value and sort the full data set after it's been downloaded.", "explode":false, "in":"query", "name":"sortby", "required":false, "schema":{ "items":{ "pattern":"[+|-]?[A-Za-z_].*", "type":"string" }, "minItems":1, "type":"array" }, "style":"form" } }, "responses":{ "200":{ "description":"successful operation" }, "204":{ "description":"no content" }, "Forbidden403":{ "content":{ "application/json":{ "examples":{ "missingApiKey":{ "summary":"Missing API Key", "value":{ "error":{ "code":"API_KEY_MISSING", "message":"No api_key was supplied. Get one at https://api.waterdata.usgs.gov/signup/" } } } }, "schema":{ "$ref":"#/components/schemas/Error" } }, "application/xml":{ "example":"\n \n API_KEY_MISSING\n No api_key was supplied. Get one at https://api.waterdata.usgs.gov/signup/\n \n ", "schema":{ "properties":{ "response":{ "properties":{ "error":{ "properties":{ "code":{ "type":"string" }, "message":{ "type":"string" } }, "required":[ "code", "message" ], "type":"object" } }, "required":[ "error" ], "type":"object" } }, "type":"object" } }, "text/csv":{ "examples":{ "missingApiKeyCsv":{ "summary":"Missing API Key (CSV)", "value":"Error Code,Error Message\nAPI_KEY_MISSING, No api_key was supplied. Get one at https://api.waterdata.usgs.gov/signup/" } }, "schema":{ "type":"string" } }, "text/html":{ "examples":{ "missingApiKeyHtml":{ "summary":"Missing API Key (HTML)", "value":"\n \n

API_KEY_MISSING

\n

No api_key was supplied. Get one at https://api.waterdata.usgs.gov/signup/

\n \n " } }, "schema":{ "type":"string" } } }, "description":"Forbidden - API key is missing or not authorized for this resource." }, "Queryables":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/queryables" } } }, "description":"successful queryables operation" }, "Tiles":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/tiles" } } }, "description":"Retrieves the tiles description for this collection" }, "TooManyRequests429":{ "content":{ "application/json":{ "examples":{ "rateLimitExceeded":{ "summary":"Rate Limit Exceeded", "value":{ "error":{ "code":"OVER_RATE_LIMIT", "message":"You have exceeded your rate limit. Make sure you provided your API key from https://api.waterdata.usgs.gov/signup/, then either try again later or contact us at https://waterdata.usgs.gov/questions-comments/?referrerUrl=https://api.waterdata.usgs.gov for assistance." } } } }, "schema":{ "$ref":"#/components/schemas/Error" } }, "application/xml":{ "example":"\n \n OVER_RATE_LIMIT\n You have exceeded your rate limit. Make sure you provided your API key from https://api.waterdata.usgs.gov/signup/, then either try again later or contact us at https://waterdata.usgs.gov/questions-comments/?referrerUrl=https://api.waterdata.usgs.gov for assistance.\n \n ", "schema":{ "properties":{ "response":{ "properties":{ "error":{ "properties":{ "code":{ "type":"string" }, "message":{ "type":"string" } }, "required":[ "code", "message" ], "type":"object" } }, "required":[ "error" ], "type":"object" } }, "type":"object" } }, "text/csv":{ "examples":{ "rateLimitCsv":{ "summary":"Rate Limit Exceeded (CSV)", "value":"Error Code,Error Message\nOVER_RATE_LIMIT,You have exceeded your rate limit. Make sure you provided your API key from https://api.waterdata.usgs.gov/signup/, then either try again later or contact us at https://waterdata.usgs.gov/questions-comments/?referrerUrl=https://api.waterdata.usgs.gov for assistance." } }, "schema":{ "type":"string" } }, "text/html":{ "examples":{ "rateLimitHtml":{ "summary":"Rate Limit Exceeded (HTML)", "value":"\n \n

OVER_RATE_LIMIT

\n

You have exceeded your rate limit. Make sure you provided your API key from https://api.waterdata.usgs.gov/signup/, then either try again later or contact us at https://waterdata.usgs.gov/questions-comments/?referrerUrl=https://api.waterdata.usgs.gov for assistance.

\n \n " } }, "schema":{ "type":"string" } } }, "description":"Too Many Requests - Rate limit exceeded." }, "default":{ "content":{ "application/json":{ "schema":{ "$ref":"https://schemas.opengis.net/ogcapi/processes/part1/1.0/openapi/schemas/exception.yaml" } } }, "description":"Unexpected error" } }, "schemas":{ "Error":{ "properties":{ "error":{ "properties":{ "code":{ "description":"Error code such as OVER_RATE_LIMIT, see https://api.data.gov/docs/developer-manual/#general-web-service-errors", "type":"string" }, "message":{ "description":"Error message", "type":"string" } }, "required":[ "code", "message" ], "type":"object" } }, "type":"object" }, "queryable":{ "properties":{ "description":{ "description":"a human-readable narrative describing the queryable", "type":"string" }, "language":{ "default":"en", "description":"the language used for the title and description", "type":"string" }, "queryable":{ "description":"the token that may be used in a CQL predicate", "type":"string" }, "title":{ "description":"a human readable title for the queryable", "type":"string" }, "type":{ "description":"the data type of the queryable", "type":"string" }, "type-ref":{ "description":"a reference to the formal definition of the type", "format":"url", "type":"string" } }, "required":[ "queryable", "type" ], "type":"object" }, "queryables":{ "properties":{ "queryables":{ "items":{ "$ref":"#/components/schemas/queryable" }, "type":"array" } }, "required":[ "queryables" ], "type":"object" }, "tilematrixsetlink":{ "properties":{ "tileMatrixSet":{ "type":"string" }, "tileMatrixSetURI":{ "type":"string" } }, "required":[ "tileMatrixSet" ], "type":"object" }, "tiles":{ "properties":{ "links":{ "items":{ "$ref":"https://schemas.opengis.net/ogcapi/tiles/part1/1.0/openapi/ogcapi-tiles-1.yaml#/components/schemas/link" }, "type":"array" }, "tileMatrixSetLinks":{ "items":{ "$ref":"#/components/schemas/tilematrixsetlink" }, "type":"array" } }, "required":[ "tileMatrixSetLinks", "links" ], "type":"object" } }, "securitySchemes":{ "ApiKeyHeader":{ "description":"Providing your API key gives you higher rate limits when querying our APIs. You can obtain an API key at https://api.waterdata.usgs.gov/signup", "in":"header", "name":"api_key", "type":"apiKey" }, "ApiKeyQuery":{ "description":"Providing your API key gives you higher rate limits when querying our APIs. You can obtain an API key at https://api.waterdata.usgs.gov/signup", "in":"query", "name":"api_key", "type":"apiKey" } } }, "info":{ "contact":{ "name":"US Geological Survey - Water Data for the Nation", "url":"https://waterdata.usgs.gov", "x-ogc-serviceContact":{ "addresses":[], "emails":[ { "value":"wdfn@usgs.gov" } ], "hoursOfService":"pointOfContact", "links":[ { "href":"https://waterdata.usgs.gov/questions-comments/?referrerUrl=https://api.waterdata.usgs.gov", "type":"text/html" } ], "name":"WDFN Support" } }, "description":"These APIs provide OGC-compliant interfaces to USGS water data, letting you download continuous sensor measurements, discrete field measurements, metadata about monitoring locations, and more.\n", "license":{ "name":"US Government work in the public domain", "url":"https://creativecommons.org/publicdomain/zero/1.0/" }, "termsOfService":"https://creativecommons.org/publicdomain/zero/1.0/", "title":"USGS Water Data OGC APIs", "version":"0.38.0", "x-keywords":[ "geospatial", "data", "api", "hydrology", "USGS" ] }, "openapi":"3.0.2", "paths":{ "/":{ "get":{ "description":"Landing page", "operationId":"getLandingPage", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/LandingPage" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "summary":"Landing page", "tags":[ "server" ] } }, "/collections":{ "get":{ "description":"Collections", "operationId":"getCollections", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/LandingPage" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "summary":"Collections", "tags":[ "server" ] } }, "/collections/agency-codes":{ "get":{ "description":"Code identifying the agency or organization used for site information, data sources, and permitting agencies. Agency codes are fixed values assigned by the National Water Information System (NWIS).\n", "operationId":"describeAgency-codesCollection", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Collection" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "summary":"Get Agency codes metadata", "tags":[ "agency-codes" ] } }, "/collections/agency-codes/items":{ "get":{ "description":"Code identifying the agency or organization used for site information, data sources, and permitting agencies. Agency codes are fixed values assigned by the National Water Information System (NWIS).\n", "operationId":"getAgency-codesFeatures", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" }, { "$ref":"#/components/parameters/bbox" }, { "description":"The optional limit parameter limits the number of items that are presented in the response document (maximum=50000, default=10000).", "explode":false, "in":"query", "name":"limit", "required":false, "schema":{ "default":10000, "maximum":50000, "minimum":1, "type":"integer" }, "style":"form" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/bbox-crs" }, { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "agency_name" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/skipGeometry" }, { "$ref":"https://raw.githubusercontent.com/opengeospatial/ogcapi-records/master/core/openapi/parameters/sortby.yaml" }, { "$ref":"#/components/parameters/offset" }, { "description":"Agency code identification number.", "explode":false, "in":"query", "name":"id", "required":false, "schema":{ "description":"Agency code identification number.", "type":"string" }, "style":"form" }, { "description":"Agency name.", "explode":false, "in":"query", "name":"agency_name", "required":false, "schema":{ "description":"Agency name.", "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Agency codes items", "tags":[ "agency-codes" ] }, "options":{ "description":"Code identifying the agency or organization used for site information, data sources, and permitting agencies. Agency codes are fixed values assigned by the National Water Information System (NWIS).\n", "operationId":"optionsAgency-codesFeatures", "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for Agency codes items", "tags":[ "agency-codes" ] }, "post":{ "description":"Code identifying the agency or organization used for site information, data sources, and permitting agencies. Agency codes are fixed values assigned by the National Water Information System (NWIS).\n", "operationId":"getCQL2Agency-codesFeatures", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"https://schemas.opengis.net/cql2/1.0/cql2.json" } } }, "description":"Get items with CQL2", "required":true }, "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Agency codes items with CQL2", "tags":[ "agency-codes" ] } }, "/collections/agency-codes/items/{featureId}":{ "get":{ "description":"Code identifying the agency or organization used for site information, data sources, and permitting agencies. Agency codes are fixed values assigned by the National Water Information System (NWIS).\n", "operationId":"getAgency-codesFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Feature" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Agency codes item by id", "tags":[ "agency-codes" ] }, "options":{ "description":"Code identifying the agency or organization used for site information, data sources, and permitting agencies. Agency codes are fixed values assigned by the National Water Information System (NWIS).\n", "operationId":"optionsAgency-codesFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" } ], "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for Agency codes item by id", "tags":[ "agency-codes" ] } }, "/collections/agency-codes/queryables":{ "get":{ "description":"Code identifying the agency or organization used for site information, data sources, and permitting agencies. Agency codes are fixed values assigned by the National Water Information System (NWIS).\n", "operationId":"getAgency-codesQueryables", "parameters":[ { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "agency_name" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/f" }, { "description":"The profile to be applied to a given request", "explode":false, "in":"query", "name":"profile", "required":false, "schema":{ "enum":[ "actual-domain", "valid-domain" ], "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Agency codes queryables", "tags":[ "agency-codes" ] } }, "/collections/agency-codes/schema":{ "get":{ "description":"Code identifying the agency or organization used for site information, data sources, and permitting agencies. Agency codes are fixed values assigned by the National Water Information System (NWIS).\n", "operationId":"getAgency-codesSchema", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Agency codes schema", "tags":[ "agency-codes" ] } }, "/collections/altitude-datums":{ "get":{ "description":"The recommended vertical datum is NAVD88 (North American Vertical Datum of 1988) where applicable as stated in Office of Information Technical Memo 2002.01. NGVD29 (National Geodetic Vertical Datum of 1929) and NAVD88 are the only datums that can be converted on output. NWIS uses the North American Vertical Datum Conversions (VERTCON) of the National Geodetic Survey to convert from NGVD29 to NAVD88 or vice versa. Conversions to or from other vertical datums are not available.\n", "operationId":"describeAltitude-datumsCollection", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Collection" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "summary":"Get Altitude datums metadata", "tags":[ "altitude-datums" ] } }, "/collections/altitude-datums/items":{ "get":{ "description":"The recommended vertical datum is NAVD88 (North American Vertical Datum of 1988) where applicable as stated in Office of Information Technical Memo 2002.01. NGVD29 (National Geodetic Vertical Datum of 1929) and NAVD88 are the only datums that can be converted on output. NWIS uses the North American Vertical Datum Conversions (VERTCON) of the National Geodetic Survey to convert from NGVD29 to NAVD88 or vice versa. Conversions to or from other vertical datums are not available.\n", "operationId":"getAltitude-datumsFeatures", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" }, { "$ref":"#/components/parameters/bbox" }, { "description":"The optional limit parameter limits the number of items that are presented in the response document (maximum=50000, default=10000).", "explode":false, "in":"query", "name":"limit", "required":false, "schema":{ "default":10000, "maximum":50000, "minimum":1, "type":"integer" }, "style":"form" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/bbox-crs" }, { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "altitude_datum_description" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/skipGeometry" }, { "$ref":"https://raw.githubusercontent.com/opengeospatial/ogcapi-records/master/core/openapi/parameters/sortby.yaml" }, { "$ref":"#/components/parameters/offset" }, { "explode":false, "in":"query", "name":"id", "required":false, "schema":{ "type":"string" }, "style":"form" }, { "explode":false, "in":"query", "name":"altitude_datum_description", "required":false, "schema":{ "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Altitude datums items", "tags":[ "altitude-datums" ] }, "options":{ "description":"The recommended vertical datum is NAVD88 (North American Vertical Datum of 1988) where applicable as stated in Office of Information Technical Memo 2002.01. NGVD29 (National Geodetic Vertical Datum of 1929) and NAVD88 are the only datums that can be converted on output. NWIS uses the North American Vertical Datum Conversions (VERTCON) of the National Geodetic Survey to convert from NGVD29 to NAVD88 or vice versa. Conversions to or from other vertical datums are not available.\n", "operationId":"optionsAltitude-datumsFeatures", "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for Altitude datums items", "tags":[ "altitude-datums" ] }, "post":{ "description":"The recommended vertical datum is NAVD88 (North American Vertical Datum of 1988) where applicable as stated in Office of Information Technical Memo 2002.01. NGVD29 (National Geodetic Vertical Datum of 1929) and NAVD88 are the only datums that can be converted on output. NWIS uses the North American Vertical Datum Conversions (VERTCON) of the National Geodetic Survey to convert from NGVD29 to NAVD88 or vice versa. Conversions to or from other vertical datums are not available.\n", "operationId":"getCQL2Altitude-datumsFeatures", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"https://schemas.opengis.net/cql2/1.0/cql2.json" } } }, "description":"Get items with CQL2", "required":true }, "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Altitude datums items with CQL2", "tags":[ "altitude-datums" ] } }, "/collections/altitude-datums/items/{featureId}":{ "get":{ "description":"The recommended vertical datum is NAVD88 (North American Vertical Datum of 1988) where applicable as stated in Office of Information Technical Memo 2002.01. NGVD29 (National Geodetic Vertical Datum of 1929) and NAVD88 are the only datums that can be converted on output. NWIS uses the North American Vertical Datum Conversions (VERTCON) of the National Geodetic Survey to convert from NGVD29 to NAVD88 or vice versa. Conversions to or from other vertical datums are not available.\n", "operationId":"getAltitude-datumsFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Feature" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Altitude datums item by id", "tags":[ "altitude-datums" ] }, "options":{ "description":"The recommended vertical datum is NAVD88 (North American Vertical Datum of 1988) where applicable as stated in Office of Information Technical Memo 2002.01. NGVD29 (National Geodetic Vertical Datum of 1929) and NAVD88 are the only datums that can be converted on output. NWIS uses the North American Vertical Datum Conversions (VERTCON) of the National Geodetic Survey to convert from NGVD29 to NAVD88 or vice versa. Conversions to or from other vertical datums are not available.\n", "operationId":"optionsAltitude-datumsFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" } ], "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for Altitude datums item by id", "tags":[ "altitude-datums" ] } }, "/collections/altitude-datums/queryables":{ "get":{ "description":"The recommended vertical datum is NAVD88 (North American Vertical Datum of 1988) where applicable as stated in Office of Information Technical Memo 2002.01. NGVD29 (National Geodetic Vertical Datum of 1929) and NAVD88 are the only datums that can be converted on output. NWIS uses the North American Vertical Datum Conversions (VERTCON) of the National Geodetic Survey to convert from NGVD29 to NAVD88 or vice versa. Conversions to or from other vertical datums are not available.\n", "operationId":"getAltitude-datumsQueryables", "parameters":[ { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "altitude_datum_description" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/f" }, { "description":"The profile to be applied to a given request", "explode":false, "in":"query", "name":"profile", "required":false, "schema":{ "enum":[ "actual-domain", "valid-domain" ], "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Altitude datums queryables", "tags":[ "altitude-datums" ] } }, "/collections/altitude-datums/schema":{ "get":{ "description":"The recommended vertical datum is NAVD88 (North American Vertical Datum of 1988) where applicable as stated in Office of Information Technical Memo 2002.01. NGVD29 (National Geodetic Vertical Datum of 1929) and NAVD88 are the only datums that can be converted on output. NWIS uses the North American Vertical Datum Conversions (VERTCON) of the National Geodetic Survey to convert from NGVD29 to NAVD88 or vice versa. Conversions to or from other vertical datums are not available.\n", "operationId":"getAltitude-datumsSchema", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Altitude datums schema", "tags":[ "altitude-datums" ] } }, "/collections/aquifer-codes":{ "get":{ "description":"Local aquifers in USGS data are identified by an aquifer name and geohydrologic unit code (a three-digit number related to the age of the formation, followed by a 4 or 5 character abbreviation for the geologic unit or aquifer name). For the age of formation (aquifer age), generally the smaller the number represents the younger the geohydrologic unit. Aquifer names and the definition of an aquifer can be very subjective. One rock unit may be called different aquifer names by different people. Local aquifers and layered aquifers are often grouped into larger named regional aquifers or aquifer systems. For example, the National Northern Atlantic Coastal Plain aquifer system (National aquifer) consists of five layered regional aquifers. Each regional aquifer is divided into two or more aquifers which may have a different name in each of the states in which the aquifer is found.\n", "operationId":"describeAquifer-codesCollection", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Collection" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "summary":"Get Aquifer codes metadata", "tags":[ "aquifer-codes" ] } }, "/collections/aquifer-codes/items":{ "get":{ "description":"Local aquifers in USGS data are identified by an aquifer name and geohydrologic unit code (a three-digit number related to the age of the formation, followed by a 4 or 5 character abbreviation for the geologic unit or aquifer name). For the age of formation (aquifer age), generally the smaller the number represents the younger the geohydrologic unit. Aquifer names and the definition of an aquifer can be very subjective. One rock unit may be called different aquifer names by different people. Local aquifers and layered aquifers are often grouped into larger named regional aquifers or aquifer systems. For example, the National Northern Atlantic Coastal Plain aquifer system (National aquifer) consists of five layered regional aquifers. Each regional aquifer is divided into two or more aquifers which may have a different name in each of the states in which the aquifer is found.\n", "operationId":"getAquifer-codesFeatures", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" }, { "$ref":"#/components/parameters/bbox" }, { "description":"The optional limit parameter limits the number of items that are presented in the response document (maximum=50000, default=10000).", "explode":false, "in":"query", "name":"limit", "required":false, "schema":{ "default":10000, "maximum":50000, "minimum":1, "type":"integer" }, "style":"form" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/bbox-crs" }, { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "aquifer_name" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/skipGeometry" }, { "$ref":"https://raw.githubusercontent.com/opengeospatial/ogcapi-records/master/core/openapi/parameters/sortby.yaml" }, { "$ref":"#/components/parameters/offset" }, { "description":"Aquifer code. The eight-character string identifying an aquifer. Codes are defined by the \\\"Catalog of Aquifer Names and Geologic Unit Codes used by the Water Resources Division.\\\"", "explode":false, "in":"query", "name":"id", "required":false, "schema":{ "description":"Aquifer code. The eight-character string identifying an aquifer. Codes are defined by the \\\"Catalog of Aquifer Names and Geologic Unit Codes used by the Water Resources Division.\\\"", "type":"string" }, "style":"form" }, { "description":"Aquifer name. Aquifer names are defined by the \\\"Catalog of Aquifer Names and Geologic Unit Codes used by the Water Resources Division.\\\"", "explode":false, "in":"query", "name":"aquifer_name", "required":false, "schema":{ "description":"Aquifer name. Aquifer names are defined by the \\\"Catalog of Aquifer Names and Geologic Unit Codes used by the Water Resources Division.\\\"", "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Aquifer codes items", "tags":[ "aquifer-codes" ] }, "options":{ "description":"Local aquifers in USGS data are identified by an aquifer name and geohydrologic unit code (a three-digit number related to the age of the formation, followed by a 4 or 5 character abbreviation for the geologic unit or aquifer name). For the age of formation (aquifer age), generally the smaller the number represents the younger the geohydrologic unit. Aquifer names and the definition of an aquifer can be very subjective. One rock unit may be called different aquifer names by different people. Local aquifers and layered aquifers are often grouped into larger named regional aquifers or aquifer systems. For example, the National Northern Atlantic Coastal Plain aquifer system (National aquifer) consists of five layered regional aquifers. Each regional aquifer is divided into two or more aquifers which may have a different name in each of the states in which the aquifer is found.\n", "operationId":"optionsAquifer-codesFeatures", "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for Aquifer codes items", "tags":[ "aquifer-codes" ] }, "post":{ "description":"Local aquifers in USGS data are identified by an aquifer name and geohydrologic unit code (a three-digit number related to the age of the formation, followed by a 4 or 5 character abbreviation for the geologic unit or aquifer name). For the age of formation (aquifer age), generally the smaller the number represents the younger the geohydrologic unit. Aquifer names and the definition of an aquifer can be very subjective. One rock unit may be called different aquifer names by different people. Local aquifers and layered aquifers are often grouped into larger named regional aquifers or aquifer systems. For example, the National Northern Atlantic Coastal Plain aquifer system (National aquifer) consists of five layered regional aquifers. Each regional aquifer is divided into two or more aquifers which may have a different name in each of the states in which the aquifer is found.\n", "operationId":"getCQL2Aquifer-codesFeatures", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"https://schemas.opengis.net/cql2/1.0/cql2.json" } } }, "description":"Get items with CQL2", "required":true }, "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Aquifer codes items with CQL2", "tags":[ "aquifer-codes" ] } }, "/collections/aquifer-codes/items/{featureId}":{ "get":{ "description":"Local aquifers in USGS data are identified by an aquifer name and geohydrologic unit code (a three-digit number related to the age of the formation, followed by a 4 or 5 character abbreviation for the geologic unit or aquifer name). For the age of formation (aquifer age), generally the smaller the number represents the younger the geohydrologic unit. Aquifer names and the definition of an aquifer can be very subjective. One rock unit may be called different aquifer names by different people. Local aquifers and layered aquifers are often grouped into larger named regional aquifers or aquifer systems. For example, the National Northern Atlantic Coastal Plain aquifer system (National aquifer) consists of five layered regional aquifers. Each regional aquifer is divided into two or more aquifers which may have a different name in each of the states in which the aquifer is found.\n", "operationId":"getAquifer-codesFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Feature" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Aquifer codes item by id", "tags":[ "aquifer-codes" ] }, "options":{ "description":"Local aquifers in USGS data are identified by an aquifer name and geohydrologic unit code (a three-digit number related to the age of the formation, followed by a 4 or 5 character abbreviation for the geologic unit or aquifer name). For the age of formation (aquifer age), generally the smaller the number represents the younger the geohydrologic unit. Aquifer names and the definition of an aquifer can be very subjective. One rock unit may be called different aquifer names by different people. Local aquifers and layered aquifers are often grouped into larger named regional aquifers or aquifer systems. For example, the National Northern Atlantic Coastal Plain aquifer system (National aquifer) consists of five layered regional aquifers. Each regional aquifer is divided into two or more aquifers which may have a different name in each of the states in which the aquifer is found.\n", "operationId":"optionsAquifer-codesFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" } ], "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for Aquifer codes item by id", "tags":[ "aquifer-codes" ] } }, "/collections/aquifer-codes/queryables":{ "get":{ "description":"Local aquifers in USGS data are identified by an aquifer name and geohydrologic unit code (a three-digit number related to the age of the formation, followed by a 4 or 5 character abbreviation for the geologic unit or aquifer name). For the age of formation (aquifer age), generally the smaller the number represents the younger the geohydrologic unit. Aquifer names and the definition of an aquifer can be very subjective. One rock unit may be called different aquifer names by different people. Local aquifers and layered aquifers are often grouped into larger named regional aquifers or aquifer systems. For example, the National Northern Atlantic Coastal Plain aquifer system (National aquifer) consists of five layered regional aquifers. Each regional aquifer is divided into two or more aquifers which may have a different name in each of the states in which the aquifer is found.\n", "operationId":"getAquifer-codesQueryables", "parameters":[ { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "aquifer_name" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/f" }, { "description":"The profile to be applied to a given request", "explode":false, "in":"query", "name":"profile", "required":false, "schema":{ "enum":[ "actual-domain", "valid-domain" ], "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Aquifer codes queryables", "tags":[ "aquifer-codes" ] } }, "/collections/aquifer-codes/schema":{ "get":{ "description":"Local aquifers in USGS data are identified by an aquifer name and geohydrologic unit code (a three-digit number related to the age of the formation, followed by a 4 or 5 character abbreviation for the geologic unit or aquifer name). For the age of formation (aquifer age), generally the smaller the number represents the younger the geohydrologic unit. Aquifer names and the definition of an aquifer can be very subjective. One rock unit may be called different aquifer names by different people. Local aquifers and layered aquifers are often grouped into larger named regional aquifers or aquifer systems. For example, the National Northern Atlantic Coastal Plain aquifer system (National aquifer) consists of five layered regional aquifers. Each regional aquifer is divided into two or more aquifers which may have a different name in each of the states in which the aquifer is found.\n", "operationId":"getAquifer-codesSchema", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Aquifer codes schema", "tags":[ "aquifer-codes" ] } }, "/collections/aquifer-types":{ "get":{ "description":"Groundwater occurs in aquifers under two different conditions. Where water only partly fills an aquifer, the upper surface is free to rise and decline. These aquifers are referred to as unconfined (or water-table) aquifers. Where water completely fills an aquifer that is overlain by a confining bed, the aquifer is referred to as a confined (or artesian) aquifer. When a confined aquifer is penetrated by a well, the water level in the well will rise above the top of the aquifer (but not necessarily above land surface).\n", "operationId":"describeAquifer-typesCollection", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Collection" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "summary":"Get Aquifer types metadata", "tags":[ "aquifer-types" ] } }, "/collections/aquifer-types/items":{ "get":{ "description":"Groundwater occurs in aquifers under two different conditions. Where water only partly fills an aquifer, the upper surface is free to rise and decline. These aquifers are referred to as unconfined (or water-table) aquifers. Where water completely fills an aquifer that is overlain by a confining bed, the aquifer is referred to as a confined (or artesian) aquifer. When a confined aquifer is penetrated by a well, the water level in the well will rise above the top of the aquifer (but not necessarily above land surface).\n", "operationId":"getAquifer-typesFeatures", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" }, { "$ref":"#/components/parameters/bbox" }, { "description":"The optional limit parameter limits the number of items that are presented in the response document (maximum=50000, default=10000).", "explode":false, "in":"query", "name":"limit", "required":false, "schema":{ "default":10000, "maximum":50000, "minimum":1, "type":"integer" }, "style":"form" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/bbox-crs" }, { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "aquifer_type_description" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/skipGeometry" }, { "$ref":"https://raw.githubusercontent.com/opengeospatial/ogcapi-records/master/core/openapi/parameters/sortby.yaml" }, { "$ref":"#/components/parameters/offset" }, { "description":"The single-character code identifying the type of aquifer", "explode":false, "in":"query", "name":"id", "required":false, "schema":{ "description":"The single-character code identifying the type of aquifer", "type":"string" }, "style":"form" }, { "description":"Longer description of the aquifer type.", "explode":false, "in":"query", "name":"aquifer_type_description", "required":false, "schema":{ "description":"Longer description of the aquifer type.", "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Aquifer types items", "tags":[ "aquifer-types" ] }, "options":{ "description":"Groundwater occurs in aquifers under two different conditions. Where water only partly fills an aquifer, the upper surface is free to rise and decline. These aquifers are referred to as unconfined (or water-table) aquifers. Where water completely fills an aquifer that is overlain by a confining bed, the aquifer is referred to as a confined (or artesian) aquifer. When a confined aquifer is penetrated by a well, the water level in the well will rise above the top of the aquifer (but not necessarily above land surface).\n", "operationId":"optionsAquifer-typesFeatures", "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for Aquifer types items", "tags":[ "aquifer-types" ] }, "post":{ "description":"Groundwater occurs in aquifers under two different conditions. Where water only partly fills an aquifer, the upper surface is free to rise and decline. These aquifers are referred to as unconfined (or water-table) aquifers. Where water completely fills an aquifer that is overlain by a confining bed, the aquifer is referred to as a confined (or artesian) aquifer. When a confined aquifer is penetrated by a well, the water level in the well will rise above the top of the aquifer (but not necessarily above land surface).\n", "operationId":"getCQL2Aquifer-typesFeatures", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"https://schemas.opengis.net/cql2/1.0/cql2.json" } } }, "description":"Get items with CQL2", "required":true }, "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Aquifer types items with CQL2", "tags":[ "aquifer-types" ] } }, "/collections/aquifer-types/items/{featureId}":{ "get":{ "description":"Groundwater occurs in aquifers under two different conditions. Where water only partly fills an aquifer, the upper surface is free to rise and decline. These aquifers are referred to as unconfined (or water-table) aquifers. Where water completely fills an aquifer that is overlain by a confining bed, the aquifer is referred to as a confined (or artesian) aquifer. When a confined aquifer is penetrated by a well, the water level in the well will rise above the top of the aquifer (but not necessarily above land surface).\n", "operationId":"getAquifer-typesFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Feature" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Aquifer types item by id", "tags":[ "aquifer-types" ] }, "options":{ "description":"Groundwater occurs in aquifers under two different conditions. Where water only partly fills an aquifer, the upper surface is free to rise and decline. These aquifers are referred to as unconfined (or water-table) aquifers. Where water completely fills an aquifer that is overlain by a confining bed, the aquifer is referred to as a confined (or artesian) aquifer. When a confined aquifer is penetrated by a well, the water level in the well will rise above the top of the aquifer (but not necessarily above land surface).\n", "operationId":"optionsAquifer-typesFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" } ], "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for Aquifer types item by id", "tags":[ "aquifer-types" ] } }, "/collections/aquifer-types/queryables":{ "get":{ "description":"Groundwater occurs in aquifers under two different conditions. Where water only partly fills an aquifer, the upper surface is free to rise and decline. These aquifers are referred to as unconfined (or water-table) aquifers. Where water completely fills an aquifer that is overlain by a confining bed, the aquifer is referred to as a confined (or artesian) aquifer. When a confined aquifer is penetrated by a well, the water level in the well will rise above the top of the aquifer (but not necessarily above land surface).\n", "operationId":"getAquifer-typesQueryables", "parameters":[ { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "aquifer_type_description" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/f" }, { "description":"The profile to be applied to a given request", "explode":false, "in":"query", "name":"profile", "required":false, "schema":{ "enum":[ "actual-domain", "valid-domain" ], "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Aquifer types queryables", "tags":[ "aquifer-types" ] } }, "/collections/aquifer-types/schema":{ "get":{ "description":"Groundwater occurs in aquifers under two different conditions. Where water only partly fills an aquifer, the upper surface is free to rise and decline. These aquifers are referred to as unconfined (or water-table) aquifers. Where water completely fills an aquifer that is overlain by a confining bed, the aquifer is referred to as a confined (or artesian) aquifer. When a confined aquifer is penetrated by a well, the water level in the well will rise above the top of the aquifer (but not necessarily above land surface).\n", "operationId":"getAquifer-typesSchema", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Aquifer types schema", "tags":[ "aquifer-types" ] } }, "/collections/continuous":{ "get":{ "description":"This is an early version of the continuous endpoint. It is feature-complete and provides access to the full continuous data record, and is being made available as we continue to work on performance improvements.\nContinuous data are collected via automated sensors installed at a monitoring location. They are collected at a high frequency and often at a fixed 15-minute interval. Depending on the specific monitoring location, the data may be transmitted automatically via telemetry and be available on WDFN within minutes of collection, while other times the delivery of data may be delayed if the monitoring location does not have the capacity to automatically transmit data. Continuous data are described by parameter name and parameter code (pcode). These data might also be referred to as \"instantaneous values\" or \"IV\".\n", "operationId":"describeContinuousCollection", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Collection" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "summary":"Get Continuous values metadata", "tags":[ "continuous" ] } }, "/collections/continuous/items":{ "get":{ "description":"This is an early version of the continuous endpoint. It is feature-complete and provides access to the full continuous data record, and is being made available as we continue to work on performance improvements.\nContinuous data are collected via automated sensors installed at a monitoring location. They are collected at a high frequency and often at a fixed 15-minute interval. Depending on the specific monitoring location, the data may be transmitted automatically via telemetry and be available on WDFN within minutes of collection, while other times the delivery of data may be delayed if the monitoring location does not have the capacity to automatically transmit data. Continuous data are described by parameter name and parameter code (pcode). These data might also be referred to as \"instantaneous values\" or \"IV\".\n", "operationId":"getContinuousFeatures", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" }, { "$ref":"#/components/parameters/bbox" }, { "description":"The optional limit parameter limits the number of items that are presented in the response document (maximum=50000, default=10).", "explode":false, "in":"query", "name":"limit", "required":false, "schema":{ "default":10, "maximum":50000, "minimum":1, "type":"integer" }, "style":"form" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/bbox-crs" }, { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "internal_id", "time_series_id", "monitoring_location_id", "parameter_code", "statistic_id", "time", "value", "unit_of_measure", "approval_status", "qualifier", "last_modified" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/skipGeometry" }, { "$ref":"#/components/parameters/wda_sortby" }, { "$ref":"#/components/parameters/offset" }, { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/datetime" }, { "description":"A unique identifier representing a single time series. This corresponds to the `id` field in the `time-series-metadata` endpoint.\n Split parameters are enabled for this field, so you can supply multiple values separated by commas.", "explode":false, "in":"query", "name":"time_series_id", "required":false, "schema":{ "description":"A unique identifier representing a single time series. This corresponds to the `id` field in the `time-series-metadata` endpoint.\n Split parameters are enabled for this field, so you can supply multiple values separated by commas.", "title":"Time series ID", "type":"string" }, "style":"form" }, { "description":"A unique identifier representing a single monitoring location. This corresponds to the `id` field in the `monitoring-locations` endpoint. Monitoring location IDs are created by combining the agency code of the agency responsible for the monitoring location (e.g. USGS) with the ID number of the monitoring location (e.g. 02238500), separated by a hyphen (e.g. USGS-02238500).\n Split parameters are enabled for this field, so you can supply multiple values separated by commas.", "explode":false, "in":"query", "name":"monitoring_location_id", "required":false, "schema":{ "description":"A unique identifier representing a single monitoring location. This corresponds to the `id` field in the `monitoring-locations` endpoint. Monitoring location IDs are created by combining the agency code of the agency responsible for the monitoring location (e.g. USGS) with the ID number of the monitoring location (e.g. 02238500), separated by a hyphen (e.g. USGS-02238500).\n Split parameters are enabled for this field, so you can supply multiple values separated by commas.", "title":"Monitoring location ID", "type":"string" }, "style":"form" }, { "description":"Parameter codes are 5-digit codes used to identify the constituent measured and the units of measure. A complete list of parameter codes and associated groupings can be found at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/parameter-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/parameter-codes/items).\n Split parameters are enabled for this field, so you can supply multiple values separated by commas.", "explode":false, "in":"query", "name":"parameter_code", "required":false, "schema":{ "description":"Parameter codes are 5-digit codes used to identify the constituent measured and the units of measure. A complete list of parameter codes and associated groupings can be found at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/parameter-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/parameter-codes/items).\n Split parameters are enabled for this field, so you can supply multiple values separated by commas.", "title":"Parameter code", "type":"string" }, "style":"form" }, { "description":"A code corresponding to the statistic an observation represents. Example codes include 00001 (max), 00002 (min), and 00003 (mean). A complete list of codes and their descriptions can be found at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/statistic-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/statistic-codes/items).\n", "explode":false, "in":"query", "name":"statistic_id", "required":false, "schema":{ "description":"A code corresponding to the statistic an observation represents. Example codes include 00001 (max), 00002 (min), and 00003 (mean). A complete list of codes and their descriptions can be found at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/statistic-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/statistic-codes/items).\n", "title":"Statistic ID", "type":"string" }, "style":"form" }, { "description":"The date an observation represents. You can query this field using date-times or intervals, adhering to RFC 3339, or using ISO 8601 duration objects. Intervals may be bounded or half-bounded (double-dots at start or end).\nExamples:\n\n - A date-time: \"2018-02-12T23:20:50Z\"\n - A bounded interval: \"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z\"\n - Half-bounded intervals: \"2018-02-12T00:00:00Z/..\" or \"../2018-03-18T12:31:12Z\"\n - Duration objects: \"P1M\" for data from the past month or \"PT36H\" for the last 36 hours\n\nOnly features that have a `time` that intersects the value of datetime are selected. If a feature has multiple temporal properties, it is the decision of the server whether only a single temporal property is used to determine the extent or all relevant temporal properties.\n", "explode":false, "in":"query", "name":"time", "required":false, "schema":{ "description":"The date an observation represents. You can query this field using date-times or intervals, adhering to RFC 3339, or using ISO 8601 duration objects. Intervals may be bounded or half-bounded (double-dots at start or end).\nExamples:\n\n - A date-time: \"2018-02-12T23:20:50Z\"\n - A bounded interval: \"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z\"\n - Half-bounded intervals: \"2018-02-12T00:00:00Z/..\" or \"../2018-03-18T12:31:12Z\"\n - Duration objects: \"P1M\" for data from the past month or \"PT36H\" for the last 36 hours\n\nOnly features that have a `time` that intersects the value of datetime are selected. If a feature has multiple temporal properties, it is the decision of the server whether only a single temporal property is used to determine the extent or all relevant temporal properties.\n", "title":"Time", "type":"string" }, "style":"form" }, { "description":"The value of the observation. Values are transmitted as strings in the JSON response format in order to preserve precision.\n", "explode":false, "in":"query", "name":"value", "required":false, "schema":{ "description":"The value of the observation. Values are transmitted as strings in the JSON response format in order to preserve precision.\n", "title":"Value", "type":"string" }, "style":"form" }, { "description":"A human-readable description of the units of measurement associated with an observation.", "explode":false, "in":"query", "name":"unit_of_measure", "required":false, "schema":{ "description":"A human-readable description of the units of measurement associated with an observation.", "title":"Unit of measure", "type":"string" }, "style":"form" }, { "description":"Some of the data that you have obtained from this U.S. Geological Survey database may not have received Director's approval. Any such data values are qualified as provisional and are subject to revision. Provisional data are released on the condition that neither the USGS nor the United States Government may be held liable for any damages resulting from its use. This field reflects the approval status of each record, and is either \"Approved\", meaining processing review has been completed and the data is approved for publication, or \"Provisional\" and subject to revision. For more information about provisional data, go to [https://waterdata.usgs.gov/provisional-data-statement/](https://waterdata.usgs.gov/provisional-data-statement/).\n", "explode":false, "in":"query", "name":"approval_status", "required":false, "schema":{ "description":"Some of the data that you have obtained from this U.S. Geological Survey database may not have received Director's approval. Any such data values are qualified as provisional and are subject to revision. Provisional data are released on the condition that neither the USGS nor the United States Government may be held liable for any damages resulting from its use. This field reflects the approval status of each record, and is either \"Approved\", meaining processing review has been completed and the data is approved for publication, or \"Provisional\" and subject to revision. For more information about provisional data, go to [https://waterdata.usgs.gov/provisional-data-statement/](https://waterdata.usgs.gov/provisional-data-statement/).\n", "enum":[ "Provisional", "Approved" ], "title":"Approval Status", "type":"string" }, "style":"form" }, { "description":"This field indicates any qualifiers associated with an observation, for instance if a sensor may have been impacted by ice or if values were estimated.\n", "explode":false, "in":"query", "name":"qualifier", "required":false, "schema":{ "description":"This field indicates any qualifiers associated with an observation, for instance if a sensor may have been impacted by ice or if values were estimated.\n", "title":"Qualifier", "type":"string" }, "style":"form" }, { "description":"The last time a record was refreshed in our database. This may happen due to regular operational processes and does not necessarily indicate anything about the measurement has changed.\nYou can query this field using date-times or intervals, adhering to RFC 3339, or using ISO 8601 duration objects. Intervals may be bounded or half-bounded (double-dots at start or end).\nExamples:\n\n - A date-time: \"2018-02-12T23:20:50Z\"\n - A bounded interval: \"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z\"\n - Half-bounded intervals: \"2018-02-12T00:00:00Z/..\" or \"../2018-03-18T12:31:12Z\"\n - Duration objects: \"P1M\" for data from the past month or \"PT36H\" for the last 36 hours\n\nOnly features that have a `last_modified` that intersects the value of datetime are selected.\n", "explode":false, "in":"query", "name":"last_modified", "required":false, "schema":{ "description":"The last time a record was refreshed in our database. This may happen due to regular operational processes and does not necessarily indicate anything about the measurement has changed.\nYou can query this field using date-times or intervals, adhering to RFC 3339, or using ISO 8601 duration objects. Intervals may be bounded or half-bounded (double-dots at start or end).\nExamples:\n\n - A date-time: \"2018-02-12T23:20:50Z\"\n - A bounded interval: \"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z\"\n - Half-bounded intervals: \"2018-02-12T00:00:00Z/..\" or \"../2018-03-18T12:31:12Z\"\n - Duration objects: \"P1M\" for data from the past month or \"PT36H\" for the last 36 hours\n\nOnly features that have a `last_modified` that intersects the value of datetime are selected.\n", "title":"Last modified date", "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Continuous values items", "tags":[ "continuous" ] }, "options":{ "description":"This is an early version of the continuous endpoint. It is feature-complete and provides access to the full continuous data record, and is being made available as we continue to work on performance improvements.\nContinuous data are collected via automated sensors installed at a monitoring location. They are collected at a high frequency and often at a fixed 15-minute interval. Depending on the specific monitoring location, the data may be transmitted automatically via telemetry and be available on WDFN within minutes of collection, while other times the delivery of data may be delayed if the monitoring location does not have the capacity to automatically transmit data. Continuous data are described by parameter name and parameter code (pcode). These data might also be referred to as \"instantaneous values\" or \"IV\".\n", "operationId":"optionsContinuousFeatures", "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for Continuous values items", "tags":[ "continuous" ] }, "post":{ "description":"This is an early version of the continuous endpoint. It is feature-complete and provides access to the full continuous data record, and is being made available as we continue to work on performance improvements.\nContinuous data are collected via automated sensors installed at a monitoring location. They are collected at a high frequency and often at a fixed 15-minute interval. Depending on the specific monitoring location, the data may be transmitted automatically via telemetry and be available on WDFN within minutes of collection, while other times the delivery of data may be delayed if the monitoring location does not have the capacity to automatically transmit data. Continuous data are described by parameter name and parameter code (pcode). These data might also be referred to as \"instantaneous values\" or \"IV\".\n", "operationId":"getCQL2ContinuousFeatures", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"https://schemas.opengis.net/cql2/1.0/cql2.json" } } }, "description":"Get items with CQL2", "required":true }, "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Continuous values items with CQL2", "tags":[ "continuous" ] } }, "/collections/continuous/items/{featureId}":{ "get":{ "description":"This is an early version of the continuous endpoint. It is feature-complete and provides access to the full continuous data record, and is being made available as we continue to work on performance improvements.\nContinuous data are collected via automated sensors installed at a monitoring location. They are collected at a high frequency and often at a fixed 15-minute interval. Depending on the specific monitoring location, the data may be transmitted automatically via telemetry and be available on WDFN within minutes of collection, while other times the delivery of data may be delayed if the monitoring location does not have the capacity to automatically transmit data. Continuous data are described by parameter name and parameter code (pcode). These data might also be referred to as \"instantaneous values\" or \"IV\".\n", "operationId":"getContinuousFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Feature" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Continuous values item by id", "tags":[ "continuous" ] }, "options":{ "description":"This is an early version of the continuous endpoint. It is feature-complete and provides access to the full continuous data record, and is being made available as we continue to work on performance improvements.\nContinuous data are collected via automated sensors installed at a monitoring location. They are collected at a high frequency and often at a fixed 15-minute interval. Depending on the specific monitoring location, the data may be transmitted automatically via telemetry and be available on WDFN within minutes of collection, while other times the delivery of data may be delayed if the monitoring location does not have the capacity to automatically transmit data. Continuous data are described by parameter name and parameter code (pcode). These data might also be referred to as \"instantaneous values\" or \"IV\".\n", "operationId":"optionsContinuousFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" } ], "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for Continuous values item by id", "tags":[ "continuous" ] } }, "/collections/continuous/queryables":{ "get":{ "description":"This is an early version of the continuous endpoint. It is feature-complete and provides access to the full continuous data record, and is being made available as we continue to work on performance improvements.\nContinuous data are collected via automated sensors installed at a monitoring location. They are collected at a high frequency and often at a fixed 15-minute interval. Depending on the specific monitoring location, the data may be transmitted automatically via telemetry and be available on WDFN within minutes of collection, while other times the delivery of data may be delayed if the monitoring location does not have the capacity to automatically transmit data. Continuous data are described by parameter name and parameter code (pcode). These data might also be referred to as \"instantaneous values\" or \"IV\".\n", "operationId":"getContinuousQueryables", "parameters":[ { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "internal_id", "time_series_id", "monitoring_location_id", "parameter_code", "statistic_id", "time", "value", "unit_of_measure", "approval_status", "qualifier", "last_modified" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/f" }, { "description":"The profile to be applied to a given request", "explode":false, "in":"query", "name":"profile", "required":false, "schema":{ "enum":[ "actual-domain", "valid-domain" ], "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Continuous values queryables", "tags":[ "continuous" ] } }, "/collections/continuous/schema":{ "get":{ "description":"This is an early version of the continuous endpoint. It is feature-complete and provides access to the full continuous data record, and is being made available as we continue to work on performance improvements.\nContinuous data are collected via automated sensors installed at a monitoring location. They are collected at a high frequency and often at a fixed 15-minute interval. Depending on the specific monitoring location, the data may be transmitted automatically via telemetry and be available on WDFN within minutes of collection, while other times the delivery of data may be delayed if the monitoring location does not have the capacity to automatically transmit data. Continuous data are described by parameter name and parameter code (pcode). These data might also be referred to as \"instantaneous values\" or \"IV\".\n", "operationId":"getContinuousSchema", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Continuous values schema", "tags":[ "continuous" ] } }, "/collections/coordinate-accuracy-codes":{ "get":{ "description":"Appropriate code on the schedule to indicate the accuracy of the latitude-longitude values.\n", "operationId":"describeCoordinate-accuracy-codesCollection", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Collection" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "summary":"Get Coordinate accuracy codes metadata", "tags":[ "coordinate-accuracy-codes" ] } }, "/collections/coordinate-accuracy-codes/items":{ "get":{ "description":"Appropriate code on the schedule to indicate the accuracy of the latitude-longitude values.\n", "operationId":"getCoordinate-accuracy-codesFeatures", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" }, { "$ref":"#/components/parameters/bbox" }, { "description":"The optional limit parameter limits the number of items that are presented in the response document (maximum=50000, default=10000).", "explode":false, "in":"query", "name":"limit", "required":false, "schema":{ "default":10000, "maximum":50000, "minimum":1, "type":"integer" }, "style":"form" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/bbox-crs" }, { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "coordinate_accuracy_description" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/skipGeometry" }, { "$ref":"https://raw.githubusercontent.com/opengeospatial/ogcapi-records/master/core/openapi/parameters/sortby.yaml" }, { "$ref":"#/components/parameters/offset" }, { "explode":false, "in":"query", "name":"id", "required":false, "schema":{ "type":"string" }, "style":"form" }, { "explode":false, "in":"query", "name":"coordinate_accuracy_description", "required":false, "schema":{ "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Coordinate accuracy codes items", "tags":[ "coordinate-accuracy-codes" ] }, "options":{ "description":"Appropriate code on the schedule to indicate the accuracy of the latitude-longitude values.\n", "operationId":"optionsCoordinate-accuracy-codesFeatures", "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for Coordinate accuracy codes items", "tags":[ "coordinate-accuracy-codes" ] }, "post":{ "description":"Appropriate code on the schedule to indicate the accuracy of the latitude-longitude values.\n", "operationId":"getCQL2Coordinate-accuracy-codesFeatures", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"https://schemas.opengis.net/cql2/1.0/cql2.json" } } }, "description":"Get items with CQL2", "required":true }, "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Coordinate accuracy codes items with CQL2", "tags":[ "coordinate-accuracy-codes" ] } }, "/collections/coordinate-accuracy-codes/items/{featureId}":{ "get":{ "description":"Appropriate code on the schedule to indicate the accuracy of the latitude-longitude values.\n", "operationId":"getCoordinate-accuracy-codesFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Feature" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Coordinate accuracy codes item by id", "tags":[ "coordinate-accuracy-codes" ] }, "options":{ "description":"Appropriate code on the schedule to indicate the accuracy of the latitude-longitude values.\n", "operationId":"optionsCoordinate-accuracy-codesFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" } ], "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for Coordinate accuracy codes item by id", "tags":[ "coordinate-accuracy-codes" ] } }, "/collections/coordinate-accuracy-codes/queryables":{ "get":{ "description":"Appropriate code on the schedule to indicate the accuracy of the latitude-longitude values.\n", "operationId":"getCoordinate-accuracy-codesQueryables", "parameters":[ { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "coordinate_accuracy_description" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/f" }, { "description":"The profile to be applied to a given request", "explode":false, "in":"query", "name":"profile", "required":false, "schema":{ "enum":[ "actual-domain", "valid-domain" ], "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Coordinate accuracy codes queryables", "tags":[ "coordinate-accuracy-codes" ] } }, "/collections/coordinate-accuracy-codes/schema":{ "get":{ "description":"Appropriate code on the schedule to indicate the accuracy of the latitude-longitude values.\n", "operationId":"getCoordinate-accuracy-codesSchema", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Coordinate accuracy codes schema", "tags":[ "coordinate-accuracy-codes" ] } }, "/collections/coordinate-datum-codes":{ "get":{ "description":"Horizontal datum code for the latitude/longitude coordinates. There are currently more than 300 horizontal datums available for entry.\n", "operationId":"describeCoordinate-datum-codesCollection", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Collection" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "summary":"Get Coordinate datum codes metadata", "tags":[ "coordinate-datum-codes" ] } }, "/collections/coordinate-datum-codes/items":{ "get":{ "description":"Horizontal datum code for the latitude/longitude coordinates. There are currently more than 300 horizontal datums available for entry.\n", "operationId":"getCoordinate-datum-codesFeatures", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" }, { "$ref":"#/components/parameters/bbox" }, { "description":"The optional limit parameter limits the number of items that are presented in the response document (maximum=50000, default=10000).", "explode":false, "in":"query", "name":"limit", "required":false, "schema":{ "default":10000, "maximum":50000, "minimum":1, "type":"integer" }, "style":"form" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/bbox-crs" }, { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "coordinate_datum_description" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/skipGeometry" }, { "$ref":"https://raw.githubusercontent.com/opengeospatial/ogcapi-records/master/core/openapi/parameters/sortby.yaml" }, { "$ref":"#/components/parameters/offset" }, { "explode":false, "in":"query", "name":"id", "required":false, "schema":{ "type":"string" }, "style":"form" }, { "explode":false, "in":"query", "name":"coordinate_datum_description", "required":false, "schema":{ "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Coordinate datum codes items", "tags":[ "coordinate-datum-codes" ] }, "options":{ "description":"Horizontal datum code for the latitude/longitude coordinates. There are currently more than 300 horizontal datums available for entry.\n", "operationId":"optionsCoordinate-datum-codesFeatures", "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for Coordinate datum codes items", "tags":[ "coordinate-datum-codes" ] }, "post":{ "description":"Horizontal datum code for the latitude/longitude coordinates. There are currently more than 300 horizontal datums available for entry.\n", "operationId":"getCQL2Coordinate-datum-codesFeatures", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"https://schemas.opengis.net/cql2/1.0/cql2.json" } } }, "description":"Get items with CQL2", "required":true }, "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Coordinate datum codes items with CQL2", "tags":[ "coordinate-datum-codes" ] } }, "/collections/coordinate-datum-codes/items/{featureId}":{ "get":{ "description":"Horizontal datum code for the latitude/longitude coordinates. There are currently more than 300 horizontal datums available for entry.\n", "operationId":"getCoordinate-datum-codesFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Feature" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Coordinate datum codes item by id", "tags":[ "coordinate-datum-codes" ] }, "options":{ "description":"Horizontal datum code for the latitude/longitude coordinates. There are currently more than 300 horizontal datums available for entry.\n", "operationId":"optionsCoordinate-datum-codesFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" } ], "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for Coordinate datum codes item by id", "tags":[ "coordinate-datum-codes" ] } }, "/collections/coordinate-datum-codes/queryables":{ "get":{ "description":"Horizontal datum code for the latitude/longitude coordinates. There are currently more than 300 horizontal datums available for entry.\n", "operationId":"getCoordinate-datum-codesQueryables", "parameters":[ { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "coordinate_datum_description" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/f" }, { "description":"The profile to be applied to a given request", "explode":false, "in":"query", "name":"profile", "required":false, "schema":{ "enum":[ "actual-domain", "valid-domain" ], "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Coordinate datum codes queryables", "tags":[ "coordinate-datum-codes" ] } }, "/collections/coordinate-datum-codes/schema":{ "get":{ "description":"Horizontal datum code for the latitude/longitude coordinates. There are currently more than 300 horizontal datums available for entry.\n", "operationId":"getCoordinate-datum-codesSchema", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Coordinate datum codes schema", "tags":[ "coordinate-datum-codes" ] } }, "/collections/coordinate-method-codes":{ "get":{ "description":"Methods used to determine latitude-longitude values.\n", "operationId":"describeCoordinate-method-codesCollection", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Collection" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "summary":"Get Coordinate method codes metadata", "tags":[ "coordinate-method-codes" ] } }, "/collections/coordinate-method-codes/items":{ "get":{ "description":"Methods used to determine latitude-longitude values.\n", "operationId":"getCoordinate-method-codesFeatures", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" }, { "$ref":"#/components/parameters/bbox" }, { "description":"The optional limit parameter limits the number of items that are presented in the response document (maximum=50000, default=10000).", "explode":false, "in":"query", "name":"limit", "required":false, "schema":{ "default":10000, "maximum":50000, "minimum":1, "type":"integer" }, "style":"form" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/bbox-crs" }, { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "coordinate_method_description" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/skipGeometry" }, { "$ref":"https://raw.githubusercontent.com/opengeospatial/ogcapi-records/master/core/openapi/parameters/sortby.yaml" }, { "$ref":"#/components/parameters/offset" }, { "explode":false, "in":"query", "name":"id", "required":false, "schema":{ "type":"string" }, "style":"form" }, { "explode":false, "in":"query", "name":"coordinate_method_description", "required":false, "schema":{ "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Coordinate method codes items", "tags":[ "coordinate-method-codes" ] }, "options":{ "description":"Methods used to determine latitude-longitude values.\n", "operationId":"optionsCoordinate-method-codesFeatures", "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for Coordinate method codes items", "tags":[ "coordinate-method-codes" ] }, "post":{ "description":"Methods used to determine latitude-longitude values.\n", "operationId":"getCQL2Coordinate-method-codesFeatures", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"https://schemas.opengis.net/cql2/1.0/cql2.json" } } }, "description":"Get items with CQL2", "required":true }, "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Coordinate method codes items with CQL2", "tags":[ "coordinate-method-codes" ] } }, "/collections/coordinate-method-codes/items/{featureId}":{ "get":{ "description":"Methods used to determine latitude-longitude values.\n", "operationId":"getCoordinate-method-codesFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Feature" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Coordinate method codes item by id", "tags":[ "coordinate-method-codes" ] }, "options":{ "description":"Methods used to determine latitude-longitude values.\n", "operationId":"optionsCoordinate-method-codesFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" } ], "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for Coordinate method codes item by id", "tags":[ "coordinate-method-codes" ] } }, "/collections/coordinate-method-codes/queryables":{ "get":{ "description":"Methods used to determine latitude-longitude values.\n", "operationId":"getCoordinate-method-codesQueryables", "parameters":[ { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "coordinate_method_description" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/f" }, { "description":"The profile to be applied to a given request", "explode":false, "in":"query", "name":"profile", "required":false, "schema":{ "enum":[ "actual-domain", "valid-domain" ], "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Coordinate method codes queryables", "tags":[ "coordinate-method-codes" ] } }, "/collections/coordinate-method-codes/schema":{ "get":{ "description":"Methods used to determine latitude-longitude values.\n", "operationId":"getCoordinate-method-codesSchema", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Coordinate method codes schema", "tags":[ "coordinate-method-codes" ] } }, "/collections/counties":{ "get":{ "description":"The name of the county or county equivalent (parish, borough, planning reagion, etc.) in which the site is located. List includes Census Bureau FIPS county codes, names and associated Country and State.\n", "operationId":"describeCountiesCollection", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Collection" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "summary":"Get County identifiers metadata", "tags":[ "counties" ] } }, "/collections/counties/items":{ "get":{ "description":"The name of the county or county equivalent (parish, borough, planning reagion, etc.) in which the site is located. List includes Census Bureau FIPS county codes, names and associated Country and State.\n", "operationId":"getCountiesFeatures", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" }, { "$ref":"#/components/parameters/bbox" }, { "description":"The optional limit parameter limits the number of items that are presented in the response document (maximum=50000, default=10000).", "explode":false, "in":"query", "name":"limit", "required":false, "schema":{ "default":10000, "maximum":50000, "minimum":1, "type":"integer" }, "style":"form" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/bbox-crs" }, { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "country_code", "state_fips_code", "county_fips_code", "county_name" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/skipGeometry" }, { "$ref":"https://raw.githubusercontent.com/opengeospatial/ogcapi-records/master/core/openapi/parameters/sortby.yaml" }, { "$ref":"#/components/parameters/offset" }, { "explode":false, "in":"query", "name":"id", "required":false, "schema":{ "type":"string" }, "style":"form" }, { "description":"FIPS country code as defined by FIPS PUB 10-4: Countries, Dependencies, Areas of Special Sovereignty, and Their Principal Administrative Divisions.", "explode":false, "in":"query", "name":"country_code", "required":false, "schema":{ "description":"FIPS country code as defined by FIPS PUB 10-4: Countries, Dependencies, Areas of Special Sovereignty, and Their Principal Administrative Divisions.", "type":"string" }, "style":"form" }, { "description":"State FIPS code.", "explode":false, "in":"query", "name":"state_fips_code", "required":false, "schema":{ "description":"State FIPS code.", "type":"string" }, "style":"form" }, { "description":"County FIPS code. A two digit code indicating a U.S. county as defined by FIPS 5-2.", "explode":false, "in":"query", "name":"county_fips_code", "required":false, "schema":{ "description":"County FIPS code. A two digit code indicating a U.S. county as defined by FIPS 5-2.", "type":"string" }, "style":"form" }, { "description":"County name. The name of a U.S. county as defined by FIPS 5-2.", "explode":false, "in":"query", "name":"county_name", "required":false, "schema":{ "description":"County name. The name of a U.S. county as defined by FIPS 5-2.", "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get County identifiers items", "tags":[ "counties" ] }, "options":{ "description":"The name of the county or county equivalent (parish, borough, planning reagion, etc.) in which the site is located. List includes Census Bureau FIPS county codes, names and associated Country and State.\n", "operationId":"optionsCountiesFeatures", "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for County identifiers items", "tags":[ "counties" ] }, "post":{ "description":"The name of the county or county equivalent (parish, borough, planning reagion, etc.) in which the site is located. List includes Census Bureau FIPS county codes, names and associated Country and State.\n", "operationId":"getCQL2CountiesFeatures", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"https://schemas.opengis.net/cql2/1.0/cql2.json" } } }, "description":"Get items with CQL2", "required":true }, "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get County identifiers items with CQL2", "tags":[ "counties" ] } }, "/collections/counties/items/{featureId}":{ "get":{ "description":"The name of the county or county equivalent (parish, borough, planning reagion, etc.) in which the site is located. List includes Census Bureau FIPS county codes, names and associated Country and State.\n", "operationId":"getCountiesFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Feature" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get County identifiers item by id", "tags":[ "counties" ] }, "options":{ "description":"The name of the county or county equivalent (parish, borough, planning reagion, etc.) in which the site is located. List includes Census Bureau FIPS county codes, names and associated Country and State.\n", "operationId":"optionsCountiesFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" } ], "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for County identifiers item by id", "tags":[ "counties" ] } }, "/collections/counties/queryables":{ "get":{ "description":"The name of the county or county equivalent (parish, borough, planning reagion, etc.) in which the site is located. List includes Census Bureau FIPS county codes, names and associated Country and State.\n", "operationId":"getCountiesQueryables", "parameters":[ { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "country_code", "state_fips_code", "county_fips_code", "county_name" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/f" }, { "description":"The profile to be applied to a given request", "explode":false, "in":"query", "name":"profile", "required":false, "schema":{ "enum":[ "actual-domain", "valid-domain" ], "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get County identifiers queryables", "tags":[ "counties" ] } }, "/collections/counties/schema":{ "get":{ "description":"The name of the county or county equivalent (parish, borough, planning reagion, etc.) in which the site is located. List includes Census Bureau FIPS county codes, names and associated Country and State.\n", "operationId":"getCountiesSchema", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get County identifiers schema", "tags":[ "counties" ] } }, "/collections/daily":{ "get":{ "description":"Daily data provide one data value to represent water conditions for the day. Throughout much of the history of the USGS, the primary water data available was daily data collected manually at the monitoring location once each day. With improved availability of computer storage and automated transmission of data, the daily data published today are generally a statistical summary or metric of the continuous data collected each day, such as the daily mean, minimum, or maximum value. Daily data are automatically calculated from the continuous data of the same parameter code and are described by parameter code and a statistic code. These data have also been referred to as \u201cdaily values\u201d or \u201cDV\u201d.\n", "operationId":"describeDailyCollection", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Collection" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "summary":"Get Daily values metadata", "tags":[ "daily" ] } }, "/collections/daily/items":{ "get":{ "description":"Daily data provide one data value to represent water conditions for the day. Throughout much of the history of the USGS, the primary water data available was daily data collected manually at the monitoring location once each day. With improved availability of computer storage and automated transmission of data, the daily data published today are generally a statistical summary or metric of the continuous data collected each day, such as the daily mean, minimum, or maximum value. Daily data are automatically calculated from the continuous data of the same parameter code and are described by parameter code and a statistic code. These data have also been referred to as \u201cdaily values\u201d or \u201cDV\u201d.\n", "operationId":"getDailyFeatures", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" }, { "$ref":"#/components/parameters/bbox" }, { "description":"The optional limit parameter limits the number of items that are presented in the response document (maximum=50000, default=10).", "explode":false, "in":"query", "name":"limit", "required":false, "schema":{ "default":10, "maximum":50000, "minimum":1, "type":"integer" }, "style":"form" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/bbox-crs" }, { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "time_series_id", "monitoring_location_id", "parameter_code", "statistic_id", "time", "value", "unit_of_measure", "approval_status", "qualifier", "last_modified" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/skipGeometry" }, { "$ref":"#/components/parameters/wda_sortby" }, { "$ref":"#/components/parameters/offset" }, { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/datetime" }, { "description":"A universally unique identifier (UUID) representing a single version of a record. It is not stable over time. Every time the record is refreshed in our database (which may happen as part of normal operations and does not imply any change to the data itself) a new ID will be generated. To uniquely identify a single observation over time, compare the `time` and `time_series_id` fields; each time series will only have a single observation at a given `time`.\n", "explode":false, "in":"query", "name":"id", "required":false, "schema":{ "description":"A universally unique identifier (UUID) representing a single version of a record. It is not stable over time. Every time the record is refreshed in our database (which may happen as part of normal operations and does not imply any change to the data itself) a new ID will be generated. To uniquely identify a single observation over time, compare the `time` and `time_series_id` fields; each time series will only have a single observation at a given `time`.\n", "format":"uuid", "type":"string" }, "style":"form" }, { "description":"A unique identifier representing a single time series. This corresponds to the `id` field in the `time-series-metadata` endpoint.\n Split parameters are enabled for this field, so you can supply multiple values separated by commas.", "explode":false, "in":"query", "name":"time_series_id", "required":false, "schema":{ "description":"A unique identifier representing a single time series. This corresponds to the `id` field in the `time-series-metadata` endpoint.\n Split parameters are enabled for this field, so you can supply multiple values separated by commas.", "title":"Time series ID", "type":"string" }, "style":"form" }, { "description":"A unique identifier representing a single monitoring location. This corresponds to the `id` field in the `monitoring-locations` endpoint. Monitoring location IDs are created by combining the agency code of the agency responsible for the monitoring location (e.g. USGS) with the ID number of the monitoring location (e.g. 02238500), separated by a hyphen (e.g. USGS-02238500).\n Split parameters are enabled for this field, so you can supply multiple values separated by commas.", "explode":false, "in":"query", "name":"monitoring_location_id", "required":false, "schema":{ "description":"A unique identifier representing a single monitoring location. This corresponds to the `id` field in the `monitoring-locations` endpoint. Monitoring location IDs are created by combining the agency code of the agency responsible for the monitoring location (e.g. USGS) with the ID number of the monitoring location (e.g. 02238500), separated by a hyphen (e.g. USGS-02238500).\n Split parameters are enabled for this field, so you can supply multiple values separated by commas.", "title":"Monitoring location ID", "type":"string" }, "style":"form" }, { "description":"Parameter codes are 5-digit codes used to identify the constituent measured and the units of measure. A complete list of parameter codes and associated groupings can be found at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/parameter-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/parameter-codes/items).\n Split parameters are enabled for this field, so you can supply multiple values separated by commas.", "explode":false, "in":"query", "name":"parameter_code", "required":false, "schema":{ "description":"Parameter codes are 5-digit codes used to identify the constituent measured and the units of measure. A complete list of parameter codes and associated groupings can be found at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/parameter-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/parameter-codes/items).\n Split parameters are enabled for this field, so you can supply multiple values separated by commas.", "title":"Parameter code", "type":"string" }, "style":"form" }, { "description":"A code corresponding to the statistic an observation represents. Example codes include 00001 (max), 00002 (min), and 00003 (mean). A complete list of codes and their descriptions can be found at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/statistic-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/statistic-codes/items).\n Split parameters are enabled for this field, so you can supply multiple values separated by commas.", "explode":false, "in":"query", "name":"statistic_id", "required":false, "schema":{ "description":"A code corresponding to the statistic an observation represents. Example codes include 00001 (max), 00002 (min), and 00003 (mean). A complete list of codes and their descriptions can be found at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/statistic-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/statistic-codes/items).\n Split parameters are enabled for this field, so you can supply multiple values separated by commas.", "title":"Statistic ID", "type":"string" }, "style":"form" }, { "description":"The date an observation represents. You can query this field using date-times or intervals, adhering to RFC 3339, or using ISO 8601 duration objects. Intervals may be bounded or half-bounded (double-dots at start or end).\nExamples:\n\n - A date-time: \"2018-02-12T23:20:50Z\"\n - A bounded interval: \"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z\"\n - Half-bounded intervals: \"2018-02-12T00:00:00Z/..\" or \"../2018-03-18T12:31:12Z\"\n - Duration objects: \"P1M\" for data from the past month or \"PT36H\" for the last 36 hours\n\nOnly features that have a `time` that intersects the value of datetime are selected. If a feature has multiple temporal properties, it is the decision of the server whether only a single temporal property is used to determine the extent or all relevant temporal properties.\n", "explode":false, "in":"query", "name":"time", "required":false, "schema":{ "description":"The date an observation represents. You can query this field using date-times or intervals, adhering to RFC 3339, or using ISO 8601 duration objects. Intervals may be bounded or half-bounded (double-dots at start or end).\nExamples:\n\n - A date-time: \"2018-02-12T23:20:50Z\"\n - A bounded interval: \"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z\"\n - Half-bounded intervals: \"2018-02-12T00:00:00Z/..\" or \"../2018-03-18T12:31:12Z\"\n - Duration objects: \"P1M\" for data from the past month or \"PT36H\" for the last 36 hours\n\nOnly features that have a `time` that intersects the value of datetime are selected. If a feature has multiple temporal properties, it is the decision of the server whether only a single temporal property is used to determine the extent or all relevant temporal properties.\n", "title":"Time", "type":"string" }, "style":"form" }, { "description":"The value of the observation. Values are transmitted as strings in the JSON response format in order to preserve precision.\n", "explode":false, "in":"query", "name":"value", "required":false, "schema":{ "description":"The value of the observation. Values are transmitted as strings in the JSON response format in order to preserve precision.\n", "title":"Value", "type":"string" }, "style":"form" }, { "description":"A human-readable description of the units of measurement associated with an observation.", "explode":false, "in":"query", "name":"unit_of_measure", "required":false, "schema":{ "description":"A human-readable description of the units of measurement associated with an observation.", "title":"Unit of measure", "type":"string" }, "style":"form" }, { "description":"Some of the data that you have obtained from this U.S. Geological Survey database may not have received Director's approval. Any such data values are qualified as provisional and are subject to revision. Provisional data are released on the condition that neither the USGS nor the United States Government may be held liable for any damages resulting from its use. This field reflects the approval status of each record, and is either \"Approved\", meaining processing review has been completed and the data is approved for publication, or \"Provisional\" and subject to revision. For more information about provisional data, go to [https://waterdata.usgs.gov/provisional-data-statement/](https://waterdata.usgs.gov/provisional-data-statement/).\n", "explode":false, "in":"query", "name":"approval_status", "required":false, "schema":{ "description":"Some of the data that you have obtained from this U.S. Geological Survey database may not have received Director's approval. Any such data values are qualified as provisional and are subject to revision. Provisional data are released on the condition that neither the USGS nor the United States Government may be held liable for any damages resulting from its use. This field reflects the approval status of each record, and is either \"Approved\", meaining processing review has been completed and the data is approved for publication, or \"Provisional\" and subject to revision. For more information about provisional data, go to [https://waterdata.usgs.gov/provisional-data-statement/](https://waterdata.usgs.gov/provisional-data-statement/).\n", "enum":[ "Provisional", "Approved" ], "title":"Approval Status", "type":"string" }, "style":"form" }, { "description":"This field indicates any qualifiers associated with an observation, for instance if a sensor may have been impacted by ice or if values were estimated.\n", "explode":false, "in":"query", "name":"qualifier", "required":false, "schema":{ "description":"This field indicates any qualifiers associated with an observation, for instance if a sensor may have been impacted by ice or if values were estimated.\n", "title":"Qualifier", "type":"string" }, "style":"form" }, { "description":"The last time a record was refreshed in our database. This may happen due to regular operational processes and does not necessarily indicate anything about the measurement has changed.\nYou can query this field using date-times or intervals, adhering to RFC 3339, or using ISO 8601 duration objects. Intervals may be bounded or half-bounded (double-dots at start or end).\nExamples:\n\n - A date-time: \"2018-02-12T23:20:50Z\"\n - A bounded interval: \"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z\"\n - Half-bounded intervals: \"2018-02-12T00:00:00Z/..\" or \"../2018-03-18T12:31:12Z\"\n - Duration objects: \"P1M\" for data from the past month or \"PT36H\" for the last 36 hours\n\nOnly features that have a `last_modified` that intersects the value of datetime are selected.\n", "explode":false, "in":"query", "name":"last_modified", "required":false, "schema":{ "description":"The last time a record was refreshed in our database. This may happen due to regular operational processes and does not necessarily indicate anything about the measurement has changed.\nYou can query this field using date-times or intervals, adhering to RFC 3339, or using ISO 8601 duration objects. Intervals may be bounded or half-bounded (double-dots at start or end).\nExamples:\n\n - A date-time: \"2018-02-12T23:20:50Z\"\n - A bounded interval: \"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z\"\n - Half-bounded intervals: \"2018-02-12T00:00:00Z/..\" or \"../2018-03-18T12:31:12Z\"\n - Duration objects: \"P1M\" for data from the past month or \"PT36H\" for the last 36 hours\n\nOnly features that have a `last_modified` that intersects the value of datetime are selected.\n", "title":"Last modified date", "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Daily values items", "tags":[ "daily" ] }, "options":{ "description":"Daily data provide one data value to represent water conditions for the day. Throughout much of the history of the USGS, the primary water data available was daily data collected manually at the monitoring location once each day. With improved availability of computer storage and automated transmission of data, the daily data published today are generally a statistical summary or metric of the continuous data collected each day, such as the daily mean, minimum, or maximum value. Daily data are automatically calculated from the continuous data of the same parameter code and are described by parameter code and a statistic code. These data have also been referred to as \u201cdaily values\u201d or \u201cDV\u201d.\n", "operationId":"optionsDailyFeatures", "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for Daily values items", "tags":[ "daily" ] }, "post":{ "description":"Daily data provide one data value to represent water conditions for the day. Throughout much of the history of the USGS, the primary water data available was daily data collected manually at the monitoring location once each day. With improved availability of computer storage and automated transmission of data, the daily data published today are generally a statistical summary or metric of the continuous data collected each day, such as the daily mean, minimum, or maximum value. Daily data are automatically calculated from the continuous data of the same parameter code and are described by parameter code and a statistic code. These data have also been referred to as \u201cdaily values\u201d or \u201cDV\u201d.\n", "operationId":"getCQL2DailyFeatures", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"https://schemas.opengis.net/cql2/1.0/cql2.json" } } }, "description":"Get items with CQL2", "required":true }, "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Daily values items with CQL2", "tags":[ "daily" ] } }, "/collections/daily/items/{featureId}":{ "get":{ "description":"Daily data provide one data value to represent water conditions for the day. Throughout much of the history of the USGS, the primary water data available was daily data collected manually at the monitoring location once each day. With improved availability of computer storage and automated transmission of data, the daily data published today are generally a statistical summary or metric of the continuous data collected each day, such as the daily mean, minimum, or maximum value. Daily data are automatically calculated from the continuous data of the same parameter code and are described by parameter code and a statistic code. These data have also been referred to as \u201cdaily values\u201d or \u201cDV\u201d.\n", "operationId":"getDailyFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Feature" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Daily values item by id", "tags":[ "daily" ] }, "options":{ "description":"Daily data provide one data value to represent water conditions for the day. Throughout much of the history of the USGS, the primary water data available was daily data collected manually at the monitoring location once each day. With improved availability of computer storage and automated transmission of data, the daily data published today are generally a statistical summary or metric of the continuous data collected each day, such as the daily mean, minimum, or maximum value. Daily data are automatically calculated from the continuous data of the same parameter code and are described by parameter code and a statistic code. These data have also been referred to as \u201cdaily values\u201d or \u201cDV\u201d.\n", "operationId":"optionsDailyFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" } ], "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for Daily values item by id", "tags":[ "daily" ] } }, "/collections/daily/queryables":{ "get":{ "description":"Daily data provide one data value to represent water conditions for the day. Throughout much of the history of the USGS, the primary water data available was daily data collected manually at the monitoring location once each day. With improved availability of computer storage and automated transmission of data, the daily data published today are generally a statistical summary or metric of the continuous data collected each day, such as the daily mean, minimum, or maximum value. Daily data are automatically calculated from the continuous data of the same parameter code and are described by parameter code and a statistic code. These data have also been referred to as \u201cdaily values\u201d or \u201cDV\u201d.\n", "operationId":"getDailyQueryables", "parameters":[ { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "time_series_id", "monitoring_location_id", "parameter_code", "statistic_id", "time", "value", "unit_of_measure", "approval_status", "qualifier", "last_modified" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/f" }, { "description":"The profile to be applied to a given request", "explode":false, "in":"query", "name":"profile", "required":false, "schema":{ "enum":[ "actual-domain", "valid-domain" ], "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Daily values queryables", "tags":[ "daily" ] } }, "/collections/daily/schema":{ "get":{ "description":"Daily data provide one data value to represent water conditions for the day. Throughout much of the history of the USGS, the primary water data available was daily data collected manually at the monitoring location once each day. With improved availability of computer storage and automated transmission of data, the daily data published today are generally a statistical summary or metric of the continuous data collected each day, such as the daily mean, minimum, or maximum value. Daily data are automatically calculated from the continuous data of the same parameter code and are described by parameter code and a statistic code. These data have also been referred to as \u201cdaily values\u201d or \u201cDV\u201d.\n", "operationId":"getDailySchema", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Daily values schema", "tags":[ "daily" ] } }, "/collections/field-measurements":{ "get":{ "description":"Field measurements are physically measured values collected during a visit to the monitoring location. Field measurements consist of measurements of gage height and discharge, and readings of groundwater levels, and are primarily used as calibration readings for the automated sensors collecting continuous data. They are collected at a low frequency, and delivery of the data in WDFN may be delayed due to data processing time.\n", "operationId":"describeField-measurementsCollection", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Collection" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "summary":"Get Field measurements metadata", "tags":[ "field-measurements" ] } }, "/collections/field-measurements/items":{ "get":{ "description":"Field measurements are physically measured values collected during a visit to the monitoring location. Field measurements consist of measurements of gage height and discharge, and readings of groundwater levels, and are primarily used as calibration readings for the automated sensors collecting continuous data. They are collected at a low frequency, and delivery of the data in WDFN may be delayed due to data processing time.\n", "operationId":"getField-measurementsFeatures", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" }, { "$ref":"#/components/parameters/bbox" }, { "description":"The optional limit parameter limits the number of items that are presented in the response document (maximum=50000, default=10).", "explode":false, "in":"query", "name":"limit", "required":false, "schema":{ "default":10, "maximum":50000, "minimum":1, "type":"integer" }, "style":"form" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/bbox-crs" }, { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "field_visit_id", "parameter_code", "monitoring_location_id", "observing_procedure_code", "observing_procedure", "value", "unit_of_measure", "time", "qualifier", "vertical_datum", "approval_status", "measuring_agency", "last_modified" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/skipGeometry" }, { "$ref":"#/components/parameters/wda_sortby" }, { "$ref":"#/components/parameters/offset" }, { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/datetime" }, { "description":"A universally unique identifier (UUID) representing a single version of a record. It is not stable over time. Every time the record is refreshed in our database (which may happen as part of normal operations and does not imply any change to the data itself) a new ID will be generated. To uniquely identify a single observation over time, compare the `time` and `time_series_id` fields; each time series will only have a single observation at a given `time`.\n", "explode":false, "in":"query", "name":"id", "required":false, "schema":{ "description":"A universally unique identifier (UUID) representing a single version of a record. It is not stable over time. Every time the record is refreshed in our database (which may happen as part of normal operations and does not imply any change to the data itself) a new ID will be generated. To uniquely identify a single observation over time, compare the `time` and `time_series_id` fields; each time series will only have a single observation at a given `time`.\n", "format":"uuid", "type":"string" }, "style":"form" }, { "description":"A universally unique identifier (UUID) for the field visit. Multiple measurements may be made during a single field visit.\n", "explode":false, "in":"query", "name":"field_visit_id", "required":false, "schema":{ "description":"A universally unique identifier (UUID) for the field visit. Multiple measurements may be made during a single field visit.\n", "format":"uuid", "title":"Field visit ID", "type":"string" }, "style":"form" }, { "description":"Parameter codes are 5-digit codes used to identify the constituent measured and the units of measure. A complete list of parameter codes and associated groupings can be found at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/parameter-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/parameter-codes/items).\n Split parameters are enabled for this field, so you can supply multiple values separated by commas.", "explode":false, "in":"query", "name":"parameter_code", "required":false, "schema":{ "description":"Parameter codes are 5-digit codes used to identify the constituent measured and the units of measure. A complete list of parameter codes and associated groupings can be found at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/parameter-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/parameter-codes/items).\n Split parameters are enabled for this field, so you can supply multiple values separated by commas.", "title":"Parameter code", "type":"string" }, "style":"form" }, { "description":"A unique identifier representing a single monitoring location. This corresponds to the `id` field in the `monitoring-locations` endpoint. Monitoring location IDs are created by combining the agency code of the agency responsible for the monitoring location (e.g. USGS) with the ID number of the monitoring location (e.g. 02238500), separated by a hyphen (e.g. USGS-02238500).\n Split parameters are enabled for this field, so you can supply multiple values separated by commas.", "explode":false, "in":"query", "name":"monitoring_location_id", "required":false, "schema":{ "description":"A unique identifier representing a single monitoring location. This corresponds to the `id` field in the `monitoring-locations` endpoint. Monitoring location IDs are created by combining the agency code of the agency responsible for the monitoring location (e.g. USGS) with the ID number of the monitoring location (e.g. 02238500), separated by a hyphen (e.g. USGS-02238500).\n Split parameters are enabled for this field, so you can supply multiple values separated by commas.", "title":"Monitoring location ID", "type":"string" }, "style":"form" }, { "description":"A short code corresponding to the observing procedure for the field measurement.", "explode":false, "in":"query", "name":"observing_procedure_code", "required":false, "schema":{ "description":"A short code corresponding to the observing procedure for the field measurement.", "title":"Observing procedure code", "type":"string" }, "style":"form" }, { "description":"Water measurement or water-quality observing procedure descriptions.", "explode":false, "in":"query", "name":"observing_procedure", "required":false, "schema":{ "description":"Water measurement or water-quality observing procedure descriptions.", "title":"Observing procedure", "type":"string" }, "style":"form" }, { "description":"The value of the observation. Values are transmitted as strings in the JSON response format in order to preserve precision.\n", "explode":false, "in":"query", "name":"value", "required":false, "schema":{ "description":"The value of the observation. Values are transmitted as strings in the JSON response format in order to preserve precision.\n", "title":"Value", "type":"string" }, "style":"form" }, { "description":"A human-readable description of the units of measurement associated with an observation.", "explode":false, "in":"query", "name":"unit_of_measure", "required":false, "schema":{ "description":"A human-readable description of the units of measurement associated with an observation.", "title":"Unit of measure", "type":"string" }, "style":"form" }, { "description":"The date an observation represents. You can query this field using date-times or intervals, adhering to RFC 3339, or using ISO 8601 duration objects. Intervals may be bounded or half-bounded (double-dots at start or end).\nExamples:\n\n - A date-time: \"2018-02-12T23:20:50Z\"\n - A bounded interval: \"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z\"\n - Half-bounded intervals: \"2018-02-12T00:00:00Z/..\" or \"../2018-03-18T12:31:12Z\"\n - Duration objects: \"P1M\" for data from the past month or \"PT36H\" for the last 36 hours\n\nOnly features that have a `time` that intersects the value of datetime are selected. If a feature has multiple temporal properties, it is the decision of the server whether only a single temporal property is used to determine the extent or all relevant temporal properties.\n", "explode":false, "in":"query", "name":"time", "required":false, "schema":{ "description":"The date an observation represents. You can query this field using date-times or intervals, adhering to RFC 3339, or using ISO 8601 duration objects. Intervals may be bounded or half-bounded (double-dots at start or end).\nExamples:\n\n - A date-time: \"2018-02-12T23:20:50Z\"\n - A bounded interval: \"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z\"\n - Half-bounded intervals: \"2018-02-12T00:00:00Z/..\" or \"../2018-03-18T12:31:12Z\"\n - Duration objects: \"P1M\" for data from the past month or \"PT36H\" for the last 36 hours\n\nOnly features that have a `time` that intersects the value of datetime are selected. If a feature has multiple temporal properties, it is the decision of the server whether only a single temporal property is used to determine the extent or all relevant temporal properties.\n", "title":"Time", "type":"string" }, "style":"form" }, { "description":"This field indicates any qualifiers associated with an observation, for instance if a sensor may have been impacted by ice or if values were estimated.\n", "explode":false, "in":"query", "name":"qualifier", "required":false, "schema":{ "description":"This field indicates any qualifiers associated with an observation, for instance if a sensor may have been impacted by ice or if values were estimated.\n", "title":"Qualifier", "type":"string" }, "style":"form" }, { "description":"The datum used to determine altitude and vertical position at the monitoring location. A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/altitude-datums/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/altitude-datums/items).\n", "explode":false, "in":"query", "name":"vertical_datum", "required":false, "schema":{ "description":"The datum used to determine altitude and vertical position at the monitoring location. A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/altitude-datums/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/altitude-datums/items).\n", "title":"Vertical datum", "type":"string" }, "style":"form" }, { "description":"Some of the data that you have obtained from this U.S. Geological Survey database may not have received Director's approval. Any such data values are qualified as provisional and are subject to revision. Provisional data are released on the condition that neither the USGS nor the United States Government may be held liable for any damages resulting from its use. This field reflects the approval status of each record, and is either \"Approved\", meaining processing review has been completed and the data is approved for publication, or \"Provisional\" and subject to revision. For more information about provisional data, go to [https://waterdata.usgs.gov/provisional-data-statement/](https://waterdata.usgs.gov/provisional-data-statement/).\n", "explode":false, "in":"query", "name":"approval_status", "required":false, "schema":{ "description":"Some of the data that you have obtained from this U.S. Geological Survey database may not have received Director's approval. Any such data values are qualified as provisional and are subject to revision. Provisional data are released on the condition that neither the USGS nor the United States Government may be held liable for any damages resulting from its use. This field reflects the approval status of each record, and is either \"Approved\", meaining processing review has been completed and the data is approved for publication, or \"Provisional\" and subject to revision. For more information about provisional data, go to [https://waterdata.usgs.gov/provisional-data-statement/](https://waterdata.usgs.gov/provisional-data-statement/).\n", "enum":[ "Provisional", "Approved" ], "title":"Approval Status", "type":"string" }, "style":"form" }, { "description":"The agency performing the measurement.", "explode":false, "in":"query", "name":"measuring_agency", "required":false, "schema":{ "description":"The agency performing the measurement.", "title":"Measuring agency", "type":"string" }, "style":"form" }, { "description":"The last time a record was refreshed in our database. This may happen due to regular operational processes and does not necessarily indicate anything about the measurement has changed.\nYou can query this field using date-times or intervals, adhering to RFC 3339, or using ISO 8601 duration objects. Intervals may be bounded or half-bounded (double-dots at start or end).\nExamples:\n\n - A date-time: \"2018-02-12T23:20:50Z\"\n - A bounded interval: \"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z\"\n - Half-bounded intervals: \"2018-02-12T00:00:00Z/..\" or \"../2018-03-18T12:31:12Z\"\n - Duration objects: \"P1M\" for data from the past month or \"PT36H\" for the last 36 hours\n\nOnly features that have a `last_modified` that intersects the value of datetime are selected.\n", "explode":false, "in":"query", "name":"last_modified", "required":false, "schema":{ "description":"The last time a record was refreshed in our database. This may happen due to regular operational processes and does not necessarily indicate anything about the measurement has changed.\nYou can query this field using date-times or intervals, adhering to RFC 3339, or using ISO 8601 duration objects. Intervals may be bounded or half-bounded (double-dots at start or end).\nExamples:\n\n - A date-time: \"2018-02-12T23:20:50Z\"\n - A bounded interval: \"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z\"\n - Half-bounded intervals: \"2018-02-12T00:00:00Z/..\" or \"../2018-03-18T12:31:12Z\"\n - Duration objects: \"P1M\" for data from the past month or \"PT36H\" for the last 36 hours\n\nOnly features that have a `last_modified` that intersects the value of datetime are selected.\n", "title":"Last modified date", "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Field measurements items", "tags":[ "field-measurements" ] }, "options":{ "description":"Field measurements are physically measured values collected during a visit to the monitoring location. Field measurements consist of measurements of gage height and discharge, and readings of groundwater levels, and are primarily used as calibration readings for the automated sensors collecting continuous data. They are collected at a low frequency, and delivery of the data in WDFN may be delayed due to data processing time.\n", "operationId":"optionsField-measurementsFeatures", "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for Field measurements items", "tags":[ "field-measurements" ] }, "post":{ "description":"Field measurements are physically measured values collected during a visit to the monitoring location. Field measurements consist of measurements of gage height and discharge, and readings of groundwater levels, and are primarily used as calibration readings for the automated sensors collecting continuous data. They are collected at a low frequency, and delivery of the data in WDFN may be delayed due to data processing time.\n", "operationId":"getCQL2Field-measurementsFeatures", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"https://schemas.opengis.net/cql2/1.0/cql2.json" } } }, "description":"Get items with CQL2", "required":true }, "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Field measurements items with CQL2", "tags":[ "field-measurements" ] } }, "/collections/field-measurements/items/{featureId}":{ "get":{ "description":"Field measurements are physically measured values collected during a visit to the monitoring location. Field measurements consist of measurements of gage height and discharge, and readings of groundwater levels, and are primarily used as calibration readings for the automated sensors collecting continuous data. They are collected at a low frequency, and delivery of the data in WDFN may be delayed due to data processing time.\n", "operationId":"getField-measurementsFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Feature" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Field measurements item by id", "tags":[ "field-measurements" ] }, "options":{ "description":"Field measurements are physically measured values collected during a visit to the monitoring location. Field measurements consist of measurements of gage height and discharge, and readings of groundwater levels, and are primarily used as calibration readings for the automated sensors collecting continuous data. They are collected at a low frequency, and delivery of the data in WDFN may be delayed due to data processing time.\n", "operationId":"optionsField-measurementsFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" } ], "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for Field measurements item by id", "tags":[ "field-measurements" ] } }, "/collections/field-measurements/queryables":{ "get":{ "description":"Field measurements are physically measured values collected during a visit to the monitoring location. Field measurements consist of measurements of gage height and discharge, and readings of groundwater levels, and are primarily used as calibration readings for the automated sensors collecting continuous data. They are collected at a low frequency, and delivery of the data in WDFN may be delayed due to data processing time.\n", "operationId":"getField-measurementsQueryables", "parameters":[ { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "field_visit_id", "parameter_code", "monitoring_location_id", "observing_procedure_code", "observing_procedure", "value", "unit_of_measure", "time", "qualifier", "vertical_datum", "approval_status", "measuring_agency", "last_modified" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/f" }, { "description":"The profile to be applied to a given request", "explode":false, "in":"query", "name":"profile", "required":false, "schema":{ "enum":[ "actual-domain", "valid-domain" ], "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Field measurements queryables", "tags":[ "field-measurements" ] } }, "/collections/field-measurements/schema":{ "get":{ "description":"Field measurements are physically measured values collected during a visit to the monitoring location. Field measurements consist of measurements of gage height and discharge, and readings of groundwater levels, and are primarily used as calibration readings for the automated sensors collecting continuous data. They are collected at a low frequency, and delivery of the data in WDFN may be delayed due to data processing time.\n", "operationId":"getField-measurementsSchema", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Field measurements schema", "tags":[ "field-measurements" ] } }, "/collections/hydrologic-unit-codes":{ "get":{ "description":"Hydrologic units are geographic areas representing part or all of a surface drainage basin or distinct hydrologic feature identified by a unique number (HUC), and a name. The United States is divided and sub-divided into successively smaller hydrologic units which are classified into four levels: regions, sub-regions, accounting units, and cataloging units. Each unit consists of two to eight digits based on the four levels of classification in the hydrologic unit system. Additional information can be found at .\n", "operationId":"describeHydrologic-unit-codesCollection", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Collection" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "summary":"Get Hydrologic unit codes (HUCs) metadata", "tags":[ "hydrologic-unit-codes" ] } }, "/collections/hydrologic-unit-codes/items":{ "get":{ "description":"Hydrologic units are geographic areas representing part or all of a surface drainage basin or distinct hydrologic feature identified by a unique number (HUC), and a name. The United States is divided and sub-divided into successively smaller hydrologic units which are classified into four levels: regions, sub-regions, accounting units, and cataloging units. Each unit consists of two to eight digits based on the four levels of classification in the hydrologic unit system. Additional information can be found at .\n", "operationId":"getHydrologic-unit-codesFeatures", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" }, { "$ref":"#/components/parameters/bbox" }, { "description":"The optional limit parameter limits the number of items that are presented in the response document (maximum=50000, default=10000).", "explode":false, "in":"query", "name":"limit", "required":false, "schema":{ "default":10000, "maximum":50000, "minimum":1, "type":"integer" }, "style":"form" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/bbox-crs" }, { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "hydrologic_unit_name", "hydrologic_unit_classification_code" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/skipGeometry" }, { "$ref":"https://raw.githubusercontent.com/opengeospatial/ogcapi-records/master/core/openapi/parameters/sortby.yaml" }, { "$ref":"#/components/parameters/offset" }, { "description":"Hydrologic unit code. The format of the code is ('RRSSBBUUWWXX') where: 'RR' is the 2-digit code for the region. 'SS' is the 2-digit code for the sub-region. 'BB' is the 2-digit code for the basin. 'UU' is the 2-digit code for the sub-basin. 'WW' is the 2-digit code for the watershed. 'XX' is the 2-digit code for the sub-watershed. Watersheds are delineated by USGS using a nationwide system based on surface hydrologic features. This system divides the country into 22 regions (2-digit), 245 subregions (4-digit), 405 basins (6-digit), ~2,400 subbasins (8-digit), ~19,000 watersheds (10-digit), and ~105,000 subwatersheds (12-digit). A hierarchical hydrologic unit code (HUC) consisting of 2 additional digits for each level in the hydrologic unit system is used to identify any hydrologic area (see Federal Standards and Procedures for the National Watershed Boundary Dataset - https://pubs.usgs.gov/tm/11/a3/).", "explode":false, "in":"query", "name":"id", "required":false, "schema":{ "description":"Hydrologic unit code. The format of the code is ('RRSSBBUUWWXX') where: 'RR' is the 2-digit code for the region. 'SS' is the 2-digit code for the sub-region. 'BB' is the 2-digit code for the basin. 'UU' is the 2-digit code for the sub-basin. 'WW' is the 2-digit code for the watershed. 'XX' is the 2-digit code for the sub-watershed. Watersheds are delineated by USGS using a nationwide system based on surface hydrologic features. This system divides the country into 22 regions (2-digit), 245 subregions (4-digit), 405 basins (6-digit), ~2,400 subbasins (8-digit), ~19,000 watersheds (10-digit), and ~105,000 subwatersheds (12-digit). A hierarchical hydrologic unit code (HUC) consisting of 2 additional digits for each level in the hydrologic unit system is used to identify any hydrologic area (see Federal Standards and Procedures for the National Watershed Boundary Dataset - https://pubs.usgs.gov/tm/11/a3/).", "type":"string" }, "style":"form" }, { "description":"Hydrologic unit name.", "explode":false, "in":"query", "name":"hydrologic_unit_name", "required":false, "schema":{ "description":"Hydrologic unit name.", "type":"string" }, "style":"form" }, { "description":"Hydrologic unit classification code.", "explode":false, "in":"query", "name":"hydrologic_unit_classification_code", "required":false, "schema":{ "description":"Hydrologic unit classification code.", "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Hydrologic unit codes (HUCs) items", "tags":[ "hydrologic-unit-codes" ] }, "options":{ "description":"Hydrologic units are geographic areas representing part or all of a surface drainage basin or distinct hydrologic feature identified by a unique number (HUC), and a name. The United States is divided and sub-divided into successively smaller hydrologic units which are classified into four levels: regions, sub-regions, accounting units, and cataloging units. Each unit consists of two to eight digits based on the four levels of classification in the hydrologic unit system. Additional information can be found at .\n", "operationId":"optionsHydrologic-unit-codesFeatures", "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for Hydrologic unit codes (HUCs) items", "tags":[ "hydrologic-unit-codes" ] }, "post":{ "description":"Hydrologic units are geographic areas representing part or all of a surface drainage basin or distinct hydrologic feature identified by a unique number (HUC), and a name. The United States is divided and sub-divided into successively smaller hydrologic units which are classified into four levels: regions, sub-regions, accounting units, and cataloging units. Each unit consists of two to eight digits based on the four levels of classification in the hydrologic unit system. Additional information can be found at .\n", "operationId":"getCQL2Hydrologic-unit-codesFeatures", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"https://schemas.opengis.net/cql2/1.0/cql2.json" } } }, "description":"Get items with CQL2", "required":true }, "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Hydrologic unit codes (HUCs) items with CQL2", "tags":[ "hydrologic-unit-codes" ] } }, "/collections/hydrologic-unit-codes/items/{featureId}":{ "get":{ "description":"Hydrologic units are geographic areas representing part or all of a surface drainage basin or distinct hydrologic feature identified by a unique number (HUC), and a name. The United States is divided and sub-divided into successively smaller hydrologic units which are classified into four levels: regions, sub-regions, accounting units, and cataloging units. Each unit consists of two to eight digits based on the four levels of classification in the hydrologic unit system. Additional information can be found at .\n", "operationId":"getHydrologic-unit-codesFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Feature" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Hydrologic unit codes (HUCs) item by id", "tags":[ "hydrologic-unit-codes" ] }, "options":{ "description":"Hydrologic units are geographic areas representing part or all of a surface drainage basin or distinct hydrologic feature identified by a unique number (HUC), and a name. The United States is divided and sub-divided into successively smaller hydrologic units which are classified into four levels: regions, sub-regions, accounting units, and cataloging units. Each unit consists of two to eight digits based on the four levels of classification in the hydrologic unit system. Additional information can be found at .\n", "operationId":"optionsHydrologic-unit-codesFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" } ], "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for Hydrologic unit codes (HUCs) item by id", "tags":[ "hydrologic-unit-codes" ] } }, "/collections/hydrologic-unit-codes/queryables":{ "get":{ "description":"Hydrologic units are geographic areas representing part or all of a surface drainage basin or distinct hydrologic feature identified by a unique number (HUC), and a name. The United States is divided and sub-divided into successively smaller hydrologic units which are classified into four levels: regions, sub-regions, accounting units, and cataloging units. Each unit consists of two to eight digits based on the four levels of classification in the hydrologic unit system. Additional information can be found at .\n", "operationId":"getHydrologic-unit-codesQueryables", "parameters":[ { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "hydrologic_unit_name", "hydrologic_unit_classification_code" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/f" }, { "description":"The profile to be applied to a given request", "explode":false, "in":"query", "name":"profile", "required":false, "schema":{ "enum":[ "actual-domain", "valid-domain" ], "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Hydrologic unit codes (HUCs) queryables", "tags":[ "hydrologic-unit-codes" ] } }, "/collections/hydrologic-unit-codes/schema":{ "get":{ "description":"Hydrologic units are geographic areas representing part or all of a surface drainage basin or distinct hydrologic feature identified by a unique number (HUC), and a name. The United States is divided and sub-divided into successively smaller hydrologic units which are classified into four levels: regions, sub-regions, accounting units, and cataloging units. Each unit consists of two to eight digits based on the four levels of classification in the hydrologic unit system. Additional information can be found at .\n", "operationId":"getHydrologic-unit-codesSchema", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Hydrologic unit codes (HUCs) schema", "tags":[ "hydrologic-unit-codes" ] } }, "/collections/latest-continuous":{ "get":{ "description":"This endpoint provides the most recent observation for each time series of continuous data. Continuous data are collected via automated sensors installed at a monitoring location. They are collected at a high frequency and often at a fixed 15-minute interval. Depending on the specific monitoring location, the data may be transmitted automatically via telemetry and be available on WDFN within minutes of collection, while other times the delivery of data may be delayed if the monitoring location does not have the capacity to automatically transmit data. Continuous data are described by parameter name and parameter code. These data might also be referred to as \"instantaneous values\" or \"IV\"\n", "operationId":"describeLatest-continuousCollection", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Collection" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "summary":"Get Latest continuous metadata", "tags":[ "latest-continuous" ] } }, "/collections/latest-continuous/items":{ "get":{ "description":"This endpoint provides the most recent observation for each time series of continuous data. Continuous data are collected via automated sensors installed at a monitoring location. They are collected at a high frequency and often at a fixed 15-minute interval. Depending on the specific monitoring location, the data may be transmitted automatically via telemetry and be available on WDFN within minutes of collection, while other times the delivery of data may be delayed if the monitoring location does not have the capacity to automatically transmit data. Continuous data are described by parameter name and parameter code. These data might also be referred to as \"instantaneous values\" or \"IV\"\n", "operationId":"getLatest-continuousFeatures", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" }, { "$ref":"#/components/parameters/bbox" }, { "description":"The optional limit parameter limits the number of items that are presented in the response document (maximum=50000, default=10).", "explode":false, "in":"query", "name":"limit", "required":false, "schema":{ "default":10, "maximum":50000, "minimum":1, "type":"integer" }, "style":"form" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/bbox-crs" }, { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "time_series_id", "monitoring_location_id", "parameter_code", "statistic_id", "time", "value", "unit_of_measure", "approval_status", "qualifier", "last_modified" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/skipGeometry" }, { "$ref":"#/components/parameters/wda_sortby" }, { "$ref":"#/components/parameters/offset" }, { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/datetime" }, { "description":"A universally unique identifier (UUID) representing a single version of a record. It is not stable over time. Every time the record is refreshed in our database (which may happen as part of normal operations and does not imply any change to the data itself) a new ID will be generated. To uniquely identify a single observation over time, compare the `time` and `time_series_id` fields; each time series will only have a single observation at a given `time`.\n", "explode":false, "in":"query", "name":"id", "required":false, "schema":{ "description":"A universally unique identifier (UUID) representing a single version of a record. It is not stable over time. Every time the record is refreshed in our database (which may happen as part of normal operations and does not imply any change to the data itself) a new ID will be generated. To uniquely identify a single observation over time, compare the `time` and `time_series_id` fields; each time series will only have a single observation at a given `time`.\n", "format":"uuid", "type":"string" }, "style":"form" }, { "description":"A unique identifier representing a single time series. This corresponds to the `id` field in the `time-series-metadata` endpoint.\n Split parameters are enabled for this field, so you can supply multiple values separated by commas.", "explode":false, "in":"query", "name":"time_series_id", "required":false, "schema":{ "description":"A unique identifier representing a single time series. This corresponds to the `id` field in the `time-series-metadata` endpoint.\n Split parameters are enabled for this field, so you can supply multiple values separated by commas.", "title":"Time series ID", "type":"string" }, "style":"form" }, { "description":"A unique identifier representing a single monitoring location. This corresponds to the `id` field in the `monitoring-locations` endpoint. Monitoring location IDs are created by combining the agency code of the agency responsible for the monitoring location (e.g. USGS) with the ID number of the monitoring location (e.g. 02238500), separated by a hyphen (e.g. USGS-02238500).\n Split parameters are enabled for this field, so you can supply multiple values separated by commas.", "explode":false, "in":"query", "name":"monitoring_location_id", "required":false, "schema":{ "description":"A unique identifier representing a single monitoring location. This corresponds to the `id` field in the `monitoring-locations` endpoint. Monitoring location IDs are created by combining the agency code of the agency responsible for the monitoring location (e.g. USGS) with the ID number of the monitoring location (e.g. 02238500), separated by a hyphen (e.g. USGS-02238500).\n Split parameters are enabled for this field, so you can supply multiple values separated by commas.", "title":"Monitoring location ID", "type":"string" }, "style":"form" }, { "description":"Parameter codes are 5-digit codes used to identify the constituent measured and the units of measure. A complete list of parameter codes and associated groupings can be found at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/parameter-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/parameter-codes/items).\n Split parameters are enabled for this field, so you can supply multiple values separated by commas.", "explode":false, "in":"query", "name":"parameter_code", "required":false, "schema":{ "description":"Parameter codes are 5-digit codes used to identify the constituent measured and the units of measure. A complete list of parameter codes and associated groupings can be found at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/parameter-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/parameter-codes/items).\n Split parameters are enabled for this field, so you can supply multiple values separated by commas.", "title":"Parameter code", "type":"string" }, "style":"form" }, { "description":"A code corresponding to the statistic an observation represents. Example codes include 00001 (max), 00002 (min), and 00003 (mean). A complete list of codes and their descriptions can be found at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/statistic-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/statistic-codes/items).\n", "explode":false, "in":"query", "name":"statistic_id", "required":false, "schema":{ "description":"A code corresponding to the statistic an observation represents. Example codes include 00001 (max), 00002 (min), and 00003 (mean). A complete list of codes and their descriptions can be found at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/statistic-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/statistic-codes/items).\n", "title":"Statistic ID", "type":"string" }, "style":"form" }, { "description":"The date an observation represents. You can query this field using date-times or intervals, adhering to RFC 3339, or using ISO 8601 duration objects. Intervals may be bounded or half-bounded (double-dots at start or end).\nExamples:\n\n - A date-time: \"2018-02-12T23:20:50Z\"\n - A bounded interval: \"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z\"\n - Half-bounded intervals: \"2018-02-12T00:00:00Z/..\" or \"../2018-03-18T12:31:12Z\"\n - Duration objects: \"P1M\" for data from the past month or \"PT36H\" for the last 36 hours\n\nOnly features that have a `time` that intersects the value of datetime are selected. If a feature has multiple temporal properties, it is the decision of the server whether only a single temporal property is used to determine the extent or all relevant temporal properties.\n", "explode":false, "in":"query", "name":"time", "required":false, "schema":{ "description":"The date an observation represents. You can query this field using date-times or intervals, adhering to RFC 3339, or using ISO 8601 duration objects. Intervals may be bounded or half-bounded (double-dots at start or end).\nExamples:\n\n - A date-time: \"2018-02-12T23:20:50Z\"\n - A bounded interval: \"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z\"\n - Half-bounded intervals: \"2018-02-12T00:00:00Z/..\" or \"../2018-03-18T12:31:12Z\"\n - Duration objects: \"P1M\" for data from the past month or \"PT36H\" for the last 36 hours\n\nOnly features that have a `time` that intersects the value of datetime are selected. If a feature has multiple temporal properties, it is the decision of the server whether only a single temporal property is used to determine the extent or all relevant temporal properties.\n", "title":"Time", "type":"string" }, "style":"form" }, { "description":"The value of the observation. Values are transmitted as strings in the JSON response format in order to preserve precision.\n", "explode":false, "in":"query", "name":"value", "required":false, "schema":{ "description":"The value of the observation. Values are transmitted as strings in the JSON response format in order to preserve precision.\n", "title":"Value", "type":"string" }, "style":"form" }, { "description":"A human-readable description of the units of measurement associated with an observation.", "explode":false, "in":"query", "name":"unit_of_measure", "required":false, "schema":{ "description":"A human-readable description of the units of measurement associated with an observation.", "title":"Unit of measure", "type":"string" }, "style":"form" }, { "description":"Some of the data that you have obtained from this U.S. Geological Survey database may not have received Director's approval. Any such data values are qualified as provisional and are subject to revision. Provisional data are released on the condition that neither the USGS nor the United States Government may be held liable for any damages resulting from its use. This field reflects the approval status of each record, and is either \"Approved\", meaining processing review has been completed and the data is approved for publication, or \"Provisional\" and subject to revision. For more information about provisional data, go to [https://waterdata.usgs.gov/provisional-data-statement/](https://waterdata.usgs.gov/provisional-data-statement/).\n", "explode":false, "in":"query", "name":"approval_status", "required":false, "schema":{ "description":"Some of the data that you have obtained from this U.S. Geological Survey database may not have received Director's approval. Any such data values are qualified as provisional and are subject to revision. Provisional data are released on the condition that neither the USGS nor the United States Government may be held liable for any damages resulting from its use. This field reflects the approval status of each record, and is either \"Approved\", meaining processing review has been completed and the data is approved for publication, or \"Provisional\" and subject to revision. For more information about provisional data, go to [https://waterdata.usgs.gov/provisional-data-statement/](https://waterdata.usgs.gov/provisional-data-statement/).\n", "enum":[ "Provisional", "Approved" ], "title":"Approval Status", "type":"string" }, "style":"form" }, { "description":"This field indicates any qualifiers associated with an observation, for instance if a sensor may have been impacted by ice or if values were estimated.\n", "explode":false, "in":"query", "name":"qualifier", "required":false, "schema":{ "description":"This field indicates any qualifiers associated with an observation, for instance if a sensor may have been impacted by ice or if values were estimated.\n", "title":"Qualifier", "type":"string" }, "style":"form" }, { "description":"The last time a record was refreshed in our database. This may happen due to regular operational processes and does not necessarily indicate anything about the measurement has changed.\nYou can query this field using date-times or intervals, adhering to RFC 3339, or using ISO 8601 duration objects. Intervals may be bounded or half-bounded (double-dots at start or end).\nExamples:\n\n - A date-time: \"2018-02-12T23:20:50Z\"\n - A bounded interval: \"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z\"\n - Half-bounded intervals: \"2018-02-12T00:00:00Z/..\" or \"../2018-03-18T12:31:12Z\"\n - Duration objects: \"P1M\" for data from the past month or \"PT36H\" for the last 36 hours\n\nOnly features that have a `last_modified` that intersects the value of datetime are selected.\n", "explode":false, "in":"query", "name":"last_modified", "required":false, "schema":{ "description":"The last time a record was refreshed in our database. This may happen due to regular operational processes and does not necessarily indicate anything about the measurement has changed.\nYou can query this field using date-times or intervals, adhering to RFC 3339, or using ISO 8601 duration objects. Intervals may be bounded or half-bounded (double-dots at start or end).\nExamples:\n\n - A date-time: \"2018-02-12T23:20:50Z\"\n - A bounded interval: \"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z\"\n - Half-bounded intervals: \"2018-02-12T00:00:00Z/..\" or \"../2018-03-18T12:31:12Z\"\n - Duration objects: \"P1M\" for data from the past month or \"PT36H\" for the last 36 hours\n\nOnly features that have a `last_modified` that intersects the value of datetime are selected.\n", "title":"Last modified date", "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Latest continuous items", "tags":[ "latest-continuous" ] }, "options":{ "description":"This endpoint provides the most recent observation for each time series of continuous data. Continuous data are collected via automated sensors installed at a monitoring location. They are collected at a high frequency and often at a fixed 15-minute interval. Depending on the specific monitoring location, the data may be transmitted automatically via telemetry and be available on WDFN within minutes of collection, while other times the delivery of data may be delayed if the monitoring location does not have the capacity to automatically transmit data. Continuous data are described by parameter name and parameter code. These data might also be referred to as \"instantaneous values\" or \"IV\"\n", "operationId":"optionsLatest-continuousFeatures", "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for Latest continuous items", "tags":[ "latest-continuous" ] }, "post":{ "description":"This endpoint provides the most recent observation for each time series of continuous data. Continuous data are collected via automated sensors installed at a monitoring location. They are collected at a high frequency and often at a fixed 15-minute interval. Depending on the specific monitoring location, the data may be transmitted automatically via telemetry and be available on WDFN within minutes of collection, while other times the delivery of data may be delayed if the monitoring location does not have the capacity to automatically transmit data. Continuous data are described by parameter name and parameter code. These data might also be referred to as \"instantaneous values\" or \"IV\"\n", "operationId":"getCQL2Latest-continuousFeatures", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"https://schemas.opengis.net/cql2/1.0/cql2.json" } } }, "description":"Get items with CQL2", "required":true }, "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Latest continuous items with CQL2", "tags":[ "latest-continuous" ] } }, "/collections/latest-continuous/items/{featureId}":{ "get":{ "description":"This endpoint provides the most recent observation for each time series of continuous data. Continuous data are collected via automated sensors installed at a monitoring location. They are collected at a high frequency and often at a fixed 15-minute interval. Depending on the specific monitoring location, the data may be transmitted automatically via telemetry and be available on WDFN within minutes of collection, while other times the delivery of data may be delayed if the monitoring location does not have the capacity to automatically transmit data. Continuous data are described by parameter name and parameter code. These data might also be referred to as \"instantaneous values\" or \"IV\"\n", "operationId":"getLatest-continuousFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Feature" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Latest continuous item by id", "tags":[ "latest-continuous" ] }, "options":{ "description":"This endpoint provides the most recent observation for each time series of continuous data. Continuous data are collected via automated sensors installed at a monitoring location. They are collected at a high frequency and often at a fixed 15-minute interval. Depending on the specific monitoring location, the data may be transmitted automatically via telemetry and be available on WDFN within minutes of collection, while other times the delivery of data may be delayed if the monitoring location does not have the capacity to automatically transmit data. Continuous data are described by parameter name and parameter code. These data might also be referred to as \"instantaneous values\" or \"IV\"\n", "operationId":"optionsLatest-continuousFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" } ], "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for Latest continuous item by id", "tags":[ "latest-continuous" ] } }, "/collections/latest-continuous/queryables":{ "get":{ "description":"This endpoint provides the most recent observation for each time series of continuous data. Continuous data are collected via automated sensors installed at a monitoring location. They are collected at a high frequency and often at a fixed 15-minute interval. Depending on the specific monitoring location, the data may be transmitted automatically via telemetry and be available on WDFN within minutes of collection, while other times the delivery of data may be delayed if the monitoring location does not have the capacity to automatically transmit data. Continuous data are described by parameter name and parameter code. These data might also be referred to as \"instantaneous values\" or \"IV\"\n", "operationId":"getLatest-continuousQueryables", "parameters":[ { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "time_series_id", "monitoring_location_id", "parameter_code", "statistic_id", "time", "value", "unit_of_measure", "approval_status", "qualifier", "last_modified" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/f" }, { "description":"The profile to be applied to a given request", "explode":false, "in":"query", "name":"profile", "required":false, "schema":{ "enum":[ "actual-domain", "valid-domain" ], "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Latest continuous queryables", "tags":[ "latest-continuous" ] } }, "/collections/latest-continuous/schema":{ "get":{ "description":"This endpoint provides the most recent observation for each time series of continuous data. Continuous data are collected via automated sensors installed at a monitoring location. They are collected at a high frequency and often at a fixed 15-minute interval. Depending on the specific monitoring location, the data may be transmitted automatically via telemetry and be available on WDFN within minutes of collection, while other times the delivery of data may be delayed if the monitoring location does not have the capacity to automatically transmit data. Continuous data are described by parameter name and parameter code. These data might also be referred to as \"instantaneous values\" or \"IV\"\n", "operationId":"getLatest-continuousSchema", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Latest continuous schema", "tags":[ "latest-continuous" ] } }, "/collections/latest-daily":{ "get":{ "description":"Daily data provide one data value to represent water conditions for the day. Throughout much of the history of the USGS, the primary water data available was daily data collected manually at the monitoring location once each day. With improved availability of computer storage and automated transmission of data, the daily data published today are generally a statistical summary or metric of the continuous data collected each day, such as the daily mean, minimum, or maximum value. Daily data are automatically calculated from the continuous data of the same parameter code and are described by parameter code and a statistic code. These data have also been referred to as \u201cdaily values\u201d or \u201cDV\u201d.\n", "operationId":"describeLatest-dailyCollection", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Collection" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "summary":"Get Latest daily values metadata", "tags":[ "latest-daily" ] } }, "/collections/latest-daily/items":{ "get":{ "description":"Daily data provide one data value to represent water conditions for the day. Throughout much of the history of the USGS, the primary water data available was daily data collected manually at the monitoring location once each day. With improved availability of computer storage and automated transmission of data, the daily data published today are generally a statistical summary or metric of the continuous data collected each day, such as the daily mean, minimum, or maximum value. Daily data are automatically calculated from the continuous data of the same parameter code and are described by parameter code and a statistic code. These data have also been referred to as \u201cdaily values\u201d or \u201cDV\u201d.\n", "operationId":"getLatest-dailyFeatures", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" }, { "$ref":"#/components/parameters/bbox" }, { "description":"The optional limit parameter limits the number of items that are presented in the response document (maximum=50000, default=10).", "explode":false, "in":"query", "name":"limit", "required":false, "schema":{ "default":10, "maximum":50000, "minimum":1, "type":"integer" }, "style":"form" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/bbox-crs" }, { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "time_series_id", "monitoring_location_id", "parameter_code", "statistic_id", "time", "value", "unit_of_measure", "approval_status", "qualifier", "last_modified" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/skipGeometry" }, { "$ref":"#/components/parameters/wda_sortby" }, { "$ref":"#/components/parameters/offset" }, { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/datetime" }, { "description":"A universally unique identifier (UUID) representing a single version of a record. It is not stable over time. Every time the record is refreshed in our database (which may happen as part of normal operations and does not imply any change to the data itself) a new ID will be generated. To uniquely identify a single observation over time, compare the `time` and `time_series_id` fields; each time series will only have a single observation at a given `time`.\n", "explode":false, "in":"query", "name":"id", "required":false, "schema":{ "description":"A universally unique identifier (UUID) representing a single version of a record. It is not stable over time. Every time the record is refreshed in our database (which may happen as part of normal operations and does not imply any change to the data itself) a new ID will be generated. To uniquely identify a single observation over time, compare the `time` and `time_series_id` fields; each time series will only have a single observation at a given `time`.\n", "format":"uuid", "type":"string" }, "style":"form" }, { "description":"A unique identifier representing a single time series. This corresponds to the `id` field in the `time-series-metadata` endpoint.\n Split parameters are enabled for this field, so you can supply multiple values separated by commas.", "explode":false, "in":"query", "name":"time_series_id", "required":false, "schema":{ "description":"A unique identifier representing a single time series. This corresponds to the `id` field in the `time-series-metadata` endpoint.\n Split parameters are enabled for this field, so you can supply multiple values separated by commas.", "title":"Time series ID", "type":"string" }, "style":"form" }, { "description":"A unique identifier representing a single monitoring location. This corresponds to the `id` field in the `monitoring-locations` endpoint. Monitoring location IDs are created by combining the agency code of the agency responsible for the monitoring location (e.g. USGS) with the ID number of the monitoring location (e.g. 02238500), separated by a hyphen (e.g. USGS-02238500).\n Split parameters are enabled for this field, so you can supply multiple values separated by commas.", "explode":false, "in":"query", "name":"monitoring_location_id", "required":false, "schema":{ "description":"A unique identifier representing a single monitoring location. This corresponds to the `id` field in the `monitoring-locations` endpoint. Monitoring location IDs are created by combining the agency code of the agency responsible for the monitoring location (e.g. USGS) with the ID number of the monitoring location (e.g. 02238500), separated by a hyphen (e.g. USGS-02238500).\n Split parameters are enabled for this field, so you can supply multiple values separated by commas.", "title":"Monitoring location ID", "type":"string" }, "style":"form" }, { "description":"Parameter codes are 5-digit codes used to identify the constituent measured and the units of measure. A complete list of parameter codes and associated groupings can be found at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/parameter-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/parameter-codes/items).\n Split parameters are enabled for this field, so you can supply multiple values separated by commas.", "explode":false, "in":"query", "name":"parameter_code", "required":false, "schema":{ "description":"Parameter codes are 5-digit codes used to identify the constituent measured and the units of measure. A complete list of parameter codes and associated groupings can be found at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/parameter-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/parameter-codes/items).\n Split parameters are enabled for this field, so you can supply multiple values separated by commas.", "title":"Parameter code", "type":"string" }, "style":"form" }, { "description":"A code corresponding to the statistic an observation represents. Example codes include 00001 (max), 00002 (min), and 00003 (mean). A complete list of codes and their descriptions can be found at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/statistic-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/statistic-codes/items).\n Split parameters are enabled for this field, so you can supply multiple values separated by commas.", "explode":false, "in":"query", "name":"statistic_id", "required":false, "schema":{ "description":"A code corresponding to the statistic an observation represents. Example codes include 00001 (max), 00002 (min), and 00003 (mean). A complete list of codes and their descriptions can be found at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/statistic-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/statistic-codes/items).\n Split parameters are enabled for this field, so you can supply multiple values separated by commas.", "title":"Statistic ID", "type":"string" }, "style":"form" }, { "description":"The date an observation represents. You can query this field using date-times or intervals, adhering to RFC 3339, or using ISO 8601 duration objects. Intervals may be bounded or half-bounded (double-dots at start or end).\nExamples:\n\n - A date-time: \"2018-02-12T23:20:50Z\"\n - A bounded interval: \"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z\"\n - Half-bounded intervals: \"2018-02-12T00:00:00Z/..\" or \"../2018-03-18T12:31:12Z\"\n - Duration objects: \"P1M\" for data from the past month or \"PT36H\" for the last 36 hours\n\nOnly features that have a `time` that intersects the value of datetime are selected. If a feature has multiple temporal properties, it is the decision of the server whether only a single temporal property is used to determine the extent or all relevant temporal properties.\n", "explode":false, "in":"query", "name":"time", "required":false, "schema":{ "description":"The date an observation represents. You can query this field using date-times or intervals, adhering to RFC 3339, or using ISO 8601 duration objects. Intervals may be bounded or half-bounded (double-dots at start or end).\nExamples:\n\n - A date-time: \"2018-02-12T23:20:50Z\"\n - A bounded interval: \"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z\"\n - Half-bounded intervals: \"2018-02-12T00:00:00Z/..\" or \"../2018-03-18T12:31:12Z\"\n - Duration objects: \"P1M\" for data from the past month or \"PT36H\" for the last 36 hours\n\nOnly features that have a `time` that intersects the value of datetime are selected. If a feature has multiple temporal properties, it is the decision of the server whether only a single temporal property is used to determine the extent or all relevant temporal properties.\n", "title":"Time", "type":"string" }, "style":"form" }, { "description":"The value of the observation. Values are transmitted as strings in the JSON response format in order to preserve precision.\n", "explode":false, "in":"query", "name":"value", "required":false, "schema":{ "description":"The value of the observation. Values are transmitted as strings in the JSON response format in order to preserve precision.\n", "title":"Value", "type":"string" }, "style":"form" }, { "description":"A human-readable description of the units of measurement associated with an observation.", "explode":false, "in":"query", "name":"unit_of_measure", "required":false, "schema":{ "description":"A human-readable description of the units of measurement associated with an observation.", "title":"Unit of measure", "type":"string" }, "style":"form" }, { "description":"Some of the data that you have obtained from this U.S. Geological Survey database may not have received Director's approval. Any such data values are qualified as provisional and are subject to revision. Provisional data are released on the condition that neither the USGS nor the United States Government may be held liable for any damages resulting from its use. This field reflects the approval status of each record, and is either \"Approved\", meaining processing review has been completed and the data is approved for publication, or \"Provisional\" and subject to revision. For more information about provisional data, go to [https://waterdata.usgs.gov/provisional-data-statement/](https://waterdata.usgs.gov/provisional-data-statement/).\n", "explode":false, "in":"query", "name":"approval_status", "required":false, "schema":{ "description":"Some of the data that you have obtained from this U.S. Geological Survey database may not have received Director's approval. Any such data values are qualified as provisional and are subject to revision. Provisional data are released on the condition that neither the USGS nor the United States Government may be held liable for any damages resulting from its use. This field reflects the approval status of each record, and is either \"Approved\", meaining processing review has been completed and the data is approved for publication, or \"Provisional\" and subject to revision. For more information about provisional data, go to [https://waterdata.usgs.gov/provisional-data-statement/](https://waterdata.usgs.gov/provisional-data-statement/).\n", "enum":[ "Provisional", "Approved" ], "title":"Approval Status", "type":"string" }, "style":"form" }, { "description":"This field indicates any qualifiers associated with an observation, for instance if a sensor may have been impacted by ice or if values were estimated.\n", "explode":false, "in":"query", "name":"qualifier", "required":false, "schema":{ "description":"This field indicates any qualifiers associated with an observation, for instance if a sensor may have been impacted by ice or if values were estimated.\n", "title":"Qualifier", "type":"string" }, "style":"form" }, { "description":"The last time a record was refreshed in our database. This may happen due to regular operational processes and does not necessarily indicate anything about the measurement has changed.\nYou can query this field using date-times or intervals, adhering to RFC 3339, or using ISO 8601 duration objects. Intervals may be bounded or half-bounded (double-dots at start or end).\nExamples:\n\n - A date-time: \"2018-02-12T23:20:50Z\"\n - A bounded interval: \"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z\"\n - Half-bounded intervals: \"2018-02-12T00:00:00Z/..\" or \"../2018-03-18T12:31:12Z\"\n - Duration objects: \"P1M\" for data from the past month or \"PT36H\" for the last 36 hours\n\nOnly features that have a `last_modified` that intersects the value of datetime are selected.\n", "explode":false, "in":"query", "name":"last_modified", "required":false, "schema":{ "description":"The last time a record was refreshed in our database. This may happen due to regular operational processes and does not necessarily indicate anything about the measurement has changed.\nYou can query this field using date-times or intervals, adhering to RFC 3339, or using ISO 8601 duration objects. Intervals may be bounded or half-bounded (double-dots at start or end).\nExamples:\n\n - A date-time: \"2018-02-12T23:20:50Z\"\n - A bounded interval: \"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z\"\n - Half-bounded intervals: \"2018-02-12T00:00:00Z/..\" or \"../2018-03-18T12:31:12Z\"\n - Duration objects: \"P1M\" for data from the past month or \"PT36H\" for the last 36 hours\n\nOnly features that have a `last_modified` that intersects the value of datetime are selected.\n", "title":"Last modified date", "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Latest daily values items", "tags":[ "latest-daily" ] }, "options":{ "description":"Daily data provide one data value to represent water conditions for the day. Throughout much of the history of the USGS, the primary water data available was daily data collected manually at the monitoring location once each day. With improved availability of computer storage and automated transmission of data, the daily data published today are generally a statistical summary or metric of the continuous data collected each day, such as the daily mean, minimum, or maximum value. Daily data are automatically calculated from the continuous data of the same parameter code and are described by parameter code and a statistic code. These data have also been referred to as \u201cdaily values\u201d or \u201cDV\u201d.\n", "operationId":"optionsLatest-dailyFeatures", "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for Latest daily values items", "tags":[ "latest-daily" ] }, "post":{ "description":"Daily data provide one data value to represent water conditions for the day. Throughout much of the history of the USGS, the primary water data available was daily data collected manually at the monitoring location once each day. With improved availability of computer storage and automated transmission of data, the daily data published today are generally a statistical summary or metric of the continuous data collected each day, such as the daily mean, minimum, or maximum value. Daily data are automatically calculated from the continuous data of the same parameter code and are described by parameter code and a statistic code. These data have also been referred to as \u201cdaily values\u201d or \u201cDV\u201d.\n", "operationId":"getCQL2Latest-dailyFeatures", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"https://schemas.opengis.net/cql2/1.0/cql2.json" } } }, "description":"Get items with CQL2", "required":true }, "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Latest daily values items with CQL2", "tags":[ "latest-daily" ] } }, "/collections/latest-daily/items/{featureId}":{ "get":{ "description":"Daily data provide one data value to represent water conditions for the day. Throughout much of the history of the USGS, the primary water data available was daily data collected manually at the monitoring location once each day. With improved availability of computer storage and automated transmission of data, the daily data published today are generally a statistical summary or metric of the continuous data collected each day, such as the daily mean, minimum, or maximum value. Daily data are automatically calculated from the continuous data of the same parameter code and are described by parameter code and a statistic code. These data have also been referred to as \u201cdaily values\u201d or \u201cDV\u201d.\n", "operationId":"getLatest-dailyFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Feature" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Latest daily values item by id", "tags":[ "latest-daily" ] }, "options":{ "description":"Daily data provide one data value to represent water conditions for the day. Throughout much of the history of the USGS, the primary water data available was daily data collected manually at the monitoring location once each day. With improved availability of computer storage and automated transmission of data, the daily data published today are generally a statistical summary or metric of the continuous data collected each day, such as the daily mean, minimum, or maximum value. Daily data are automatically calculated from the continuous data of the same parameter code and are described by parameter code and a statistic code. These data have also been referred to as \u201cdaily values\u201d or \u201cDV\u201d.\n", "operationId":"optionsLatest-dailyFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" } ], "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for Latest daily values item by id", "tags":[ "latest-daily" ] } }, "/collections/latest-daily/queryables":{ "get":{ "description":"Daily data provide one data value to represent water conditions for the day. Throughout much of the history of the USGS, the primary water data available was daily data collected manually at the monitoring location once each day. With improved availability of computer storage and automated transmission of data, the daily data published today are generally a statistical summary or metric of the continuous data collected each day, such as the daily mean, minimum, or maximum value. Daily data are automatically calculated from the continuous data of the same parameter code and are described by parameter code and a statistic code. These data have also been referred to as \u201cdaily values\u201d or \u201cDV\u201d.\n", "operationId":"getLatest-dailyQueryables", "parameters":[ { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "time_series_id", "monitoring_location_id", "parameter_code", "statistic_id", "time", "value", "unit_of_measure", "approval_status", "qualifier", "last_modified" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/f" }, { "description":"The profile to be applied to a given request", "explode":false, "in":"query", "name":"profile", "required":false, "schema":{ "enum":[ "actual-domain", "valid-domain" ], "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Latest daily values queryables", "tags":[ "latest-daily" ] } }, "/collections/latest-daily/schema":{ "get":{ "description":"Daily data provide one data value to represent water conditions for the day. Throughout much of the history of the USGS, the primary water data available was daily data collected manually at the monitoring location once each day. With improved availability of computer storage and automated transmission of data, the daily data published today are generally a statistical summary or metric of the continuous data collected each day, such as the daily mean, minimum, or maximum value. Daily data are automatically calculated from the continuous data of the same parameter code and are described by parameter code and a statistic code. These data have also been referred to as \u201cdaily values\u201d or \u201cDV\u201d.\n", "operationId":"getLatest-dailySchema", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Latest daily values schema", "tags":[ "latest-daily" ] } }, "/collections/medium-codes":{ "get":{ "description":"Medium refers to the specific environmental medium from which the sample was collected. Medium type differs from site type because one site type, such as surface water, could have data for several media, such as water, bottom sediment, fish tissue, and others.\n", "operationId":"describeMedium-codesCollection", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Collection" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "summary":"Get Medium codes metadata", "tags":[ "medium-codes" ] } }, "/collections/medium-codes/items":{ "get":{ "description":"Medium refers to the specific environmental medium from which the sample was collected. Medium type differs from site type because one site type, such as surface water, could have data for several media, such as water, bottom sediment, fish tissue, and others.\n", "operationId":"getMedium-codesFeatures", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" }, { "$ref":"#/components/parameters/bbox" }, { "description":"The optional limit parameter limits the number of items that are presented in the response document (maximum=50000, default=10000).", "explode":false, "in":"query", "name":"limit", "required":false, "schema":{ "default":10000, "maximum":50000, "minimum":1, "type":"integer" }, "style":"form" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/bbox-crs" }, { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "medium_name", "medium_description", "legacy_medium_code" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/skipGeometry" }, { "$ref":"https://raw.githubusercontent.com/opengeospatial/ogcapi-records/master/core/openapi/parameters/sortby.yaml" }, { "$ref":"#/components/parameters/offset" }, { "description":"The medium code is the 3-character alpha code that identifies the material type and quality-assurance type of the sample. The first character of the code is the \\\"super\\\" medium, which describes the primary matrix of the sample. The second character is the sub-medium, which characterizes the sample type as a unique entity within the \\\"super\\\" medium category. The third character is used to designate whether a sample is an environmental or QC sample. A blank in position three denotes an environmental sample; a \\\"Q\\\" in position three denotes a QC sample.", "explode":false, "in":"query", "name":"id", "required":false, "schema":{ "description":"The medium code is the 3-character alpha code that identifies the material type and quality-assurance type of the sample. The first character of the code is the \\\"super\\\" medium, which describes the primary matrix of the sample. The second character is the sub-medium, which characterizes the sample type as a unique entity within the \\\"super\\\" medium category. The third character is used to designate whether a sample is an environmental or QC sample. A blank in position three denotes an environmental sample; a \\\"Q\\\" in position three denotes a QC sample.", "type":"string" }, "style":"form" }, { "description":"The medium name is a short identifying appellation that explains the associated medium code. See qwmed for examples of codes, names, and descriptions.", "explode":false, "in":"query", "name":"medium_name", "required":false, "schema":{ "description":"The medium name is a short identifying appellation that explains the associated medium code. See qwmed for examples of codes, names, and descriptions.", "type":"string" }, "style":"form" }, { "description":"The medium description is a short string of words that explains the associated medium code. See qwmed for examples of codes, names, and descriptions.", "explode":false, "in":"query", "name":"medium_description", "required":false, "schema":{ "description":"The medium description is a short string of words that explains the associated medium code. See qwmed for examples of codes, names, and descriptions.", "type":"string" }, "style":"form" }, { "description":"Historical 1-char medium code that corresponds to the 3-char code.", "explode":false, "in":"query", "name":"legacy_medium_code", "required":false, "schema":{ "description":"Historical 1-char medium code that corresponds to the 3-char code.", "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Medium codes items", "tags":[ "medium-codes" ] }, "options":{ "description":"Medium refers to the specific environmental medium from which the sample was collected. Medium type differs from site type because one site type, such as surface water, could have data for several media, such as water, bottom sediment, fish tissue, and others.\n", "operationId":"optionsMedium-codesFeatures", "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for Medium codes items", "tags":[ "medium-codes" ] }, "post":{ "description":"Medium refers to the specific environmental medium from which the sample was collected. Medium type differs from site type because one site type, such as surface water, could have data for several media, such as water, bottom sediment, fish tissue, and others.\n", "operationId":"getCQL2Medium-codesFeatures", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"https://schemas.opengis.net/cql2/1.0/cql2.json" } } }, "description":"Get items with CQL2", "required":true }, "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Medium codes items with CQL2", "tags":[ "medium-codes" ] } }, "/collections/medium-codes/items/{featureId}":{ "get":{ "description":"Medium refers to the specific environmental medium from which the sample was collected. Medium type differs from site type because one site type, such as surface water, could have data for several media, such as water, bottom sediment, fish tissue, and others.\n", "operationId":"getMedium-codesFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Feature" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Medium codes item by id", "tags":[ "medium-codes" ] }, "options":{ "description":"Medium refers to the specific environmental medium from which the sample was collected. Medium type differs from site type because one site type, such as surface water, could have data for several media, such as water, bottom sediment, fish tissue, and others.\n", "operationId":"optionsMedium-codesFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" } ], "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for Medium codes item by id", "tags":[ "medium-codes" ] } }, "/collections/medium-codes/queryables":{ "get":{ "description":"Medium refers to the specific environmental medium from which the sample was collected. Medium type differs from site type because one site type, such as surface water, could have data for several media, such as water, bottom sediment, fish tissue, and others.\n", "operationId":"getMedium-codesQueryables", "parameters":[ { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "medium_name", "medium_description", "legacy_medium_code" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/f" }, { "description":"The profile to be applied to a given request", "explode":false, "in":"query", "name":"profile", "required":false, "schema":{ "enum":[ "actual-domain", "valid-domain" ], "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Medium codes queryables", "tags":[ "medium-codes" ] } }, "/collections/medium-codes/schema":{ "get":{ "description":"Medium refers to the specific environmental medium from which the sample was collected. Medium type differs from site type because one site type, such as surface water, could have data for several media, such as water, bottom sediment, fish tissue, and others.\n", "operationId":"getMedium-codesSchema", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Medium codes schema", "tags":[ "medium-codes" ] } }, "/collections/monitoring-locations":{ "get":{ "description":"Location information is basic information about the monitoring location including the name, identifier, agency responsible for data collection, and the date the location was established. It also includes information about the type of location, such as stream, lake, or groundwater, and geographic information about the location, such as state, county, latitude and longitude, and hydrologic unit code (HUC).\n", "operationId":"describeMonitoring-locationsCollection", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Collection" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "summary":"Get Monitoring locations metadata", "tags":[ "monitoring-locations" ] } }, "/collections/monitoring-locations/items":{ "get":{ "description":"Location information is basic information about the monitoring location including the name, identifier, agency responsible for data collection, and the date the location was established. It also includes information about the type of location, such as stream, lake, or groundwater, and geographic information about the location, such as state, county, latitude and longitude, and hydrologic unit code (HUC).\n", "operationId":"getMonitoring-locationsFeatures", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" }, { "$ref":"#/components/parameters/bbox" }, { "description":"The optional limit parameter limits the number of items that are presented in the response document (maximum=50000, default=10).", "explode":false, "in":"query", "name":"limit", "required":false, "schema":{ "default":10, "maximum":50000, "minimum":1, "type":"integer" }, "style":"form" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/bbox-crs" }, { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "agency_code", "agency_name", "monitoring_location_number", "monitoring_location_name", "district_code", "country_code", "country_name", "state_code", "state_name", "county_code", "county_name", "minor_civil_division_code", "site_type_code", "site_type", "hydrologic_unit_code", "basin_code", "altitude", "altitude_accuracy", "altitude_method_code", "altitude_method_name", "vertical_datum", "vertical_datum_name", "horizontal_positional_accuracy_code", "horizontal_positional_accuracy", "horizontal_position_method_code", "horizontal_position_method_name", "original_horizontal_datum", "original_horizontal_datum_name", "drainage_area", "contributing_drainage_area", "time_zone_abbreviation", "uses_daylight_savings", "construction_date", "aquifer_code", "national_aquifer_code", "aquifer_type_code", "well_constructed_depth", "hole_constructed_depth", "depth_source_code" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/skipGeometry" }, { "$ref":"#/components/parameters/wda_sortby" }, { "$ref":"#/components/parameters/offset" }, { "description":"A unique identifier representing a single monitoring location. This corresponds to the `id` field in the `monitoring-locations` endpoint. Monitoring location IDs are created by combining the agency code of the agency responsible for the monitoring location (e.g. USGS) with the ID number of the monitoring location (e.g. 02238500), separated by a hyphen (e.g. USGS-02238500).\n Split parameters are enabled for this field, so you can supply multiple values separated by commas.", "explode":false, "in":"query", "name":"id", "required":false, "schema":{ "description":"A unique identifier representing a single monitoring location. This corresponds to the `id` field in the `monitoring-locations` endpoint. Monitoring location IDs are created by combining the agency code of the agency responsible for the monitoring location (e.g. USGS) with the ID number of the monitoring location (e.g. 02238500), separated by a hyphen (e.g. USGS-02238500).\n Split parameters are enabled for this field, so you can supply multiple values separated by commas.", "title":"Monitoring location ID", "type":"string" }, "style":"form" }, { "description":"The agency that is reporting the data. Agency codes are fixed values assigned by the National Water Information System (NWIS). A list of agency codes is available at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/agency-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/agency-codes/items).\n", "explode":false, "in":"query", "name":"agency_code", "required":false, "schema":{ "description":"The agency that is reporting the data. Agency codes are fixed values assigned by the National Water Information System (NWIS). A list of agency codes is available at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/agency-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/agency-codes/items).\n", "title":"Agency code", "type":"string" }, "style":"form" }, { "description":"The name of the agency that is reporting the data.\n", "explode":false, "in":"query", "name":"agency_name", "required":false, "schema":{ "description":"The name of the agency that is reporting the data.\n", "title":"Agency name", "type":"string" }, "style":"form" }, { "description":"Each monitoring location in the USGS data base has a unique 8- to 15-digit identification number.\n", "explode":false, "in":"query", "name":"monitoring_location_number", "required":false, "schema":{ "description":"Each monitoring location in the USGS data base has a unique 8- to 15-digit identification number.\n", "title":"Monitoring location number", "type":"string" }, "style":"form" }, { "description":"This is the official name of the monitoring location in the database. For well information this can be a district-assigned local number.\n", "explode":false, "in":"query", "name":"monitoring_location_name", "required":false, "schema":{ "description":"This is the official name of the monitoring location in the database. For well information this can be a district-assigned local number.\n", "title":"Monitoring location name", "type":"string" }, "style":"form" }, { "description":"The Water Science Centers (WSCs) across the United States use the FIPS state code as the district code. In some case, monitoring locations and samples may be managed by a water science center that is adjacent to the state in which the monitoring location actually resides. For example a monitoring location may have a district code of 30 which translates to Montana, but the state code could be 56 for Wyoming because that is where the monitoring location actually is located.\n", "explode":false, "in":"query", "name":"district_code", "required":false, "schema":{ "description":"The Water Science Centers (WSCs) across the United States use the FIPS state code as the district code. In some case, monitoring locations and samples may be managed by a water science center that is adjacent to the state in which the monitoring location actually resides. For example a monitoring location may have a district code of 30 which translates to Montana, but the state code could be 56 for Wyoming because that is where the monitoring location actually is located.\n", "title":"District code", "type":"string" }, "style":"form" }, { "description":"The code for the country in which the monitoring location is located.\n", "explode":false, "in":"query", "name":"country_code", "required":false, "schema":{ "description":"The code for the country in which the monitoring location is located.\n", "title":"Country code", "type":"string" }, "style":"form" }, { "description":"The name of the country in which the monitoring location is located.\n", "explode":false, "in":"query", "name":"country_name", "required":false, "schema":{ "description":"The name of the country in which the monitoring location is located.\n", "title":"Country name", "type":"string" }, "style":"form" }, { "description":"State code. A [two-digit ANSI code](https://www2.census.gov/geo/docs/reference/state.txt) (formerly FIPS code) as defined by the American National Standards Institute, to define States and equivalents. A three-digit ANSI code is used to define counties and county equivalents. [A lookup table is available.](https://www.census.gov/library/reference/code-lists/ansi.html#states) The only countries with political subdivisions other than the US are Mexico and Canada. The Mexican states have US state codes ranging from 81-86 and Canadian provinces have state codes ranging from 90-98.\n", "explode":false, "in":"query", "name":"state_code", "required":false, "schema":{ "description":"State code. A [two-digit ANSI code](https://www2.census.gov/geo/docs/reference/state.txt) (formerly FIPS code) as defined by the American National Standards Institute, to define States and equivalents. A three-digit ANSI code is used to define counties and county equivalents. [A lookup table is available.](https://www.census.gov/library/reference/code-lists/ansi.html#states) The only countries with political subdivisions other than the US are Mexico and Canada. The Mexican states have US state codes ranging from 81-86 and Canadian provinces have state codes ranging from 90-98.\n", "title":"State code", "type":"string" }, "style":"form" }, { "description":"The name of the state or state equivalent in which the monitoring location is located.\n", "explode":false, "in":"query", "name":"state_name", "required":false, "schema":{ "description":"The name of the state or state equivalent in which the monitoring location is located.\n", "title":"State name", "type":"string" }, "style":"form" }, { "description":"The code for the county or county equivalent (parish, borough, etc.) in which the monitoring location is located. A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/counties/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/counties/items).\n", "explode":false, "in":"query", "name":"county_code", "required":false, "schema":{ "description":"The code for the county or county equivalent (parish, borough, etc.) in which the monitoring location is located. A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/counties/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/counties/items).\n", "title":"County code", "type":"string" }, "style":"form" }, { "description":"The name of the county or county equivalent (parish, borough, etc.) in which the monitoring location is located. [A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/counties/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/counties/items).\n", "explode":false, "in":"query", "name":"county_name", "required":false, "schema":{ "description":"The name of the county or county equivalent (parish, borough, etc.) in which the monitoring location is located. [A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/counties/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/counties/items).\n", "title":"County name", "type":"string" }, "style":"form" }, { "description":"Codes for primary governmental or administrative divisions of the county or county equivalent in which the monitoring location is located.\n", "explode":false, "in":"query", "name":"minor_civil_division_code", "required":false, "schema":{ "description":"Codes for primary governmental or administrative divisions of the county or county equivalent in which the monitoring location is located.\n", "title":"Minor civil division code", "type":"string" }, "style":"form" }, { "description":"A code describing the hydrologic setting of the monitoring location. A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/site-types/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/site-types/items).\n", "explode":false, "in":"query", "name":"site_type_code", "required":false, "schema":{ "description":"A code describing the hydrologic setting of the monitoring location. A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/site-types/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/site-types/items).\n", "title":"Monitoring location type code", "type":"string" }, "style":"form" }, { "description":"A description of the hydrologic setting of the monitoring location. A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/site-types/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/site-types/items).\n", "explode":false, "in":"query", "name":"site_type", "required":false, "schema":{ "description":"A description of the hydrologic setting of the monitoring location. A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/site-types/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/site-types/items).\n", "title":"Monitoring location type", "type":"string" }, "style":"form" }, { "description":"The United States is divided and sub-divided into successively smaller hydrologic units which are classified into four levels: regions, sub-regions, accounting units, and cataloging units. The hydrologic units are arranged within each other, from the smallest (cataloging units) to the largest (regions). Each hydrologic unit is identified by a unique hydrologic unit code (HUC) consisting of two to eight digits based on the four levels of classification in the hydrologic unit system.\n Search will match partial HUCs.", "explode":false, "in":"query", "name":"hydrologic_unit_code", "required":false, "schema":{ "description":"The United States is divided and sub-divided into successively smaller hydrologic units which are classified into four levels: regions, sub-regions, accounting units, and cataloging units. The hydrologic units are arranged within each other, from the smallest (cataloging units) to the largest (regions). Each hydrologic unit is identified by a unique hydrologic unit code (HUC) consisting of two to eight digits based on the four levels of classification in the hydrologic unit system.\n Search will match partial HUCs.", "title":"Hydrologic unit code (HUC)", "type":"string" }, "style":"form" }, { "description":"The Basin Code or \"drainage basin code\" is a two-digit code that further subdivides the 8-digit hydrologic-unit code. The drainage basin code is defined by the USGS State Office where the monitoring location is located.\n", "explode":false, "in":"query", "name":"basin_code", "required":false, "schema":{ "description":"The Basin Code or \"drainage basin code\" is a two-digit code that further subdivides the 8-digit hydrologic-unit code. The drainage basin code is defined by the USGS State Office where the monitoring location is located.\n", "title":"Basin code", "type":"string" }, "style":"form" }, { "description":"Altitude of the monitoring location referenced to the specified Vertical Datum.\n", "explode":false, "in":"query", "name":"altitude", "required":false, "schema":{ "description":"Altitude of the monitoring location referenced to the specified Vertical Datum.\n", "title":"Altitude", "type":"number" }, "style":"form" }, { "description":"Accuracy of the altitude, in feet. An accuracy of +/- 0.1 foot would be entered as \u201c.1\u201d. Many altitudes are interpolated from the contours on topographic maps; accuracies determined in this way are generally entered as one-half of the contour interval.\n", "explode":false, "in":"query", "name":"altitude_accuracy", "required":false, "schema":{ "description":"Accuracy of the altitude, in feet. An accuracy of +/- 0.1 foot would be entered as \u201c.1\u201d. Many altitudes are interpolated from the contours on topographic maps; accuracies determined in this way are generally entered as one-half of the contour interval.\n", "title":"Altitude accuracy", "type":"number" }, "style":"form" }, { "description":"Codes representing the method used to measure altitude.\n", "explode":false, "in":"query", "name":"altitude_method_code", "required":false, "schema":{ "description":"Codes representing the method used to measure altitude.\n", "title":"Altitude method code", "type":"string" }, "style":"form" }, { "description":"The name of the the method used to measure altitude.\n", "explode":false, "in":"query", "name":"altitude_method_name", "required":false, "schema":{ "description":"The name of the the method used to measure altitude.\n", "title":"Altitude method name", "type":"string" }, "style":"form" }, { "description":"The datum used to determine altitude and vertical position at the monitoring location. A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/altitude-datums/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/altitude-datums/items).\n", "explode":false, "in":"query", "name":"vertical_datum", "required":false, "schema":{ "description":"The datum used to determine altitude and vertical position at the monitoring location. A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/altitude-datums/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/altitude-datums/items).\n", "title":"Vertical datum", "type":"string" }, "style":"form" }, { "description":"The datum used to determine altitude and vertical position at the monitoring location. A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/altitude-datums/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/altitude-datums/items).\n", "explode":false, "in":"query", "name":"vertical_datum_name", "required":false, "schema":{ "description":"The datum used to determine altitude and vertical position at the monitoring location. A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/altitude-datums/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/altitude-datums/items).\n", "title":"Vertical datum name", "type":"string" }, "style":"form" }, { "description":"Indicates the accuracy of the latitude longitude values. A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/coordinate-accuracy-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/coordinate-accuracy-codes/items).\n", "explode":false, "in":"query", "name":"horizontal_positional_accuracy_code", "required":false, "schema":{ "description":"Indicates the accuracy of the latitude longitude values. A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/coordinate-accuracy-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/coordinate-accuracy-codes/items).\n", "title":"Horizontal positional accuracy code", "type":"string" }, "style":"form" }, { "description":"Indicates the accuracy of the latitude longitude values. A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/coordinate-accuracy-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/coordinate-accuracy-codes/items).\n", "explode":false, "in":"query", "name":"horizontal_positional_accuracy", "required":false, "schema":{ "description":"Indicates the accuracy of the latitude longitude values. A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/coordinate-accuracy-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/coordinate-accuracy-codes/items).\n", "title":"Horizontal positional accuracy", "type":"string" }, "style":"form" }, { "description":"Indicates the method used to determine latitude longitude values. A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/coordinate-method-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/coordinate-method-codes/items).\n", "explode":false, "in":"query", "name":"horizontal_position_method_code", "required":false, "schema":{ "description":"Indicates the method used to determine latitude longitude values. A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/coordinate-method-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/coordinate-method-codes/items).\n", "title":"Horizontal position method code", "type":"string" }, "style":"form" }, { "description":"Indicates the method used to determine latitude longitude values. A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/coordinate-method-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/coordinate-method-codes/items).\n", "explode":false, "in":"query", "name":"horizontal_position_method_name", "required":false, "schema":{ "description":"Indicates the method used to determine latitude longitude values. A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/coordinate-method-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/coordinate-method-codes/items).\n", "title":"Horizontal position method name", "type":"string" }, "style":"form" }, { "description":"Coordinates are published in EPSG:4326 / WGS84 / World Geodetic System 1984. This field indicates the original datum used to determine coordinates before they were converted. A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/coordinate-datum-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/coordinate-datum-codes/items).\n", "explode":false, "in":"query", "name":"original_horizontal_datum", "required":false, "schema":{ "description":"Coordinates are published in EPSG:4326 / WGS84 / World Geodetic System 1984. This field indicates the original datum used to determine coordinates before they were converted. A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/coordinate-datum-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/coordinate-datum-codes/items).\n", "title":"Original horizontal datum", "type":"string" }, "style":"form" }, { "description":"Coordinates are published in EPSG:4326 / WGS84 / World Geodetic System 1984. This field indicates the original datum used to determine coordinates before they were converted. A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/coordinate-datum-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/coordinate-datum-codes/items).\n", "explode":false, "in":"query", "name":"original_horizontal_datum_name", "required":false, "schema":{ "description":"Coordinates are published in EPSG:4326 / WGS84 / World Geodetic System 1984. This field indicates the original datum used to determine coordinates before they were converted. A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/coordinate-datum-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/coordinate-datum-codes/items).\n", "title":"Original horizontal datum name", "type":"string" }, "style":"form" }, { "description":"The area enclosed by a topographic divide from which direct surface runoff from precipitation normally drains by gravity into the stream above that point.\n", "explode":false, "in":"query", "name":"drainage_area", "required":false, "schema":{ "description":"The area enclosed by a topographic divide from which direct surface runoff from precipitation normally drains by gravity into the stream above that point.\n", "title":"Drainage area", "type":"number" }, "style":"form" }, { "description":"The contributing drainage area of a lake, stream, wetland, or estuary monitoring location, in square miles. This item should be present only if the contributing area is different from the total drainage area. This situation can occur when part of the drainage area consists of very porous soil or depressions that either allow all runoff to enter the groundwater or traps the water in ponds so that rainfall does not contribute to runoff. A transbasin diversion can also affect the total drainage area.\n", "explode":false, "in":"query", "name":"contributing_drainage_area", "required":false, "schema":{ "description":"The contributing drainage area of a lake, stream, wetland, or estuary monitoring location, in square miles. This item should be present only if the contributing area is different from the total drainage area. This situation can occur when part of the drainage area consists of very porous soil or depressions that either allow all runoff to enter the groundwater or traps the water in ponds so that rainfall does not contribute to runoff. A transbasin diversion can also affect the total drainage area.\n", "title":"Contributing drainage area", "type":"number" }, "style":"form" }, { "description":"A short code describing the time zone used by a monitoring location.\n", "explode":false, "in":"query", "name":"time_zone_abbreviation", "required":false, "schema":{ "description":"A short code describing the time zone used by a monitoring location.\n", "title":"Time zone abbreviation", "type":"string" }, "style":"form" }, { "description":"A flag indicating whether or not a monitoring location uses daylight savings.\n", "explode":false, "in":"query", "name":"uses_daylight_savings", "required":false, "schema":{ "description":"A flag indicating whether or not a monitoring location uses daylight savings.\n", "title":"Uses daylight savings flag", "type":"string" }, "style":"form" }, { "description":"Date the well was completed.\n", "explode":false, "in":"query", "name":"construction_date", "required":false, "schema":{ "description":"Date the well was completed.\n", "title":"Construction date", "type":"string" }, "style":"form" }, { "description":"Local aquifers in the USGS water resources data base are identified by a geohydrologic unit code (a three-digit number related to the age of the formation, followed by a 4 or 5 character abbreviation for the geologic unit or aquifer name).\n", "explode":false, "in":"query", "name":"aquifer_code", "required":false, "schema":{ "description":"Local aquifers in the USGS water resources data base are identified by a geohydrologic unit code (a three-digit number related to the age of the formation, followed by a 4 or 5 character abbreviation for the geologic unit or aquifer name).\n", "title":"Aquifer code", "type":"string" }, "style":"form" }, { "description":"National aquifers are the principal aquifers or aquifer systems in the United States, defined as regionally extensive aquifers or aquifer systems that have the potential to be used as a source of potable water. Not all groundwater monitoring locations can be associated with a National Aquifer. Such monitoring locations will not be retrieved using this search criteria. A list of National aquifer codes and names is available at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/national-aquifer-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/national-aquifer-codes/items).\n", "explode":false, "in":"query", "name":"national_aquifer_code", "required":false, "schema":{ "description":"National aquifers are the principal aquifers or aquifer systems in the United States, defined as regionally extensive aquifers or aquifer systems that have the potential to be used as a source of potable water. Not all groundwater monitoring locations can be associated with a National Aquifer. Such monitoring locations will not be retrieved using this search criteria. A list of National aquifer codes and names is available at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/national-aquifer-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/national-aquifer-codes/items).\n", "title":"National aquifer code", "type":"string" }, "style":"form" }, { "description":"Groundwater occurs in aquifers under two different conditions. Where water only partly fills an aquifer, the upper surface is free to rise and decline. These aquifers are referred to as unconfined (or water-table) aquifers. Where water completely fills an aquifer that is overlain by a confining bed, the aquifer is referred to as a confined (or artesian) aquifer. When a confined aquifer is penetrated by a well, the water level in the well will rise above the top of the aquifer (but not necessarily above land surface).\n", "explode":false, "in":"query", "name":"aquifer_type_code", "required":false, "schema":{ "description":"Groundwater occurs in aquifers under two different conditions. Where water only partly fills an aquifer, the upper surface is free to rise and decline. These aquifers are referred to as unconfined (or water-table) aquifers. Where water completely fills an aquifer that is overlain by a confining bed, the aquifer is referred to as a confined (or artesian) aquifer. When a confined aquifer is penetrated by a well, the water level in the well will rise above the top of the aquifer (but not necessarily above land surface).\n", "title":"Aquifer type code", "type":"string" }, "style":"form" }, { "description":"The depth of the finished well, in feet below land surface datum. Note: Not all groundwater monitoring locations have information on Well Depth. Such monitoring locations will not be retrieved using this search criteria.\n", "explode":false, "in":"query", "name":"well_constructed_depth", "required":false, "schema":{ "description":"The depth of the finished well, in feet below land surface datum. Note: Not all groundwater monitoring locations have information on Well Depth. Such monitoring locations will not be retrieved using this search criteria.\n", "title":"Well constructed depth", "type":"number" }, "style":"form" }, { "description":"The total depth to which the hole is drilled, in feet below land surface datum. Note: Not all groundwater monitoring locations have information on Hole Depth. Such monitoring locations will not be retrieved using this search criteria.\n", "explode":false, "in":"query", "name":"hole_constructed_depth", "required":false, "schema":{ "description":"The total depth to which the hole is drilled, in feet below land surface datum. Note: Not all groundwater monitoring locations have information on Hole Depth. Such monitoring locations will not be retrieved using this search criteria.\n", "title":"Hole constructed depth", "type":"number" }, "style":"form" }, { "description":"A code indicating the source of water-level data.\n", "explode":false, "in":"query", "name":"depth_source_code", "required":false, "schema":{ "description":"A code indicating the source of water-level data.\n", "title":"Depth source code", "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Monitoring locations items", "tags":[ "monitoring-locations" ] }, "options":{ "description":"Location information is basic information about the monitoring location including the name, identifier, agency responsible for data collection, and the date the location was established. It also includes information about the type of location, such as stream, lake, or groundwater, and geographic information about the location, such as state, county, latitude and longitude, and hydrologic unit code (HUC).\n", "operationId":"optionsMonitoring-locationsFeatures", "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for Monitoring locations items", "tags":[ "monitoring-locations" ] }, "post":{ "description":"Location information is basic information about the monitoring location including the name, identifier, agency responsible for data collection, and the date the location was established. It also includes information about the type of location, such as stream, lake, or groundwater, and geographic information about the location, such as state, county, latitude and longitude, and hydrologic unit code (HUC).\n", "operationId":"getCQL2Monitoring-locationsFeatures", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"https://schemas.opengis.net/cql2/1.0/cql2.json" } } }, "description":"Get items with CQL2", "required":true }, "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Monitoring locations items with CQL2", "tags":[ "monitoring-locations" ] } }, "/collections/monitoring-locations/items/{featureId}":{ "get":{ "description":"Location information is basic information about the monitoring location including the name, identifier, agency responsible for data collection, and the date the location was established. It also includes information about the type of location, such as stream, lake, or groundwater, and geographic information about the location, such as state, county, latitude and longitude, and hydrologic unit code (HUC).\n", "operationId":"getMonitoring-locationsFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Feature" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Monitoring locations item by id", "tags":[ "monitoring-locations" ] }, "options":{ "description":"Location information is basic information about the monitoring location including the name, identifier, agency responsible for data collection, and the date the location was established. It also includes information about the type of location, such as stream, lake, or groundwater, and geographic information about the location, such as state, county, latitude and longitude, and hydrologic unit code (HUC).\n", "operationId":"optionsMonitoring-locationsFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" } ], "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for Monitoring locations item by id", "tags":[ "monitoring-locations" ] } }, "/collections/monitoring-locations/queryables":{ "get":{ "description":"Location information is basic information about the monitoring location including the name, identifier, agency responsible for data collection, and the date the location was established. It also includes information about the type of location, such as stream, lake, or groundwater, and geographic information about the location, such as state, county, latitude and longitude, and hydrologic unit code (HUC).\n", "operationId":"getMonitoring-locationsQueryables", "parameters":[ { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "agency_code", "agency_name", "monitoring_location_number", "monitoring_location_name", "district_code", "country_code", "country_name", "state_code", "state_name", "county_code", "county_name", "minor_civil_division_code", "site_type_code", "site_type", "hydrologic_unit_code", "basin_code", "altitude", "altitude_accuracy", "altitude_method_code", "altitude_method_name", "vertical_datum", "vertical_datum_name", "horizontal_positional_accuracy_code", "horizontal_positional_accuracy", "horizontal_position_method_code", "horizontal_position_method_name", "original_horizontal_datum", "original_horizontal_datum_name", "drainage_area", "contributing_drainage_area", "time_zone_abbreviation", "uses_daylight_savings", "construction_date", "aquifer_code", "national_aquifer_code", "aquifer_type_code", "well_constructed_depth", "hole_constructed_depth", "depth_source_code" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/f" }, { "description":"The profile to be applied to a given request", "explode":false, "in":"query", "name":"profile", "required":false, "schema":{ "enum":[ "actual-domain", "valid-domain" ], "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Monitoring locations queryables", "tags":[ "monitoring-locations" ] } }, "/collections/monitoring-locations/schema":{ "get":{ "description":"Location information is basic information about the monitoring location including the name, identifier, agency responsible for data collection, and the date the location was established. It also includes information about the type of location, such as stream, lake, or groundwater, and geographic information about the location, such as state, county, latitude and longitude, and hydrologic unit code (HUC).\n", "operationId":"getMonitoring-locationsSchema", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Monitoring locations schema", "tags":[ "monitoring-locations" ] } }, "/collections/national-aquifer-codes":{ "get":{ "description":"National aquifers are the principal aquifers or aquifer systems in the United States, defined as regionally extensive aquifers or aquifer systems that have the potential to be used as a source of potable water.\n", "operationId":"describeNational-aquifer-codesCollection", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Collection" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "summary":"Get National aquifer codes metadata", "tags":[ "national-aquifer-codes" ] } }, "/collections/national-aquifer-codes/items":{ "get":{ "description":"National aquifers are the principal aquifers or aquifer systems in the United States, defined as regionally extensive aquifers or aquifer systems that have the potential to be used as a source of potable water.\n", "operationId":"getNational-aquifer-codesFeatures", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" }, { "$ref":"#/components/parameters/bbox" }, { "description":"The optional limit parameter limits the number of items that are presented in the response document (maximum=50000, default=10000).", "explode":false, "in":"query", "name":"limit", "required":false, "schema":{ "default":10000, "maximum":50000, "minimum":1, "type":"integer" }, "style":"form" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/bbox-crs" }, { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "national_aquifer_name" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/skipGeometry" }, { "$ref":"https://raw.githubusercontent.com/opengeospatial/ogcapi-records/master/core/openapi/parameters/sortby.yaml" }, { "$ref":"#/components/parameters/offset" }, { "description":"National aquifer code.", "explode":false, "in":"query", "name":"id", "required":false, "schema":{ "description":"National aquifer code.", "type":"string" }, "style":"form" }, { "description":"National aquifer name.", "explode":false, "in":"query", "name":"national_aquifer_name", "required":false, "schema":{ "description":"National aquifer name.", "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get National aquifer codes items", "tags":[ "national-aquifer-codes" ] }, "options":{ "description":"National aquifers are the principal aquifers or aquifer systems in the United States, defined as regionally extensive aquifers or aquifer systems that have the potential to be used as a source of potable water.\n", "operationId":"optionsNational-aquifer-codesFeatures", "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for National aquifer codes items", "tags":[ "national-aquifer-codes" ] }, "post":{ "description":"National aquifers are the principal aquifers or aquifer systems in the United States, defined as regionally extensive aquifers or aquifer systems that have the potential to be used as a source of potable water.\n", "operationId":"getCQL2National-aquifer-codesFeatures", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"https://schemas.opengis.net/cql2/1.0/cql2.json" } } }, "description":"Get items with CQL2", "required":true }, "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get National aquifer codes items with CQL2", "tags":[ "national-aquifer-codes" ] } }, "/collections/national-aquifer-codes/items/{featureId}":{ "get":{ "description":"National aquifers are the principal aquifers or aquifer systems in the United States, defined as regionally extensive aquifers or aquifer systems that have the potential to be used as a source of potable water.\n", "operationId":"getNational-aquifer-codesFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Feature" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get National aquifer codes item by id", "tags":[ "national-aquifer-codes" ] }, "options":{ "description":"National aquifers are the principal aquifers or aquifer systems in the United States, defined as regionally extensive aquifers or aquifer systems that have the potential to be used as a source of potable water.\n", "operationId":"optionsNational-aquifer-codesFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" } ], "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for National aquifer codes item by id", "tags":[ "national-aquifer-codes" ] } }, "/collections/national-aquifer-codes/queryables":{ "get":{ "description":"National aquifers are the principal aquifers or aquifer systems in the United States, defined as regionally extensive aquifers or aquifer systems that have the potential to be used as a source of potable water.\n", "operationId":"getNational-aquifer-codesQueryables", "parameters":[ { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "national_aquifer_name" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/f" }, { "description":"The profile to be applied to a given request", "explode":false, "in":"query", "name":"profile", "required":false, "schema":{ "enum":[ "actual-domain", "valid-domain" ], "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get National aquifer codes queryables", "tags":[ "national-aquifer-codes" ] } }, "/collections/national-aquifer-codes/schema":{ "get":{ "description":"National aquifers are the principal aquifers or aquifer systems in the United States, defined as regionally extensive aquifers or aquifer systems that have the potential to be used as a source of potable water.\n", "operationId":"getNational-aquifer-codesSchema", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get National aquifer codes schema", "tags":[ "national-aquifer-codes" ] } }, "/collections/parameter-codes":{ "get":{ "description":"Parameter codes are 5-digit codes and associated descriptions used to identify the constituent measured and the units of measure. Some parameter code definitions include information about the sampling matrix, fraction, and methods used to measure the constituent. Some parameters are fixed-value (fxd) numeric codes having textual meaning (for example: parameter code 00041 is a weather code parameter, code of 60 means rain), but more commonly represent a numeric value for chemical, physical, or biological data.\n", "operationId":"describeParameter-codesCollection", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Collection" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "summary":"Get Parameter codes metadata", "tags":[ "parameter-codes" ] } }, "/collections/parameter-codes/items":{ "get":{ "description":"Parameter codes are 5-digit codes and associated descriptions used to identify the constituent measured and the units of measure. Some parameter code definitions include information about the sampling matrix, fraction, and methods used to measure the constituent. Some parameters are fixed-value (fxd) numeric codes having textual meaning (for example: parameter code 00041 is a weather code parameter, code of 60 means rain), but more commonly represent a numeric value for chemical, physical, or biological data.\n", "operationId":"getParameter-codesFeatures", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" }, { "$ref":"#/components/parameters/bbox" }, { "description":"The optional limit parameter limits the number of items that are presented in the response document (maximum=50000, default=10000).", "explode":false, "in":"query", "name":"limit", "required":false, "schema":{ "default":10000, "maximum":50000, "minimum":1, "type":"integer" }, "style":"form" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/bbox-crs" }, { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "parameter_name", "unit_of_measure", "parameter_group_code", "parameter_description", "medium", "statistical_basis", "time_basis", "weight_basis", "particle_size_basis", "sample_fraction", "temperature_basis", "epa_equivalence" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/skipGeometry" }, { "$ref":"https://raw.githubusercontent.com/opengeospatial/ogcapi-records/master/core/openapi/parameters/sortby.yaml" }, { "$ref":"#/components/parameters/offset" }, { "description":"Parameter code.", "explode":false, "in":"query", "name":"id", "required":false, "schema":{ "description":"Parameter code.", "type":"string" }, "style":"form" }, { "description":"Parameter short name.", "explode":false, "in":"query", "name":"parameter_name", "required":false, "schema":{ "description":"Parameter short name.", "type":"string" }, "style":"form" }, { "description":"Parameter reporting units defined to cooperate with descriptions by USEPA.", "explode":false, "in":"query", "name":"unit_of_measure", "required":false, "schema":{ "description":"Parameter reporting units defined to cooperate with descriptions by USEPA.", "type":"string" }, "style":"form" }, { "description":"Categorical groupings of parameters by water-quality data type for display and report ordering", "explode":false, "in":"query", "name":"parameter_group_code", "required":false, "schema":{ "description":"Categorical groupings of parameters by water-quality data type for display and report ordering", "type":"string" }, "style":"form" }, { "description":"Parameter description.", "explode":false, "in":"query", "name":"parameter_description", "required":false, "schema":{ "description":"Parameter description.", "type":"string" }, "style":"form" }, { "description":"Parameter medium.", "explode":false, "in":"query", "name":"medium", "required":false, "schema":{ "description":"Parameter medium.", "type":"string" }, "style":"form" }, { "description":"Parameter statistical basis.", "explode":false, "in":"query", "name":"statistical_basis", "required":false, "schema":{ "description":"Parameter statistical basis.", "type":"string" }, "style":"form" }, { "description":"Parameter time basis.", "explode":false, "in":"query", "name":"time_basis", "required":false, "schema":{ "description":"Parameter time basis.", "type":"string" }, "style":"form" }, { "description":"Parameter weight basis.", "explode":false, "in":"query", "name":"weight_basis", "required":false, "schema":{ "description":"Parameter weight basis.", "type":"string" }, "style":"form" }, { "description":"Parameter particle-size basis.", "explode":false, "in":"query", "name":"particle_size_basis", "required":false, "schema":{ "description":"Parameter particle-size basis.", "type":"string" }, "style":"form" }, { "description":"Parameter fraction.", "explode":false, "in":"query", "name":"sample_fraction", "required":false, "schema":{ "description":"Parameter fraction.", "type":"string" }, "style":"form" }, { "description":"Parameter temperature basis.", "explode":false, "in":"query", "name":"temperature_basis", "required":false, "schema":{ "description":"Parameter temperature basis.", "type":"string" }, "style":"form" }, { "description":"Indicates the relationship of the USGS parameter code to the EPA code.", "explode":false, "in":"query", "name":"epa_equivalence", "required":false, "schema":{ "description":"Indicates the relationship of the USGS parameter code to the EPA code.", "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Parameter codes items", "tags":[ "parameter-codes" ] }, "options":{ "description":"Parameter codes are 5-digit codes and associated descriptions used to identify the constituent measured and the units of measure. Some parameter code definitions include information about the sampling matrix, fraction, and methods used to measure the constituent. Some parameters are fixed-value (fxd) numeric codes having textual meaning (for example: parameter code 00041 is a weather code parameter, code of 60 means rain), but more commonly represent a numeric value for chemical, physical, or biological data.\n", "operationId":"optionsParameter-codesFeatures", "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for Parameter codes items", "tags":[ "parameter-codes" ] }, "post":{ "description":"Parameter codes are 5-digit codes and associated descriptions used to identify the constituent measured and the units of measure. Some parameter code definitions include information about the sampling matrix, fraction, and methods used to measure the constituent. Some parameters are fixed-value (fxd) numeric codes having textual meaning (for example: parameter code 00041 is a weather code parameter, code of 60 means rain), but more commonly represent a numeric value for chemical, physical, or biological data.\n", "operationId":"getCQL2Parameter-codesFeatures", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"https://schemas.opengis.net/cql2/1.0/cql2.json" } } }, "description":"Get items with CQL2", "required":true }, "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Parameter codes items with CQL2", "tags":[ "parameter-codes" ] } }, "/collections/parameter-codes/items/{featureId}":{ "get":{ "description":"Parameter codes are 5-digit codes and associated descriptions used to identify the constituent measured and the units of measure. Some parameter code definitions include information about the sampling matrix, fraction, and methods used to measure the constituent. Some parameters are fixed-value (fxd) numeric codes having textual meaning (for example: parameter code 00041 is a weather code parameter, code of 60 means rain), but more commonly represent a numeric value for chemical, physical, or biological data.\n", "operationId":"getParameter-codesFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Feature" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Parameter codes item by id", "tags":[ "parameter-codes" ] }, "options":{ "description":"Parameter codes are 5-digit codes and associated descriptions used to identify the constituent measured and the units of measure. Some parameter code definitions include information about the sampling matrix, fraction, and methods used to measure the constituent. Some parameters are fixed-value (fxd) numeric codes having textual meaning (for example: parameter code 00041 is a weather code parameter, code of 60 means rain), but more commonly represent a numeric value for chemical, physical, or biological data.\n", "operationId":"optionsParameter-codesFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" } ], "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for Parameter codes item by id", "tags":[ "parameter-codes" ] } }, "/collections/parameter-codes/queryables":{ "get":{ "description":"Parameter codes are 5-digit codes and associated descriptions used to identify the constituent measured and the units of measure. Some parameter code definitions include information about the sampling matrix, fraction, and methods used to measure the constituent. Some parameters are fixed-value (fxd) numeric codes having textual meaning (for example: parameter code 00041 is a weather code parameter, code of 60 means rain), but more commonly represent a numeric value for chemical, physical, or biological data.\n", "operationId":"getParameter-codesQueryables", "parameters":[ { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "parameter_name", "unit_of_measure", "parameter_group_code", "parameter_description", "medium", "statistical_basis", "time_basis", "weight_basis", "particle_size_basis", "sample_fraction", "temperature_basis", "epa_equivalence" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/f" }, { "description":"The profile to be applied to a given request", "explode":false, "in":"query", "name":"profile", "required":false, "schema":{ "enum":[ "actual-domain", "valid-domain" ], "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Parameter codes queryables", "tags":[ "parameter-codes" ] } }, "/collections/parameter-codes/schema":{ "get":{ "description":"Parameter codes are 5-digit codes and associated descriptions used to identify the constituent measured and the units of measure. Some parameter code definitions include information about the sampling matrix, fraction, and methods used to measure the constituent. Some parameters are fixed-value (fxd) numeric codes having textual meaning (for example: parameter code 00041 is a weather code parameter, code of 60 means rain), but more commonly represent a numeric value for chemical, physical, or biological data.\n", "operationId":"getParameter-codesSchema", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Parameter codes schema", "tags":[ "parameter-codes" ] } }, "/collections/reliability-codes":{ "get":{ "description":"Code indicating the reliability of the data available for the site.\n", "operationId":"describeReliability-codesCollection", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Collection" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "summary":"Get Reliability codes metadata", "tags":[ "reliability-codes" ] } }, "/collections/reliability-codes/items":{ "get":{ "description":"Code indicating the reliability of the data available for the site.\n", "operationId":"getReliability-codesFeatures", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" }, { "$ref":"#/components/parameters/bbox" }, { "description":"The optional limit parameter limits the number of items that are presented in the response document (maximum=50000, default=10000).", "explode":false, "in":"query", "name":"limit", "required":false, "schema":{ "default":10000, "maximum":50000, "minimum":1, "type":"integer" }, "style":"form" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/bbox-crs" }, { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "reliability_description" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/skipGeometry" }, { "$ref":"https://raw.githubusercontent.com/opengeospatial/ogcapi-records/master/core/openapi/parameters/sortby.yaml" }, { "$ref":"#/components/parameters/offset" }, { "explode":false, "in":"query", "name":"id", "required":false, "schema":{ "type":"string" }, "style":"form" }, { "explode":false, "in":"query", "name":"reliability_description", "required":false, "schema":{ "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Reliability codes items", "tags":[ "reliability-codes" ] }, "options":{ "description":"Code indicating the reliability of the data available for the site.\n", "operationId":"optionsReliability-codesFeatures", "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for Reliability codes items", "tags":[ "reliability-codes" ] }, "post":{ "description":"Code indicating the reliability of the data available for the site.\n", "operationId":"getCQL2Reliability-codesFeatures", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"https://schemas.opengis.net/cql2/1.0/cql2.json" } } }, "description":"Get items with CQL2", "required":true }, "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Reliability codes items with CQL2", "tags":[ "reliability-codes" ] } }, "/collections/reliability-codes/items/{featureId}":{ "get":{ "description":"Code indicating the reliability of the data available for the site.\n", "operationId":"getReliability-codesFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Feature" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Reliability codes item by id", "tags":[ "reliability-codes" ] }, "options":{ "description":"Code indicating the reliability of the data available for the site.\n", "operationId":"optionsReliability-codesFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" } ], "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for Reliability codes item by id", "tags":[ "reliability-codes" ] } }, "/collections/reliability-codes/queryables":{ "get":{ "description":"Code indicating the reliability of the data available for the site.\n", "operationId":"getReliability-codesQueryables", "parameters":[ { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "reliability_description" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/f" }, { "description":"The profile to be applied to a given request", "explode":false, "in":"query", "name":"profile", "required":false, "schema":{ "enum":[ "actual-domain", "valid-domain" ], "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Reliability codes queryables", "tags":[ "reliability-codes" ] } }, "/collections/reliability-codes/schema":{ "get":{ "description":"Code indicating the reliability of the data available for the site.\n", "operationId":"getReliability-codesSchema", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Reliability codes schema", "tags":[ "reliability-codes" ] } }, "/collections/site-types":{ "get":{ "description":"The hydrologic cycle setting or a man-made feature thought to affect the hydrologic conditions measured at a site. Primary and secondary site types associated with data collection sites. All sites have a primary site type, and may additionally have a secondary site type that further describes the location.\n", "operationId":"describeSite-typesCollection", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Collection" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "summary":"Get Site types metadata", "tags":[ "site-types" ] } }, "/collections/site-types/items":{ "get":{ "description":"The hydrologic cycle setting or a man-made feature thought to affect the hydrologic conditions measured at a site. Primary and secondary site types associated with data collection sites. All sites have a primary site type, and may additionally have a secondary site type that further describes the location.\n", "operationId":"getSite-typesFeatures", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" }, { "$ref":"#/components/parameters/bbox" }, { "description":"The optional limit parameter limits the number of items that are presented in the response document (maximum=50000, default=10000).", "explode":false, "in":"query", "name":"limit", "required":false, "schema":{ "default":10000, "maximum":50000, "minimum":1, "type":"integer" }, "style":"form" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/bbox-crs" }, { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "site_type_primary_flag", "site_type_name", "site_type_description" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/skipGeometry" }, { "$ref":"https://raw.githubusercontent.com/opengeospatial/ogcapi-records/master/core/openapi/parameters/sortby.yaml" }, { "$ref":"#/components/parameters/offset" }, { "description":"An acronym specifying the primary or secondary site type.", "explode":false, "in":"query", "name":"id", "required":false, "schema":{ "description":"An acronym specifying the primary or secondary site type.", "type":"string" }, "style":"form" }, { "description":"Identifies which site types are primary.", "explode":false, "in":"query", "name":"site_type_primary_flag", "required":false, "schema":{ "description":"Identifies which site types are primary.", "type":"string" }, "style":"form" }, { "description":"A long name for the site type used in retrieved output.", "explode":false, "in":"query", "name":"site_type_name", "required":false, "schema":{ "description":"A long name for the site type used in retrieved output.", "type":"string" }, "style":"form" }, { "description":"Site type description.", "explode":false, "in":"query", "name":"site_type_description", "required":false, "schema":{ "description":"Site type description.", "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Site types items", "tags":[ "site-types" ] }, "options":{ "description":"The hydrologic cycle setting or a man-made feature thought to affect the hydrologic conditions measured at a site. Primary and secondary site types associated with data collection sites. All sites have a primary site type, and may additionally have a secondary site type that further describes the location.\n", "operationId":"optionsSite-typesFeatures", "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for Site types items", "tags":[ "site-types" ] }, "post":{ "description":"The hydrologic cycle setting or a man-made feature thought to affect the hydrologic conditions measured at a site. Primary and secondary site types associated with data collection sites. All sites have a primary site type, and may additionally have a secondary site type that further describes the location.\n", "operationId":"getCQL2Site-typesFeatures", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"https://schemas.opengis.net/cql2/1.0/cql2.json" } } }, "description":"Get items with CQL2", "required":true }, "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Site types items with CQL2", "tags":[ "site-types" ] } }, "/collections/site-types/items/{featureId}":{ "get":{ "description":"The hydrologic cycle setting or a man-made feature thought to affect the hydrologic conditions measured at a site. Primary and secondary site types associated with data collection sites. All sites have a primary site type, and may additionally have a secondary site type that further describes the location.\n", "operationId":"getSite-typesFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Feature" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Site types item by id", "tags":[ "site-types" ] }, "options":{ "description":"The hydrologic cycle setting or a man-made feature thought to affect the hydrologic conditions measured at a site. Primary and secondary site types associated with data collection sites. All sites have a primary site type, and may additionally have a secondary site type that further describes the location.\n", "operationId":"optionsSite-typesFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" } ], "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for Site types item by id", "tags":[ "site-types" ] } }, "/collections/site-types/queryables":{ "get":{ "description":"The hydrologic cycle setting or a man-made feature thought to affect the hydrologic conditions measured at a site. Primary and secondary site types associated with data collection sites. All sites have a primary site type, and may additionally have a secondary site type that further describes the location.\n", "operationId":"getSite-typesQueryables", "parameters":[ { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "site_type_primary_flag", "site_type_name", "site_type_description" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/f" }, { "description":"The profile to be applied to a given request", "explode":false, "in":"query", "name":"profile", "required":false, "schema":{ "enum":[ "actual-domain", "valid-domain" ], "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Site types queryables", "tags":[ "site-types" ] } }, "/collections/site-types/schema":{ "get":{ "description":"The hydrologic cycle setting or a man-made feature thought to affect the hydrologic conditions measured at a site. Primary and secondary site types associated with data collection sites. All sites have a primary site type, and may additionally have a secondary site type that further describes the location.\n", "operationId":"getSite-typesSchema", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Site types schema", "tags":[ "site-types" ] } }, "/collections/states":{ "get":{ "description":"State name or territory. Includes U.S. states and foreign entities classified under FIPS as 'Principal Administrative Divisions'.\n", "operationId":"describeStatesCollection", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Collection" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "summary":"Get State identifiers metadata", "tags":[ "states" ] } }, "/collections/states/items":{ "get":{ "description":"State name or territory. Includes U.S. states and foreign entities classified under FIPS as 'Principal Administrative Divisions'.\n", "operationId":"getStatesFeatures", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" }, { "$ref":"#/components/parameters/bbox" }, { "description":"The optional limit parameter limits the number of items that are presented in the response document (maximum=50000, default=10000).", "explode":false, "in":"query", "name":"limit", "required":false, "schema":{ "default":10000, "maximum":50000, "minimum":1, "type":"integer" }, "style":"form" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/bbox-crs" }, { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "country_code", "state_fips_code", "state_name", "state_postal_code" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/skipGeometry" }, { "$ref":"https://raw.githubusercontent.com/opengeospatial/ogcapi-records/master/core/openapi/parameters/sortby.yaml" }, { "$ref":"#/components/parameters/offset" }, { "explode":false, "in":"query", "name":"id", "required":false, "schema":{ "type":"string" }, "style":"form" }, { "description":"FIPS country code as defined by FIPS PUB 10-4: Countries, Dependencies, Areas of Special Sovereignty, and Their Principal Administrative Divisions.", "explode":false, "in":"query", "name":"country_code", "required":false, "schema":{ "description":"FIPS country code as defined by FIPS PUB 10-4: Countries, Dependencies, Areas of Special Sovereignty, and Their Principal Administrative Divisions.", "type":"string" }, "style":"form" }, { "description":"State FIPS code.", "explode":false, "in":"query", "name":"state_fips_code", "required":false, "schema":{ "description":"State FIPS code.", "type":"string" }, "style":"form" }, { "description":"State name.", "explode":false, "in":"query", "name":"state_name", "required":false, "schema":{ "description":"State name.", "type":"string" }, "style":"form" }, { "description":"State postal abbreviation. A two-letter USPS state postal abbreviation.", "explode":false, "in":"query", "name":"state_postal_code", "required":false, "schema":{ "description":"State postal abbreviation. A two-letter USPS state postal abbreviation.", "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get State identifiers items", "tags":[ "states" ] }, "options":{ "description":"State name or territory. Includes U.S. states and foreign entities classified under FIPS as 'Principal Administrative Divisions'.\n", "operationId":"optionsStatesFeatures", "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for State identifiers items", "tags":[ "states" ] }, "post":{ "description":"State name or territory. Includes U.S. states and foreign entities classified under FIPS as 'Principal Administrative Divisions'.\n", "operationId":"getCQL2StatesFeatures", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"https://schemas.opengis.net/cql2/1.0/cql2.json" } } }, "description":"Get items with CQL2", "required":true }, "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get State identifiers items with CQL2", "tags":[ "states" ] } }, "/collections/states/items/{featureId}":{ "get":{ "description":"State name or territory. Includes U.S. states and foreign entities classified under FIPS as 'Principal Administrative Divisions'.\n", "operationId":"getStatesFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Feature" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get State identifiers item by id", "tags":[ "states" ] }, "options":{ "description":"State name or territory. Includes U.S. states and foreign entities classified under FIPS as 'Principal Administrative Divisions'.\n", "operationId":"optionsStatesFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" } ], "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for State identifiers item by id", "tags":[ "states" ] } }, "/collections/states/queryables":{ "get":{ "description":"State name or territory. Includes U.S. states and foreign entities classified under FIPS as 'Principal Administrative Divisions'.\n", "operationId":"getStatesQueryables", "parameters":[ { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "country_code", "state_fips_code", "state_name", "state_postal_code" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/f" }, { "description":"The profile to be applied to a given request", "explode":false, "in":"query", "name":"profile", "required":false, "schema":{ "enum":[ "actual-domain", "valid-domain" ], "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get State identifiers queryables", "tags":[ "states" ] } }, "/collections/states/schema":{ "get":{ "description":"State name or territory. Includes U.S. states and foreign entities classified under FIPS as 'Principal Administrative Divisions'.\n", "operationId":"getStatesSchema", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get State identifiers schema", "tags":[ "states" ] } }, "/collections/statistic-codes":{ "get":{ "description":"Statistic codes.\n", "operationId":"describeStatistic-codesCollection", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Collection" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "summary":"Get Statistic codes metadata", "tags":[ "statistic-codes" ] } }, "/collections/statistic-codes/items":{ "get":{ "description":"Statistic codes.\n", "operationId":"getStatistic-codesFeatures", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" }, { "$ref":"#/components/parameters/bbox" }, { "description":"The optional limit parameter limits the number of items that are presented in the response document (maximum=50000, default=10000).", "explode":false, "in":"query", "name":"limit", "required":false, "schema":{ "default":10000, "maximum":50000, "minimum":1, "type":"integer" }, "style":"form" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/bbox-crs" }, { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "statistic_name", "statistic_description" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/skipGeometry" }, { "$ref":"https://raw.githubusercontent.com/opengeospatial/ogcapi-records/master/core/openapi/parameters/sortby.yaml" }, { "$ref":"#/components/parameters/offset" }, { "description":"Statistic code.", "explode":false, "in":"query", "name":"id", "required":false, "schema":{ "description":"Statistic code.", "type":"string" }, "style":"form" }, { "description":"Statistic name.", "explode":false, "in":"query", "name":"statistic_name", "required":false, "schema":{ "description":"Statistic name.", "type":"string" }, "style":"form" }, { "description":"Statistic description.", "explode":false, "in":"query", "name":"statistic_description", "required":false, "schema":{ "description":"Statistic description.", "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Statistic codes items", "tags":[ "statistic-codes" ] }, "options":{ "description":"Statistic codes.\n", "operationId":"optionsStatistic-codesFeatures", "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for Statistic codes items", "tags":[ "statistic-codes" ] }, "post":{ "description":"Statistic codes.\n", "operationId":"getCQL2Statistic-codesFeatures", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"https://schemas.opengis.net/cql2/1.0/cql2.json" } } }, "description":"Get items with CQL2", "required":true }, "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Statistic codes items with CQL2", "tags":[ "statistic-codes" ] } }, "/collections/statistic-codes/items/{featureId}":{ "get":{ "description":"Statistic codes.\n", "operationId":"getStatistic-codesFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Feature" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Statistic codes item by id", "tags":[ "statistic-codes" ] }, "options":{ "description":"Statistic codes.\n", "operationId":"optionsStatistic-codesFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" } ], "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for Statistic codes item by id", "tags":[ "statistic-codes" ] } }, "/collections/statistic-codes/queryables":{ "get":{ "description":"Statistic codes.\n", "operationId":"getStatistic-codesQueryables", "parameters":[ { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "statistic_name", "statistic_description" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/f" }, { "description":"The profile to be applied to a given request", "explode":false, "in":"query", "name":"profile", "required":false, "schema":{ "enum":[ "actual-domain", "valid-domain" ], "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Statistic codes queryables", "tags":[ "statistic-codes" ] } }, "/collections/statistic-codes/schema":{ "get":{ "description":"Statistic codes.\n", "operationId":"getStatistic-codesSchema", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Statistic codes schema", "tags":[ "statistic-codes" ] } }, "/collections/time-series-metadata":{ "get":{ "description":"Daily data and continuous measurements are grouped into time series, which represent a collection of observations of a single parameter, potentially aggregated using a standard statistic, at a single monitoring location. This endpoint provides metadata about those time series, including their operational thresholds, units of measurement, and when the earliest and most recent observations in a time series occurred.\n", "operationId":"describeTime-series-metadataCollection", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Collection" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "summary":"Get Time series metadata metadata", "tags":[ "time-series-metadata" ] } }, "/collections/time-series-metadata/items":{ "get":{ "description":"Daily data and continuous measurements are grouped into time series, which represent a collection of observations of a single parameter, potentially aggregated using a standard statistic, at a single monitoring location. This endpoint provides metadata about those time series, including their operational thresholds, units of measurement, and when the earliest and most recent observations in a time series occurred.\n", "operationId":"getTime-series-metadataFeatures", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" }, { "$ref":"#/components/parameters/bbox" }, { "description":"The optional limit parameter limits the number of items that are presented in the response document (maximum=50000, default=10).", "explode":false, "in":"query", "name":"limit", "required":false, "schema":{ "default":10, "maximum":50000, "minimum":1, "type":"integer" }, "style":"form" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/bbox-crs" }, { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "unit_of_measure", "parameter_name", "parameter_code", "statistic_id", "hydrologic_unit_code", "state_name", "last_modified", "begin", "end", "begin_utc", "end_utc", "computation_period_identifier", "computation_identifier", "thresholds", "sublocation_identifier", "primary", "monitoring_location_id", "web_description", "parameter_description", "parent_time_series_id" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/skipGeometry" }, { "$ref":"#/components/parameters/wda_sortby" }, { "$ref":"#/components/parameters/offset" }, { "description":"A unique identifier representing a single time series. This corresponds to the `id` field in the `time-series-metadata` endpoint.\n Split parameters are enabled for this field, so you can supply multiple values separated by commas.", "explode":false, "in":"query", "name":"id", "required":false, "schema":{ "description":"A unique identifier representing a single time series. This corresponds to the `id` field in the `time-series-metadata` endpoint.\n Split parameters are enabled for this field, so you can supply multiple values separated by commas.", "title":"Time series ID", "type":"string" }, "style":"form" }, { "description":"A human-readable description of the units of measurement associated with an observation.", "explode":false, "in":"query", "name":"unit_of_measure", "required":false, "schema":{ "description":"A human-readable description of the units of measurement associated with an observation.", "title":"Unit of measure", "type":"string" }, "style":"form" }, { "description":"A human-understandable name corresponding to `parameter_code`.", "explode":false, "in":"query", "name":"parameter_name", "required":false, "schema":{ "description":"A human-understandable name corresponding to `parameter_code`.", "title":"Parameter name", "type":"string" }, "style":"form" }, { "description":"Parameter codes are 5-digit codes used to identify the constituent measured and the units of measure. A complete list of parameter codes and associated groupings can be found at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/parameter-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/parameter-codes/items).\n Split parameters are enabled for this field, so you can supply multiple values separated by commas.", "explode":false, "in":"query", "name":"parameter_code", "required":false, "schema":{ "description":"Parameter codes are 5-digit codes used to identify the constituent measured and the units of measure. A complete list of parameter codes and associated groupings can be found at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/parameter-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/parameter-codes/items).\n Split parameters are enabled for this field, so you can supply multiple values separated by commas.", "title":"Parameter code", "type":"string" }, "style":"form" }, { "description":"A code corresponding to the statistic an observation represents. Example codes include 00001 (max), 00002 (min), and 00003 (mean). A complete list of codes and their descriptions can be found at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/statistic-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/statistic-codes/items).\n Split parameters are enabled for this field, so you can supply multiple values separated by commas.", "explode":false, "in":"query", "name":"statistic_id", "required":false, "schema":{ "description":"A code corresponding to the statistic an observation represents. Example codes include 00001 (max), 00002 (min), and 00003 (mean). A complete list of codes and their descriptions can be found at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/statistic-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/statistic-codes/items).\n Split parameters are enabled for this field, so you can supply multiple values separated by commas.", "title":"Statistic ID", "type":"string" }, "style":"form" }, { "description":"The United States is divided and sub-divided into successively smaller hydrologic units which are classified into four levels: regions, sub-regions, accounting units, and cataloging units. The hydrologic units are arranged within each other, from the smallest (cataloging units) to the largest (regions). Each hydrologic unit is identified by a unique hydrologic unit code (HUC) consisting of two to eight digits based on the four levels of classification in the hydrologic unit system.\n Search will match partial HUCs.", "explode":false, "in":"query", "name":"hydrologic_unit_code", "required":false, "schema":{ "description":"The United States is divided and sub-divided into successively smaller hydrologic units which are classified into four levels: regions, sub-regions, accounting units, and cataloging units. The hydrologic units are arranged within each other, from the smallest (cataloging units) to the largest (regions). Each hydrologic unit is identified by a unique hydrologic unit code (HUC) consisting of two to eight digits based on the four levels of classification in the hydrologic unit system.\n Search will match partial HUCs.", "title":"Hydrologic unit code (HUC)", "type":"string" }, "style":"form" }, { "description":"The name of the state or state equivalent in which the monitoring location is located.\n", "explode":false, "in":"query", "name":"state_name", "required":false, "schema":{ "description":"The name of the state or state equivalent in which the monitoring location is located.\n", "title":"State name", "type":"string" }, "style":"form" }, { "description":"The last time a record was refreshed in our database. This may happen due to regular operational processes and does not necessarily indicate anything about the measurement has changed.\nYou can query this field using date-times or intervals, adhering to RFC 3339, or using ISO 8601 duration objects. Intervals may be bounded or half-bounded (double-dots at start or end).\nExamples:\n\n - A date-time: \"2018-02-12T23:20:50Z\"\n - A bounded interval: \"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z\"\n - Half-bounded intervals: \"2018-02-12T00:00:00Z/..\" or \"../2018-03-18T12:31:12Z\"\n - Duration objects: \"P1M\" for data from the past month or \"PT36H\" for the last 36 hours\n\nOnly features that have a `last_modified` that intersects the value of datetime are selected.\n", "explode":false, "in":"query", "name":"last_modified", "required":false, "schema":{ "description":"The last time a record was refreshed in our database. This may happen due to regular operational processes and does not necessarily indicate anything about the measurement has changed.\nYou can query this field using date-times or intervals, adhering to RFC 3339, or using ISO 8601 duration objects. Intervals may be bounded or half-bounded (double-dots at start or end).\nExamples:\n\n - A date-time: \"2018-02-12T23:20:50Z\"\n - A bounded interval: \"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z\"\n - Half-bounded intervals: \"2018-02-12T00:00:00Z/..\" or \"../2018-03-18T12:31:12Z\"\n - Duration objects: \"P1M\" for data from the past month or \"PT36H\" for the last 36 hours\n\nOnly features that have a `last_modified` that intersects the value of datetime are selected.\n", "title":"Last modified date", "type":"string" }, "style":"form" }, { "description":"This field contains the same information as \"begin_utc\", but in the local time of the monitoring location. It is retained for backwards compatibility, but will be removed in V1 of these APIs.\n", "explode":false, "in":"query", "name":"begin", "required":false, "schema":{ "description":"This field contains the same information as \"begin_utc\", but in the local time of the monitoring location. It is retained for backwards compatibility, but will be removed in V1 of these APIs.\n", "title":"Time series first observation timestamp - local time", "type":"string" }, "style":"form" }, { "description":"This field contains the same information as \"end_utc\", but in the local time of the monitoring location. It is retained for backwards compatibility, but will be removed in V1 of these APIs.\n", "explode":false, "in":"query", "name":"end", "required":false, "schema":{ "description":"This field contains the same information as \"end_utc\", but in the local time of the monitoring location. It is retained for backwards compatibility, but will be removed in V1 of these APIs.\n", "title":"Time series most recent observation timestamp - local time", "type":"string" }, "style":"form" }, { "description":"The datetime of the earliest observation in the time series. Together with `end`, this field represents the period of record of a time series. Note that some time series may have large gaps in their collection record.\nYou can query this field using date-times or intervals, adhering to RFC 3339, or using ISO 8601 duration objects. Intervals may be bounded or half-bounded (double-dots at start or end).\nExamples:\n\n - A date-time: \"2018-02-12T23:20:50Z\"\n - A bounded interval: \"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z\"\n - Half-bounded intervals: \"2018-02-12T00:00:00Z/..\" or \"../2018-03-18T12:31:12Z\"\n - Duration objects: \"P1M\" for data from the past month or \"PT36H\" for the last 36 hours\n\nOnly features that have a `begin` that intersects the value of datetime are selected.\n", "explode":false, "in":"query", "name":"begin_utc", "required":false, "schema":{ "description":"The datetime of the earliest observation in the time series. Together with `end`, this field represents the period of record of a time series. Note that some time series may have large gaps in their collection record.\nYou can query this field using date-times or intervals, adhering to RFC 3339, or using ISO 8601 duration objects. Intervals may be bounded or half-bounded (double-dots at start or end).\nExamples:\n\n - A date-time: \"2018-02-12T23:20:50Z\"\n - A bounded interval: \"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z\"\n - Half-bounded intervals: \"2018-02-12T00:00:00Z/..\" or \"../2018-03-18T12:31:12Z\"\n - Duration objects: \"P1M\" for data from the past month or \"PT36H\" for the last 36 hours\n\nOnly features that have a `begin` that intersects the value of datetime are selected.\n", "title":"Time series first observation timestamp - UTC", "type":"string" }, "style":"form" }, { "description":"The datetime of the most recent observation in the time series. Data returned by this endpoint updates at most once per day, and potentially less frequently than that, and as such there may be more recent observations within a time series than the time series `end` value reflects. Together with `begin`, this field represents the period of record of a time series. It is additionally used to determine whether a time series is \"active\".\nYou can query this field using date-times or intervals, adhering to RFC 3339, or using ISO 8601 duration objects. Intervals may be bounded or half-bounded (double-dots at start or end).\nExamples:\n\n - A date-time: \"2018-02-12T23:20:50Z\"\n - A bounded interval: \"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z\"\n - Half-bounded intervals: \"2018-02-12T00:00:00Z/..\" or \"../2018-03-18T12:31:12Z\"\n - Duration objects: \"P1M\" for data from the past month or \"PT36H\" for the last 36 hours\n\nOnly features that have a `end` that intersects the value of datetime are selected.\n", "explode":false, "in":"query", "name":"end_utc", "required":false, "schema":{ "description":"The datetime of the most recent observation in the time series. Data returned by this endpoint updates at most once per day, and potentially less frequently than that, and as such there may be more recent observations within a time series than the time series `end` value reflects. Together with `begin`, this field represents the period of record of a time series. It is additionally used to determine whether a time series is \"active\".\nYou can query this field using date-times or intervals, adhering to RFC 3339, or using ISO 8601 duration objects. Intervals may be bounded or half-bounded (double-dots at start or end).\nExamples:\n\n - A date-time: \"2018-02-12T23:20:50Z\"\n - A bounded interval: \"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z\"\n - Half-bounded intervals: \"2018-02-12T00:00:00Z/..\" or \"../2018-03-18T12:31:12Z\"\n - Duration objects: \"P1M\" for data from the past month or \"PT36H\" for the last 36 hours\n\nOnly features that have a `end` that intersects the value of datetime are selected.\n", "title":"Time series most recent observation timestamp - UTC", "type":"string" }, "style":"form" }, { "description":"Indicates the period of data used for any statistical computations. Split parameters are enabled for this field, so you can supply multiple values separated by commas.", "explode":false, "in":"query", "name":"computation_period_identifier", "required":false, "schema":{ "description":"Indicates the period of data used for any statistical computations. Split parameters are enabled for this field, so you can supply multiple values separated by commas.", "title":"Computation period identifier", "type":"string" }, "style":"form" }, { "description":"Indicates whether the data from this time series represent a specific statistical computation. Split parameters are enabled for this field, so you can supply multiple values separated by commas.", "explode":false, "in":"query", "name":"computation_identifier", "required":false, "schema":{ "description":"Indicates whether the data from this time series represent a specific statistical computation. Split parameters are enabled for this field, so you can supply multiple values separated by commas.", "title":"Computation identifier", "type":"string" }, "style":"form" }, { "description":"Thresholds represent known numeric limits for a time series, for example the historic maximum value for a parameter or a level below which a sensor is non-operative. These thresholds are sometimes used to automatically determine if an observation is erroneous due to sensor error, and therefore shouldn't be included in the time series.\n", "explode":false, "in":"query", "name":"thresholds", "required":false, "schema":{ "description":"Thresholds represent known numeric limits for a time series, for example the historic maximum value for a parameter or a level below which a sensor is non-operative. These thresholds are sometimes used to automatically determine if an observation is erroneous due to sensor error, and therefore shouldn't be included in the time series.\n", "title":"Operational thresholds", "type":"string" }, "style":"form" }, { "description":"An optional human-readable identifier used to specify where measurements are recorded at a monitoring location.\n", "explode":false, "in":"query", "name":"sublocation_identifier", "required":false, "schema":{ "description":"An optional human-readable identifier used to specify where measurements are recorded at a monitoring location.\n", "title":"Sublocation identifier", "type":"string" }, "style":"form" }, { "description":"A flag identifying if the time series is a \"primary\" time series. \"Primary\" time series (which have this flag) are standard observations which undergo [Bureau review and approval processes](https://www.usgs.gov/survey-manual/5028-fundamental-science-practices-review-and-approval-scientific-data-release). Non-primary time series, which will have missing values for \"primary\", are provisional datasets made available to meet the need for timely best science and to assist with daily operations which need real-time information. Non-primary time series data are only retained by this system for 120 days. See the [USGS Provisional Data Statement](https://waterdata.usgs.gov/provisional-data-statement/) for more information.\n", "explode":false, "in":"query", "name":"primary", "required":false, "schema":{ "description":"A flag identifying if the time series is a \"primary\" time series. \"Primary\" time series (which have this flag) are standard observations which undergo [Bureau review and approval processes](https://www.usgs.gov/survey-manual/5028-fundamental-science-practices-review-and-approval-scientific-data-release). Non-primary time series, which will have missing values for \"primary\", are provisional datasets made available to meet the need for timely best science and to assist with daily operations which need real-time information. Non-primary time series data are only retained by this system for 120 days. See the [USGS Provisional Data Statement](https://waterdata.usgs.gov/provisional-data-statement/) for more information.\n", "title":"Primary flag", "type":"string" }, "style":"form" }, { "description":"A unique identifier representing a single monitoring location. This corresponds to the `id` field in the `monitoring-locations` endpoint. Monitoring location IDs are created by combining the agency code of the agency responsible for the monitoring location (e.g. USGS) with the ID number of the monitoring location (e.g. 02238500), separated by a hyphen (e.g. USGS-02238500).\n Split parameters are enabled for this field, so you can supply multiple values separated by commas.", "explode":false, "in":"query", "name":"monitoring_location_id", "required":false, "schema":{ "description":"A unique identifier representing a single monitoring location. This corresponds to the `id` field in the `monitoring-locations` endpoint. Monitoring location IDs are created by combining the agency code of the agency responsible for the monitoring location (e.g. USGS) with the ID number of the monitoring location (e.g. 02238500), separated by a hyphen (e.g. USGS-02238500).\n Split parameters are enabled for this field, so you can supply multiple values separated by commas.", "title":"Monitoring location ID", "type":"string" }, "style":"form" }, { "description":"A description of what this time series represents, as used by WDFN and other USGS data dissemination products.\n", "explode":false, "in":"query", "name":"web_description", "required":false, "schema":{ "description":"A description of what this time series represents, as used by WDFN and other USGS data dissemination products.\n", "title":"Time series description", "type":"string" }, "style":"form" }, { "description":"A description of what the parameter code represents, as used by WDFN and other USGS data dissemination products.\n", "explode":false, "in":"query", "name":"parameter_description", "required":false, "schema":{ "description":"A description of what the parameter code represents, as used by WDFN and other USGS data dissemination products.\n", "title":"Parameter description", "type":"string" }, "style":"form" }, { "description":"The unique identifier representing the parent or \"upchain\" time series that a daily values time series is generated from. Daily values time series have one and only one parent time series.\n", "explode":false, "in":"query", "name":"parent_time_series_id", "required":false, "schema":{ "description":"The unique identifier representing the parent or \"upchain\" time series that a daily values time series is generated from. Daily values time series have one and only one parent time series.\n", "title":"Parent time series ID", "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Time series metadata items", "tags":[ "time-series-metadata" ] }, "options":{ "description":"Daily data and continuous measurements are grouped into time series, which represent a collection of observations of a single parameter, potentially aggregated using a standard statistic, at a single monitoring location. This endpoint provides metadata about those time series, including their operational thresholds, units of measurement, and when the earliest and most recent observations in a time series occurred.\n", "operationId":"optionsTime-series-metadataFeatures", "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for Time series metadata items", "tags":[ "time-series-metadata" ] }, "post":{ "description":"Daily data and continuous measurements are grouped into time series, which represent a collection of observations of a single parameter, potentially aggregated using a standard statistic, at a single monitoring location. This endpoint provides metadata about those time series, including their operational thresholds, units of measurement, and when the earliest and most recent observations in a time series occurred.\n", "operationId":"getCQL2Time-series-metadataFeatures", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"https://schemas.opengis.net/cql2/1.0/cql2.json" } } }, "description":"Get items with CQL2", "required":true }, "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Time series metadata items with CQL2", "tags":[ "time-series-metadata" ] } }, "/collections/time-series-metadata/items/{featureId}":{ "get":{ "description":"Daily data and continuous measurements are grouped into time series, which represent a collection of observations of a single parameter, potentially aggregated using a standard statistic, at a single monitoring location. This endpoint provides metadata about those time series, including their operational thresholds, units of measurement, and when the earliest and most recent observations in a time series occurred.\n", "operationId":"getTime-series-metadataFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Feature" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Time series metadata item by id", "tags":[ "time-series-metadata" ] }, "options":{ "description":"Daily data and continuous measurements are grouped into time series, which represent a collection of observations of a single parameter, potentially aggregated using a standard statistic, at a single monitoring location. This endpoint provides metadata about those time series, including their operational thresholds, units of measurement, and when the earliest and most recent observations in a time series occurred.\n", "operationId":"optionsTime-series-metadataFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" } ], "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for Time series metadata item by id", "tags":[ "time-series-metadata" ] } }, "/collections/time-series-metadata/queryables":{ "get":{ "description":"Daily data and continuous measurements are grouped into time series, which represent a collection of observations of a single parameter, potentially aggregated using a standard statistic, at a single monitoring location. This endpoint provides metadata about those time series, including their operational thresholds, units of measurement, and when the earliest and most recent observations in a time series occurred.\n", "operationId":"getTime-series-metadataQueryables", "parameters":[ { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "unit_of_measure", "parameter_name", "parameter_code", "statistic_id", "hydrologic_unit_code", "state_name", "last_modified", "begin", "end", "begin_utc", "end_utc", "computation_period_identifier", "computation_identifier", "thresholds", "sublocation_identifier", "primary", "monitoring_location_id", "web_description", "parameter_description", "parent_time_series_id" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/f" }, { "description":"The profile to be applied to a given request", "explode":false, "in":"query", "name":"profile", "required":false, "schema":{ "enum":[ "actual-domain", "valid-domain" ], "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Time series metadata queryables", "tags":[ "time-series-metadata" ] } }, "/collections/time-series-metadata/schema":{ "get":{ "description":"Daily data and continuous measurements are grouped into time series, which represent a collection of observations of a single parameter, potentially aggregated using a standard statistic, at a single monitoring location. This endpoint provides metadata about those time series, including their operational thresholds, units of measurement, and when the earliest and most recent observations in a time series occurred.\n", "operationId":"getTime-series-metadataSchema", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Time series metadata schema", "tags":[ "time-series-metadata" ] } }, "/collections/time-zone-codes":{ "get":{ "description":"The ISO 8601 standard defines time zone offsets as a numerical value added to a local time to convert it to Coordinated Universal Time (UTC), either as +hh:mm or -hh:mm, or represented by the letter Z to explicitly indicate UTC. For example, +05:30 means 5 hours and 30 minutes ahead of UTC, while -08:00 means 8 hours behind UTC. The offset Z specifically signifies UTC.\n", "operationId":"describeTime-zone-codesCollection", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Collection" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "summary":"Get Time zone codes metadata", "tags":[ "time-zone-codes" ] } }, "/collections/time-zone-codes/items":{ "get":{ "description":"The ISO 8601 standard defines time zone offsets as a numerical value added to a local time to convert it to Coordinated Universal Time (UTC), either as +hh:mm or -hh:mm, or represented by the letter Z to explicitly indicate UTC. For example, +05:30 means 5 hours and 30 minutes ahead of UTC, while -08:00 means 8 hours behind UTC. The offset Z specifically signifies UTC.\n", "operationId":"getTime-zone-codesFeatures", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" }, { "$ref":"#/components/parameters/bbox" }, { "description":"The optional limit parameter limits the number of items that are presented in the response document (maximum=50000, default=10000).", "explode":false, "in":"query", "name":"limit", "required":false, "schema":{ "default":10000, "maximum":50000, "minimum":1, "type":"integer" }, "style":"form" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/bbox-crs" }, { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "time_zone_name", "time_zone_description", "time_zone_utc_offset", "time_zone_daylight_savings_time_code", "time_zone_daylight_savings_time_name", "time_zone_daylight_savings_utc_offset" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/skipGeometry" }, { "$ref":"https://raw.githubusercontent.com/opengeospatial/ogcapi-records/master/core/openapi/parameters/sortby.yaml" }, { "$ref":"#/components/parameters/offset" }, { "description":"Time zone code. An NWIS time zone code.", "explode":false, "in":"query", "name":"id", "required":false, "schema":{ "description":"Time zone code. An NWIS time zone code.", "type":"string" }, "style":"form" }, { "description":"Time zone name. An English name for a world time zone.", "explode":false, "in":"query", "name":"time_zone_name", "required":false, "schema":{ "description":"Time zone name. An English name for a world time zone.", "type":"string" }, "style":"form" }, { "description":"Time zone description.", "explode":false, "in":"query", "name":"time_zone_description", "required":false, "schema":{ "description":"Time zone description.", "type":"string" }, "style":"form" }, { "description":"Coordinated Universal Time (UTC) offset time. The number of hours offset from UTC time, in ISO format.", "explode":false, "in":"query", "name":"time_zone_utc_offset", "required":false, "schema":{ "description":"Coordinated Universal Time (UTC) offset time. The number of hours offset from UTC time, in ISO format.", "type":"string" }, "style":"form" }, { "description":"Time zone Daylight Saving Time code.", "explode":false, "in":"query", "name":"time_zone_daylight_savings_time_code", "required":false, "schema":{ "description":"Time zone Daylight Saving Time code.", "type":"string" }, "style":"form" }, { "description":"Time zone Daylight Saving Time name.", "explode":false, "in":"query", "name":"time_zone_daylight_savings_time_name", "required":false, "schema":{ "description":"Time zone Daylight Saving Time name.", "type":"string" }, "style":"form" }, { "description":"Daylight Saving Time offset time. The number of hours offset from UTC time when Daylight Saving Time is in effect, in ISO format.", "explode":false, "in":"query", "name":"time_zone_daylight_savings_utc_offset", "required":false, "schema":{ "description":"Daylight Saving Time offset time. The number of hours offset from UTC time when Daylight Saving Time is in effect, in ISO format.", "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Time zone codes items", "tags":[ "time-zone-codes" ] }, "options":{ "description":"The ISO 8601 standard defines time zone offsets as a numerical value added to a local time to convert it to Coordinated Universal Time (UTC), either as +hh:mm or -hh:mm, or represented by the letter Z to explicitly indicate UTC. For example, +05:30 means 5 hours and 30 minutes ahead of UTC, while -08:00 means 8 hours behind UTC. The offset Z specifically signifies UTC.\n", "operationId":"optionsTime-zone-codesFeatures", "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for Time zone codes items", "tags":[ "time-zone-codes" ] }, "post":{ "description":"The ISO 8601 standard defines time zone offsets as a numerical value added to a local time to convert it to Coordinated Universal Time (UTC), either as +hh:mm or -hh:mm, or represented by the letter Z to explicitly indicate UTC. For example, +05:30 means 5 hours and 30 minutes ahead of UTC, while -08:00 means 8 hours behind UTC. The offset Z specifically signifies UTC.\n", "operationId":"getCQL2Time-zone-codesFeatures", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"https://schemas.opengis.net/cql2/1.0/cql2.json" } } }, "description":"Get items with CQL2", "required":true }, "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Time zone codes items with CQL2", "tags":[ "time-zone-codes" ] } }, "/collections/time-zone-codes/items/{featureId}":{ "get":{ "description":"The ISO 8601 standard defines time zone offsets as a numerical value added to a local time to convert it to Coordinated Universal Time (UTC), either as +hh:mm or -hh:mm, or represented by the letter Z to explicitly indicate UTC. For example, +05:30 means 5 hours and 30 minutes ahead of UTC, while -08:00 means 8 hours behind UTC. The offset Z specifically signifies UTC.\n", "operationId":"getTime-zone-codesFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Feature" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Time zone codes item by id", "tags":[ "time-zone-codes" ] }, "options":{ "description":"The ISO 8601 standard defines time zone offsets as a numerical value added to a local time to convert it to Coordinated Universal Time (UTC), either as +hh:mm or -hh:mm, or represented by the letter Z to explicitly indicate UTC. For example, +05:30 means 5 hours and 30 minutes ahead of UTC, while -08:00 means 8 hours behind UTC. The offset Z specifically signifies UTC.\n", "operationId":"optionsTime-zone-codesFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" } ], "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for Time zone codes item by id", "tags":[ "time-zone-codes" ] } }, "/collections/time-zone-codes/queryables":{ "get":{ "description":"The ISO 8601 standard defines time zone offsets as a numerical value added to a local time to convert it to Coordinated Universal Time (UTC), either as +hh:mm or -hh:mm, or represented by the letter Z to explicitly indicate UTC. For example, +05:30 means 5 hours and 30 minutes ahead of UTC, while -08:00 means 8 hours behind UTC. The offset Z specifically signifies UTC.\n", "operationId":"getTime-zone-codesQueryables", "parameters":[ { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "time_zone_name", "time_zone_description", "time_zone_utc_offset", "time_zone_daylight_savings_time_code", "time_zone_daylight_savings_time_name", "time_zone_daylight_savings_utc_offset" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/f" }, { "description":"The profile to be applied to a given request", "explode":false, "in":"query", "name":"profile", "required":false, "schema":{ "enum":[ "actual-domain", "valid-domain" ], "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Time zone codes queryables", "tags":[ "time-zone-codes" ] } }, "/collections/time-zone-codes/schema":{ "get":{ "description":"The ISO 8601 standard defines time zone offsets as a numerical value added to a local time to convert it to Coordinated Universal Time (UTC), either as +hh:mm or -hh:mm, or represented by the letter Z to explicitly indicate UTC. For example, +05:30 means 5 hours and 30 minutes ahead of UTC, while -08:00 means 8 hours behind UTC. The offset Z specifically signifies UTC.\n", "operationId":"getTime-zone-codesSchema", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Time zone codes schema", "tags":[ "time-zone-codes" ] } }, "/collections/topographic-codes":{ "get":{ "description":"The code that best describes the topographic setting in which the site is located. Topographic setting refers to the geomorphic features in the vicinity of the site.\n", "operationId":"describeTopographic-codesCollection", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Collection" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "summary":"Get Topographic codes metadata", "tags":[ "topographic-codes" ] } }, "/collections/topographic-codes/items":{ "get":{ "description":"The code that best describes the topographic setting in which the site is located. Topographic setting refers to the geomorphic features in the vicinity of the site.\n", "operationId":"getTopographic-codesFeatures", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" }, { "$ref":"#/components/parameters/bbox" }, { "description":"The optional limit parameter limits the number of items that are presented in the response document (maximum=50000, default=10000).", "explode":false, "in":"query", "name":"limit", "required":false, "schema":{ "default":10000, "maximum":50000, "minimum":1, "type":"integer" }, "style":"form" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/bbox-crs" }, { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "topography_name", "short_topography_description", "full_topography_description" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/skipGeometry" }, { "$ref":"https://raw.githubusercontent.com/opengeospatial/ogcapi-records/master/core/openapi/parameters/sortby.yaml" }, { "$ref":"#/components/parameters/offset" }, { "explode":false, "in":"query", "name":"id", "required":false, "schema":{ "type":"string" }, "style":"form" }, { "explode":false, "in":"query", "name":"topography_name", "required":false, "schema":{ "type":"string" }, "style":"form" }, { "explode":false, "in":"query", "name":"short_topography_description", "required":false, "schema":{ "type":"string" }, "style":"form" }, { "explode":false, "in":"query", "name":"full_topography_description", "required":false, "schema":{ "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Topographic codes items", "tags":[ "topographic-codes" ] }, "options":{ "description":"The code that best describes the topographic setting in which the site is located. Topographic setting refers to the geomorphic features in the vicinity of the site.\n", "operationId":"optionsTopographic-codesFeatures", "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for Topographic codes items", "tags":[ "topographic-codes" ] }, "post":{ "description":"The code that best describes the topographic setting in which the site is located. Topographic setting refers to the geomorphic features in the vicinity of the site.\n", "operationId":"getCQL2Topographic-codesFeatures", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"https://schemas.opengis.net/cql2/1.0/cql2.json" } } }, "description":"Get items with CQL2", "required":true }, "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Topographic codes items with CQL2", "tags":[ "topographic-codes" ] } }, "/collections/topographic-codes/items/{featureId}":{ "get":{ "description":"The code that best describes the topographic setting in which the site is located. Topographic setting refers to the geomorphic features in the vicinity of the site.\n", "operationId":"getTopographic-codesFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" }, { "$ref":"#/components/parameters/crs" }, { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Feature" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Topographic codes item by id", "tags":[ "topographic-codes" ] }, "options":{ "description":"The code that best describes the topographic setting in which the site is located. Topographic setting refers to the geomorphic features in the vicinity of the site.\n", "operationId":"optionsTopographic-codesFeature", "parameters":[ { "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId" } ], "responses":{ "200":{ "description":"options response" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Options for Topographic codes item by id", "tags":[ "topographic-codes" ] } }, "/collections/topographic-codes/queryables":{ "get":{ "description":"The code that best describes the topographic setting in which the site is located. Topographic setting refers to the geomorphic features in the vicinity of the site.\n", "operationId":"getTopographic-codesQueryables", "parameters":[ { "description":"The properties that should be included for each feature. The parameter value is a comma-separated list of property names.", "explode":false, "in":"query", "name":"properties", "required":false, "schema":{ "items":{ "enum":[ "id", "topography_name", "short_topography_description", "full_topography_description" ], "type":"string" }, "type":"array" }, "style":"form" }, { "$ref":"#/components/parameters/f" }, { "description":"The profile to be applied to a given request", "explode":false, "in":"query", "name":"profile", "required":false, "schema":{ "enum":[ "actual-domain", "valid-domain" ], "type":"string" }, "style":"form" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Topographic codes queryables", "tags":[ "topographic-codes" ] } }, "/collections/topographic-codes/schema":{ "get":{ "description":"The code that best describes the topographic setting in which the site is located. Topographic setting refers to the geomorphic features in the vicinity of the site.\n", "operationId":"getTopographic-codesSchema", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"#/components/responses/Queryables" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "404":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "security":[ { "ApiKeyQuery":[] }, { "ApiKeyHeader":[] } ], "summary":"Get Topographic codes schema", "tags":[ "topographic-codes" ] } }, "/conformance":{ "get":{ "description":"API conformance definition", "operationId":"getConformanceDeclaration", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" } ], "responses":{ "200":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/LandingPage" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "500":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError" } }, "summary":"API conformance definition", "tags":[ "server" ] } }, "/openapi":{ "get":{ "description":"This document", "operationId":"getOpenapi", "parameters":[ { "$ref":"#/components/parameters/f" }, { "$ref":"#/components/parameters/lang" }, { "description":"UI to render the OpenAPI document", "explode":false, "in":"query", "name":"ui", "required":false, "schema":{ "default":"swagger", "enum":[ "swagger", "redoc" ], "type":"string" }, "style":"form" } ], "responses":{ "200":{ "$ref":"#/components/responses/200" }, "400":{ "$ref":"https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter" }, "403":{ "$ref":"#/components/responses/Forbidden403" }, "429":{ "$ref":"#/components/responses/TooManyRequests429" }, "default":{ "$ref":"#/components/responses/default" } }, "summary":"This document", "tags":[ "server" ] } } }, "servers":[ { "description":"These APIs provide OGC-compliant interfaces to USGS water data, letting you download continuous sensor measurements, discrete field measurements, metadata about monitoring locations, and more.\n", "url":"https://api.waterdata.usgs.gov/ogcapi/v0" } ], "tags":[ { "description":"These APIs provide OGC-compliant interfaces to USGS water data, letting you download continuous sensor measurements, discrete field measurements, metadata about monitoring locations, and more.\n", "externalDocs":{ "description":"information", "url":"https://api.waterdata.usgs.gov" }, "name":"server" }, { "description":"This endpoint provides the most recent observation for each time series of continuous data. Continuous data are collected via automated sensors installed at a monitoring location. They are collected at a high frequency and often at a fixed 15-minute interval. Depending on the specific monitoring location, the data may be transmitted automatically via telemetry and be available on WDFN within minutes of collection, while other times the delivery of data may be delayed if the monitoring location does not have the capacity to automatically transmit data. Continuous data are described by parameter name and parameter code. These data might also be referred to as \"instantaneous values\" or \"IV\"\n", "name":"latest-continuous" }, { "description":"This is an early version of the continuous endpoint. It is feature-complete and provides access to the full continuous data record, and is being made available as we continue to work on performance improvements.\nContinuous data are collected via automated sensors installed at a monitoring location. They are collected at a high frequency and often at a fixed 15-minute interval. Depending on the specific monitoring location, the data may be transmitted automatically via telemetry and be available on WDFN within minutes of collection, while other times the delivery of data may be delayed if the monitoring location does not have the capacity to automatically transmit data. Continuous data are described by parameter name and parameter code (pcode). These data might also be referred to as \"instantaneous values\" or \"IV\".\n", "name":"continuous" }, { "description":"Daily data provide one data value to represent water conditions for the day. Throughout much of the history of the USGS, the primary water data available was daily data collected manually at the monitoring location once each day. With improved availability of computer storage and automated transmission of data, the daily data published today are generally a statistical summary or metric of the continuous data collected each day, such as the daily mean, minimum, or maximum value. Daily data are automatically calculated from the continuous data of the same parameter code and are described by parameter code and a statistic code. These data have also been referred to as \u201cdaily values\u201d or \u201cDV\u201d.\n", "name":"daily" }, { "description":"Daily data provide one data value to represent water conditions for the day. Throughout much of the history of the USGS, the primary water data available was daily data collected manually at the monitoring location once each day. With improved availability of computer storage and automated transmission of data, the daily data published today are generally a statistical summary or metric of the continuous data collected each day, such as the daily mean, minimum, or maximum value. Daily data are automatically calculated from the continuous data of the same parameter code and are described by parameter code and a statistic code. These data have also been referred to as \u201cdaily values\u201d or \u201cDV\u201d.\n", "name":"latest-daily" }, { "description":"Field measurements are physically measured values collected during a visit to the monitoring location. Field measurements consist of measurements of gage height and discharge, and readings of groundwater levels, and are primarily used as calibration readings for the automated sensors collecting continuous data. They are collected at a low frequency, and delivery of the data in WDFN may be delayed due to data processing time.\n", "name":"field-measurements" }, { "description":"Daily data and continuous measurements are grouped into time series, which represent a collection of observations of a single parameter, potentially aggregated using a standard statistic, at a single monitoring location. This endpoint provides metadata about those time series, including their operational thresholds, units of measurement, and when the earliest and most recent observations in a time series occurred.\n", "name":"time-series-metadata" }, { "description":"Location information is basic information about the monitoring location including the name, identifier, agency responsible for data collection, and the date the location was established. It also includes information about the type of location, such as stream, lake, or groundwater, and geographic information about the location, such as state, county, latitude and longitude, and hydrologic unit code (HUC).\n", "name":"monitoring-locations" }, { "description":"Code identifying the agency or organization used for site information, data sources, and permitting agencies. Agency codes are fixed values assigned by the National Water Information System (NWIS).\n", "name":"agency-codes" }, { "description":"The recommended vertical datum is NAVD88 (North American Vertical Datum of 1988) where applicable as stated in Office of Information Technical Memo 2002.01. NGVD29 (National Geodetic Vertical Datum of 1929) and NAVD88 are the only datums that can be converted on output. NWIS uses the North American Vertical Datum Conversions (VERTCON) of the National Geodetic Survey to convert from NGVD29 to NAVD88 or vice versa. Conversions to or from other vertical datums are not available.\n", "name":"altitude-datums" }, { "description":"Local aquifers in USGS data are identified by an aquifer name and geohydrologic unit code (a three-digit number related to the age of the formation, followed by a 4 or 5 character abbreviation for the geologic unit or aquifer name). For the age of formation (aquifer age), generally the smaller the number represents the younger the geohydrologic unit. Aquifer names and the definition of an aquifer can be very subjective. One rock unit may be called different aquifer names by different people. Local aquifers and layered aquifers are often grouped into larger named regional aquifers or aquifer systems. For example, the National Northern Atlantic Coastal Plain aquifer system (National aquifer) consists of five layered regional aquifers. Each regional aquifer is divided into two or more aquifers which may have a different name in each of the states in which the aquifer is found.\n", "name":"aquifer-codes" }, { "description":"Groundwater occurs in aquifers under two different conditions. Where water only partly fills an aquifer, the upper surface is free to rise and decline. These aquifers are referred to as unconfined (or water-table) aquifers. Where water completely fills an aquifer that is overlain by a confining bed, the aquifer is referred to as a confined (or artesian) aquifer. When a confined aquifer is penetrated by a well, the water level in the well will rise above the top of the aquifer (but not necessarily above land surface).\n", "name":"aquifer-types" }, { "description":"Appropriate code on the schedule to indicate the accuracy of the latitude-longitude values.\n", "name":"coordinate-accuracy-codes" }, { "description":"Horizontal datum code for the latitude/longitude coordinates. There are currently more than 300 horizontal datums available for entry.\n", "name":"coordinate-datum-codes" }, { "description":"Methods used to determine latitude-longitude values.\n", "name":"coordinate-method-codes" }, { "description":"The name of the county or county equivalent (parish, borough, planning reagion, etc.) in which the site is located. List includes Census Bureau FIPS county codes, names and associated Country and State.\n", "name":"counties" }, { "description":"Hydrologic units are geographic areas representing part or all of a surface drainage basin or distinct hydrologic feature identified by a unique number (HUC), and a name. The United States is divided and sub-divided into successively smaller hydrologic units which are classified into four levels: regions, sub-regions, accounting units, and cataloging units. Each unit consists of two to eight digits based on the four levels of classification in the hydrologic unit system. Additional information can be found at .\n", "name":"hydrologic-unit-codes" }, { "description":"Medium refers to the specific environmental medium from which the sample was collected. Medium type differs from site type because one site type, such as surface water, could have data for several media, such as water, bottom sediment, fish tissue, and others.\n", "name":"medium-codes" }, { "description":"National aquifers are the principal aquifers or aquifer systems in the United States, defined as regionally extensive aquifers or aquifer systems that have the potential to be used as a source of potable water.\n", "name":"national-aquifer-codes" }, { "description":"Parameter codes are 5-digit codes and associated descriptions used to identify the constituent measured and the units of measure. Some parameter code definitions include information about the sampling matrix, fraction, and methods used to measure the constituent. Some parameters are fixed-value (fxd) numeric codes having textual meaning (for example: parameter code 00041 is a weather code parameter, code of 60 means rain), but more commonly represent a numeric value for chemical, physical, or biological data.\n", "name":"parameter-codes" }, { "description":"Code indicating the reliability of the data available for the site.\n", "name":"reliability-codes" }, { "description":"The hydrologic cycle setting or a man-made feature thought to affect the hydrologic conditions measured at a site. Primary and secondary site types associated with data collection sites. All sites have a primary site type, and may additionally have a secondary site type that further describes the location.\n", "name":"site-types" }, { "description":"State name or territory. Includes U.S. states and foreign entities classified under FIPS as 'Principal Administrative Divisions'.\n", "name":"states" }, { "description":"Statistic codes.\n", "name":"statistic-codes" }, { "description":"The code that best describes the topographic setting in which the site is located. Topographic setting refers to the geomorphic features in the vicinity of the site.\n", "name":"topographic-codes" }, { "description":"The ISO 8601 standard defines time zone offsets as a numerical value added to a local time to convert it to Coordinated Universal Time (UTC), either as +hh:mm or -hh:mm, or represented by the letter Z to explicitly indicate UTC. For example, +05:30 means 5 hours and 30 minutes ahead of UTC, while -08:00 means 8 hours behind UTC. The offset Z specifically signifies UTC.\n", "name":"time-zone-codes" } ] }