WS-Beschreibung - Terminologieserver Search ListValueSetContents

Aus Termserver-CTS2
Wechseln zu: Navigation, Suche
System Terminologieserver
Webservice Search
WSDL http://www.term.mi.fh-dortmund.de:8080/Terminologieserver/Search?wsdl
Methode ListValueSetContents

Inhaltsverzeichnis

Funktionalität

Listet alle Konzepte aus, die mit dem ValueSet bzw. der ValueSet-Version verknüpft sind.

Vorbedingungen

Request/Response

Request

Parameter Typ Länge Kardinalität Beschreibung
LoginType LoginType 0..1 Login-Informationen
sessionID String 1..1 Die Session-ID des Benutzers
value_set value_set 1..1 Stellt eine Untermenge von Begriffen dar. Jedes Valueset hat mindestens eine Valueset-Version.
value_set_version value_set_version 0..1 Stellt die Version eines Valuesets dar.
releaseDate java.util.Date 0..1 Datum, ab dem die Valueset-Version gültig ist
versionId Long 1..1 Versions-ID des Valuesets
SortingType SortingType 0..1 Legt Sortierung fest. Falls nicht angegeben, werden die Konzepte aufsteigend nach dem Code sortiert.
sortBy String 0..1 Mögliche Werte: CODE, TERM Standardwert: CODE
sortDirection String 0..1 Mögliche Werte: ASCENDING, DESCENDING Standardwert: ASCENDING
sortType String 0..1 Mögliche Werte: ALPHABETICALLY, ORDER_NR Standardwert: ALPHABETICALLY

Response

Parameter Typ Länge Kardinalität Beschreibung
ReturnType ReturnType 1..1 Enthält 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
code_system_entity code_system_entity 0..N Abstrakte Klasse. Eine Eintrag muss mindestens einen Eintrag in code_system_entity_version besitzen.
currentVersionId Long 1..1 Die aktuelle ID der code_system_entity_version
id Long 1..1
code_system_entity_version code_system_entity_version 1..N Ein code_system_entity_version ist die Oberklasse entweder eines Begriffs oder einer Beziehung.
effectiveDate java.util.Date 1..1 Zeitpunkt der letzten Änderung
insertTimestamp java.util.Date 1..1 Zeitstempel, wann der Eintrag eingefügt worden ist
isLeaf Boolean 1..1 Gibt an, wenn ein Begriff das Blattelement ist. Dieser Wert wird durch Trigger gesetzt, kann also nur gelesen werden.
majorRevision Integer 1..1 Hauptversion dieses Eintrags (Zusammensetzung aus Haupt- und Nebenversion, z.B. 1.3)
minorRevision Integer 1..1 Nebenversion dieses Eintrags (Zusammensetzung aus Haupt- und Nebenversion, z.B. 1.3)
previousVersionId Long 1..1 Gibt es mehr als 1 Version, zeigt diese ID auf die vorherige Version.
status Integer 1..1 Der Status des aktuellen Eintrags. Kann einer Domäne entnommen werden.
statusDate java.util.Date 1..1 Änderungszeitpunkt des Status
versionId Long 1..1 Versions-ID der Entity-Version
association_type association_type 0..1 Stellt den Namen einer Beziehung dar. Speziealisierung von code_system_entity_version. Die codeSystemEntityVersionId entspricht der versionId aus code_system_entity_version.
forwardName String 50 1..1 Name der Beziehung in normaler Leserichtung (ID 1->2)
reverseName String 50 1..1 Name der Beziehung in umgekehrter Leserichtung (ID 2->1)
code_system_concept code_system_concept 0..1 Stellt ein Konzept bzw. ein Begriff dar. Speziealisierung von code_system_entity_version.
code String 100 1..1 Der Code zu einem Begriff bzw. Konzepts
isPreferred Boolean 1..1 Gibt an, ob es sich um einen Vorzugsbegriff handelt
term String 65535 1..1 Der Begriff selbst
termAbbrevation String 50 1..1 Abkürzung des Begriffs
code_system_concept_translation code_system_concept_translation 0..N Übersetzung eines Begriffs.
codeSystemEntityVersionId Long 1..1
languageId Long 1..1 Sprache der Übersetzung. Der Wert kommt von Domain-Value mit der Domain-ID 1 (ISO_639_1_Language_Codes)
term String 65535 1..1 Übersetzter Begriff
termAbbrevation String 50 1..1 Abkürzung des übersetzten Begriffs
property property 0..N
currentVersionId Long 1..1
id Long 1..1
property_version property_version 1..N
content byte[] 1..1
contentMimetype String 50 1..1
contentName String 255 1..1
contentSize Integer 1..1
description String 65535 1..1
insertTimestamp java.util.Date 1..1
languageId Long 1..1
name String 65535 1..1
previousVersionId Long 1..1
propertyKindId Long 1..1
status Integer 1..1
statusDate java.util.Date 1..1
versionId Long 1..1
code_system_version_entity_membership code_system_version_entity_membership 1..1 Stellt die Verknüpfung zwischen einer Codesystem-Version und den Entitäten her.
codeSystemEntityId Long 1..1
codeSystemVersionId Long 1..1
isAxis Boolean 1..1 true, wenn die zugehörige Entity des Eintrags eine Achse des Codesystems ist
isMainClass Boolean 1..1 true, wenn die zugehörige Entity des Eintrags eine Hauptklasse (root-Element) des Codesystems ist

Anmerkungen

Besonderheiten

Hinweise

Beispiele

SOAP-Nachrichten

<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>
               <id>1</id>
               <valueSetVersions>
                 <versionId>1</versionId>
               </valueSetVersions>
            </valueSet>
         </parameter>
      </sear:ListValueSetContents>
   </soapenv:Body>
</soapenv:Envelope>

Code-Beispiele

Java

 
Meine Werkzeuge
Namensräume
Varianten
Aktionen
Navigation
Werkzeuge