WaterOneFlow Web Service

WaterOneFlow

Click here for a complete list of operations.

GetVariablesObject

Given a variable code, this method returns the variable's siteName. Pass in the variable in this format: 'NetworkName:Variable'

Test this call...

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /trwa/cuahsi_1_1.asmx HTTP/1.1
Host: hydroportal.cuahsi.org
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.cuahsi.org/his/1.1/ws/GetVariablesObject"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetVariablesObject xmlns="http://www.cuahsi.org/his/1.1/ws/">
      <authToken>string</authToken>
    </GetVariablesObject>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetVariablesObjectResponse xmlns="http://www.cuahsi.org/his/1.1/ws/">
      <variablesResponse xmlns="http://www.cuahsi.org/waterML/1.1/">
        <queryInfo>
          <creationTime>dateTime</creationTime>
          <queryURL>string</queryURL>
          <criteria MethodCalled="normalizedString">
            <locationParam>string</locationParam>
            <variableParam>string</variableParam>
            <timeParam>
              <beginDateTime>string</beginDateTime>
              <endDateTime>string</endDateTime>
            </timeParam>
            <parameter name="token" value="string" />
            <parameter name="token" value="string" />
          </criteria>
          <note type="token" href="string" title="string" show="string" />
          <note type="token" href="string" title="string" show="string" />
          <extension />
        </queryInfo>
        <variables>
          <variable oid="normalizedString" metadataTime="dateTime">
            <variableCode network="token" vocabulary="token" default="boolean" variableID="int" />
            <variableCode network="token" vocabulary="token" default="boolean" variableID="int" />
            <variableName>string</variableName>
            <variableDescription>string</variableDescription>
            <valueType>string</valueType>
            <dataType>string</dataType>
            <generalCategory>string</generalCategory>
            <sampleMedium>string</sampleMedium>
            <unit unitID="int">
              <unitName>string</unitName>
              <unitDescription>string</unitDescription>
              <unitType>string</unitType>
              <unitAbbreviation>string</unitAbbreviation>
              <unitCode>token</unitCode>
            </unit>
            <options>
              <option name="normalizedString" optionID="integer" optionCode="token" />
              <option name="normalizedString" optionID="integer" optionCode="token" />
            </options>
            <note type="token" href="string" title="string" show="string" />
            <note type="token" href="string" title="string" show="string" />
            <related>
              <parentCode network="token" vocabulary="token" default="boolean" />
              <parentCode network="token" vocabulary="token" default="boolean" />
              <relatedCode network="token" vocabulary="token" default="boolean" />
              <relatedCode network="token" vocabulary="token" default="boolean" />
            </related>
            <extension />
            <noDataValue>double</noDataValue>
            <timeScale isRegular="boolean">
              <unit unitID="int">
                <unitName>string</unitName>
                <unitDescription>string</unitDescription>
                <unitType>string</unitType>
                <unitAbbreviation>string</unitAbbreviation>
                <unitCode>token</unitCode>
              </unit>
              <timeSpacing>float</timeSpacing>
              <timeSupport>float</timeSupport>
            </timeScale>
            <speciation>string</speciation>
            <categories>
              <category categoryID="int">
                <dataValue>decimal</dataValue>
                <description>string</description>
              </category>
              <category categoryID="int">
                <dataValue>decimal</dataValue>
                <description>string</description>
              </category>
            </categories>
            <variableProperty type="token" name="normalizedString" uri="anyURI" />
            <variableProperty type="token" name="normalizedString" uri="anyURI" />
          </variable>
          <variable oid="normalizedString" metadataTime="dateTime">
            <variableCode network="token" vocabulary="token" default="boolean" variableID="int" />
            <variableCode network="token" vocabulary="token" default="boolean" variableID="int" />
            <variableName>string</variableName>
            <variableDescription>string</variableDescription>
            <valueType>string</valueType>
            <dataType>string</dataType>
            <generalCategory>string</generalCategory>
            <sampleMedium>string</sampleMedium>
            <unit unitID="int">
              <unitName>string</unitName>
              <unitDescription>string</unitDescription>
              <unitType>string</unitType>
              <unitAbbreviation>string</unitAbbreviation>
              <unitCode>token</unitCode>
            </unit>
            <options>
              <option name="normalizedString" optionID="integer" optionCode="token" />
              <option name="normalizedString" optionID="integer" optionCode="token" />
            </options>
            <note type="token" href="string" title="string" show="string" />
            <note type="token" href="string" title="string" show="string" />
            <related>
              <parentCode network="token" vocabulary="token" default="boolean" />
              <parentCode network="token" vocabulary="token" default="boolean" />
              <relatedCode network="token" vocabulary="token" default="boolean" />
              <relatedCode network="token" vocabulary="token" default="boolean" />
            </related>
            <extension />
            <noDataValue>double</noDataValue>
            <timeScale isRegular="boolean">
              <unit unitID="int">
                <unitName>string</unitName>
                <unitDescription>string</unitDescription>
                <unitType>string</unitType>
                <unitAbbreviation>string</unitAbbreviation>
                <unitCode>token</unitCode>
              </unit>
              <timeSpacing>float</timeSpacing>
              <timeSupport>float</timeSupport>
            </timeScale>
            <speciation>string</speciation>
            <categories>
              <category categoryID="int">
                <dataValue>decimal</dataValue>
                <description>string</description>
              </category>
              <category categoryID="int">
                <dataValue>decimal</dataValue>
                <description>string</description>
              </category>
            </categories>
            <variableProperty type="token" name="normalizedString" uri="anyURI" />
            <variableProperty type="token" name="normalizedString" uri="anyURI" />
          </variable>
        </variables>
      </variablesResponse>
    </GetVariablesObjectResponse>
  </soap:Body>
</soap:Envelope>

GetVariablesObject

Test this call...

Show sample request/response...