Terminologieserver - Authoring - CreateValueSet
Aus Termserver-CTS2
(Unterschied zwischen Versionen)
(automatisch erstellt vom Webservice-Schnittstellen-Tool) |
(automatisch erstellt vom Webservice-Schnittstellen-Tool) |
||
| Zeile 1: | Zeile 1: | ||
[[Terminologieserver - Webservice Dokumentation|zurück zur Webservice-Übersicht]]<br><br> | [[Terminologieserver - Webservice Dokumentation|zurück zur Webservice-Übersicht]]<br><br> | ||
| + | =Beschreibung= | ||
| + | Create 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.<br> | ||
=Request/Response= | =Request/Response= | ||
==Request== | ==Request== | ||
| Zeile 49: | Zeile 51: | ||
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
<td>Represents the version of an valueset.</td> | <td>Represents the version of an valueset.</td> | ||
| + | </tr> | ||
| + | <tr> | ||
| + | <td id="cardinality_cell">3</td> | ||
| + | <td id="param_level3">name</td> | ||
| + | <td>String</td> | ||
| + | <td></td> | ||
| + | <td id="cardinality_cell">0..1</td> | ||
| + | <td></td> | ||
| + | </tr> | ||
| + | <tr> | ||
| + | <td id="cardinality_cell">3</td> | ||
| + | <td id="param_level3">oid</td> | ||
| + | <td>String</td> | ||
| + | <td></td> | ||
| + | <td id="cardinality_cell">0..1</td> | ||
| + | <td></td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 64: | Zeile 82: | ||
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
<td>Start date for the validity of the valueset version.</td> | <td>Start date for the validity of the valueset version.</td> | ||
| + | </tr> | ||
| + | <tr> | ||
| + | <td id="cardinality_cell">3</td> | ||
| + | <td id="param_level3">validityRange</td> | ||
| + | <td>Long</td> | ||
| + | <td></td> <td id="cardinality_cell">0..1</td> | ||
| + | <td>Validity range (German: Gültigkeitsbereich)</td> | ||
</tr> | </tr> | ||
</table> | </table> | ||
| Zeile 79: | Zeile 104: | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="cardinality_cell">1</td> | <td id="cardinality_cell">1</td> | ||
| − | <td id="param_level1"> | + | <td id="param_level1">returnInfos</td> |
<td>ReturnType</td> | <td>ReturnType</td> | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
| Zeile 150: | Zeile 175: | ||
</tr> | </tr> | ||
</table> | </table> | ||
| + | =Beispiele= | ||
| + | ==SOAP== | ||
| + | ===Create a simple new value set=== | ||
| + | <source lang="xml"> | ||
| + | <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> | ||
| + | <loginToken>237b6ee6-a448-4b91-8210-a896bf50258a</loginToken> | ||
| + | </parameter> | ||
| + | </aut:CreateValueSet> | ||
| + | </soapenv:Body> | ||
| + | </soapenv:Envelope> | ||
| + | </source> | ||
<br><br> | <br><br> | ||
[[Terminologieserver - Webservice Dokumentation|zurück zur Webservice-Übersicht]] | [[Terminologieserver - Webservice Dokumentation|zurück zur Webservice-Übersicht]] | ||
Version vom 23. Juli 2014, 10:09 Uhr
zurück zur Webservice-Übersicht
Inhaltsverzeichnis |
Beschreibung
Create 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.
Request/Response
Request
| Level | Parameter | Typ | Länge | Kardinalität | Beschreibung |
|---|---|---|---|---|---|
| 1 | loginToken | String | 1..1 | Login-Token that ensures the user is logged in. | |
| 1 | valueSet | value_set | 1..1 | A subset of terms.Every valueset has at least one valueset-version. | |
| 2 | description | String | 65535 | 0..1 | Description of the valueset. |
| 2 | name | String | 50 | 1..1 | Name of the valueset. |
| 2 | valueSetVersion | value_set_version | 0..1 | Represents the version of an valueset. | |
| 3 | name | String | 0..1 | ||
| 3 | oid | String | 0..1 | ||
| 3 | preferredLanguageCd | String | 30 | 0..1 | Preferred language of value set version. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...) |
| 3 | releaseDate | java.util.Date | 0..1 | Start date for the validity of the valueset version. | |
| 3 | validityRange | Long | 0..1 | Validity range (German: Gültigkeitsbereich) |
Response
| Level | Parameter | Typ | Länge | Kardinalität | Beschreibung |
|---|---|---|---|---|---|
| 1 | returnInfos | ReturnType | 1..1 | Return information | |
| 2 | message | String | 1..1 | an additional message | |
| 2 | overallErrorCategory | 1..1 | INFO, WARN, ERROR | ||
| 2 | status | 1..1 | OK, FAILURE | ||
| 1 | valueSet | value_set | 1..1 | A subset of terms.Every valueset has at least one valueset-version. | |
| 2 | id | Long | 1..1 | ID of the valueset. | |
| 2 | valueSetVersion | value_set_version | 1..1 | Represents the version of an valueset. | |
| 3 | preferredLanguageCd | String | 30 | 0..1 | Preferred language of value set version. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...) |
| 3 | releaseDate | java.util.Date | 0..1 | Start date for the validity of the valueset version. | |
| 3 | versionId | Long | 1..1 | Version ID of the value set |
Beispiele
SOAP
Create a simple new value set
<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> <loginToken>237b6ee6-a448-4b91-8210-a896bf50258a</loginToken> </parameter> </aut:CreateValueSet> </soapenv:Body> </soapenv:Envelope>
