WS-Beschreibung - Terminologieserver Search ReturnCodeSystemDetails
Aus Termserver-CTS2
Version vom 26. März 2012, 11:07 Uhr von Muetzner (Diskussion | Beiträge)
System | Terminologieserver |
Webservice | Search |
WSDL | http://www.term.mi.fh-dortmund.de:8080/Terminologieserver/Search?wsdl |
Methode | ReturnCodeSystemDetails |
Inhaltsverzeichnis |
Funktionalität
Listet alle Eigenschaften des angegebenen Vokabulars oder Vokabular-Version auf. Im Abschnitt Request/Response ist eine Liste der Eigenschaften zu finden, welche zurückgegeben werden.
Vorbedingungen
Request/Response
Request
Parameter | Typ | Länge | Kardinalität | Beschreibung |
---|---|---|---|---|
LoginType | 0..1 | Login-Informationen | ||
ip | String | - | Die IP-Adresse des Benutzers (wird intern vergeben) | |
password | String | - | Passwort des Benutzers (als MD5-Wert) | |
sessionID | String | 1..1 | Die Session-ID des Benutzers | |
username | String | - | Benutzername | |
code_system | 1..1 | Name eines Codesystems/Vokabulars. Jedes Codesystem muss mindestens 1 Version besitzen. | ||
currentVersionId | Long | - | Die aktuelle Versions-ID | |
description | String | 65535 | - | Beschreibung eines Codesystems |
id | Long | 1..1 | ||
insertTimestamp | java.util.Date | - | Zeitstempel, wann das Codesystem eingefügt worden ist | |
name | String | 100 | - | Name des Codesystems. Der genau Name sollte in der Version angegeben werden |
code_system_version | 0..1 | Version eines Codesystems | ||
codeSystemId | Long | - | ||
description | String | 65535 | - | Beschreibung des Codesystems |
expirationDate | java.util.Date | - | Datum, bis wann die Version gültig ist | |
insertTimestamp | java.util.Date | - | Zeitstempel, wann die Codesystem-Version eingefügt worden ist | |
licenceHolder | String | 65535 | - | Besitzer der Lizenz |
name | String | 100 | - | Vollständiger Name des Codesystems |
oid | String | 100 | - | Offizielle OID |
preferredLanguageId | Long | - | Bevorzugte Sprache des Codesystems (ID ist aus der Domäne 'ISO_639_1_Language_Codes' mit der ID 1 zu entnehmen) | |
previousVersionID | Long | - | Gibt es mehr als 1 Version, zeigt diese ID auf die vorherige Version. | |
releaseDate | java.util.Date | - | Datum, ab wann die Version gültig ist | |
source | String | 65535 | - | Herausgeber der Codesystem-Version |
status | Integer | - | Der Status des aktuellen Eintrags. Kann einer Domäne entnommen werden. | |
statusDate | java.util.Date | - | Änderungszeitpunkt des Status | |
underLicence | Boolean | - | true, wenn das Vokabular unter Lizenzen fällt (ist dann für Benutzer ohne entsprechende Rechte nicht sichtbar) | |
versionId | Long | 1..1 |
Response
Parameter | Typ | Länge | Kardinalität | Beschreibung |
---|---|---|---|---|
ReturnType | 1..1 | Entählt Informationen über die Antwort. | ||
count | Integer | - | Anzahl der Ergebnisse | |
message | String | 1..1 | Status- oder Fehlermeldung | |
overallErrorCategory | 1..1 | INFO, WARN, ERROR | ||
status | 1..1 | OK, FAILURE | ||
code_system | 0..1 | Name eines Codesystems/Vokabulars. Jedes Codesystem muss mindestens 1 Version besitzen. | ||
currentVersionId | Long | 1..1 | Die aktuelle Versions-ID | |
description | String | 65535 | 1..1 | Beschreibung eines Codesystems |
id | Long | 1..1 | ||
insertTimestamp | java.util.Date | 1..1 | Zeitstempel, wann das Codesystem eingefügt worden ist | |
name | String | 100 | 1..1 | Name des Codesystems. Der genau Name sollte in der Version angegeben werden |
code_system_version | 0..N | Version eines Codesystems | ||
codeSystemId | Long | - | ||
description | String | 65535 | 1..1 | Beschreibung des Codesystems |
expirationDate | java.util.Date | 1..1 | Datum, bis wann die Version gültig ist | |
insertTimestamp | java.util.Date | 1..1 | Zeitstempel, wann die Codesystem-Version eingefügt worden ist | |
licenceHolder | String | 65535 | 1..1 | Besitzer der Lizenz |
name | String | 100 | 1..1 | Vollständiger Name des Codesystems |
oid | String | 100 | 1..1 | Offizielle OID |
preferredLanguageId | Long | 1..1 | Bevorzugte Sprache des Codesystems (ID ist aus der Domäne 'ISO_639_1_Language_Codes' mit der ID 1 zu entnehmen) | |
previousVersionID | Long | 1..1 | Gibt es mehr als 1 Version, zeigt diese ID auf die vorherige Version. | |
releaseDate | java.util.Date | 1..1 | Datum, ab wann die Version gültig ist | |
source | String | 65535 | 1..1 | Herausgeber der Codesystem-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 | |
underLicence | Boolean | 1..1 | true, wenn das Vokabular unter Lizenzen fällt (ist dann für Benutzer ohne entsprechende Rechte nicht sichtbar) | |
versionId | Long | 1..1 | ||
licence_type | 0..N | Arten von Lizenztypen | ||
codeSystemVersionId | Long | 1..1 | ||
id | Long | 1..1 | ||
typeTxt | String | 65535 | 1..1 | Name des Lizenztyps |
Anmerkungen
Besonderheiten
Hinweise
Die Ergebnismenge ist meistens eher klein.
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:ReturnCodeSystemDetails> <parameter> <codeSystem> <id>1</id> <codeSystemVersions> <versionId>4</versionId> </codeSystemVersions> </codeSystem> </parameter> </sear:ReturnCodeSystemDetails> </soapenv:Body> </soapenv:Envelope>