WS-Beschreibung - Terminologieserver Search ListCodeSystems

Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
(→Hinweise)
(→Request/Response)
Zeile 23: Zeile 23:
  
 
=Request/Response=
 
=Request/Response=
 +
==Request==
 +
<table border="1" cellpadding="1" class="ws_table">
 +
  <tr class="ws_table_head">
 +
    <th>Parameter</th>
 +
    <th>Typ</th>
 +
    <th>L&auml;nge</th>
 +
    <th id="cardinality_cell">Kardinalit&auml;t</th>
 +
    <th>Beschreibung</th>
 +
  </tr>
 +
<tr id="row_object">
 +
  <td id="param_level1">LoginType</td>
 +
  <td></td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>Login-Informationen</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="param_level2">ip</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Die IP-Adresse des Benutzers (wird intern vergeben)</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="param_level2">password</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Passwort des Benutzers (als MD5-Wert)</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">sessionID</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Die Session-ID des Benutzers</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="param_level2">username</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Benutzername</td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level1">code_system</td>
 +
  <td></td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>Ist ein Codesystemangegeben, werden die Angaben als Filter verwendet</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="param_level2">currentVersionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Die aktuelle Versions-ID</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">description</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">0..1</td>
 +
  <td>Beschreibung eines Codesystems</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="param_level2">id</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">insertTimestamp</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>Zeitstempel, wann das Codesystem eingefügt worden ist</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">name</td>
 +
  <td>String</td>
 +
  <td>100</td>
 +
  <td id="cardinality_cell">0..1</td>
 +
  <td>Name des Codesystems. Der genau Name sollte in der Version angegeben werden</td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level2">code_system_version</td>
 +
  <td></td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>Version eines Codesystems</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="param_level3">codeSystemId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">description</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">0..1</td>
 +
  <td>Beschreibung des Codesystems</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">expirationDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>Datum, bis wann die Version gültig ist</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">insertTimestamp</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>Zeitstempel, wann die Codesystem-Version eingefügt worden ist</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">licenceHolder</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">0..1</td>
 +
  <td>Besitzer der Lizenz</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">name</td>
 +
  <td>String</td>
 +
  <td>100</td>
 +
  <td id="cardinality_cell">0..1</td>
 +
  <td>Vollständiger Name des Codesystems</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">oid</td>
 +
  <td>String</td>
 +
  <td>100</td>
 +
  <td id="cardinality_cell">0..1</td>
 +
  <td>Offizielle OID</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">preferredLanguageId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>Bevorzugte Sprache des Codesystems (ID ist aus der Domäne 'ISO_639_1_Language_Codes' mit der ID 1 zu entnehmen)</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="param_level3">previousVersionID</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Gibt es mehr als 1 Version, zeigt diese ID auf die vorherige Version.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">releaseDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>Datum, ab wann die Version gültig ist</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">source</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">0..1</td>
 +
  <td>Herausgeber der Codesystem-Version</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">status</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>Der Status des aktuellen Eintrags. Kann einer Domäne entnommen werden.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">statusDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>Änderungszeitpunkt des Status</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">underLicence</td>
 +
  <td>Boolean</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>true, wenn das Vokabular unter Lizenzen fällt (ist dann für Benutzer ohne entsprechende Rechte nicht sichtbar)</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="param_level3">versionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td></td>
 +
</tr>
 +
</table>
 +
==Response==
 +
<table border="1" cellpadding="1" class="ws_table">
 +
  <tr class="ws_table_head">
 +
    <th>Parameter</th>
 +
    <th>Typ</th>
 +
    <th>L&auml;nge</th>
 +
    <th id="cardinality_cell">Kardinalit&auml;t</th>
 +
    <th>Beschreibung</th>
 +
  </tr>
 +
<tr id="row_object">
 +
  <td id="param_level1">ReturnType</td>
 +
  <td></td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Entählt Informationen über die Antwort.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">count</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Anzahl der Ergebnisse</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">message</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Status- oder Fehlermeldung</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">overallErrorCategory</td>
 +
  <td></td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>INFO, WARN, ERROR</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">status</td>
 +
  <td></td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>OK, FAILURE</td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level1">code_system</td>
 +
  <td></td>
 +
<td></td>  <td id="cardinality_cell">0..N</td>
 +
  <td>Name eines Codesystems/Vokabulars. Jedes Codesystem muss mindestens 1 Version besitzen.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">currentVersionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Die aktuelle Versions-ID</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="param_level2">description</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Beschreibung eines Codesystems</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">id</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">insertTimestamp</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Zeitstempel, wann das Codesystem eingefügt worden ist</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">name</td>
 +
  <td>String</td>
 +
  <td>100</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Name des Codesystems. Der genau Name sollte in der Version angegeben werden</td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level2">code_system_version</td>
 +
  <td></td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Version eines Codesystems</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="param_level3">codeSystemId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td></td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="param_level3">description</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Beschreibung des Codesystems</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="param_level3">expirationDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Datum, bis wann die Version gültig ist</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">insertTimestamp</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Zeitstempel, wann die Codesystem-Version eingefügt worden ist</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="param_level3">licenceHolder</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Besitzer der Lizenz</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">name</td>
 +
  <td>String</td>
 +
  <td>100</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Vollständiger Name des Codesystems</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="param_level3">oid</td>
 +
  <td>String</td>
 +
  <td>100</td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Offizielle OID</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="param_level3">preferredLanguageId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Bevorzugte Sprache des Codesystems (ID ist aus der Domäne 'ISO_639_1_Language_Codes' mit der ID 1 zu entnehmen)</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">previousVersionID</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Gibt es mehr als 1 Version, zeigt diese ID auf die vorherige Version.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="param_level3">releaseDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Datum, ab wann die Version gültig ist</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="param_level3">source</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Herausgeber der Codesystem-Version</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="param_level3">status</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Der Status des aktuellen Eintrags. Kann einer Domäne entnommen werden.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="param_level3">statusDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Änderungszeitpunkt des Status</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">underLicence</td>
 +
  <td>Boolean</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>true, wenn das Vokabular unter Lizenzen fällt (ist dann für Benutzer ohne entsprechende Rechte nicht sichtbar)</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">versionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td></td>
 +
</tr>
 +
</table>
  
 
=Anmerkungen=
 
=Anmerkungen=

Version vom 26. März 2012, 11:05 Uhr

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

Inhaltsverzeichnis

Funktionalität

Listet alle Vokabulare und deren Versionen auf, welche ggf. die Filterkriterien erfüllen. Nach welchen Kriterien gefiltert werden kann ist der Request-Tabelle zu entnehmen.

Vorbedingungen

Request/Response

Request

Parameter Typ Länge Kardinalität Beschreibung
LoginType 0..1 Login-Informationen
ip String - Die IP-Adresse des Benutzers (wird intern vergeben)
password String - Passwort des Benutzers (als MD5-Wert)
sessionID String 1..1 Die Session-ID des Benutzers
username String - Benutzername
code_system 0..1 Ist ein Codesystemangegeben, werden die Angaben als Filter verwendet
currentVersionId Long - Die aktuelle Versions-ID
description String 65535 0..1 Beschreibung eines Codesystems
id Long -
insertTimestamp java.util.Date 0..1 Zeitstempel, wann das Codesystem eingefügt worden ist
name String 100 0..1 Name des Codesystems. Der genau Name sollte in der Version angegeben werden
code_system_version 0..1 Version eines Codesystems
codeSystemId Long -
description String 65535 0..1 Beschreibung des Codesystems
expirationDate java.util.Date 0..1 Datum, bis wann die Version gültig ist
insertTimestamp java.util.Date 0..1 Zeitstempel, wann die Codesystem-Version eingefügt worden ist
licenceHolder String 65535 0..1 Besitzer der Lizenz
name String 100 0..1 Vollständiger Name des Codesystems
oid String 100 0..1 Offizielle OID
preferredLanguageId Long 0..1 Bevorzugte Sprache des Codesystems (ID ist aus der Domäne 'ISO_639_1_Language_Codes' mit der ID 1 zu entnehmen)
previousVersionID Long - Gibt es mehr als 1 Version, zeigt diese ID auf die vorherige Version.
releaseDate java.util.Date 0..1 Datum, ab wann die Version gültig ist
source String 65535 0..1 Herausgeber der Codesystem-Version
status Integer 0..1 Der Status des aktuellen Eintrags. Kann einer Domäne entnommen werden.
statusDate java.util.Date 0..1 Änderungszeitpunkt des Status
underLicence Boolean 0..1 true, wenn das Vokabular unter Lizenzen fällt (ist dann für Benutzer ohne entsprechende Rechte nicht sichtbar)
versionId Long -

Response

Parameter Typ Länge Kardinalität Beschreibung
ReturnType 1..1 Entählt Informationen über die Antwort.
count Integer 1..1 Anzahl der Ergebnisse
message String 1..1 Status- oder Fehlermeldung
overallErrorCategory 1..1 INFO, WARN, ERROR
status 1..1 OK, FAILURE
code_system 0..N Name eines Codesystems/Vokabulars. Jedes Codesystem muss mindestens 1 Version besitzen.
currentVersionId Long 1..1 Die aktuelle Versions-ID
description String 65535 - Beschreibung eines Codesystems
id Long 1..1
insertTimestamp java.util.Date 1..1 Zeitstempel, wann das Codesystem eingefügt worden ist
name String 100 1..1 Name des Codesystems. Der genau Name sollte in der Version angegeben werden
code_system_version 1..1 Version eines Codesystems
codeSystemId Long -
description String 65535 - Beschreibung des Codesystems
expirationDate java.util.Date - Datum, bis wann die Version gültig ist
insertTimestamp java.util.Date 1..1 Zeitstempel, wann die Codesystem-Version eingefügt worden ist
licenceHolder String 65535 - Besitzer der Lizenz
name String 100 1..1 Vollständiger Name des Codesystems
oid String 100 - Offizielle OID
preferredLanguageId Long - Bevorzugte Sprache des Codesystems (ID ist aus der Domäne 'ISO_639_1_Language_Codes' mit der ID 1 zu entnehmen)
previousVersionID Long 1..1 Gibt es mehr als 1 Version, zeigt diese ID auf die vorherige Version.
releaseDate java.util.Date - Datum, ab wann die Version gültig ist
source String 65535 - Herausgeber der Codesystem-Version
status Integer - Der Status des aktuellen Eintrags. Kann einer Domäne entnommen werden.
statusDate java.util.Date - Änderungszeitpunkt des Status
underLicence Boolean 1..1 true, wenn das Vokabular unter Lizenzen fällt (ist dann für Benutzer ohne entsprechende Rechte nicht sichtbar)
versionId Long 1..1

Anmerkungen

Besonderheiten

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:ListCodeSystems>
         </sear:ListCodeSystems>
   </soapenv:Body>
</soapenv:Envelope>

Suche nach Vokabularen mit bestimmten Eigenschaften (hier Name der Vokabularversion)

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/">
   <soapenv:Header/>
   <soapenv:Body>
      <sear:ListCodeSystems>
         <parameter>
            <codeSystem>
               <codeSystemVersions>
                  <name>ICD</name>
               </codeSystemVersions>
            </codeSystem>
         </parameter>
      </sear:ListCodeSystems>
   </soapenv:Body>
</soapenv:Envelope>

Code-Beispiele

Java

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