Terminologieserver - Search - ListDomainValues

Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
(automatisch erstellt vom Webservice-Schnittstellen-Tool)
(automatisch erstellt vom Webservice-Schnittstellen-Tool)
 
Zeile 20: Zeile 20:
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
   <td>List of all available domains (lists of values).</td>
 
   <td>List of all available domains (lists of values).</td>
</tr>
 
<tr id="gray">
 
  <td id="cardinality_cell">2</td>
 
  <td id="param_level2">defaultValue</td>
 
  <td>String</td>
 
  <td>60</td>
 
  <td id="cardinality_cell">-</td>
 
  <td>Default value, has to be taken from the table domain_value and the attribute 'code'</td>
 
</tr>
 
<tr id="gray">
 
  <td id="cardinality_cell">2</td>
 
  <td id="param_level2">description</td>
 
  <td>String</td>
 
  <td>65535</td>
 
  <td id="cardinality_cell">-</td>
 
  <td>Description of the domain.</td>
 
</tr>
 
<tr id="gray">
 
  <td id="cardinality_cell">2</td>
 
  <td id="param_level2">displayOrder</td>
 
  <td>Long</td>
 
<td></td>  <td id="cardinality_cell">-</td>
 
  <td>Order of display of the values. The ID has to be chosen from the domain with the ID 3 'Display Order'.
 
Possible values on the terminolgy server are ID 185 - to ID, ID 186 - to Order-Number, ID 187 - to name</td>
 
</tr>
 
<tr id="gray">
 
  <td id="cardinality_cell">2</td>
 
  <td id="param_level2">displayText</td>
 
  <td>String</td>
 
  <td>65535</td>
 
  <td id="cardinality_cell">-</td>
 
  <td>Name of the domain that should be shown.</td>
 
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 58: Zeile 26:
 
   <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>
 
</tr>
 
<tr id="gray">
 
  <td id="cardinality_cell">2</td>
 
  <td id="param_level2">domainName</td>
 
  <td>String</td>
 
  <td>50</td>
 
  <td id="cardinality_cell">-</td>
 
  <td>Name of the domain (e.g. country codes)</td>
 
</tr>
 
<tr id="gray">
 
  <td id="cardinality_cell">2</td>
 
  <td id="param_level2">domainOid</td>
 
  <td>String</td>
 
  <td>50</td>
 
  <td id="cardinality_cell">-</td>
 
  <td>OID of the domain, if existing.</td>
 
</tr>
 
<tr id="gray">
 
  <td id="cardinality_cell">2</td>
 
  <td id="param_level2">domainType</td>
 
  <td>String</td>
 
  <td>50</td>
 
  <td id="cardinality_cell">-</td>
 
  <td></td>
 
</tr>
 
<tr id="gray">
 
  <td id="cardinality_cell">2</td>
 
  <td id="param_level2">isOptional</td>
 
  <td>Boolean</td>
 
<td></td>  <td id="cardinality_cell">-</td>
 
 
   <td></td>
 
   <td></td>
 
</tr>
 
</tr>
Zeile 213: Zeile 150:
 
<td></td>  <td id="cardinality_cell">0..N</td>
 
<td></td>  <td id="cardinality_cell">0..N</td>
 
   <td>Gives information about the codesystem a domainvalue has relation with.</td>
 
   <td>Gives information about the codesystem a domainvalue has relation with.</td>
</tr>
 
<tr id="gray">
 
  <td id="cardinality_cell">3</td>
 
  <td id="param_level3">codeSystemType</td>
 
  <td>String</td>
 
  <td>30</td>
 
  <td id="cardinality_cell">-</td>
 
  <td>Type of Code System (Taxonomy, Ontology). Possible values are available in domain table with id 6</td>
 
</tr>
 
<tr id="gray">
 
  <td id="cardinality_cell">3</td>
 
  <td id="param_level3">currentVersionId</td>
 
  <td>Long</td>
 
<td></td>  <td id="cardinality_cell">-</td>
 
  <td>Version of the Code System</td>
 
</tr>
 
<tr id="gray">
 
  <td id="cardinality_cell">3</td>
 
  <td id="param_level3">description</td>
 
  <td>String</td>
 
  <td>65535</td>
 
  <td id="cardinality_cell">-</td>
 
  <td>Narrative description of Code System</td>
 
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 243: Zeile 157:
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
   <td>Internal ID = Primary Key of Code System</td>
 
   <td>Internal ID = Primary Key of Code System</td>
</tr>
 
<tr id="gray">
 
  <td id="cardinality_cell">3</td>
 
  <td id="param_level3">insertTimestamp</td>
 
  <td>java.util.Date</td>
 
<td></td>  <td id="cardinality_cell">-</td>
 
  <td>Timestamp, when the Code System was inserted</td>
 
 
</tr>
 
</tr>
 
<tr>
 
<tr>

Aktuelle Version vom 30. September 2014, 12:31 Uhr

zurück zur Webservice-Übersicht

Inhaltsverzeichnis

Beschreibung

List domain values from a given domain id. The domain id can be obtained with ListDomains.

Request/Response

Request

Level Parameter Typ Länge Kardinalität Beschreibung
1 domain domain 1..1 List of all available domains (lists of values).
2 domainId Long 1..1


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 domainValue domain_value 0..N Value from a domain.
2 attribut1Classname String 50 1..1 Additonal information
2 attribut1Value String 50 1..1 Additonal information
2 domainCode String 50 1..1 Code of the value. It is used as foreign key.
2 domainDisplay String 100 1..1 Displayed name of the value.
2 domainId Long 1..1
2 domainValueId Long 1..1
2 imageFile String 65535 1..1 Filename of an image saved on the file system.
2 orderNo Integer 1..1 Manual order of the values. The 'displayOrder' of the domain in the table 'domain' with 186 (to Order-Number) has to be used.
2 codeSystem code_system 0..N Gives information about the codesystem a domainvalue has relation with.
3 id Long 1..1 Internal ID = Primary Key of Code System
3 name String 100 1..1 Name of the Code System. The precise name should be specified in the Code System Version.

Beispiele

SOAP

List all domain values from a given domain

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



zurück zur Webservice-Übersicht

Meine Werkzeuge
Namensräume
Varianten
Aktionen
Navigation
Werkzeuge