CUAHSI WaterOneFlow 1.0 API
Four calls:
- GetVariableInfo("VarVocab:code", "AuthToken")
- GetSiteInfo("SiteVocab:Code", "AuthToken")
- GetValues("SiteVocab:Code","VarVocab:code","YYYY-MM-DD","YYYY-MM-DD", "AuthToken")
- For services with few sites,
- GetSites(["SiteVocab:Code","SiteVocab:Code2",...], "AuthToken")
AuthToken is not presently used in CUAHSI web services. Any AuthToken is ignored, and can be null.
The variable request string is overloaded to allow for selection of a specific value
- "vocab:code/Property=Value"
- "vocab:code/DataType=Average"
- "vocab:code/SampleMedium=Water/DataType=Average"
VarVocab - Variable Vocabulary, aka cvocabulary
SiteVocab - Site Vocabulary, aka network
Parameters
- ["string"] - Array
- "String" - Single String
| Method | SiteInfo | SiteCatalog | VariableInfo | TimeSeries | QueryInfo |
|---|
| GetVariableInfo(null) | | | All | | X |
| GetVariableInfo("VarVocab:code") | | | All Matched | | X |
| GetVariableInfo("vocab:code/Property=Value") | | | All Matched | | X |
| GetSites(null) | All, or exception, too many sites | | | | |
| GetSites(["SiteVocab:Code"]) | one | | | | X |
| GetSites(["SiteVocab:Code","SiteVocab:Code2",...]) | multiple | | | | |
| GetSiteInfo("SiteVocab:Code") | one | X | | | X |
| GetValues("SiteVocab:Code","VarVocab:code","YYYY-MM-DD","YYYY-MM-DD") | one | | X | X | X |
Comment by Joe Hu July 02 2008
I see Excellent work has been done here by define the water1flow api interface!
Without this interface, it is nightmare for me to write client to use water1flow.