WS-Beschreibung - Terminologieserver Authoring CreateCodeSystem
Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Becker (Diskussion | Beiträge) (→Request/Response) |
Becker (Diskussion | Beiträge) (→Request/Response) |
||
Zeile 106: | Zeile 106: | ||
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
− | <td id=" | + | <td id="param_level2">code_system_version</td> |
<td></td> | <td></td> | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
Zeile 112: | Zeile 112: | ||
</tr> | </tr> | ||
<tr id="gray"> | <tr id="gray"> | ||
− | <td id=" | + | <td id="param_level3">codeSystemId</td> |
<td>Long</td> | <td>Long</td> | ||
<td></td> <td id="cardinality_cell">-</td> | <td></td> <td id="cardinality_cell">-</td> | ||
Zeile 118: | Zeile 118: | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td id=" | + | <td id="param_level3">description</td> |
<td>String</td> | <td>String</td> | ||
<td>65535</td> | <td>65535</td> | ||
Zeile 125: | Zeile 125: | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td id=" | + | <td id="param_level3">expirationDate</td> |
<td>java.util.Date</td> | <td>java.util.Date</td> | ||
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
Zeile 131: | Zeile 131: | ||
</tr> | </tr> | ||
<tr id="gray"> | <tr id="gray"> | ||
− | <td id=" | + | <td id="param_level3">insertTimestamp</td> |
<td>java.util.Date</td> | <td>java.util.Date</td> | ||
<td></td> <td id="cardinality_cell">-</td> | <td></td> <td id="cardinality_cell">-</td> | ||
Zeile 137: | Zeile 137: | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td id=" | + | <td id="param_level3">licenceHolder</td> |
<td>String</td> | <td>String</td> | ||
<td>65535</td> | <td>65535</td> | ||
Zeile 144: | Zeile 144: | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td id=" | + | <td id="param_level3">name</td> |
<td>String</td> | <td>String</td> | ||
<td>100</td> | <td>100</td> | ||
Zeile 151: | Zeile 151: | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td id=" | + | <td id="param_level3">oid</td> |
<td>String</td> | <td>String</td> | ||
<td>100</td> | <td>100</td> | ||
Zeile 158: | Zeile 158: | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td id=" | + | <td id="param_level3">preferredLanguageId</td> |
<td>Long</td> | <td>Long</td> | ||
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
Zeile 164: | Zeile 164: | ||
</tr> | </tr> | ||
<tr id="gray"> | <tr id="gray"> | ||
− | <td id=" | + | <td id="param_level3">previousVersionID</td> |
<td>Long</td> | <td>Long</td> | ||
<td></td> <td id="cardinality_cell">-</td> | <td></td> <td id="cardinality_cell">-</td> | ||
Zeile 170: | Zeile 170: | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td id=" | + | <td id="param_level3">releaseDate</td> |
<td>java.util.Date</td> | <td>java.util.Date</td> | ||
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
Zeile 176: | Zeile 176: | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td id=" | + | <td id="param_level3">source</td> |
<td>String</td> | <td>String</td> | ||
<td>65535</td> | <td>65535</td> | ||
Zeile 182: | Zeile 182: | ||
<td></td> | <td></td> | ||
</tr> | </tr> | ||
− | <tr | + | <tr> |
− | <td id=" | + | <td id="param_level3">status</td> |
<td>Integer</td> | <td>Integer</td> | ||
− | <td></td> <td id="cardinality_cell"> | + | <td></td> <td id="cardinality_cell">0..1</td> |
<td></td> | <td></td> | ||
</tr> | </tr> | ||
<tr id="gray"> | <tr id="gray"> | ||
− | <td id=" | + | <td id="param_level3">statusDate</td> |
<td>java.util.Date</td> | <td>java.util.Date</td> | ||
<td></td> <td id="cardinality_cell">-</td> | <td></td> <td id="cardinality_cell">-</td> | ||
Zeile 195: | Zeile 195: | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td id=" | + | <td id="param_level3">underLicence</td> |
<td>Boolean</td> | <td>Boolean</td> | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
Zeile 201: | Zeile 201: | ||
</tr> | </tr> | ||
<tr id="gray"> | <tr id="gray"> | ||
− | <td id=" | + | <td id="param_level3">versionId</td> |
<td>Long</td> | <td>Long</td> | ||
<td></td> <td id="cardinality_cell">-</td> | <td></td> <td id="cardinality_cell">-</td> | ||
Zeile 286: | Zeile 286: | ||
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
− | <td id=" | + | <td id="param_level2">code_system_version</td> |
<td></td> | <td></td> | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
Zeile 292: | Zeile 292: | ||
</tr> | </tr> | ||
<tr id="gray"> | <tr id="gray"> | ||
− | <td id=" | + | <td id="param_level3">codeSystemId</td> |
<td>Long</td> | <td>Long</td> | ||
<td></td> <td id="cardinality_cell">-</td> | <td></td> <td id="cardinality_cell">-</td> | ||
Zeile 298: | Zeile 298: | ||
</tr> | </tr> | ||
<tr id="gray"> | <tr id="gray"> | ||
− | <td id=" | + | <td id="param_level3">description</td> |
<td>String</td> | <td>String</td> | ||
<td>65535</td> | <td>65535</td> | ||
Zeile 305: | Zeile 305: | ||
</tr> | </tr> | ||
<tr id="gray"> | <tr id="gray"> | ||
− | <td id=" | + | <td id="param_level3">expirationDate</td> |
<td>java.util.Date</td> | <td>java.util.Date</td> | ||
<td></td> <td id="cardinality_cell">-</td> | <td></td> <td id="cardinality_cell">-</td> | ||
Zeile 311: | Zeile 311: | ||
</tr> | </tr> | ||
<tr id="gray"> | <tr id="gray"> | ||
− | <td id=" | + | <td id="param_level3">insertTimestamp</td> |
<td>java.util.Date</td> | <td>java.util.Date</td> | ||
<td></td> <td id="cardinality_cell">-</td> | <td></td> <td id="cardinality_cell">-</td> | ||
Zeile 317: | Zeile 317: | ||
</tr> | </tr> | ||
<tr id="gray"> | <tr id="gray"> | ||
− | <td id=" | + | <td id="param_level3">licenceHolder</td> |
<td>String</td> | <td>String</td> | ||
<td>65535</td> | <td>65535</td> | ||
Zeile 324: | Zeile 324: | ||
</tr> | </tr> | ||
<tr id="gray"> | <tr id="gray"> | ||
− | <td id=" | + | <td id="param_level3">name</td> |
<td>String</td> | <td>String</td> | ||
<td>100</td> | <td>100</td> | ||
Zeile 331: | Zeile 331: | ||
</tr> | </tr> | ||
<tr id="gray"> | <tr id="gray"> | ||
− | <td id=" | + | <td id="param_level3">oid</td> |
<td>String</td> | <td>String</td> | ||
<td>100</td> | <td>100</td> | ||
Zeile 338: | Zeile 338: | ||
</tr> | </tr> | ||
<tr id="gray"> | <tr id="gray"> | ||
− | <td id=" | + | <td id="param_level3">preferredLanguageId</td> |
<td>Long</td> | <td>Long</td> | ||
<td></td> <td id="cardinality_cell">-</td> | <td></td> <td id="cardinality_cell">-</td> | ||
Zeile 344: | Zeile 344: | ||
</tr> | </tr> | ||
<tr id="gray"> | <tr id="gray"> | ||
− | <td id=" | + | <td id="param_level3">previousVersionID</td> |
<td>Long</td> | <td>Long</td> | ||
<td></td> <td id="cardinality_cell">-</td> | <td></td> <td id="cardinality_cell">-</td> | ||
Zeile 350: | Zeile 350: | ||
</tr> | </tr> | ||
<tr id="gray"> | <tr id="gray"> | ||
− | <td id=" | + | <td id="param_level3">releaseDate</td> |
<td>java.util.Date</td> | <td>java.util.Date</td> | ||
<td></td> <td id="cardinality_cell">-</td> | <td></td> <td id="cardinality_cell">-</td> | ||
Zeile 356: | Zeile 356: | ||
</tr> | </tr> | ||
<tr id="gray"> | <tr id="gray"> | ||
− | <td id=" | + | <td id="param_level3">source</td> |
<td>String</td> | <td>String</td> | ||
<td>65535</td> | <td>65535</td> | ||
Zeile 363: | Zeile 363: | ||
</tr> | </tr> | ||
<tr id="gray"> | <tr id="gray"> | ||
− | <td id=" | + | <td id="param_level3">status</td> |
<td>Integer</td> | <td>Integer</td> | ||
<td></td> <td id="cardinality_cell">-</td> | <td></td> <td id="cardinality_cell">-</td> | ||
Zeile 369: | Zeile 369: | ||
</tr> | </tr> | ||
<tr id="gray"> | <tr id="gray"> | ||
− | <td id=" | + | <td id="param_level3">statusDate</td> |
<td>java.util.Date</td> | <td>java.util.Date</td> | ||
<td></td> <td id="cardinality_cell">-</td> | <td></td> <td id="cardinality_cell">-</td> | ||
Zeile 375: | Zeile 375: | ||
</tr> | </tr> | ||
<tr id="gray"> | <tr id="gray"> | ||
− | <td id=" | + | <td id="param_level3">underLicence</td> |
<td>Boolean</td> | <td>Boolean</td> | ||
<td></td> <td id="cardinality_cell">-</td> | <td></td> <td id="cardinality_cell">-</td> | ||
Zeile 381: | Zeile 381: | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td id=" | + | <td id="param_level3">versionId</td> |
<td>Long</td> | <td>Long</td> | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> |
Version vom 23. März 2012, 12:17 Uhr
System | Terminologieserver |
Webservice | Authoring |
WSDL | http://www.term.mi.fh-dortmund.de:8080/Terminologieserver/Authoring?wsdl |
Methode | CreateCodeSystem |
Inhaltsverzeichnis |
Funktionalität
Anlegen neuer Vokabulare und deren erste Version. Falls im Parameter eine Vokabular-ID angegeben wurde und diese in der Datenbank schon vergeben ist, wird nur eine neue Vokabular-Version angelegt.
Vorbedingungen
Erfordert Login.
Request/Response
Request
Parameter | Typ | Länge | Kardinalität | Beschreibung |
---|---|---|---|---|
LoginType | 0..1 | |||
ip | String | - | ||
password | String | - | ||
sessionID | String | 1..1 | ||
username | String | - | ||
code_system | 1..1 | |||
currentVersionId | Long | - | ||
description | String | 65535 | 0..1 | |
id | Long | 0..1 | Id eines bestehenden Vokabulars | |
insertTimestamp | java.util.Date | - | ||
name | String | 100 | 1..1 | Name des neuen Vokabulars. Wird ignoriert falls eine id vergeben wurde, die auch in der Datenbank vorhanden ist. |
code_system_version | 1..1 | |||
codeSystemId | Long | - | ||
description | String | 65535 | 0..1 | |
expirationDate | java.util.Date | 0..1 | ||
insertTimestamp | java.util.Date | - | ||
licenceHolder | String | 65535 | 0..1 | |
name | String | 100 | 1..1 | |
oid | String | 100 | 0..1 | |
preferredLanguageId | Long | 0..1 | ||
previousVersionID | Long | - | ||
releaseDate | java.util.Date | 0..1 | ||
source | String | 65535 | 0..1 | |
status | Integer | 0..1 | ||
statusDate | java.util.Date | - | ||
underLicence | Boolean | 1..1 | ||
versionId | Long | - |
Response
Parameter | Typ | Länge | Kardinalität | Beschreibung |
---|---|---|---|---|
ReturnType | 1..1 | |||
count | Integer | 1..1 | ||
message | String | 1..1 | ||
overallErrorCategory | 1..1 | INFO, WARN, ERROR | ||
status | 1..1 | OK, FAILURE | ||
code_system | 1..1 | |||
currentVersionId | Long | 1..1 | ||
description | String | 65535 | - | |
id | Long | 1..1 | ||
insertTimestamp | java.util.Date | - | ||
name | String | 100 | - | |
code_system_version | 1..1 | |||
codeSystemId | Long | - | ||
description | String | 65535 | - | |
expirationDate | java.util.Date | - | ||
insertTimestamp | java.util.Date | - | ||
licenceHolder | String | 65535 | - | |
name | String | 100 | - | |
oid | String | 100 | - | |
preferredLanguageId | Long | - | ||
previousVersionID | Long | - | ||
releaseDate | java.util.Date | - | ||
source | String | 65535 | - | |
status | Integer | - | ||
statusDate | java.util.Date | - | ||
underLicence | Boolean | - | ||
versionId | Long | 1..1 |
Anmerkungen
Besonderheiten
Hinweise
Beispiele
SOAP-Nachrichten
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:aut="http://authoring.ws.terminologie.fhdo.de/"> <soapenv:Header/> <soapenv:Body> <aut:CreateCodeSystem> <parameter> <codeSystem> <name>Test Vok 1</name> <codeSystemVersions> <name>Test Vok Version 1</name> </codeSystemVersions> </codeSystem> <login> <sessionID> AbcdefghijklmnopqrstuvwxyZ </sessionID> </login> </parameter> </aut:CreateCodeSystem> </soapenv:Body> </soapenv:Envelope>