CUAHSI available REST endpoints. This collection includes: waterOneFlow, hisCentral and HydroShare
- Source:
Members
(static) hisCentral :Object
HIS Central serves as the main functions that can be used for a specific resource. It allows for users to obtain specific data from a resource without the need of manipulation a large chunk of data, but rather, allow a function to query the data. Each function has its own usage and is constrained by the parameters passed within HydroLang functions. More information about HIS Central can be found in the following link: https://his.cuahsi.org/
Type:
- Object
(static) hydroShare :Object
HydroShare API, enabling acccess to data resources, examples, models and more hosted within the HydroShare sphere. Swagger example found in the following link:https://www.hydroshare.org/hsapi/
Type:
- Object
(static) waterOneFlow :Object
Data endpoints for the CUAHSI HIS WaterOneFlow services. The services accessed require POST requests through SOAP protocol. The endpoints are compliant with version 1.1 of the service. More information about the request can be found in the following links: https://cuahsi.zendesk.com/hc/en-us/articles/205153157-HydroServer-and-the-WaterOneFlow-Web-Services-API https://hydroportal.cuahsi.org/ipswich/
Includes the following methods
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
sourceType |
string | source that will be queried. Requires source, see list for more references. |
GetSiteInfo |
string | returns site metadata, given a specific site number for multiple sites. Values passed as strings. |
GetSiteInfoMultpleObject |
string | returns site metadata, given a specific site number. Pass value as string |
GetSiteInfoObject |
string | returns site metadata, given a specific site number. Pass value as string |
GetSites |
string | given an array of sites, returns the metadata for each site. Pass values as array of strings |
GetSitesByBoxObject |
string | finds sites for a specific source on a bounding box having properties {west, south, east, north} |
GetSitesObject |
string | returns site metadata, pass site as array of strings |
GetValues |
string | returns timeseries for a specific location. Requires {location: string, variable: string, startDate: string, endDate: string} |
GetValuesForASiteObject |
string | returns values as array of strings as {site: string, startDate: string , endDate: string} |
GetValuesObject |
string | returns timeseries for a given location and timespan {location: string, variable: string, startDate: string, endDate: string} |
GetVariableInfo |
string | returns variable name given information for a variable. Pass as string. |
GetVariableInfoObject |
string | returns a variable's name, given specific information for the variable. Pass value as string |
GetVariables |
string | get all avaibale variables from a specific source. No parameters required. |
GetVariablesObject |
string | get all avaibale variables from a specific source. No parameters required. |