hiscentral Web Service

hiscentral

Click here for a complete list of operations.

GetControlledVocabulary

Get the terms and definitions of controlled vocabulary (CV), which are dynamically updated from http://his.cuahsi.org/mastercvreg/cv11.aspxTypically used when the user requires terms from these controlled vocabularies to provide additional filtering parameters.

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/GetControlledVocabulary"

<?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>
    <GetControlledVocabulary xmlns="http://hiscentral.cuahsi.org/20100205/">
      <cvField>string</cvField>
    </GetControlledVocabulary>
  </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>
    <GetControlledVocabularyResponse xmlns="http://hiscentral.cuahsi.org/20100205/">
      <GetControlledVocabularyResult>
        <name>string</name>
        <itemCount>long</itemCount>
        <items>
          <item>
            <term>string</term>
            <definition>string</definition>
            <count>long</count>
          </item>
          <item>
            <term>string</term>
            <definition>string</definition>
            <count>long</count>
          </item>
        </items>
      </GetControlledVocabularyResult>
    </GetControlledVocabularyResponse>
  </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>
    <GetControlledVocabulary xmlns="http://hiscentral.cuahsi.org/20100205/">
      <cvField>string</cvField>
    </GetControlledVocabulary>
  </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>
    <GetControlledVocabularyResponse xmlns="http://hiscentral.cuahsi.org/20100205/">
      <GetControlledVocabularyResult>
        <name>string</name>
        <itemCount>long</itemCount>
        <items>
          <item>
            <term>string</term>
            <definition>string</definition>
            <count>long</count>
          </item>
          <item>
            <term>string</term>
            <definition>string</definition>
            <count>long</count>
          </item>
        </items>
      </GetControlledVocabularyResult>
    </GetControlledVocabularyResponse>
  </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/GetControlledVocabulary?cvField=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"?>
<FacetField xmlns="http://hiscentral.cuahsi.org/20100205/">
  <name>string</name>
  <itemCount>long</itemCount>
  <items>
    <item>
      <term>string</term>
      <definition>string</definition>
      <count>long</count>
    </item>
    <item>
      <term>string</term>
      <definition>string</definition>
      <count>long</count>
    </item>
  </items>
</FacetField>

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/GetControlledVocabulary HTTP/1.1
Host: hiscentral.cuahsi.org
Content-Type: application/x-www-form-urlencoded
Content-Length: length

cvField=string

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

<?xml version="1.0" encoding="utf-8"?>
<FacetField xmlns="http://hiscentral.cuahsi.org/20100205/">
  <name>string</name>
  <itemCount>long</itemCount>
  <items>
    <item>
      <term>string</term>
      <definition>string</definition>
      <count>long</count>
    </item>
    <item>
      <term>string</term>
      <definition>string</definition>
      <count>long</count>
    </item>
  </items>
</FacetField>

Parameter	Value
cvField: