WS-Beschreibung - Terminologieserver Search ReturnCodeSystemDetails

Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
(→Request/Response)
 
(Eine dazwischenliegende Version von einem Benutzer wird nicht angezeigt)
Zeile 1: Zeile 1:
−
=Funktionalität=
+
=Functionality=
−
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.
+
Lists all details of the given code system or code system version. See request/response section for properties that will be returned.
  
−
=Vorbedingungen=
+
=Prerequisites=
  
 
=Request/Response=
 
=Request/Response=
Zeile 18: Zeile 18:
 
   <td>LoginType</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 information</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 25: Zeile 25:
 
   <td></td>
 
   <td></td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
−
   <td>Die Session-ID des Benutzers</td>
+
   <td>Session-ID from user (given by system)</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 31: Zeile 31:
 
   <td>code_system</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 of codesystem. Each codesystem requires at least one version.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 37: Zeile 37:
 
   <td>Long</td>
 
   <td>Long</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
−
   <td>Die ID braucht nicht angegeben zu werden, falls eine Codesystem-Versions-ID angegeben ist.</td>
+
   <td>The ID does not required, if a Codesystem-Version-ID is listed.</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 43: Zeile 43:
 
   <td>code_system_version</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 of a Code System</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 65: Zeile 65:
 
   <td>ReturnType</td>
 
   <td>ReturnType</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Enthält Informationen über die Antwort.</td>
+
   <td>Return information</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 72: Zeile 72:
 
   <td></td>
 
   <td></td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
−
   <td>Status- oder Fehlermeldung</td>
+
   <td>an additional message</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 90: Zeile 90:
 
   <td>code_system</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 of codesystem. Each codesystem requires at least one version.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 96: Zeile 96:
 
   <td>Long</td>
 
   <td>Long</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Die aktuelle Versions-ID</td>
+
   <td>Version of the Code System</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 103: Zeile 103:
 
   <td>65535</td>
 
   <td>65535</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
−
   <td>Beschreibung eines Codesystems</td>
+
   <td>Narrative description of Code System</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 109: Zeile 109:
 
   <td>Long</td>
 
   <td>Long</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td></td>
+
   <td>Internal ID = Primary Key of Code System</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 115: Zeile 115:
 
   <td>java.util.Date</td>
 
   <td>java.util.Date</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Zeitstempel, wann das Codesystem eingefügt worden ist</td>
+
   <td>Timestamp, wenn the Code System was inserted</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 122: Zeile 122:
 
   <td>100</td>
 
   <td>100</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
−
   <td>Name des Codesystems. Der genau Name sollte in der Version angegeben werden</td>
+
   <td>Name of the Code System. The precise name should be specified in the Code System Version.</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 128: Zeile 128:
 
   <td>code_system_version</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 of a Code System</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 135: Zeile 135:
 
   <td>65535</td>
 
   <td>65535</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
−
   <td>Beschreibung des Codesystems</td>
+
   <td>Description of the Code System</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 141: Zeile 141:
 
   <td>java.util.Date</td>
 
   <td>java.util.Date</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Datum, bis wann die Version gültig ist</td>
+
   <td>Point of time the Code System looses its validity.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 147: Zeile 147:
 
   <td>java.util.Date</td>
 
   <td>java.util.Date</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Zeitstempel, wann die Codesystem-Version eingefügt worden ist</td>
+
   <td>Point of time when the Code System Version was inserted.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 154: Zeile 154:
 
   <td>65535</td>
 
   <td>65535</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
−
   <td>Besitzer der Lizenz</td>
+
   <td>Owner of the licence.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 161: Zeile 161:
 
   <td>100</td>
 
   <td>100</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
−
   <td>Vollständiger Name des Codesystems</td>
+
   <td>Complete Name of the Code System.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 168: Zeile 168:
 
   <td>100</td>
 
   <td>100</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
−
   <td>Offizielle OID</td>
+
   <td>Official OID</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 174: Zeile 174:
 
   <td>Long</td>
 
   <td>Long</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..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>
+
   <td>Preferred language of the  Code System ( ID has to be taken from domain 'ISO_639_1_Language_Codes' with ID 1)</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 180: Zeile 180:
 
   <td>Long</td>
 
   <td>Long</td>
 
<td></td>  <td id="cardinality_cell">1..1</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>
+
   <td>Refers to the prior version, if there are more than one.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 186: Zeile 186:
 
   <td>java.util.Date</td>
 
   <td>java.util.Date</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Datum, ab wann die Version gültig ist</td>
+
   <td>Point of time, when this version starts to be valid.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 193: Zeile 193:
 
   <td>65535</td>
 
   <td>65535</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
−
   <td>Herausgeber der Codesystem-Version</td>
+
   <td>Source of the Code System Version</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 199: Zeile 199:
 
   <td>Integer</td>
 
   <td>Integer</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Der Status des aktuellen Eintrags. Kann einer Domäne entnommen werden.</td>
+
   <td>Status of the current entry. Can be taken from a domain.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 205: Zeile 205:
 
   <td>java.util.Date</td>
 
   <td>java.util.Date</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Änderungszeitpunkt des Status</td>
+
   <td>Point of time of the last change of the status</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 211: Zeile 211:
 
   <td>Boolean</td>
 
   <td>Boolean</td>
 
<td></td>  <td id="cardinality_cell">1..1</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>
+
   <td>true, if Code System is under license (Code System will be invisible for all users without proper license)</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">validityRange</td>
 +
  <td>String</td>
 +
  <td>30</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Validity range, Values from domain list "codesystem_validityrange".
 +
Standard: 1 (required), 2 (recomended), 3 (limited), 4 (optional)</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 223: Zeile 231:
 
   <td>licence_type</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>Sorts of licence types.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 242: Zeile 250:
 
   <td>65535</td>
 
   <td>65535</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
−
   <td>Name des Lizenztyps</td>
+
   <td>Name of the licence type.</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 248: Zeile 256:
 
   <td>metadata_parameter</td>
 
   <td>metadata_parameter</td>
 
<td></td>  <td id="cardinality_cell">0..N</td>
 
<td></td>  <td id="cardinality_cell">0..N</td>
−
   <td>Umfasst Sammlung von Metadaten (Liste der verfügbaren Bezeichnungen)</td>
+
   <td>Contains an accumulation of meta data. (List of the available descriptions)</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 261: Zeile 269:
 
   <td>30</td>
 
   <td>30</td>
 
   <td id="cardinality_cell">1..1</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>
+
   <td>Type of the meta data. A possible list of values is contained in the domain table.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 268: Zeile 276:
 
   <td>65535</td>
 
   <td>65535</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
−
   <td>Datentyp des Wertes, der in code_system_metadata_value steht.</td>
+
   <td>Data type of the value in code_system_metadata_value.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 275: Zeile 283:
 
   <td>65535</td>
 
   <td>65535</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
−
   <td>Bezeichnung von Metadaten (z.B. Einheit)</td>
+
   <td>Description of meta data (e.g. measurement unit)</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
−
=Anmerkungen=
+
=Annotations=
−
==Besonderheiten==
+
==Noteworthiness==
−
 
+
==Hints==
−
==Hinweise==
+
The result set is typically small.
−
Die Ergebnismenge ist meistens eher klein.
+
  
−
=Beispiele=
+
=Examples=
−
==SOAP-Nachrichten==
+
==SOAP messages==
 
<source lang="xml">
 
<source lang="xml">
 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/">
 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/">
Zeile 305: Zeile 312:
 
</source>
 
</source>
  
−
==Code-Beispiele==
+
==Code examples==
 
===Java===
 
===Java===
 
<source lang="java">
 
<source lang="java">
  
 
</source>
 
</source>

Aktuelle Version vom 9. August 2013, 09:30 Uhr

Inhaltsverzeichnis

Functionality

Lists all details of the given code system or code system version. See request/response section for properties that will be returned.

Prerequisites

Request/Response

Request

Parameter Typ Länge Kardinalität Beschreibung
LoginType LoginType 0..1 Login information
sessionID String 1..1 Session-ID from user (given by system)
code_system code_system 1..1 Name of codesystem. Each codesystem requires at least one version.
id Long 0..1 The ID does not required, if a Codesystem-Version-ID is listed.
code_system_version code_system_version 0..1 Version of a Code System
versionId Long 1..1

Response

Parameter Typ Länge Kardinalität Beschreibung
ReturnType ReturnType 1..1 Return information
message String 1..1 an additional message
overallErrorCategory 1..1 INFO, WARN, ERROR
status 1..1 OK, FAILURE
code_system code_system 0..1 Name of codesystem. Each codesystem requires at least one version.
currentVersionId Long 1..1 Version of the Code System
description String 65535 1..1 Narrative description of Code System
id Long 1..1 Internal ID = Primary Key of Code System
insertTimestamp java.util.Date 1..1 Timestamp, wenn the Code System was inserted
name String 100 1..1 Name of the Code System. The precise name should be specified in the Code System Version.
code_system_version code_system_version 0..N Version of a Code System
description String 65535 1..1 Description of the Code System
expirationDate java.util.Date 1..1 Point of time the Code System looses its validity.
insertTimestamp java.util.Date 1..1 Point of time when the Code System Version was inserted.
licenceHolder String 65535 1..1 Owner of the licence.
name String 100 1..1 Complete Name of the Code System.
oid String 100 1..1 Official OID
preferredLanguageId Long 1..1 Preferred language of the Code System ( ID has to be taken from domain 'ISO_639_1_Language_Codes' with ID 1)
previousVersionID Long 1..1 Refers to the prior version, if there are more than one.
releaseDate java.util.Date 1..1 Point of time, when this version starts to be valid.
source String 65535 1..1 Source of the Code System Version
status Integer 1..1 Status of the current entry. Can be taken from a domain.
statusDate java.util.Date 1..1 Point of time of the last change of the status
underLicence Boolean 1..1 true, if Code System is under license (Code System will be invisible for all users without proper license)
validityRange String 30 1..1 Validity range, Values from domain list "codesystem_validityrange". Standard: 1 (required), 2 (recomended), 3 (limited), 4 (optional)
versionId Long 1..1
licence_type licence_type 0..N Sorts of licence types.
codeSystemVersionId Long 1..1
id Long 1..1
typeTxt String 65535 1..1 Name of the licence type.
metadata_parameter metadata_parameter 0..N Contains an accumulation of meta data. (List of the available descriptions)
id Long 1..1
metadataParameterType String 30 1..1 Type of the meta data. A possible list of values is contained in the domain table.
paramDatatype String 65535 1..1 Data type of the value in code_system_metadata_value.
paramName String 65535 1..1 Description of meta data (e.g. measurement unit)

Annotations

Noteworthiness

Hints

The result set is typically small.

Examples

SOAP messages

<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 examples

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