WS-Beschreibung - Terminologieserver Authoring MaintainCodeSystemVersion
Aus Termserver-CTS2
Inhaltsverzeichnis |
Functionality
Creates a new code system version or edits an existing one.
Prerequisites
Requires Login.
Request/Response
The required request parameters differs for creating a new version and editing an existing one. The request and response table below refers to the creation of a new version only.
Required fields: new version
- name
Required fields: edit version
- versionId
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) | |
| VersioningType | VersioningType | 1..1 | Versioning information | |
| createNewVersion | Boolean | 1..1 | true if a new version should be created | |
| majorUpdate | Boolean | 0..1 | true if major version should count up | |
| minorUpdate | Boolean | 0..1 | true if minor version should count up | |
| 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 | If the name of the Vokabulsars should be changed, the Id must be given. | |
| name | String | 100 | 0..1 | see Id |
| code_system_version | code_system_version | - | 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 | It must not be listed, if an existing version is worked on. |
| 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 |
| underLicence | Boolean | 0..1 | true, if Code System is under license (Code System will be invisible for all users without proper license) | |
| validityRange | String | 30 | 0..1 | Validity range, Values from domain list "codesystem_validityrange". Standard: 1 (required), 2 (recomended), 3 (limited), 4 (optional) |
| versionId | Long | 1..1 |
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 |
Annotations
Noteworthiness
Hints
Examples
SOAP messages
Minimal SOAP message
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:aut="http://authoring.ws.terminologie.fhdo.de/"> <soapenv:Header/> <soapenv:Body> <aut:MaintainCodeSystemVersion> <parameter> <codeSystem> <codeSystemVersions> <versionId>1</versionId> <name>Name der neuen Version</name> </codeSystemVersions> <id>1</id> </codeSystem> <login> <sessionID>xxx</sessionID> </login> <versioning> <createNewVersion>1</createNewVersion> </versioning> </parameter> </aut:MaintainCodeSystemVersion> </soapenv:Body> </soapenv:Envelope>
