WS-Beschreibung - Terminologieserver Search ReturnCodeSystemDetails

Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
(→Request/Response)
(→Request/Response)
Zeile 34: Zeile 34:
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="param_level1">LoginType</td>
 
   <td id="param_level1">LoginType</td>
−
   <td></td>
+
   <td>LoginType</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
   <td>Login-Informationen</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>
 
<tr>
 
<tr>
Zeile 58: Zeile 44:
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td>Die Session-ID des Benutzers</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>
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="param_level1">code_system</td>
 
   <td id="param_level1">code_system</td>
−
   <td></td>
+
   <td>code_system</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
   <td>Name eines Codesystems/Vokabulars. Jedes Codesystem muss mindestens 1 Version besitzen.</td>
 
   <td>Name eines Codesystems/Vokabulars. Jedes Codesystem muss mindestens 1 Version besitzen.</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 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>
 
<tr>
 
<tr>
 
   <td id="param_level2">id</td>
 
   <td id="param_level2">id</td>
 
   <td>Long</td>
 
   <td>Long</td>
−
<td></td>  <td id="cardinality_cell">1..1</td>
+
<td></td>  <td id="cardinality_cell">0..1</td>
−
   <td></td>
+
   <td>Die ID braucht nicht angegeben zu werden, falls eine Codesystem-Versions-ID angegeben ist.</td>
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level2">insertTimestamp</td>
+
−
  <td>java.util.Date</td>
+
−
<td></td>  <td id="cardinality_cell">-</td>
+
−
  <td>Zeitstempel, wann das Codesystem eingefügt worden ist</td>
+
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level2">name</td>
+
−
  <td>String</td>
+
−
  <td>100</td>
+
−
  <td id="cardinality_cell">-</td>
+
−
  <td>Name des Codesystems. Der genau Name sollte in der Version angegeben werden</td>
+
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="param_level2">code_system_version</td>
 
   <td id="param_level2">code_system_version</td>
−
   <td></td>
+
   <td>code_system_version</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
   <td>Version eines Codesystems</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 id="gray">
 
−
  <td id="param_level3">insertTimestamp</td>
 
−
  <td>java.util.Date</td>
 
−
<td></td>  <td id="cardinality_cell">-</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 id="gray">
 
−
  <td id="param_level3">name</td>
 
−
  <td>String</td>
 
−
  <td>100</td>
 
−
  <td id="cardinality_cell">-</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 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 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 id="gray">
 
−
  <td id="param_level3">underLicence</td>
 
−
  <td>Boolean</td>
 
−
<td></td>  <td id="cardinality_cell">-</td>
 
−
  <td>true, wenn das Vokabular unter Lizenzen fällt (ist dann für Benutzer ohne entsprechende Rechte nicht sichtbar)</td>
 
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 217: Zeile 81:
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="param_level1">ReturnType</td>
 
   <td id="param_level1">ReturnType</td>
−
   <td></td>
+
   <td>ReturnType</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Entählt Informationen über die Antwort.</td>
+
   <td>Enthält Informationen über die Antwort.</td>
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level2">count</td>
+
−
  <td>Integer</td>
+
−
<td></td>  <td id="cardinality_cell">-</td>
+
−
  <td>Anzahl der Ergebnisse</td>
+
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 248: Zeile 106:
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="param_level1">code_system</td>
 
   <td id="param_level1">code_system</td>
−
   <td></td>
+
   <td>code_system</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
   <td>Name eines Codesystems/Vokabulars. Jedes Codesystem muss mindestens 1 Version besitzen.</td>
 
   <td>Name eines Codesystems/Vokabulars. Jedes Codesystem muss mindestens 1 Version besitzen.</td>
Zeile 286: Zeile 144:
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="param_level2">code_system_version</td>
 
   <td id="param_level2">code_system_version</td>
−
   <td></td>
+
   <td>code_system_version</td>
 
<td></td>  <td id="cardinality_cell">0..N</td>
 
<td></td>  <td id="cardinality_cell">0..N</td>
 
   <td>Version eines Codesystems</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>
 
<tr>
 
<tr>
Zeile 387: Zeile 239:
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="param_level3">licence_type</td>
 
   <td id="param_level3">licence_type</td>
−
   <td></td>
+
   <td>licence_type</td>
 
<td></td>  <td id="cardinality_cell">0..N</td>
 
<td></td>  <td id="cardinality_cell">0..N</td>
 
   <td>Arten von Lizenztypen</td>
 
   <td>Arten von Lizenztypen</td>
Zeile 409: Zeile 261:
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td>Name des Lizenztyps</td>
 
   <td>Name des Lizenztyps</td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level2">metadata_parameter</td>
 +
  <td>metadata_parameter</td>
 +
<td></td>  <td id="cardinality_cell">0..N</td>
 +
  <td>Umfasst Sammlung von Metadaten (Liste der verfügbaren Bezeichnungen)</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">id</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">metadataParameterType</td>
 +
  <td>String</td>
 +
  <td>30</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Gibt den Typ des Metadata an. Eine mögliche Werteliste ist in der Domaintabelle vorhanden.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">paramDatatype</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Datentyp des Wertes, der in code_system_metadata_value steht.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">paramName</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Bezeichnung von Metadaten (z.B. Einheit)</td>
 
</tr>
 
</tr>
 
</table>
 
</table>

Version vom 17. Januar 2013, 10:04 Uhr

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

Inhaltsverzeichnis

Funktionalität

Listet alle Eigenschaften des angegebenen Vokabulars oder Vokabular-Version auf. Im Abschnitt Request/Response ist eine Liste der Eigenschaften zu finden, welche zurückgegeben werden.

Vorbedingungen

Request/Response

Request

Parameter Typ Länge Kardinalität Beschreibung
LoginType LoginType 0..1 Login-Informationen
sessionID String 1..1 Die Session-ID des Benutzers
code_system code_system 1..1 Name eines Codesystems/Vokabulars. Jedes Codesystem muss mindestens 1 Version besitzen.
id Long 0..1 Die ID braucht nicht angegeben zu werden, falls eine Codesystem-Versions-ID angegeben ist.
code_system_version code_system_version 0..1 Version eines Codesystems
versionId Long 1..1

Response

Parameter Typ Länge Kardinalität Beschreibung
ReturnType ReturnType 1..1 Enthält Informationen über die Antwort.
message String 1..1 Status- oder Fehlermeldung
overallErrorCategory 1..1 INFO, WARN, ERROR
status 1..1 OK, FAILURE
code_system code_system 0..1 Name eines Codesystems/Vokabulars. Jedes Codesystem muss mindestens 1 Version besitzen.
currentVersionId Long 1..1 Die aktuelle Versions-ID
description String 65535 1..1 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 code_system_version 0..N Version eines Codesystems
description String 65535 1..1 Beschreibung des Codesystems
expirationDate java.util.Date 1..1 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 1..1 Besitzer der Lizenz
name String 100 1..1 Vollständiger Name des Codesystems
oid String 100 1..1 Offizielle OID
preferredLanguageId Long 1..1 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 1..1 Datum, ab wann die Version gültig ist
source String 65535 1..1 Herausgeber der Codesystem-Version
status Integer 1..1 Der Status des aktuellen Eintrags. Kann einer Domäne entnommen werden.
statusDate java.util.Date 1..1 Ä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
licence_type licence_type 0..N Arten von Lizenztypen
codeSystemVersionId Long 1..1
id Long 1..1
typeTxt String 65535 1..1 Name des Lizenztyps
metadata_parameter metadata_parameter 0..N Umfasst Sammlung von Metadaten (Liste der verfügbaren Bezeichnungen)
id Long 1..1
metadataParameterType String 30 1..1 Gibt den Typ des Metadata an. Eine mögliche Werteliste ist in der Domaintabelle vorhanden.
paramDatatype String 65535 1..1 Datentyp des Wertes, der in code_system_metadata_value steht.
paramName String 65535 1..1 Bezeichnung von Metadaten (z.B. Einheit)

Anmerkungen

Besonderheiten

Hinweise

Die Ergebnismenge ist meistens eher klein.

Beispiele

SOAP-Nachrichten

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

Code-Beispiele

Java

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