WS-Beschreibung - Terminologieserver Authoring CreateCodeSystem
Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Becker (Diskussion | Beiträge) |
Becker (Diskussion | Beiträge) (→Request/Response) |
||
| Zeile 17: | Zeile 17: | ||
<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> | + | <td>Login information</td> |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 40: | Zeile 26: | ||
<td></td> | <td></td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
| − | <td> | + | <td>Session-ID from user (given by system)</td> |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level1">code_system</td> | <td id="param_level1">code_system</td> | ||
| − | <td></td> | + | <td>code_system</td> |
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
| − | <td> | + | <td>Name of codesystem. Each codesystem requires at least one version.</td> |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 66: | Zeile 39: | ||
<td>65535</td> | <td>65535</td> | ||
<td id="cardinality_cell">0..1</td> | <td id="cardinality_cell">0..1</td> | ||
| − | <td></td> | + | <td>Narrative description of Code System</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 72: | Zeile 45: | ||
<td>Long</td> | <td>Long</td> | ||
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
| − | <td>Id | + | <td>Id of an existing vocabulary</td> |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 85: | Zeile 52: | ||
<td>100</td> | <td>100</td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
| − | <td>Name | + | <td>Name of the new vocabulary. It is ignored if id was taken which also exists in the data bank.</td> |
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level2">code_system_version</td> | <td id="param_level2">code_system_version</td> | ||
| − | <td></td> | + | <td>code_system_version</td> |
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
| − | <td> | + | <td>Version of a Code System</td> |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 104: | Zeile 65: | ||
<td>65535</td> | <td>65535</td> | ||
<td id="cardinality_cell">0..1</td> | <td id="cardinality_cell">0..1</td> | ||
| − | <td></td> | + | <td>Description of the Code System</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 110: | Zeile 71: | ||
<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> | ||
| − | <td> | + | <td>Point of time the Code System looses its validity.</td> |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 123: | Zeile 78: | ||
<td>65535</td> | <td>65535</td> | ||
<td id="cardinality_cell">0..1</td> | <td id="cardinality_cell">0..1</td> | ||
| − | <td></td> | + | <td>Owner of the licence.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 130: | Zeile 85: | ||
<td>100</td> | <td>100</td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
| − | <td></td> | + | <td>Complete Name of the Code System.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 137: | Zeile 92: | ||
<td>100</td> | <td>100</td> | ||
<td id="cardinality_cell">0..1</td> | <td id="cardinality_cell">0..1</td> | ||
| − | <td></td> | + | <td>Official OID</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 143: | Zeile 98: | ||
<td>Long</td> | <td>Long</td> | ||
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
| − | <td> | + | <td>Preferred language of the Code System ( ID has to be taken from domain 'ISO_639_1_Language_Codes' with ID 1)</td> |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 155: | Zeile 104: | ||
<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> | ||
| − | <td></td> | + | <td>Point of time, when this version starts to be valid.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 162: | Zeile 111: | ||
<td>65535</td> | <td>65535</td> | ||
<td id="cardinality_cell">0..1</td> | <td id="cardinality_cell">0..1</td> | ||
| − | <td></td> | + | <td>Source of the Code System Version</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 168: | Zeile 117: | ||
<td>Integer</td> | <td>Integer</td> | ||
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
| − | <td> | + | <td>Status of the current entry. Can be taken from a domain.</td> |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 180: | Zeile 123: | ||
<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>true, if Code System is under license (Code System will be invisible for all users without proper license)</td> |
</tr> | </tr> | ||
| − | <tr | + | <tr> |
| − | <td id="param_level3"> | + | <td id="param_level3">validityRange</td> |
| − | <td> | + | <td>String</td> |
| − | <td></td> | + | <td>30</td> |
| − | <td></td> | + | <td id="cardinality_cell">1..1</td> |
| + | <td>Validity range, Values from domain list "codesystem_validityrange". | ||
| + | Standard: 1 (required), 2 (recomended), 3 (limited), 4 (optional)</td> | ||
</tr> | </tr> | ||
</table> | </table> | ||
| Zeile 200: | Zeile 145: | ||
<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>Return information</td> |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 215: | Zeile 154: | ||
<td></td> | <td></td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
| − | <td></td> | + | <td>an additional message</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 231: | Zeile 170: | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level1">code_system</td> | <td id="param_level1">code_system</td> | ||
| − | <td></td> | + | <td>code_system</td> |
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
| − | <td></td> | + | <td>Name of codesystem. Each codesystem requires at least one version.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 239: | Zeile 178: | ||
<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>Version of the Code System</td> |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 252: | Zeile 184: | ||
<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>Internal ID = Primary Key of Code System</td> |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level2">code_system_version</td> | <td id="param_level2">code_system_version</td> | ||
| − | <td></td> | + | <td>code_system_version</td> |
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
| − | <td> | + | <td>Version of a Code System</td> |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
Version vom 9. August 2013, 08:33 Uhr
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 | LoginType | 0..1 | Login information | |
| sessionID | String | 1..1 | Session-ID from user (given by system) | |
| code_system | code_system | 1..1 | Name of codesystem. Each codesystem requires at least one version. | |
| description | String | 65535 | 0..1 | Narrative description of Code System |
| id | Long | 0..1 | Id of an existing vocabulary | |
| name | String | 100 | 1..1 | Name of the new vocabulary. It is ignored if id was taken which also exists in the data bank. |
| code_system_version | code_system_version | 1..1 | Version of a Code System | |
| description | String | 65535 | 0..1 | Description of the Code System |
| expirationDate | java.util.Date | 0..1 | Point of time the Code System looses its validity. | |
| licenceHolder | String | 65535 | 0..1 | Owner of the licence. |
| name | String | 100 | 1..1 | Complete Name of the Code System. |
| oid | String | 100 | 0..1 | Official OID |
| preferredLanguageId | Long | 0..1 | Preferred language of the Code System ( ID has to be taken from domain 'ISO_639_1_Language_Codes' with ID 1) | |
| releaseDate | java.util.Date | 0..1 | Point of time, when this version starts to be valid. | |
| source | String | 65535 | 0..1 | Source of the Code System Version |
| status | Integer | 0..1 | Status of the current entry. Can be taken from a domain. | |
| underLicence | Boolean | 1..1 | true, if Code System is under license (Code System will be invisible for all users without proper license) | |
| validityRange | String | 30 | 1..1 | Validity range, Values from domain list "codesystem_validityrange". Standard: 1 (required), 2 (recomended), 3 (limited), 4 (optional) |
Response
| Parameter | Typ | Länge | Kardinalität | Beschreibung |
|---|---|---|---|---|
| ReturnType | ReturnType | 1..1 | Return information | |
| message | String | 1..1 | an additional message | |
| overallErrorCategory | 1..1 | INFO, WARN, ERROR | ||
| status | 1..1 | OK, FAILURE | ||
| code_system | code_system | 1..1 | Name of codesystem. Each codesystem requires at least one version. | |
| currentVersionId | Long | 1..1 | Version of the Code System | |
| id | Long | 1..1 | Internal ID = Primary Key of Code System | |
| code_system_version | code_system_version | 1..1 | Version of a Code System | |
| 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>
