CIMS Web Service

CIMS

Click here for a complete list of operations.

GetValuesObject

Given a site code, a variable, a start date, and an end date, this method returns a time series object serialized to XML. Pass in the sitecode and variable in this format: 'CIMS:SiteCode' and 'CIMS:VariableCode'

Test

The test form is only available for requests from the local machine.

SOAP 1.1

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

POST /wateroneflow/CIMS.asmx HTTP/1.1
Host: cbe.cae.drexel.edu
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.cuahsi.org/his/1.0/ws/GetValuesObject"

<?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>
    <GetValuesObject xmlns="http://www.cuahsi.org/his/1.0/ws/">
      <location>string</location>
      <variable>string</variable>
      <startDate>string</startDate>
      <endDate>string</endDate>
      <authToken>string</authToken>
    </GetValuesObject>
  </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>
    <GetValuesObjectResponse xmlns="http://www.cuahsi.org/his/1.0/ws/">
      <timeSeriesResponse xmlns="http://www.cuahsi.org/waterML/1.0/">
        <queryInfo>
          <creationTime>dateTime</creationTime>
          <queryURL>string</queryURL>
          <querySQL>string</querySQL>
          <criteria>
            <locationParam>string</locationParam>
            <variableParam>string</variableParam>
            <timeParam xsi:nil="true" />
          </criteria>
          <note type="string" href="string" title="string" show="string" />
          <note type="string" href="string" title="string" show="string" />
          <extension />
        </queryInfo>
        <timeSeries name="string">
          <sourceInfo />
          <variable oid="normalizedString" metadataDateTime="dateTime">
            <variableCode xsi:nil="true" />
            <variableCode xsi:nil="true" />
            <variableName>string</variableName>
            <variableDescription>string</variableDescription>
            <valueType>Field Observation or Sample or Model Simulation Result or Derived Value</valueType>
            <dataType>Continuous or Instantaneous or Cumulative or Incremental or Average or Maximum or Minimum or Constant Over Interval or Categorical or Best Easy Systematic Estimator </dataType>
            <generalCategory>Water Quality or Climate or Hydrology or Geology or Biota</generalCategory>
            <sampleMedium>Surface Water or Ground Water or Sediment or Soil or Air or Tissue or Precipitation</sampleMedium>
            <units xsi:nil="true" />
            <options xsi:nil="true" />
            <note xsi:nil="true" />
            <note xsi:nil="true" />
            <related xsi:nil="true" />
            <extension />
            <NoDataValue>string</NoDataValue>
            <timeSupport xsi:nil="true" />
          </variable>
          <values timeZoneShiftApplied="boolean" unitsAbbreviation="normalizedString" unitsCode="token" unitsType="Angle or Area or Dimensionless or Energy or Energy Flux or Flow or Force or Frequency or Length or Light or Mass or Permeability or Power or Pressure/Stress or Resolution or Scale or Temperature or Time or Velocity or Volume" count="nonNegativeInteger" unitsAreConverted="boolean">
            <value xsi:nil="true" />
            <value xsi:nil="true" />
            <qualifier xsi:nil="true" />
            <qualifier xsi:nil="true" />
            <qualityControlLevel xsi:nil="true" />
          </values>
        </timeSeries>
      </timeSeriesResponse>
    </GetValuesObjectResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

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

POST /wateroneflow/CIMS.asmx HTTP/1.1
Host: cbe.cae.drexel.edu
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetValuesObject xmlns="http://www.cuahsi.org/his/1.0/ws/">
      <location>string</location>
      <variable>string</variable>
      <startDate>string</startDate>
      <endDate>string</endDate>
      <authToken>string</authToken>
    </GetValuesObject>
  </soap12:Body>
</soap12:Envelope>

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

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetValuesObjectResponse xmlns="http://www.cuahsi.org/his/1.0/ws/">
      <timeSeriesResponse xmlns="http://www.cuahsi.org/waterML/1.0/">
        <queryInfo>
          <creationTime>dateTime</creationTime>
          <queryURL>string</queryURL>
          <querySQL>string</querySQL>
          <criteria>
            <locationParam>string</locationParam>
            <variableParam>string</variableParam>
            <timeParam xsi:nil="true" />
          </criteria>
          <note type="string" href="string" title="string" show="string" />
          <note type="string" href="string" title="string" show="string" />
          <extension />
        </queryInfo>
        <timeSeries name="string">
          <sourceInfo />
          <variable oid="normalizedString" metadataDateTime="dateTime">
            <variableCode xsi:nil="true" />
            <variableCode xsi:nil="true" />
            <variableName>string</variableName>
            <variableDescription>string</variableDescription>
            <valueType>Field Observation or Sample or Model Simulation Result or Derived Value</valueType>
            <dataType>Continuous or Instantaneous or Cumulative or Incremental or Average or Maximum or Minimum or Constant Over Interval or Categorical or Best Easy Systematic Estimator </dataType>
            <generalCategory>Water Quality or Climate or Hydrology or Geology or Biota</generalCategory>
            <sampleMedium>Surface Water or Ground Water or Sediment or Soil or Air or Tissue or Precipitation</sampleMedium>
            <units xsi:nil="true" />
            <options xsi:nil="true" />
            <note xsi:nil="true" />
            <note xsi:nil="true" />
            <related xsi:nil="true" />
            <extension />
            <NoDataValue>string</NoDataValue>
            <timeSupport xsi:nil="true" />
          </variable>
          <values timeZoneShiftApplied="boolean" unitsAbbreviation="normalizedString" unitsCode="token" unitsType="Angle or Area or Dimensionless or Energy or Energy Flux or Flow or Force or Frequency or Length or Light or Mass or Permeability or Power or Pressure/Stress or Resolution or Scale or Temperature or Time or Velocity or Volume" count="nonNegativeInteger" unitsAreConverted="boolean">
            <value xsi:nil="true" />
            <value xsi:nil="true" />
            <qualifier xsi:nil="true" />
            <qualifier xsi:nil="true" />
            <qualityControlLevel xsi:nil="true" />
          </values>
        </timeSeries>
      </timeSeriesResponse>
    </GetValuesObjectResponse>
  </soap12:Body>
</soap12:Envelope>