HIS Central Metadata Web Services
The following are descriptions of methods that would be needed to support centralized data discovery of all data registered and cataloged at HIS Central.
http://water.sdsc.edu/hiscentral/webservices/hiscentral.asmxdeployed on river, but login is required:
http://hiscentral.cuahsi.org/webservices/hiscentral.asmxGetSearchableConcepts
Input Parameters: None
Returns: A list of all searchable concepts from the HIS ontology.
Test method:
GetSearchableConcepts
GetConceptTree
Input Parameters: Concept (Optional)
Returns: Concept tree in XML format, starting with the input concept as the root and including only child nodes of the concept (and the concept itself). Zichuan Ye will log on and edit the wiki to elaborate on his concept scheme.
GetWaterOneFlowServiceInfo
Input Parameters: A comma separated list of ServiceIDs (Optional)
Returns: A list of all WaterOneFlow web services registered with HIS Central. We need a WaterML serviceInfo type to define this and should probably have the following elements.
- ServiceID
- Data Service Name
- Data Service Title
- Data Service WSDL URL
- Data Service Description URL
- Geographic Extent (xmin, xmax, ymin, ymax)
- Abstract
- Contact Name
- Contact Email
- Contact Phone
- Organization
- Organization Website
- Supported Methods
- Citation
- Value Count
- Variable Count
- Site Count
- Earliest Record DateTime
- Latest Record DateTime
- ServiceStatus
Test Method here:
GetWaterOneFlowServiceInfo
GetMappedVariables
Input Parameters: Searchable Ontology concept, a comma separated list of ServiceIDs (Optional)
Returns: A list of all variables that are either mapped to or fall under the input ontology concept and that are contained within one of the input ServiceIDs.
Return Format: List of WaterML variableInfoType elements that also returns enough information about the service from which the variable(s) originate to call the GetWaterOneFlowServiceInfo method to get the service information. Also includes the ConceptCode/ConceptID to which the Variable has been mapped.
Test Method here:
GetMappedVariables
GetMappedVariablesInBox
Input Parameters: Searchable Ontology Concept, Geographic bounding box
Returns: Same as GetMappedVariables.
Return Format: Same as GetMappedVariables.
GetHydrologicUnits
Input Parameters: None
Returns: A list of all USGS 8-Digit Hydrologic Unit Codes.
GetSitesInBox
Input Parameters: Lat/Long Box, Ontology Concept (optional), Begin Date (Optional), End Date (Optional), Number of Data Values (Optional), a comma separated list of ServiceIDs (Optional)
Returns: A list of all sites that fall within the bounding box, have variables that are mapped to or fall under the Ontology Concept, overlap the date range of interest, have a minimum number of data values, and are within the list of services.
Return Format: A list of WaterML siteInfo elements that includes enough information to identify the service from which the sites were extracted and the HUC Code and HUC Name for the HUC in which the sites are located (as a general rule, anywhere the siteInfo element is used it should contain the HUC Code and HUC Name).
GetSitesInService
Input Parameters: Data Service Name, Ontology Concept (optional), Begin Date (Optional), End Date (Optional), Number of Data Values (Optional)
Returns: Same as GetSitesInBox
Return Format: Same as GetSitesInBox
GetSitesInHUC
Input Parameters: USGS HUC Code, Ontology Concept (Optional), Begin Date (Optional), End Date (Optional), Number of Data Values (Optional), a comma separated list of ServiceIDs (Optional)
Returns: Same as GetSitesInBox
Return Format: Same as GetSitesInBox
GetSeriesCatalogForSite
Input Parameters: ServiceID, Network:SiteCode, Ontology Concept (Optional), Begin Date (Optional), End Date (Optional), Number of Observations (Optional)
Returns: A list of all data series available for the site that are either mapped to or fall under the input ontology concept, overlap the input date range, and have a minimum number of observations.
Return Format: A list of WaterML siteInfo elements that also include information about the service (ServiceID, ServiceName, ServiceWSDL) that they came from and the ontology concepts that go with the variables.
GetSeriesCatalogForBox
Input Parameters: Lat/Long Box, Ontology Concept (Optional), Begin Date (Optional), End Date (Optional), Number of Observations (Optional), a comma separated list of ServiceIDs (Optional)
Returns: A list of all data series for all sites that fall within a Lat/Long box, are either mapped to or fall under the input ontology concept, overlap the input date range, have a minimum number of observations, and are within one of the services in the list of services.
Return Format: Same as GetSiteCatalog.
GetSeriesCatalogForHUC
Input Parameters: USGS HUC Code, Ontology Concept (Optional), Begin Date (Optional), End Date (Optional), Number of Observations (Optional), a comma separated list of ServiceIDs (Optional)
Returns: A list of all data series that fall within a USGS HUC, are either mapped to or fall under the input ontology concept, overlap the input date range, have a minimum number of observations, and are within one of the services in the list of services.
Return Format: Same as GetSiteCatalog.
GetServicesInBox
Input Parameters: Lat/Long box
Returns: A list of data services that overlap the Lat/Long box
Return Format: Same as GetWaterOneFlowServiceInfo.