hiscentral Web Service

hiscentral

Click here for a complete list of operations.

getOntologywithOption

Get the subnodes (both leaf and non-leaf) for input concept keyword in the Ontology Tree.

Keyword is one of the search criteria used in HydroClient (refer to notes in this section).
Keyword is also used when data provider uploads data and try to make the uploaded data comply with WaterOneFlow schema. Generally, the user is required to choose a leaf keyword in the ontology tree for each input variable name, so that the newly added variable name is searchable in HisCentral catalog.
The current HisCentral catalog has timeseries data that utilize a subset of the total keywords in the < strong > full ontology tree.Hereafter, the ontology tree composed of the nodes with existing variables in HisCentral catalog(i.e., those ~500 keywords) is referred as partial ontology tree.
GetOntologyTree() returns nodes in the full ontology tree, while GetOntologyTreewithOption() adds the option of returning nodes in the partial ontology tree

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

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 /webservices/hiscentral.asmx HTTP/1.1
Host: hiscentral.cuahsi.org
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://hiscentral.cuahsi.org/20100205/getOntologywithOption"

<?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>
    <getOntologywithOption xmlns="http://hiscentral.cuahsi.org/20100205/">
      <conceptKeyword>string</conceptKeyword>
      <fullTree>boolean</fullTree>
    </getOntologywithOption>
  </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>
    <getOntologywithOptionResponse xmlns="http://hiscentral.cuahsi.org/20100205/">
      <getOntologywithOptionResult>
        <keyword>string</keyword>
        <conceptid>int</conceptid>
        <childNodes>
          <OntologyNode>
            <keyword>string</keyword>
            <conceptid>int</conceptid>
            <childNodes xsi:nil="true" />
          </OntologyNode>
          <OntologyNode>
            <keyword>string</keyword>
            <conceptid>int</conceptid>
            <childNodes xsi:nil="true" />
          </OntologyNode>
        </childNodes>
      </getOntologywithOptionResult>
    </getOntologywithOptionResponse>
  </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 /webservices/hiscentral.asmx HTTP/1.1
Host: hiscentral.cuahsi.org
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>
    <getOntologywithOption xmlns="http://hiscentral.cuahsi.org/20100205/">
      <conceptKeyword>string</conceptKeyword>
      <fullTree>boolean</fullTree>
    </getOntologywithOption>
  </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>
    <getOntologywithOptionResponse xmlns="http://hiscentral.cuahsi.org/20100205/">
      <getOntologywithOptionResult>
        <keyword>string</keyword>
        <conceptid>int</conceptid>
        <childNodes>
          <OntologyNode>
            <keyword>string</keyword>
            <conceptid>int</conceptid>
            <childNodes xsi:nil="true" />
          </OntologyNode>
          <OntologyNode>
            <keyword>string</keyword>
            <conceptid>int</conceptid>
            <childNodes xsi:nil="true" />
          </OntologyNode>
        </childNodes>
      </getOntologywithOptionResult>
    </getOntologywithOptionResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

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

GET /webservices/hiscentral.asmx/getOntologywithOption?conceptKeyword=string&fullTree=string HTTP/1.1
Host: hiscentral.cuahsi.org

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

<?xml version="1.0" encoding="utf-8"?>
<OntologyNode xmlns="http://hiscentral.cuahsi.org/20100205/">
  <keyword>string</keyword>
  <conceptid>int</conceptid>
  <childNodes>
    <OntologyNode>
      <keyword>string</keyword>
      <conceptid>int</conceptid>
      <childNodes>
        <OntologyNode d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <OntologyNode d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </childNodes>
    </OntologyNode>
    <OntologyNode>
      <keyword>string</keyword>
      <conceptid>int</conceptid>
      <childNodes>
        <OntologyNode d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <OntologyNode d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </childNodes>
    </OntologyNode>
  </childNodes>
</OntologyNode>

HTTP POST

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

POST /webservices/hiscentral.asmx/getOntologywithOption HTTP/1.1
Host: hiscentral.cuahsi.org
Content-Type: application/x-www-form-urlencoded
Content-Length: length

conceptKeyword=string&fullTree=string

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

<?xml version="1.0" encoding="utf-8"?>
<OntologyNode xmlns="http://hiscentral.cuahsi.org/20100205/">
  <keyword>string</keyword>
  <conceptid>int</conceptid>
  <childNodes>
    <OntologyNode>
      <keyword>string</keyword>
      <conceptid>int</conceptid>
      <childNodes>
        <OntologyNode d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <OntologyNode d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </childNodes>
    </OntologyNode>
    <OntologyNode>
      <keyword>string</keyword>
      <conceptid>int</conceptid>
      <childNodes>
        <OntologyNode d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <OntologyNode d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </childNodes>
    </OntologyNode>
  </childNodes>
</OntologyNode>

Parameter	Value
conceptKeyword:
fullTree: