WS-Beschreibung - Terminologieserver Authoring CreateCodeSystem
Aus Termserver-CTS2
Inhaltsverzeichnis |
Functionality
Creates a new code system and its first code system version. If the parameter codeSystemId is set and a code system with this id already exists, only a new version will be added instead.
Prerequisites
Requires 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 |
Annotations
Noteworthiness
Hints
Examples
SOAP messages
<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>
