Terminologieserver - Search - ListValueSetContents
Aus Termserver-CTS2
Version vom 22. Juli 2014, 07:28 Uhr von Muetzner (Diskussion | Beiträge)
zurück zur Webservice-Übersicht
Inhaltsverzeichnis |
Request/Response
Request
| Level | Parameter | Typ | Länge | Kardinalität | Beschreibung |
|---|---|---|---|---|---|
| 1 | LoginType | LoginType | 0..1 | Login information | |
| 2 | sessionID | String | 1..1 | Session-ID from user (given by system) | |
| 1 | valueSet | value_set | 1..1 | A subset of terms.Every valueset has at least one valueset-version. | |
| 2 | valueSetVersion | value_set_version | 0..1 | Represents the version of an valueset. | |
| 3 | releaseDate | java.util.Date | 0..1 | Start date for the validity of the valueset version. | |
| 3 | versionId | Long | 1..1 | Version ID of the value set | |
| 3 | conceptValueSetMembership | concept_value_set_membership | 0..1 | Connects a valueset to an entity. | |
| 1 | SortingType | SortingType | 0..1 | Determines the assortment. If not given, the concepts are sorted asscending according to the code. | |
| 2 | sortBy | String | 0..1 | possible values: CODE, TERM default value: CODE | |
| 2 | sortDirection | String | 0..1 | possible values: ASCENDING, DESCENDING default value: ASCENDING | |
| 2 | sortType | String | 0..1 | possible values: ALPHABETICALLY, ORDER_NR default value: ALPHABETICALLY | |
| 1 | readMetadata | Boolean | 0..1 | falls true, werden alle Metadaten zu den Konzepten zurückgeliefert |
Response
| Level | Parameter | Typ | Länge | Kardinalität | Beschreibung |
|---|---|---|---|---|---|
| 1 | ReturnType | 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 | codeSystemEntity | code_system_entity | 0..N | Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version. | |
| 2 | currentVersionId | Long | 1..1 | Current ID of code_system_entity_version. | |
| 2 | id | Long | 1..1 | ||
| 2 | codeSystemEntityVersion | code_system_entity_version | 1..N | code_system_entity_version is the superclass of every Concept and Association. | |
| 3 | effectiveDate | java.util.Date | 1..1 | Point in time of the last change. | |
| 3 | insertTimestamp | java.util.Date | 1..1 | Point in time, when entry was inserted. | |
| 3 | isLeaf | Boolean | 1..1 | Indicates if a concept is a leaf element or not. Value will be set by a trigger and is therefore read only. | |
| 3 | majorRevision | Integer | 1..1 | Major revision of this entry (composition of major and minor version e.g. 1.3). | |
| 3 | minorRevision | Integer | 1..1 | Minor revision of this entry (composition of major and minor version e.g. 1.3) | |
| 3 | previousVersionId | Long | 1..1 | Refers to the prior version, if there are more than one version. | |
| 3 | status | Integer | 1..1 | Status of the current entry. Can be taken from a domain. | |
| 3 | statusDate | java.util.Date | 1..1 | Point of time of the last change of the status. | |
| 3 | versionId | Long | 1..1 | Version-ID of Entity-Version | |
| 3 | associationType | association_type | 0..1 | Displays the name of a association. Specialization of code_system_entity_version. The codeSystemEntityVersionId equates the versionId of code_system_entity_version | |
| 4 | forwardName | String | 50 | 1..1 | Name of association in normal reading direction (ID 1->2) |
| 4 | reverseName | String | 50 | 1..1 | Name of association in reversed reading direction (ID 2->1) |
| 3 | codeSystemConcept | code_system_concept | 0..1 | Displays a concept or term. Specialization of code_system_entity_version. | |
| 4 | code | String | 100 | 1..1 | Code of a concept or term. |
| 4 | description | String | 1..1 | Description of a term or concept | |
| 4 | isPreferred | Boolean | 1..1 | Specifies, if a term or concept is preferred or not. | |
| 4 | term | String | 65535 | 1..1 | The term itself |
| 4 | termAbbrevation | String | 50 | 1..1 | The abbrevation of the term. |
| 4 | codeSystemConceptTranslation | code_system_concept_translation | 0..N | Translation of a term | |
| 5 | codeSystemEntityVersionId | Long | 1..1 | ||
| 5 | description | String | 1..1 | Description of the translated term. | |
| 5 | id | Long | 1..1 | ||
| 5 | languageId | Long | 1..1 | Language of the translation. Value comes from Domain-Value with Domain-ID 1 (ISO_639_1_Language_Codes) | |
| 5 | term | String | 65535 | 1..1 | Translated term |
| 5 | termAbbrevation | String | 50 | 1..1 | Abbreviation of the translated term. |
| 3 | property | property | 0..N | ||
| 4 | currentVersionId | Long | 1..1 | ||
| 4 | id | Long | 1..1 | ||
| 4 | propertyVersion | property_version | 1..N | ||
| 5 | content | byte[] | 1..1 | ||
| 5 | contentMimetype | String | 50 | 1..1 | |
| 5 | contentName | String | 255 | 1..1 | |
| 5 | contentSize | Integer | 1..1 | ||
| 5 | description | String | 65535 | 1..1 | |
| 5 | insertTimestamp | java.util.Date | 1..1 | ||
| 5 | languageId | Long | 1..1 | ||
| 5 | name | String | 65535 | 1..1 | |
| 5 | previousVersionId | Long | 1..1 | ||
| 5 | propertyKindId | Long | 1..1 | ||
| 5 | status | Integer | 1..1 | ||
| 5 | statusDate | java.util.Date | 1..1 | ||
| 5 | versionId | Long | 1..1 | ||
| 2 | codeSystemVersionEntityMembership | code_system_version_entity_membership | 1..1 | Connects the version of a Code System to the entities. | |
| 3 | codeSystemEntityId | Long | 1..1 | ||
| 3 | codeSystemVersionId | Long | 1..1 | ||
| 3 | isAxis | Boolean | 1..1 | true, if the belonging entity of the entry is an axis of the code system | |
| 3 | isMainClass | Boolean | 1..1 | true, if the belonging entity of the entry is a root element of the code system. |
Beispiele
SOAP
List valueset content with valueset version-id 6
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/"> <soapenv:Header/> <soapenv:Body> <sear:ListValueSetContents> <parameter> <valueSet> <valueSetVersions> <versionId>6</versionId> </valueSetVersions> </valueSet> </parameter> </sear:ListValueSetContents> </soapenv:Body> </soapenv:Envelope>
