Navigation¶

• Main Page
  

• Random Page
• Create a new Page
• All Pages
• Categories
• Navigation Paths
  

• Administration
• File Management
  

• Create Account
  

Quick Search
»

Service signatures and parameters

There are parameters used in WaterOneFlow web services version 1.1. 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
  

Methods ¶

There are several methods in WaterOneFlow web services version 1.1.

• Service Description
  • GetCapabilities new in v1.1
• Descriptive Site Information (site name, location)
  • GetSitesObject, GetSites
  • GetSitesInBox new in v1.1
• Descriptive Variable Information
  • GetVariableInfo
• Series Information
  • GetSiteInfo
  • GetSitesInBox new in v1.1
• Results/Values
  • GetValues
  • GetValuesForSite new in v1.1
    

Information Returned ¶

WaterOneFlow 1.1

Method	SiteInfo	SiteCatalog	VariableInfo	TimeSeries	QueryInfo
GetVariableInfo(null)			All		X
GetVariableInfo("VarVocab:code")			All Matched		X
GetVariableInfo("VarVocab:code/Property=Value")			All Matched		X
GetSites(null)	All, or limited to number of records in Capabilities
GetSites(["SiteVocab:Code"])	one				X
GetSites(["SiteVocab:Code","SiteVocab:Code2",...])	multiple
GetSites("GEOM:BOX(w s, e n)")	multiple
GetSiteInfo("SiteVocab:Code")	one	X			X
GetValues("SiteVocab:Code","VarVocab:code","YYYY-MM-DD","YYYY-MM-DD")	one		X	X	X
GetSitesInBox(west,south,east,north,includeSeries)	X	yes, includeSeries=true\\ no, includeSeries=false			X
GetValuesForSite("SiteVocab:Code","YYYY-MM-DD","YYYY-MM-DD")	one		X	many, one per variable	X

WaterOneFlow 1.0

Method	SiteInfo	SiteCatalog	VariableInfo	TimeSeries	QueryInfo
GetVariableInfo(null)			All		X
GetVariableInfo("VarVocab:code")			All Matched		X
GetVariableInfo("VarVocab:code/Property=Value")			All Matched		X
GetSites(null)	All, or limited to number of records in Capabilities
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

Method Discussion ¶

Parameters¶

parameter	type	description
variable	string	vocabulary:vocabularyCode
location	string	network:siteCode or GEOM:Point(Lat Lon) or GEOM:BOX(w s, e n)
beginDate	string	iso date or dateTime as a string
endDate	string	iso date or dateTime as a string
site	string	network:siteCode
site[]	array of string	array of network:siteCode
site[]	array of string	some services allow override to retrieve multiples GEOM:BOX(w s, e n)
west, south, east, north	decimal	Geographic Coordinates for use in GetSitesInBox
includeSeries	boolean	include series information when calling GetSitesInBox

GetVariableInfo¶

• GetVariableInfoObject returns WaterML inline
• GetVariableInfo returns WaterML converted to string
  

Single Parameter, if null returns all variables Simple: GetVariableInfo("VOCABULARY:code/option/optionN", "AuthToken")
Detailed Variable: GetVariableInfo("VOCABULARY:code/option/optionN", "AuthToken") eg

GetSites ¶

• GetSitesObject returns WaterML inline
• GetSites returns WaterML converted to string
  

WaterOneFlow 1.0 Note.

• GetSites returns WaterML inline
• GetSitesXml returns WaterML converted to string
  

Returns all sites up to a limit (usually 50,000 records)

GetSites(null)	All, or limited to number of records in Capabilities
GetSites(["SiteVocab:Code"])	one
GetSites(["SiteVocab:Code","SiteVocab:Code2",...])	multiple

GetSiteInfo¶

• GetSiteInfoObject returns WaterML inline
• GetSiteInfo returns WaterML converted to string
  

Single Location Parameter, if null, returns SoapException(Client)

GetSiteInfo(ODM:USU-LBR-Mendon, "AuthToken")

GetSitesInBox ¶

WaterOneFlow 1.1 only

• GetSiteInfoObject returns WaterML inline
• GetSiteInfo returns WaterML converted to string
  

Returns a list of sites, or if includeSeries=true, then also includes series information

GetSitesInBox(west,south,east,north,includeSeries)

GetSitesInBox(-180,-90,180,90,false) same as GetSites("GEOM:BOX(-180,-90,180,90)" )

GetSitesInBox(-180,-90,180,90,true) return series information for multiple sites in region

GetValues¶

• GetValuesObject returns WaterML inline
• GetValues returns WaterML converted to string
  

Four Parameters, plus authorization

GetValues (Location,Variable,BeginDate,EndDate, "AuthToken")

Dates can be null.

• null beginDate translated to 1753-01-01 (earliest SQL date)
• null endDate translated to TODAY
  

Detailed GetValues MORE HERE