WS-Beschreibung - Terminologieserver Authoring MaintainValueSet
Aus Termserver-CTS2
Inhaltsverzeichnis |
Functionality
Creates a new value set version or edits an existing one.
Prerequisites
Requires (Login).
Request/Response
Request
| Parameter | Typ | Länge | Kardinalität | Beschreibung |
|---|---|---|---|---|
| LoginType | LoginType | 0..1 | Login information | |
| password | String | 1..1 | password from user (as MD5-hash) | |
| 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 | |
| value_set | value_set | 1..1 | A subset of terms.Every valueset has at least one valueset-version. | |
| description | String | 65535 | 0..1 | Description of the valueset. |
| id | Long | 1..1 | ID of the valueset. | |
| name | String | 50 | 1..1 | Name of the valueset. |
| value_set_version | value_set_version | - | Represents the version of an valueset. | |
| preferredLanguageId | Long | 0..1 | The preferred langue of the code system. (The ID has to be taken from the domain 'ISO_639_1_Language_Codes' - ID 1) | |
| releaseDate | java.util.Date | 0..1 | Start date for the validity of the valueset version. | |
| status | Integer | 0..1 | The status of the current entry. Can be found in a domain. | |
| versionId | Long | 1..1 | Only mandatory, if no new version is put on. |
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:MaintainValueSet> <parameter> <valueSet> <id>1</id> <valueSetVersions> <versionId>1</versionId> <name>Changed Versionname</name> </valueSetVersions> </valueSet> <versioning> <createNewVersion>1</createNewVersion> </versioning> <login> <sessionID>xxx</sessionID> </login> </parameter> </aut:MaintainValueSet> </soapenv:Body> </soapenv:Envelope>
