NAM12KM Web Service

NAM12KM

Click here for a complete list of operations.

GetVariableInfoObject

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

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/NAM12k/Service.asmx HTTP/1.1
Host: water.sdsc.edu
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.cuahsi.org/his/1.0/ws/GetVariableInfoObject"

<?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>
    <GetVariableInfoObject xmlns="http://www.cuahsi.org/his/1.0/ws/">
      <variable>string</variable>
      <authToken>string</authToken>
    </GetVariableInfoObject>
  </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>
    <GetVariableInfoObjectResponse xmlns="http://www.cuahsi.org/his/1.0/ws/">
      <variablesResponse xmlns="http://www.cuahsi.org/waterML/1.0/">
        <variables>
          <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>
            <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 />
          </variable>
          <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>
            <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 />
          </variable>
        </variables>
      </variablesResponse>
    </GetVariableInfoObjectResponse>
  </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/NAM12k/Service.asmx HTTP/1.1
Host: water.sdsc.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>
    <GetVariableInfoObject xmlns="http://www.cuahsi.org/his/1.0/ws/">
      <variable>string</variable>
      <authToken>string</authToken>
    </GetVariableInfoObject>
  </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>
    <GetVariableInfoObjectResponse xmlns="http://www.cuahsi.org/his/1.0/ws/">
      <variablesResponse xmlns="http://www.cuahsi.org/waterML/1.0/">
        <variables>
          <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>
            <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 />
          </variable>
          <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>
            <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 />
          </variable>
        </variables>
      </variablesResponse>
    </GetVariableInfoObjectResponse>
  </soap12:Body>
</soap12:Envelope>