WS-Beschreibung - Terminologieserver Search ListDomainValues
Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Becker (Diskussion | Beiträge) |
Becker (Diskussion | Beiträge) |
||
| Zeile 1: | Zeile 1: | ||
| − | = | + | =Functionality= |
| − | + | Lists all domain values from a certain domain, specified by its id. | |
| − | = | + | =Prerequisites= |
=Request/Response= | =Request/Response= | ||
| Zeile 135: | Zeile 135: | ||
</table> | </table> | ||
| − | = | + | =Annotations= |
| − | == | + | ==Noteworthiness== |
| − | + | In addition to domain values, the dedicated code systems will be returned as well. This is necessary to get the taxonomy of code systems. | |
| + | ==Hints== | ||
| − | = | + | =Examples= |
| − | + | ==SOAP messages== | |
| − | + | ||
| − | ==SOAP | + | |
<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/"> | ||
Version vom 8. August 2013, 11:37 Uhr
Inhaltsverzeichnis |
Functionality
Lists all domain values from a certain domain, specified by its id.
Prerequisites
Request/Response
Request
| Parameter | Typ | Länge | Kardinalität | Beschreibung |
|---|---|---|---|---|
| domain | 1..1 | Liste aller verfügbaren Domänen (Wertelisten). | ||
| domainId | Long | 1..1 |
Response
| Parameter | Typ | Länge | Kardinalität | Beschreibung |
|---|---|---|---|---|
| ReturnType | 1..1 | Entählt Informationen über die Antwort. | ||
| count | Integer | 1..1 | Anzahl der Ergebnisse | |
| message | String | 1..1 | Status- oder Fehlermeldung | |
| overallErrorCategory | 1..1 | INFO, WARN, ERROR | ||
| status | 1..1 | OK, FAILURE | ||
| domain_value | 0..N | Wert aus einer Domäne | ||
| attribut1Classname | String | 50 | 1..1 | zusätzliche Angaben |
| attribut1Value | String | 50 | 1..1 | zusätzliche Angaben |
| domainCode | String | 50 | 1..1 | Code des Wertes. Dieser dient als Fremdschlüssel |
| domainDisplay | String | 100 | 1..1 | Anzeigename des Wertes |
| domainId | Long | 1..1 | ||
| imageFile | String | 65535 | 1..1 | Dateiname eines Bilder, welches auf dem Dateisystem liegt |
| code_system | 0..N | Name eines Codesystems/Vokabulars. Jedes Codesystem muss mindestens 1 Version besitzen. | ||
| id | Long | 1..1 | ||
| name | String | 100 | 1..1 | Name des Codesystems. Der genau Name sollte in der Version angegeben werden |
Annotations
Noteworthiness
In addition to domain values, the dedicated code systems will be returned as well. This is necessary to get the taxonomy of code systems.
Hints
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:ListDomainValues> <parameter> <domain> <domainId>8</domainId> </domain> </parameter> </sear:ListDomainValues> </soapenv:Body> </soapenv:Envelope>
