WS-Beschreibung - Terminologieserver Authoring CreateValueSet
Aus Termserver-CTS2
Inhaltsverzeichnis |
Functionality
Creates a new value set and its first version. If a value set id is specified in request parameter, a new value set version will be created 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) | |
| 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. |
| name | String | 50 | 1..1 | Name of the valueset. |
| value_set_version | value_set_version | 0..1 | 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. |
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 | ||
| value_set | value_set | 1..1 | A subset of terms.Every valueset has at least one valueset-version. | |
| id | Long | 1..1 | ID of the valueset. | |
| value_set_version | value_set_version | 1..1 | 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. | |
| versionId | Long | 1..1 | Version ID of the value set |
Annotations
Noteworthiness
Hints
Examples
SOAP messages
A simple SOAP message to create a new value set and its first version.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:aut="http://authoring.ws.terminologie.fhdo.de/"> <soapenv:Header/> <soapenv:Body> <aut:CreateValueSet> <parameter> <valueSet> <name>Test VS 1</name> <valueSetVersions> <name>Test VS Version 1</name> </valueSetVersions> </valueSet> <login> <sessionID>xxxyyyzzz</sessionID> </login> </parameter> </aut:CreateValueSet> </soapenv:Body> </soapenv:Envelope>
