WS-Beschreibung - Terminologieserver Search ListValueSets
Aus Termserver-CTS2
Inhaltsverzeichnis |
Functionality
Lists all value sets and their versions. The result set ca be filtered by some properties (see request table).
Prerequisites
Request/Response
Request
| Parameter | Typ | Länge | Kardinalität | Beschreibung |
|---|---|---|---|---|
| LoginType | LoginType | 0..1 | Login information | |
| sessionID | String | 1..1 | Session-ID from user (given by system) | |
| code_system_entity | code_system_entity | 0..1 | Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version. | |
| id | Long | 1..1 | ||
| code_system_entity_version | code_system_entity_version | 0..1 | code_system_entity_version is the superclass of every Concept and Association. | |
| versionId | Long | 1..1 | Version-ID of Entity-Version | |
| value_set | value_set | 0..1 | A subset of terms.Every valueset has at least one valueset-version. | |
| description | String | 65535 | 0..1 | Description of the valueset. |
| name | String | 50 | 0..1 | Name of the valueset. |
| value_set_version | value_set_version | 0..1 | Represents the version of an valueset. | |
| releaseDate | java.util.Date | 0..1 | Start date for the validity of the valueset version. | |
| status | Integer | 0..1 | The status of the current entry. Can be found in a domain. | |
| statusDate | java.util.Date | 0..1 | Alteration time of the status. |
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 | ||
| value_set | value_set | 0..N | A subset of terms.Every valueset has at least one valueset-version. | |
| currentVersionId | Long | 1..1 | Points to the current version of the valueset. | |
| id | Long | 1..1 | ID of the valueset. | |
| name | String | 50 | 1..1 | Name of the valueset. |
| status | Integer | 1..1 | Status of the current entry. Can be found in a domain. | |
| statusDate | java.util.Date | 1..1 | Alteration time of the status. | |
| value_set_version | value_set_version | 0..N | Represents the version of an valueset. | |
| insertTimestamp | java.util.Date | 1..1 | Timestamp of the insertion of the valueset version. | |
| preferredLanguageId | Long | 1..1 | The preferred langue of the code system. (The ID has to be taken from the domain 'ISO_639_1_Language_Codes' - ID 1) | |
| previousVersionId | Long | 1..1 | Points to the previous version. | |
| releaseDate | java.util.Date | 1..1 | Start date for the validity of the valueset version. | |
| status | Integer | 1..1 | The status of the current entry. Can be found in a domain. | |
| statusDate | java.util.Date | 1..1 | Alteration time of the status. | |
| versionId | Long | 1..1 | Version ID of the value set |
Annotations
Noteworthiness
Hints
The result set is typically very small.
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:ListValueSets> <parameter> </parameter> </sear:ListValueSets> </soapenv:Body> </soapenv:Envelope>
