WS-Beschreibung - Terminologieserver Search ListCodeSystemConcepts

Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
(Die Seite wurde neu angelegt: „<table border="0"> <tr> <td width="100px" style="font-weight: bold;">System</td> <td>Terminologieserver</td> </tr> <tr> <td style="font-weight: …“)
 
(→Besonderheiten)
Zeile 26: Zeile 26:
 
=Anmerkungen=
 
=Anmerkungen=
 
==Besonderheiten==
 
==Besonderheiten==
−
Filter dienen dazu die Suche einzuschränken. Suchparameter dienen dazu nicht alle Suchergenisse auf einmal anzuzeigen, sondern nur einen Teil. Dies geschieht mit Hilfe von zwei Parametern "pageSize" und "pageIndex". Ersterer gibt an, wieviele Treffer angezeigt werden sollen. Zweiterer gibt an, welche "Seite" angezeigt werden soll. Stellt man also "pageSize" auf 5 und "pageIndex" auf 0, würden die Treffer 1-5 angezeigt werden. Stellt man "pageIndex" auf 2, die Treffer 11-15.
+
===Filter===
 +
Filter dienen dazu die Suche einzuschränken.  
 +
 
 +
===Such-Parameter===
 +
 
 +
*'''pageSize und pageIndex:''' ''pageSize'' und ''pageIndex'' begrenzen die Menge an zurückgelieferten Treffern, damit die Suchanfragen nicht so viele Resourcen verbrauchen. ''pageSize'' gibt dabei an, wieviele Treffer angezeigt werden sollen. ''pageIndex'' gibt an, welche Treffer angezeigt werden sollen. Stellt man ''pageSize'' auf 5 und ''pageIndex'' auf 0, würden die Treffer 1-5 angezeigt werden. Stellt man ''pageIndex'' auf 2, die Treffer 11-15.
 +
 
 +
*'''traverseConceptsToRoot:''' Bewirkt, dass zu jedem gefundenem Konzept die übergeordneten Konzepte bis zur Wurzel mit angegeben werden.
 +
 
 
==Hinweise==
 
==Hinweise==
  

Version vom 17. Februar 2012, 09:21 Uhr

System Terminologieserver
Webservice Search
WSDL http://www.term.mi.fh-dortmund.de:8080/Terminologieserver/Search?wsdl
Methode ListCodeSystemConcepts

Inhaltsverzeichnis

Funktionalität

Listet alle Konzepte des angegebenen Vokabulars bzw. einer Vokabularversion an. Es können Filter benutzt werden um nach bestimmten Konzepten zu suchen.

Vorbedingungen

Request/Response

Anmerkungen

Besonderheiten

Filter

Filter dienen dazu die Suche einzuschränken.

Such-Parameter

Hinweise

Beispiele

SOAP-Nachrichten

Einfache Suche ohne Filter

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/">
  <soapenv:Header/>
  <soapenv:Body>
    <sear:ListCodeSystemConcepts>
      <parameter>
        <codeSystem>
          <codeSystemVersions>
            <versionId>1</versionId>
          </codeSystemVersions>
          <id>1</id>
        </codeSystem>
      </parameter>
    </sear:ListCodeSystemConcepts>
  </soapenv:Body>
</soapenv:Envelope>

Suche nach Konzepten die einen bestimmten Term enthalten

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/">
  <soapenv:Header/>
  <soapenv:Body>
    <sear:ListCodeSystemConcepts>
      <parameter>
        <codeSystem>
          <codeSystemVersions>
            <versionId>4</versionId>
          </codeSystemVersions>
          <id>1</id>
        </codeSystem>
        <codeSystemEntity>
          <codeSystemVersionEntityMemberships>
            <isAxis>false</isAxis>
          </codeSystemVersionEntityMemberships>
          <codeSystemEntityVersions>          
            <codeSystemConcepts>          
              <term>Zungen</term>
            </codeSystemConcepts>
          </codeSystemEntityVersions>
        </codeSystemEntity>
      </parameter>
    </sear:ListCodeSystemConcepts>
  </soapenv:Body>
</soapenv:Envelope>

Suche mit Filter- und Such-Kriterien

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/" xmlns:de="de.fhdo.termserver.types">
  <soapenv:Header/>
  <soapenv:Body>
    <sear:ListCodeSystemConcepts>
      <parameter>
        <codeSystem>
          <codeSystemVersions>
            <versionId>4</versionId>
          </codeSystemVersions>
          <id>1</id>
        </codeSystem>
        <codeSystemEntity>
          <codeSystemEntityVersions>
            <codeSystemConcepts>
              <term>Zunge</term>
              <isPreferred>true</isPreferred>
            </codeSystemConcepts>
          </codeSystemEntityVersions>
        </codeSystemEntity>
        <searchParameter>
          <pageSize>5</pageSize>
          <pageIndex>0</pageIndex>
          <traverseConceptsToRoot>true</traverseConceptsToRoot>
        </searchParameter>
      </parameter>
    </sear:ListCodeSystemConcepts>
  </soapenv:Body>
</soapenv:Envelope>

Code-Beispiele

Java

 
Von „http://www.wiki.mi.fh-dortmund.de/cts2/index.php?title=WS-Beschreibung_-_Terminologieserver_Search_ListCodeSystemConcepts“
Meine Werkzeuge
Namensräume
Varianten
Aktionen
Navigation
Werkzeuge