WS-Beschreibung - Terminologieserver Search ListValueSetContents
Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Becker (Diskussion | Beiträge) (→Funktionalität) |
(→Request/Response) |
||
| Zeile 34: | Zeile 34: | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level1">LoginType</td> | <td id="param_level1">LoginType</td> | ||
| − | <td></td> | + | <td>LoginType</td> |
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
<td>Login-Informationen</td> | <td>Login-Informationen</td> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 58: | Zeile 44: | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
<td>Die Session-ID des Benutzers</td> | <td>Die Session-ID des Benutzers</td> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level1">value_set</td> | <td id="param_level1">value_set</td> | ||
| − | <td></td> | + | <td>value_set</td> |
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
<td>Stellt eine Untermenge von Begriffen dar. Jedes Valueset hat mindestens eine Valueset-Version.</td> | <td>Stellt eine Untermenge von Begriffen dar. Jedes Valueset hat mindestens eine Valueset-Version.</td> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level2">value_set_version</td> | <td id="param_level2">value_set_version</td> | ||
| − | <td></td> | + | <td>value_set_version</td> |
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
<td>Stellt die Version eines Valuesets dar.</td> | <td>Stellt die Version eines Valuesets dar.</td> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 140: | Zeile 63: | ||
<td>Datum, ab dem die Valueset-Version gültig ist</td> | <td>Datum, ab dem die Valueset-Version gültig ist</td> | ||
</tr> | </tr> | ||
| − | <tr | + | <tr> |
| − | <td id="param_level3"> | + | <td id="param_level3">versionId</td> |
| − | <td> | + | <td>Long</td> |
| − | <td></td> <td id="cardinality_cell"> | + | <td></td> <td id="cardinality_cell">1..1</td> |
| − | <td> | + | <td>Versions-ID des Valuesets</td> |
</tr> | </tr> | ||
| − | <tr id=" | + | <tr id="row_object"> |
| − | <td id=" | + | <td id="param_level1">SortingType</td> |
| − | <td> | + | <td>SortingType</td> |
| − | <td></td> <td id="cardinality_cell"> | + | <td></td> <td id="cardinality_cell">0..1</td> |
| − | <td> | + | <td>Legt Sortierung fest. Falls nicht angegeben, werden die Konzepte aufsteigend nach dem Code sortiert.</td> |
</tr> | </tr> | ||
| − | <tr | + | <tr> |
| − | <td id=" | + | <td id="param_level2">sortBy</td> |
| − | <td> | + | <td>String</td> |
| − | + | ||
<td></td> | <td></td> | ||
| + | <td id="cardinality_cell">0..1</td> | ||
| + | <td>Mögliche Werte: CODE, TERM | ||
| + | |||
| + | Standardwert: CODE</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | <td id=" | + | <td id="param_level2">sortDirection</td> |
| − | <td> | + | <td>String</td> |
| − | + | ||
<td></td> | <td></td> | ||
| + | <td id="cardinality_cell">0..1</td> | ||
| + | <td>Mögliche Werte: ASCENDING, DESCENDING | ||
| + | |||
| + | Standardwert: ASCENDING</td> | ||
| + | </tr> | ||
| + | <tr> | ||
| + | <td id="param_level2">sortType</td> | ||
| + | <td>String</td> | ||
| + | <td></td> | ||
| + | <td id="cardinality_cell">0..1</td> | ||
| + | <td>Mögliche Werte: ALPHABETICALLY, ORDER_NR | ||
| + | |||
| + | Standardwert: ALPHABETICALLY</td> | ||
</tr> | </tr> | ||
</table> | </table> | ||
| Zeile 176: | Zeile 114: | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level1">ReturnType</td> | <td id="param_level1">ReturnType</td> | ||
| − | <td></td> | + | <td>ReturnType</td> |
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
| − | <td> | + | <td>Enthält Informationen über die Antwort.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 207: | Zeile 145: | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level1">code_system_entity</td> | <td id="param_level1">code_system_entity</td> | ||
| − | <td></td> | + | <td>code_system_entity</td> |
<td></td> <td id="cardinality_cell">0..N</td> | <td></td> <td id="cardinality_cell">0..N</td> | ||
<td>Abstrakte Klasse. Eine Eintrag muss mindestens einen Eintrag in code_system_entity_version besitzen.</td> | <td>Abstrakte Klasse. Eine Eintrag muss mindestens einen Eintrag in code_system_entity_version besitzen.</td> | ||
| Zeile 225: | Zeile 163: | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level2">code_system_entity_version</td> | <td id="param_level2">code_system_entity_version</td> | ||
| − | <td></td> | + | <td>code_system_entity_version</td> |
<td></td> <td id="cardinality_cell">1..N</td> | <td></td> <td id="cardinality_cell">1..N</td> | ||
<td>Ein code_system_entity_version ist die Oberklasse entweder eines Begriffs oder einer Beziehung.</td> | <td>Ein code_system_entity_version ist die Oberklasse entweder eines Begriffs oder einer Beziehung.</td> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 287: | Zeile 219: | ||
<td>Long</td> | <td>Long</td> | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
| − | <td></td> | + | <td>Versions-ID der Entity-Version</td> |
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level3">association_type</td> | <td id="param_level3">association_type</td> | ||
| − | <td></td> | + | <td>association_type</td> |
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
<td>Stellt den Namen einer Beziehung dar. Speziealisierung von code_system_entity_version. Die codeSystemEntityVersionId entspricht der versionId aus code_system_entity_version.</td> | <td>Stellt den Namen einer Beziehung dar. Speziealisierung von code_system_entity_version. Die codeSystemEntityVersionId entspricht der versionId aus code_system_entity_version.</td> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 317: | Zeile 243: | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level3">code_system_concept</td> | <td id="param_level3">code_system_concept</td> | ||
| − | <td></td> | + | <td>code_system_concept</td> |
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
<td>Stellt ein Konzept bzw. ein Begriff dar. Speziealisierung von code_system_entity_version.</td> | <td>Stellt ein Konzept bzw. ein Begriff dar. Speziealisierung von code_system_entity_version.</td> | ||
| Zeile 326: | Zeile 252: | ||
<td>100</td> | <td>100</td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
| − | <td> | + | <td>Der Code zu einem Begriff bzw. Konzepts</td> |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 338: | Zeile 258: | ||
<td>Boolean</td> | <td>Boolean</td> | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
| − | <td></td> | + | <td>Gibt an, ob es sich um einen Vorzugsbegriff handelt</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 345: | Zeile 265: | ||
<td>65535</td> | <td>65535</td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
| − | <td></td> | + | <td>Der Begriff selbst</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 352: | Zeile 272: | ||
<td>50</td> | <td>50</td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
| − | <td></td> | + | <td>Abkürzung des Begriffs</td> |
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level4">code_system_concept_translation</td> | <td id="param_level4">code_system_concept_translation</td> | ||
| − | <td></td> | + | <td>code_system_concept_translation</td> |
<td></td> <td id="cardinality_cell">0..N</td> | <td></td> <td id="cardinality_cell">0..N</td> | ||
<td>Übersetzung eines Begriffs.</td> | <td>Übersetzung eines Begriffs.</td> | ||
| Zeile 364: | Zeile 284: | ||
<td>Long</td> | <td>Long</td> | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
<td></td> | <td></td> | ||
</tr> | </tr> | ||
| Zeile 376: | Zeile 290: | ||
<td>Long</td> | <td>Long</td> | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
| − | <td></td> | + | <td>Sprache der Übersetzung. Der Wert kommt von Domain-Value mit der Domain-ID 1 (ISO_639_1_Language_Codes)</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 383: | Zeile 297: | ||
<td>65535</td> | <td>65535</td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
| − | <td></td> | + | <td>Übersetzter Begriff</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 390: | Zeile 304: | ||
<td>50</td> | <td>50</td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
| − | <td></td> | + | <td>Abkürzung des übersetzten Begriffs</td> |
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level3">property</td> | <td id="param_level3">property</td> | ||
| − | <td></td> | + | <td>property</td> |
<td></td> <td id="cardinality_cell">0..N</td> | <td></td> <td id="cardinality_cell">0..N</td> | ||
<td></td> | <td></td> | ||
| Zeile 408: | Zeile 322: | ||
<td>Long</td> | <td>Long</td> | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
<td></td> | <td></td> | ||
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level4">property_version</td> | <td id="param_level4">property_version</td> | ||
| − | <td></td> | + | <td>property_version</td> |
<td></td> <td id="cardinality_cell">1..N</td> | <td></td> <td id="cardinality_cell">1..N</td> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
<td></td> | <td></td> | ||
</tr> | </tr> | ||
| Zeile 485: | Zeile 386: | ||
<td>Long</td> | <td>Long</td> | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
<td></td> | <td></td> | ||
</tr> | </tr> | ||
| Zeile 519: | Zeile 414: | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level2">code_system_version_entity_membership</td> | <td id="param_level2">code_system_version_entity_membership</td> | ||
| − | <td></td> | + | <td>code_system_version_entity_membership</td> |
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
<td>Stellt die Verknüpfung zwischen einer Codesystem-Version und den Entitäten her.</td> | <td>Stellt die Verknüpfung zwischen einer Codesystem-Version und den Entitäten her.</td> | ||
Version vom 18. Juni 2013, 11:59 Uhr
| 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>
