Changes:
2006-07-10 valentine
removed choice. Replaced with Types
defined TimePeriodType
TimeIntervalType
TimeSingleType
added GeogLocationType to hold the geometry
redefined LatLongPoint as a type
defined LatLongBox to hold
defined simpleTypes Latitude and Longitude
added DataSetLocation Element (type GeogLocationType) to dataset info
removed xlink namespace. Just used the xlink concept (problems getting it to compile with xlink schema)
2006-08-30 valentine
MANY CHANGES to:
sync with the Observations Database terminolog
simplify. Removed many unneeded types. (initial version was Type happy)
types mostly used only when needed (Geometry, SourceInfo, TimeSeries, Notes, Enumerations).
*** Element Case Standardize ****
All types are PascalCase
All CUAHSI elements and attributes are camelCase
* All root response elements are now elements, and not types
** SitesResponse
** TimeSeriesResponse (not timeSeriesType)
** VariablesResponse
* extension elements added.
** These are extension points for groups like
the USGS that wish to include more information than the normal community uses.
* enumerations added
* unitType
* censorCode (characters used because symbols make for unmaintainable source code)
* lt - less than
* gt - greater than
* nc - no code
* variable types consolidated
* units element added
* consistent siteID/variableID pattern (both include a XXXCode)
* Remove many types
** too many to list.
* values == TsValuesType renamed from TsValuesSingleVariableType
** split values element out to type ValueSingleVar (c# change tsValuesTypeValueType to ValueSingleVar).
** qualifier elements can be added after the final value element in the Values element.
*** we don't know the full list of included qualifiers until we get done with the values.
*** at present, qualifiers attribute in the value element is an aggregated field.
element block looks like:
= values
== value qualifers="A"
== value qualifers="Ae"
== qualifier qualifierCode="A" "Approved"
== qualifier qualifierCode="e" "Estimated. This value has been estimated."
2006-09-08
variableID renamed variableCode
siteID renamed siteCode
siteID and variableID attributes added, xxCode removed
siteCode name moved into siteInfo
2006-09-15
variable/name to variable/variableName
variablePeriod to variablePeriodOfObservation
2006-09-17
added QualityControlLevelEnum
added attribute qualityControlLevel to valueAttribute group. (affects ValueSingleVariable)
added qualityControlLevel element, and element to the TSValuesSingleVariableType
namespace changed to http://www.cuahsi.org/waterML/1.0/
return to types for top level elements, without this they get named getValuesResponse
added note to siteInfoElement. We need to put the URL or Retireved from DB not in this block.
added TimePeriodRealTime. Need to represent real time data.
2006-0920
variablePeriodofRecorr to seriesCatalog
variablePeriodOfObservation to series
variableObservationCount to valueCount (to match the OD)
added enumerations from the OD
valueTypeEnum
generalCategoryEnum
sampleMediumEnum
dataTypeEnum
2006-09-24
queryInfo/criteria/timeParam is now a sequence, since a start or end time can be null
The community wants it to be easy, and VB and other .net have problems with some values:
converted xsd:decimal to xsd:double. decimal is not well handled by VB
converted tsValuesSingleVaribaleType/count from xsd:nonNegativeInteger to xsd:int.
2006-09-28
API signature has been changed to strings.
queryInfo/timeInterval/... changed to strings
2007-07-09
ODM seriesCatalog table added columns. Columns now added
DataValue element was missing: DataType(eg statistic), Method, Source, and QualityControlLevel.
2007-08-28
added to values method[](methodType), source[](SourceType)
added "Unknown" to many enumerations.
contactInformation in sourceType changed to unbounded
2007-08-29
DT/DM believes that including an offsetDescription on every element is verbose
offsetTypeID attribute added to offsetAttr
offsetType Type added, Designed to be a bit more extensible, and handle
2007-08-30
restored attributes that had the offset information on the values
offsetAttr restored attr
offsetUnitsAbbreviation
offsetUnitsCode
offsetDescription
2007-11-14
Many services use agency (aka EPA, and USGS)
added attributes agencyCode and AgencyName to siteCode.
2007-11-29
SiteInfo/TimezoneInfo min occurs 0 max 1
Series/QualityControlLevel min occurs 0 max 1
2009-07
added back attributeGroup vocabulary attributes got dropp drop VariableInfoType.
changes to min/max occurs in several locations
A sampling station is any place where data are collected.
SiteInfoType is the Element that for the core information about a point sampling location. The core information includes SiteName, SiteCode(s), location, elevation, timeZone information and note(s).
SiteInfoType is <siteInfo> in a <site> of a <sitesResponse>. It is derived from SourceType so that other geographic location descriptions can be utilized in the <sourceInfo> of the <timeSeriesResponse>
Full name of the sampling site. eg “LOGAN RIVER ABOVE STATE DAM, NEAR LOGAN,UT”
A siteCode is an identifier that this site is referred to as. This Code used by organization that collects the data to identify the site.
A siteCode has a reference to it's source or network as the @network. For waterWebServices, a site/location is the network plus the value of the sitecode, eg '@network:siteCode'
siteCode identifiers often change, so multiple siteCode elements are allowed There may be multiple siteCode elements. Only one should be labeled as the default using @defaultID (set attribute defaultID=true)
Multiple siteCode elements can utilize different observation networks may refer to the same site with different identifiers.
True if this is the main identifier that this service uses to access this site.
default value is false.
The abbreviation for the datasource or observation network that this site code is associated with.
A siteCode has a reference to it's source or network as the @network. For waterWebServices, a site/location is the network plus the value of the sitecode, eg '@network:siteCode'
An internal numeric identifier of the site.
Code used to differentiate sites in a datasource. Agency codes are specific to a data source, and are not required nor do they need to be understood by a web service client.
optional name to provide more detail about an agency code
Specifies the time zone information about a site.
The default time zone for this site (+00:00) and if this site shifts to daylight savings time (attribute: usesDaylightSavingsTime)
The geoLocation speficies the details of the geographic location. It contains two portions, a geographic locaiton &lt;geogLocation&gt;, and a local location &lt;localSiteXY&gt;.
In order to be discovered spatially, geogLocation is required. The geogLocation can be of GeogLocationType, which at present is either a latLonPoint or a latLongBox.
There may be multiple localSiteXY, which might be used by data sources to provide other coordinated system information, like UTM and State Plane coordinates.
Geographic location:
A geographic location is required as part of the site information (siteInfoType or siteInfo element)
At present this can be elements of GeogLocationType: LatLonPointType and LatLonBoxType. an xml schema type attribute can be used to determine which type is contained in this element (xsi:type="LatLonPointType" or xsi:type="LatLonBoxType")
Site information can contain one or more other locations using the localSiteXY element. The projection string should be stored in projectionInformation.
Lat or Northing = Y
Lon or Easting = X
Additional information should be encoded in zero or more note elmements.
The name of the property should be @title, and the value should be inside the note value. Attribute @type is provided so that notes can be grouped.
Spatial Reference System of the local coordinates.
This should use the PROJ4 projection string standard
Elevation in meters.
A vertical datum should also be provided.
Additional information, like state, county, or other properties like HUC codes should be encoded in zero or more <note> elmements.
The name of the property should be @title, and the value should be inside the <note>value</note>. Attribute @type is provided so that notes can be grouped.
In order to simplify comprehension, data sources are encouraged to put additional informaiton in the extension area, using thier own namespace. Clients need not understand information in <extension?
Alternate name
TsValuesSingleVariableTypea aggregates the list of values and associated metadata. It is the values element in the timeSereisResponse
Attributes are optional, but use @count is encouraged.
The atrributes @unitsAreConverted, @untsCode,@unitsAbbreviation, and @unitsType were originally included to allow for translation from orignal variable units. Thier use is not encouraged. Get unit information from the Variable element.
Multiple <value>s represent the data series.
multiple <qualifier>s containg the data qualifying comments that accompany the data.
<qualityControlLevel> contains the quality control levels that are used for versioning data within the data values
Multiple &amp;lt;method&amp;gt;s lists the methods used to collect the data and any additional information about the method.
@methodID is the link between the values, and method.
Different instruments should be represented as different methods, according to ODM best practices
The Sources the original sources of the data, providing information sufficient to retrieve the data value.
@sourceID is the link bewteen source the values.
<offset> is of type OffsetType. offset lists full descriptive information for each of the measurement offsets.
@offsetID is the link between offset, and values.
If a webservice has transformed the time zone from the original data.
the measurment units of the value elements in this values element
True if a webservice has transformed the data from the original units.
VariableInfoType is a complex type containting full descriptive information about a variable, as described by the ODM. This includes one or more variable codes, the short variable name, a detailed variable description, and suggest
It also extends the ODM model, in several methods:
- options contain extended reuqest information.
- note(s) are for generic extenstion.
- extension is an element where additional namespace information should be placed.
- related allows for parent and child relationships between variables to be communicated.
One of more elements representing the Text code used by the organization that collects the data to identify the variable.
A brief name of the variable that could be shown in a menu
A detailed description of the variable. May include processing information and other details.
Text value indicating what type of data value is being recorded. For 1.0 this must be from the valueTypeEnum type.
A default value of “Unknown” can be used where the value type is unknown.
Text value that identifies the data values as one of several types from the dataTypeEnum
A default value of “Unknown” can be used where the data type is unknown.
General category of the data values from the generalCategoryEnum.
A default value of “Unknown” can be used where the general category is unknown.
Only terms from the SampleMediumEnume can be used to populate the sampleMedium element.
A default value of “Unknown” is used where the sample medium is unknown.
The units of the measurements asociated withthe variable.
This will be changed to UnitsType in WaterML 1.1
A list of options. Option elements are key-value pair elements that control how a variable maght be utilized in a service.
Examples:
MODIS web service. Information is aggreated over land or ocean or both. The plotarea option can include: plotarea=land, plotarea=land, plotarea=landocean
USGS uses a statistic code, 0003, to repesent a value type of 'Average'. The USGS statistic codes also several options that do not fit the ODM data model.
Additional information, properties like should be encoded in zero or more &lt;note&gt; elmements.
The name of the property should be @title, and the value should be inside the <note>value</note>. Attribute @type is provided so that notes can be grouped.
This can be used to build up relationships between variables.
variableCode for the parent
Child or other relationships can be encoded using the related element.
In order to simplify comprehension, data sources are encouraged to put additional informaiton in the extension area, using thier own namespace. Clients need not understand information in <extension?
Numeric value used to encode no data values for this variable.
Element containing the time support (or temporal footprint) of the data values.
@isRegular indicates if the spacing is regular.
In waterML 1.0, there is a divergence of mean between ODM, and WaterML.
WaterML only communcates the regularity, and the spacing of the observations (timeInterval). Whereas timesupport in the ODM is associated with the dataType, and time support. This will be addressed in 1.1
0 is used to indicate data values that are instantaneous. Other values indicate the time over which the data values are implicitly or explicitly averaged or aggregated.
The default for the TimeSupport field is 0. This corresponds to instantaneous values. If the TimeSupport field is set to a value other than 0, an appropriate TimeUnitsID must be specified. The TimeUnitsID field can only reference valid UnitsID values from the Units controlled vocabulary table. If the TimeSupport field is set to 0, any time units can be used (i.e., seconds, minutes, hours, etc.), however a default value of 103 has been used, which corresponds with hours
This contains information about the request, and is used to enable the XML responses (timeSeriesResponse, variablesResponse,siteResponse) to be stored on disk.
When was this response originally created.
The URL of the web page that was used as the original source for the response. Often requests scrap HTML pages. This should be the URL of that page.
If the response is retreive from a rest URL. This is also a the location for the URL.
For debugging, the SQL used to generate this request may be placed in this element.
The criteria are the actual parameters that are passed into the method. If you are generate this without a XML helper class, be sure to properly encode these elements.
the location or site parameter passed into the site
the variable paramter passed into the service
the begin and end time of the GetValues request used to generate a timeSeriesResponse.
The string submited as startDate to the GetValues method
The string submited a startDate to the GetValues method
Additional information, properties like should be encoded in zero or more &lt;note&gt; elmements.
The name of the property should be @title, and the value should be inside the <note>value</note>. Attribute @type is provided so that notes can be grouped.
In order to simplify comprehension, data sources are encouraged to put additional informaiton in the extension area, using thier own namespace. Clients need not understand information in <extension?
variables is a list of variable elements (VariableInfoType).
zero or more variable elements are contained in a variables element.
See VariableInfoType for more details on the information in the variable element
Tthe attribute group vocabularyAttributes contains common attributes used to differentiate data source codes.
A network should be provided with a siteCode, and a vocabular should be provided with a variableCode.
If there is more than one code, one code should be provided as the default code for the service.
@netowrk codespace for the siteCode datasource.
Submitted to webservice as 'network:sitecode'
@vocabulary codespace for the variableCode for a datasource.
Submitted to webservice as 'vocabulary:vocabularyCode'
this attribute group provides provenance information for when an object is retrieved from a database.
object identifier, or guid for an object
time object was created in the database.
The default time zone for this site (+00:00) and if this site shifts to daylight savings time (attribute: usesDaylightSavingsTime)
The default time zone for a site, specified in hours and minutes: "hh:mm"
The daylight savings time zone for a site, specified in hours and minutes: "hh:mm"
If the location shifts it's data sources to Daylight Savings Time, this flag should be true.
valueAttr contains the possible attributes that can be associated with a data value element.
@qualifier contains a qualifier code whose details are described in the values/ qualifier element(s)
Space delimit multiple qualifier codes.
indication of whether the data value is censored
@censorCode codelist is censorCodeEnum.
XML date and time at which the data value was observed. This is an ISO specified string, that can contain a time zone offset, if apprpriate. If no time offset is specificed, the data is in the local time zone of the station.
text string giving the level of quality control that the value has been subjected to.
Codelist is from qualityControlLevelEnum.
@qualifier contains a identifier whose details are described in the values/method element(s)
@methodID contains an identifier whose details are described in the values/method element(s)
Numeric value that describes the measurement accuracy of the data value. If not given, it is interpreted as unknown.
If a value is categorical, then @codedVocabulary is set to true, and the categorical term is placed in@codedVocabularyTerm, and a numeric value put in the value.
While not a good practice, allows for categorical and numeric values to be intermixed.
@sampleId contains a n identifier whose details are described in the values/samples element(s)
This is required only if the data value resulted from a physical sample processed in a lab.
the standard abbreviation for this time zone (GMT; EST)
Hours and minutes offset for this time zone (+00:00).
A list of options. Option elements are key-value pair elements that control how a variable maght be utilized in a service.
Examples:
MODIS web service. Information is aggreated over land or ocean or both. The plotarea option can include: plotarea=land, plotarea=land, plotarea=landocean
USGS uses a statistic code, 0003, to repesent a value type of 'Average'. The USGS statistic codes also several options that do not fit the ODM data model.
Option elements are key-value pair elements that control how a variable maght be utilized in a service.
Examples:
MODIS web service. Information is aggreated over land or ocean or both. The plotarea option can include: plotarea=land, plotarea=land, plotarea=landocean
USGS uses a statistic code, 0003, to repesent a value type of 'Average'. The USGS statistic codes also several options that do not fit the ODM data model.
SourceInfoType is used to describe the data source in the timeSeriesResponse.
SourceInfoType is the base type for data source information. At present, two types are derived from SourceInfoType: SiteInfoType, and DataSetInfoType. SiteInfoType describes tlocation for a timeseries where that time series is located at a site or a DataSetInfoType describes time series derived from a dataset, such as a netCDF file, or a gridded model.
DataSetInfoType describes time series derived from a dataset, such as a netCDF file, or a gridded model.
The indentifier which the original source uses to identify this dataset. This may be a unique indentifier, or a URL from which the data source was retireved
the default time zone for this site (+00:00) and if this site shifts to daylight savings time (attribute: usesDaylightSavingsTime)
Text description describing the data source.
Additional information, about a dataset, or other properties should be encoded in zero or more &lt;note&gt; elmements.
The name of the property should be @title, and the value should be inside the <note>value</note>. Attribute @type is provided so that notes can be grouped.
geolocation describing the spatial coverage of a gridded dataset.
In order to simplify comprehension, data sources are encouraged to put additional informaiton in the extension area, using thier own namespace. Clients need not understand information in extension element
dataSetInfo element describes time series derived from a dataset, such as a netCDF file, or a gridded model.
time series (site-variable-observation) can have three types of time periods:
1) definite start and end time, or TimeIntervalType,
2) single observation, or TimeSingleType
3) Real Time station with moving window of data available, or TimeRealTimeType
In order to simplify client development, all types now include beginDateTime, and endDateTime.
A fourth type should be added:
4) continuing site, where start is known, and site is still collecting data. This could be a realTimeType, or rename the real time type to TimeDefinedPeriodType.
For where a series has multiple observations, and a define beingDateTime as dateTime of the first data value in the series, and endDateTime dateTime of the last data value in the series.
dateTime of the first data value in the series.
The dateTime is specified in the following form "YYYY-MM-DDThh:mm:ss" where:
* YYYY indicates the year
* MM indicates the month
* DD indicates the day
* T indicates the start of the required time section
* hh indicates the hour
* mm indicates the minute
* ss indicates the second
Note: All components are required!
Date of the last data value in the series.
The dateTime is specified in the following form "YYYY-MM-DDThh:mm:ss" where:
* YYYY indicates the year
* MM indicates the month
* DD indicates the day
* T indicates the start of the required time section
* hh indicates the hour
* mm indicates the minute
* ss indicates the second
Note: All components are required!
For where a series is a single observation.
timeSingle, beginDateTime, and endDateTime will have the same value. The beginDateTime and endDateTime are provided to simplify usage by clients.They should be be calculated based on the duration stored in realTimeDataPeriod
dateTime of the first data value in the series.
The dateTime is specified in the following form "YYYY-MM-DDThh:mm:ss" where:
* YYYY indicates the year
* MM indicates the month
* DD indicates the day
* T indicates the start of the required time section
* hh indicates the hour
* mm indicates the minute
* ss indicates the second
Note: All components are required!
Date of the last data value in the series.
The dateTime is specified in the following form "YYYY-MM-DDThh:mm:ss" where:
* YYYY indicates the year
* MM indicates the month
* DD indicates the day
* T indicates the start of the required time section
* hh indicates the hour
* mm indicates the minute
* ss indicates the second
Note: All components are required!
Use where a site has an evolving period where data is available.
The US Geological Survey real time data is available for 30 days, the realTimeDataPeriod element is an XML duration and woudl be "30d"
The beginDateTime and endDateTime are provided to simplify usage by clients.They should be be calculated based on the duration stored in realTimeDataPeriod
Duration Data Type
The duration data type is used to specify a time interval.
The time interval is specified in the following form "PnYnMnDTnHnMnS" where:
* P indicates the period (required)
* nY indicates the number of years
* nM indicates the number of months
* nD indicates the number of days
* T indicates the start of a time section (required if you are going to specify hours, minutes, or seconds)
* nH indicates the number of hours
* nM indicates the number of minutes
* nS indicates the number of seconds
dateTime of the first data value in the series.
This should be be calculated based on the duration stored in realTimeDataPeriod
The dateTime is specified in the following form "YYYY-MM-DDThh:mm:ss" where:
* YYYY indicates the year
* MM indicates the month
* DD indicates the day
* T indicates the start of the required time section
* hh indicates the hour
* mm indicates the minute
* ss indicates the second
Note: All components are required!
Date of the last data value in the series.
This should be be calculated based on the duration stored in realTimeDataPeriod
The dateTime is specified in the following form "YYYY-MM-DDThh:mm:ss" where:
* YYYY indicates the year
* MM indicates the month
* DD indicates the day
* T indicates the start of the required time section
* hh indicates the hour
* mm indicates the minute
* ss indicates the second
Note: All components are required!
GeogLocationType is the base class for the two geometry types: LatLonPointType, and LatLonBoxType.
Any additional types should derive from this type.
The default spatial reference system is @srs is EPSG:4326 or Geographic lat long.
The latitude of the site in a decimal degrees as calculated in terms of the given datum.
The longitude of the site in a decimal degrees as calculated in terms of the given datum.
Point type for describing a geographic location
South Latitude
West Longitude
North Latitude
East longitude.
Box type describing a geographic location.
The longitude of the site in a decimal degrees as calculated in terms of the given datum.
The latitude of the site in a decimal degrees as calculated in terms of the given datum.
Series catalog represents a list of series, where each separate data series are for the purposes of identifying or displaying what data are available at each site.
Additional information, properties like should be encoded in zero or more
In seriesCatalog note elements are placed at the top, to simplify human identification, since there can be tens, or hundred of series for a location.
The name of the property should be @title, and the value should be inside the note
element. Attribute @type is provided so that notes can be grouped.
Separate data series are for the purposes of identifying or displaying what data are available at each site.
Site information is a parent of the series so that it does not need to be repeated (difference from the ODM. ). A Site contains one or more seriesCatalogs which contain one or more series.
Assotiated with site, a series is a unique combination of the textual repesentation of ODM series: Variable,Method,Source,QualityControlLevel.
An ODM series is a unique site/variable combinations are defined by unique combinations of SiteID, VariableID, MethodID, SourceID, and QualityControlLevelID.
Text value that identifies the data as one of several types as found ing dataTypeEnum
this describes the time period that ana variable or observed parameter are available for.
This is of TimePeriodType, which is presently:
TimeIntervalType - definite begin and end
TimeSingleType - single observation/datavalue
TimePeriodRealTime - a floating time period for when data is available.
This will have a xml schema type attribute:
xsi:type="TimeIntervalType"
xsi:type="TimeSingleType"
xsi:type="TimePeriodRealTime"
Text value indicating what type of data value is being recorded as listed in valueTypeEnum
General category of the variable as listed in generalCategoryEnum
The medium of the sample as listed in SampleTypeEnum
Method description.
Optional, since many sources do not have detailed methods.
ODM datasources require methods.
Source of the data values and reference information to recover/discover the data from the source.
Code used to identify the level of quality control to which data values have been subjected.
For clients, this is the list of the html select group element.
This would allow for groups or seriesCatalogs to appear in an HTML select menu.
(depreciated)
location of the WaterOneFlow service that the client should execute GetValues call on.
All services now proxy getValues methods from other sources.
qualifying comments that accompany the data
qualifying comments that accompany the data. value/@qaulifier is a space delimted list of qualifiers for a data value. @qualifierCode is the link to the value/@qualifier for a single value
The value inside provides the textual description. @qualifierCode is the reference code.
@qualifierCode=A
qualifier value=Approved
@vocabulary and @network are suggested. For example a value from the USGS may qualifiers from multiple vocabularies, and the network would be the data service.
Text code used by organization that collects the data.
value/@qaulifier is a space delimted list of qualifiers for a data value. @qualifierCode is the link to the value/@qualifier for a single value
Contains the source of the time series, the variable, and values element which is an array of value elements and thier associated metadata (qualifiers, methods, sources, quality control level, samples)
Contains full descriptive information about a variable, as described by the ODM. This includes one or more variable codes, the short variable name, a detailed variable description, and suggest.
See VariableInforType for full details.
A list of values and associated metadata. It is the values element in the timeSerissResponse
Name of the time series. optional.
NoteType defines the note element available in many defined types.
the value should the description of the note.
@title should be the brief name that might be displayed as a lable
@type can be used to allow for grouping of elements.
Option elements are key-value pair elements that control how a variable maght be utilized in a service.
Examples:
MODIS web service. Information is aggreated over land or ocean or both. The plotarea option can include: plotarea=land, plotarea=land, plotarea=landocean
USGS uses a statistic code, 0003, to repesent a value type of 'Average'. The USGS statistic codes also several options that do not fit the ODM data model.
Text code used by the organization that collects the data to identify the variable. The attribute @vocabulary must be set to the data source name, so the clients can subbumit variable requests to a web service (net
USGS discharge
variableCode
@vocabularyk=NWISDV
@default=true
“00060”
qualifying comments that accompany the data
In order to simplify comprehension, data sources are encouraged to put additional informaiton in the extension area, using thier own namespace. Clients need not understand information in <extension?
VariablesResponseType is object type returned by the method GetVariableInfo. The elemnt name is variablesResponse. The request will contain a variables element containing a list of variable elements.
the parameter information passed to GetVariableInfo(variable) should be placed in QueryInfoType/criteria/variableParam
See QueryInfoType for more details.
variables element contains a list of variable elements
the parameter information passed to Getvalues(location,variable,beginDate,endDate) should be placed in QueryInfoType/criteria/
See QueryInfoType for more details.
Contains the source of the time series, the variable, and values element which is an array of value elements and thier associated metadata (qualifiers, methods, sources, quality control level, samples)
A sitesResponse contains a list of zero or more site elements.
The siteInfo element contains the basic site information, siteName, location, siteCodes, properties.
The seriesCatalog contains the list of observation series conducted at a site.
A site element can have two parts: siteInfo, and one or more seriesCatalogs.
Rules:
GetSites(site[]) or GetSites(null), return no seriesCatalogs elements
GetSiteInfo(site) return all information about a site, including the seriesCatalog.
The parameter information passed to GetSiteInfo(site) or GetSites(site[]) should be placed in QueryInfoType/criteria/locationParam
See QueryInfoType for more details.
A sitesResponse contains a list of zero or more site elements. A site element is
A site element can have two parts: siteInfo, and one or more seriesCatalogs.
The siteInfo element contains the basic site information, siteName, location, siteCodes, properties.
The seriesCatalog contains the list of observation series conducted at a site.
Rules:
GetSites(site[]) or GetSites(null), return no seriesCatalogs elements
GetSiteInfo(site) return all information about a site, including the seriesCatalog.
siteInfo element contains a list of information about a site.
See SiteInfoType
In order to simplify comprehension, data sources are encouraged to put additional informaiton in the extension area, using thier own namespace. Clients need not understand information in extension element
quality control levels that are used for versioning data within the database.
Unique integer identifying the quality control level.
Code used to identify the level of quality control to which data values have been subjected.
Value is the text Code used to identify the level of quality control to which data values have been subjected.
Integer identifier that indicates the level of quality control that the data values have been subjected to.
Method used to collect the data and any additional information about the method.
@methodId is the link to value/@method
As per communication from the ODM designers, multiple instruments observing the same variable, should be different methods.
Methods should describe the manner in which the observation was collected (i.e., collected manually, or collected using an automated sampler) or measured (i.e., measured using a temperature sensor or measured using a turbidity sensor). Details about the specific sensor models and manufacturers can be included in the MethodDescription
Text description of each method.
Link to additional reference material on the method.
information about physical samples analyzed in a laboratory.
@sampleID is the link to the datavalues/@sampleID
LabSampleCode is the sample code. In WaterML 1.1 this will be the link to the dataValue
SampleType describes the the sample type
LabMethod is a LabMethodType containing infomration about lab methods
Code or label used to identify and track lab sample or sample container (e.g. bottle) during lab analysis.
Controlled vocabulary specifying the sample type from the SampleTypeEnum.
LabMethod is a LabMethodType containing infomration about lab methods
contains descriptions of the laboratory methods used to analyze physical samples for specific constituents.
Name of the laboratory responsible for processing the sample.
Organization responsible for sample analysis.
Name of the method and protocols used for sample analysis.
Suggest using nemi names and codes
http://www.nemi.gov/
“USEPA-365.1”
Description of the method and protocols used for sample analysis.
Link to additional reference material on the analysis method.
Unique integer identifier for each laboratory method. This is the key used by the Samples table to reference a laboratory method.
original sources of the data, providing information sufficient to retrieve and reconstruct the data value from the original data files if necessary
Name of the organization that collected the data. This should be the agency or organization that collected the data, even if it came out of a database consolidated from many sources such as STORET.
“Utah Division of Water Quality”
Full text description of the source of the data.
“Text file retrieved from the EPA STORET system indicating data originally from Utah Division of Water Quality”
MetadataType contains the information from the ODM table IsoMetadata. It is anticpated that many data sources may not have this fully available.
Contact information about source.
Link that can be pointed at the original data file and/or associated metadata stored in the digital library or URL of data source.
Unique integer identifier that identifies each data source.
link to datavalues/@sourceID
Contains information about a contact.
A contact can be a person or an agency.
The name of the contact is required.
And address, email or phone is suggested. (in 1.1 one of these will be required.
name of contact, or title of organization
Type of contact, in open terms:
Project Contact
Data source contact
HIS Admin
Data Source Admin
Data Base Admin
phone
email address
Any address element structure that can be used to communicate contact information.
MetadataType contains the information from the ODM table IsoMetadata. It is anticpated that many data sources may not have this fully available.
IsoMetadata table contains dataset and project level metadata required by the CUAHSI HIS metadata system (http://www.cuahsi.org/his/documentation.html) for compliance with standards such as the draft ISO 19115 or ISO 8601. The mandatory fields in this table must be populated to provide a complete set of ISO compliant metadata in the database.
Topic category keyword that gives the broad ISO19115 metadata topic category for data from this source. The controlled vocabulary of topic category keywords is given in the TopicCategoryCV table.
Title of data from a specific data source.
Title field should be populated with a brief text description of what the referenced data represent. This field can be populated with “Unknown” if there is no title for the data.
Abstract of data from a specific data source.
Abstract field should be populated with a more complete text description of the data that the metadata record references. This field can be populated with “Unknown” if there is no abstract for the data.
Name of metadata profile used by the data source
Link to additional metadata reference material.
OffsetType contains full descriptive information for each of the measurement offsets.
A set of observations may be done at an offset for the central location.
offsetTypeID links to dataValue/@offsetTypeId
offsetValue element is value of offset.
If 0, then offset is not needed, and offsetTypeId should not be included on the dataValue
Full text description of the offset type.
Field should be filled in with a complete text description of the offset that provides enough information to interpret the type of offset being used. For example, “Distance from stream bank” is ambiguous because it is not known which bank is being referred to.
Units of the offsetValue
By default, the offset is vertical.
If the offset is horizontal, then this becomes a direction, and distance from the observation point
if offsetIsVertical=false, then this is the direction of the offset
Unique integer identifier that identifies the type of measurement offset.
Suggested that this is offsetType from ODM database.