Terminologieserver - Search - ListDomainValues
Aus Termserver-CTS2
(Unterschied zwischen Versionen)
(automatisch erstellt vom Webservice-Schnittstellen-Tool) |
(automatisch erstellt vom Webservice-Schnittstellen-Tool) |
||
| Zeile 118: | Zeile 118: | ||
<td id="cardinality_cell">2</td> | <td id="cardinality_cell">2</td> | ||
<td id="param_level2">domainId</td> | <td id="param_level2">domainId</td> | ||
| + | <td>Long</td> | ||
| + | <td></td> <td id="cardinality_cell">1..1</td> | ||
| + | <td></td> | ||
| + | </tr> | ||
| + | <tr> | ||
| + | <td id="cardinality_cell">2</td> | ||
| + | <td id="param_level2">domainValueId</td> | ||
<td>Long</td> | <td>Long</td> | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
| Zeile 129: | Zeile 136: | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
<td>Filename of an image saved on the file system.</td> | <td>Filename of an image saved on the file system.</td> | ||
| + | </tr> | ||
| + | <tr> | ||
| + | <td id="cardinality_cell">2</td> | ||
| + | <td id="param_level2">orderNo</td> | ||
| + | <td>Integer</td> | ||
| + | <td></td> <td id="cardinality_cell">1..1</td> | ||
| + | <td>Manual order of the values. The 'displayOrder' of the domain in the table 'domain' with 186 (to Order-Number) has to be used.</td> | ||
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
| Zeile 135: | Zeile 149: | ||
<td>code_system</td> | <td>code_system</td> | ||
<td></td> <td id="cardinality_cell">0..N</td> | <td></td> <td id="cardinality_cell">0..N</td> | ||
| − | <td> | + | <td>Gives information about the codesystem a domainvalue has relation with.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Version vom 22. Juli 2014, 08:54 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>
