Terminologieserver - Search - ListValueSets

Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
(automatisch erstellt vom Webservice-Schnittstellen-Tool)
 
(automatisch erstellt vom Webservice-Schnittstellen-Tool)
Zeile 1: Zeile 1:
 
[[Terminologieserver - Webservice Dokumentation|zurück zur Webservice-Übersicht]]<br><br>
 
[[Terminologieserver - Webservice Dokumentation|zurück zur Webservice-Übersicht]]<br><br>
  
 +
=Beschreibung=
 +
List all value sets including their versions. The result set can be filtered by some properties (see request table). <br>
 
=Request/Response=
 
=Request/Response=
 
==Request==
 
==Request==
Zeile 12: Zeile 14:
 
     <th>Beschreibung</th>
 
     <th>Beschreibung</th>
 
   </tr>
 
   </tr>
−
<tr id="row_object">
+
<tr>
 
   <td id="cardinality_cell">1</td>
 
   <td id="cardinality_cell">1</td>
−
   <td id="param_level1">LoginType</td>
+
   <td id="param_level1">loginToken</td>
−
  <td>LoginType</td>
+
−
<td></td>  <td id="cardinality_cell">0..1</td>
+
−
  <td>Login information</td>
+
−
</tr>
+
−
<tr>
+
−
  <td id="cardinality_cell">2</td>
+
−
  <td id="param_level2">sessionID</td>
+
 
   <td>String</td>
 
   <td>String</td>
 
   <td></td>
 
   <td></td>
−
   <td id="cardinality_cell">1..1</td>
+
   <td id="cardinality_cell">0..1</td>
−
   <td>Session-ID from user (given by system)</td>
+
   <td>Login-Token that ensures the user is logged in.</td>
−
</tr>
+
−
<tr id="row_object">
+
−
  <td id="cardinality_cell">1</td>
+
−
  <td id="param_level1">codeSystemEntity</td>
+
−
  <td>code_system_entity</td>
+
−
<td></td>  <td id="cardinality_cell">0..1</td>
+
−
  <td>Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version. </td>
+
−
</tr>
+
−
<tr>
+
−
  <td id="cardinality_cell">2</td>
+
−
  <td id="param_level2">id</td>
+
−
  <td>Long</td>
+
−
<td></td>  <td id="cardinality_cell">1..1</td>
+
−
  <td></td>
+
−
</tr>
+
−
<tr id="row_object">
+
−
  <td id="cardinality_cell">2</td>
+
−
  <td id="param_level2">codeSystemEntityVersion</td>
+
−
  <td>code_system_entity_version</td>
+
−
<td></td>  <td id="cardinality_cell">0..1</td>
+
−
  <td>code_system_entity_version is the superclass of every Concept and Association.  </td>
+
−
</tr>
+
−
<tr>
+
−
  <td id="cardinality_cell">3</td>
+
−
  <td id="param_level3">versionId</td>
+
−
  <td>Long</td>
+
−
<td></td>  <td id="cardinality_cell">1..1</td>
+
−
  <td>Version-ID of Entity-Version</td>
+
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 84: Zeile 51:
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
   <td>Represents  the version of an valueset.</td>
 
   <td>Represents  the version of an valueset.</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">name</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">0..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">oid</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">0..1</td>
 +
  <td></td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 105: Zeile 88:
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
   <td>Alteration time of the status.</td>
 
   <td>Alteration time of the status.</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">validityRange</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>Validity range (German: Gültigkeitsbereich)</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
Zeile 120: Zeile 110:
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="cardinality_cell">1</td>
 
   <td id="cardinality_cell">1</td>
−
   <td id="param_level1">ReturnType</td>
+
   <td id="param_level1">returnInfos</td>
 
   <td>ReturnType</td>
 
   <td>ReturnType</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
Zeile 167: Zeile 157:
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
   <td>Points to the current version of the valueset.</td>
 
   <td>Points to the current version of the valueset.</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">description</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Description of the valueset.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 210: Zeile 208:
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
   <td>Timestamp of the insertion of the valueset version.</td>
 
   <td>Timestamp of the insertion of the valueset version.</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">name</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">oid</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td></td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 215: Zeile 229:
 
   <td id="param_level3">preferredLanguageCd</td>
 
   <td id="param_level3">preferredLanguageCd</td>
 
   <td>String</td>
 
   <td>String</td>
−
   <td>19</td>
+
   <td>30</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
−
   <td>The preferred langue of the code system. (The ID has to be taken from the domain 'ISO_639_1_Language_Codes' - ID 1)</td>
+
   <td>Preferred language of value set version. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...)</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 246: Zeile 260:
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
   <td>Alteration time of the status.</td>
 
   <td>Alteration time of the status.</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">valueSetId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Foreign key to the ID of the valueset.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>

Version vom 22. Juli 2014, 08:54 Uhr

zurück zur Webservice-Übersicht

Inhaltsverzeichnis

Beschreibung

List all value sets including their versions. The result set can be filtered by some properties (see request table).

Request/Response

Request

Level Parameter Typ Länge Kardinalität Beschreibung
1 loginToken String 0..1 Login-Token that ensures the user is logged in.
1 valueSet value_set 0..1 A subset of terms.Every valueset has at least one valueset-version.
2 description String 65535 0..1 Description of the valueset.
2 name String 50 0..1 Name of the valueset.
2 valueSetVersion value_set_version 0..1 Represents the version of an valueset.
3 name String 0..1
3 oid String 0..1
3 releaseDate java.util.Date 0..1 Start date for the validity of the valueset version.
3 status Integer 0..1 The status of the current entry. Can be found in a domain.
3 statusDate java.util.Date 0..1 Alteration time of the status.
3 validityRange Long 0..1 Validity range (German: Gültigkeitsbereich)


Response

Level Parameter Typ Länge Kardinalität Beschreibung
1 returnInfos ReturnType 1..1 Return information
2 count Integer 1..1 number of results
2 message String 1..1 an additional message
2 overallErrorCategory 1..1 INFO, WARN, ERROR
2 status 1..1 OK, FAILURE
1 valueSet value_set 0..N A subset of terms.Every valueset has at least one valueset-version.
2 currentVersionId Long 1..1 Points to the current version of the valueset.
2 description String 65535 1..1 Description of the valueset.
2 id Long 1..1 ID of the valueset.
2 name String 50 1..1 Name of the valueset.
2 status Integer 1..1 Status of the current entry. Can be found in a domain.
2 statusDate java.util.Date 1..1 Alteration time of the status.
2 valueSetVersion value_set_version 0..N Represents the version of an valueset.
3 insertTimestamp java.util.Date 1..1 Timestamp of the insertion of the valueset version.
3 name String 1..1
3 oid String 1..1
3 preferredLanguageCd String 30 1..1 Preferred language of value set version. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...)
3 previousVersionId Long 1..1 Points to the previous version.
3 releaseDate java.util.Date 1..1 Start date for the validity of the valueset version.
3 status Integer 1..1 The status of the current entry. Can be found in a domain.
3 statusDate java.util.Date 1..1 Alteration time of the status.
3 valueSetId Long 1..1 Foreign key to the ID of the valueset.
3 versionId Long 1..1 Version ID of the value set

Beispiele

SOAP

List all available valuesets

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



zurück zur Webservice-Übersicht

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