WS-Beschreibung - Terminologieserver Search ListDomainValues
Aus Termserver-CTS2
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 | domain | 1..1 | List of all available domains (lists of values). | |
| domainId | Long | 1..1 |
Response
| Parameter | Typ | Länge | Kardinalität | Beschreibung |
|---|---|---|---|---|
| ReturnType | ReturnType | 1..1 | Return information | |
| count | Integer | 1..1 | number of results | |
| message | String | 1..1 | an additional message | |
| overallErrorCategory | 1..1 | INFO, WARN, ERROR | ||
| status | 1..1 | OK, FAILURE | ||
| domain_value | domain_value | 0..N | Value from a domain. | |
| attribut1Classname | String | 50 | 1..1 | Additonal information |
| attribut1Value | String | 50 | 1..1 | Additonal information |
| domainCode | String | 50 | 1..1 | Code of the value. It is used as foreign key. |
| domainDisplay | String | 100 | 1..1 | Displayed name of the value. |
| domainId | Long | 1..1 | ||
| imageFile | String | 65535 | 1..1 | Filename of an image saved on the file system. |
| code_system | code_system | 0..N | Name of codesystem. Each codesystem requires at least one version. | |
| id | Long | 1..1 | Internal ID = Primary Key of Code System | |
| name | String | 100 | 1..1 | Name of the Code System. The precise name should be specified in the Code System Version. |
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>
