WS-Beschreibung - Terminologieserver Search ReturnCodeSystemDetails

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: …“)
 
(→Request/Response)
 
(4 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
−
<table border="0">
+
=Functionality=
−
  <tr>
+
Lists all details of the given code system or code system version. See request/response section for properties that will be returned.
−
    <td width="100px" style="font-weight: bold;">System</td>
+
−
    <td>Terminologieserver</td>
+
−
  </tr>
+
−
  <tr>
+
−
    <td style="font-weight: bold;">Webservice</td>
+
−
    <td>Search</td>
+
−
  </tr>
+
−
  <tr>
+
−
    <td style="font-weight: bold;">WSDL</td>
+
−
    <td>http://www.term.mi.fh-dortmund.de:8080/Terminologieserver/Search?wsdl</td>
+
−
  </tr>
+
−
  <tr>
+
−
    <td style="font-weight: bold;">Methode</td>
+
−
    <td>ReturnCodeSystemDetails</td>
+
−
  </tr>
+
−
</table><br>
+
−
=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=
+
=Prerequisites=
  
 
=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>LoginType</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>Login information</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">sessionID</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Session-ID from user (given by system)</td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level1">code_system</td>
 +
  <td>code_system</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Name of codesystem. Each codesystem requires at least one version.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">id</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>The ID does not required, if a Codesystem-Version-ID is listed.</td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level2">code_system_version</td>
 +
  <td>code_system_version</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>Version of a Code System</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>
 +
==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>ReturnType</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Return information</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">message</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>an additional message</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>code_system</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>Name of codesystem. Each codesystem requires at least one version.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">currentVersionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Version of the Code System</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">description</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Narrative description of Code System</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">id</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Internal ID = Primary Key of Code System</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">insertTimestamp</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Timestamp, wenn the Code System was inserted</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">name</td>
 +
  <td>String</td>
 +
  <td>100</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Name of the Code System. The precise name should be specified in the Code System Version.</td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level2">code_system_version</td>
 +
  <td>code_system_version</td>
 +
<td></td>  <td id="cardinality_cell">0..N</td>
 +
  <td>Version of a Code System</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">description</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Description of the Code System</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">expirationDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Point of time the Code System looses its validity.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">insertTimestamp</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Point of time when the Code System Version was inserted.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">licenceHolder</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Owner of the licence.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">name</td>
 +
  <td>String</td>
 +
  <td>100</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Complete Name of the Code System.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">oid</td>
 +
  <td>String</td>
 +
  <td>100</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Official OID</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">preferredLanguageId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</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>
 +
  <td id="param_level3">previousVersionID</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Refers to the prior version, if there are more than one.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">releaseDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Point of time, when this version starts to be valid.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">source</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Source of the Code System Version</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">status</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Status of the current entry. Can be taken from a domain.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">statusDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Point of time of the last change of the status</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">underLicence</td>
 +
  <td>Boolean</td>
 +
<td></td>  <td id="cardinality_cell">1..1</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>
 +
  <td id="param_level3">versionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level3">licence_type</td>
 +
  <td>licence_type</td>
 +
<td></td>  <td id="cardinality_cell">0..N</td>
 +
  <td>Sorts of licence types.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level4">codeSystemVersionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level4">id</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level4">typeTxt</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Name of the licence type.</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>Contains an accumulation of meta data. (List of the available descriptions)</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>Type of the meta data. A possible list of values is contained in the domain table.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">paramDatatype</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Data type of the value in code_system_metadata_value.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">paramName</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Description of meta data (e.g. measurement unit)</td>
 +
</tr>
 +
</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 50: 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