Terminologieserver - Authoring - UpdateValueSetStatus
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= | ||
| + | Edit the status of a value set or value set version. <br> | ||
=Request/Response= | =Request/Response= | ||
==Request== | ==Request== | ||
| Zeile 77: | Zeile 79: | ||
<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 112: | Zeile 114: | ||
</tr> | </tr> | ||
</table> | </table> | ||
| + | =Beispiele= | ||
| + | ==SOAP== | ||
| + | ===Update status=== | ||
| + | <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:UpdateValueSetStatus> | ||
| + | <parameter> | ||
| + | <valueSet> | ||
| + | <status>1</status> | ||
| + | <id>1</id> | ||
| + | <valueSetVersions> | ||
| + | <versionId>4</versionId> | ||
| + | <status>1</status> | ||
| + | </valueSetVersions> | ||
| + | </valueSet> | ||
| + | <loginToken>237b6ee6-a448-4b91-8210-a896bf50258a</loginToken> | ||
| + | </parameter> | ||
| + | </aut:UpdateValueSetStatus> | ||
| + | </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
Edit the status of a value set or value set version.
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 | id | Long | 1..1 | ID of the valueset. | |
| 2 | status | Integer | 0..1 | Status of the current entry. Can be found in a domain. The status is changed, if he is listed. | |
| 2 | valueSetVersion | value_set_version | 0..1 | Represents the version of an valueset. | |
| 3 | status | Integer | 1..1 | The status of the current entry. Can be found in a domain. | |
| 3 | versionId | Long | 1..1 | Version ID of the value set |
Response
| Level | Parameter | Typ | Länge | Kardinalität | Beschreibung |
|---|---|---|---|---|---|
| 1 | returnInfos | ReturnType | 1..1 | Return information | |
| 2 | count | Integer | 1..1 | number of results | |
| 2 | message | String | 1..1 | an additional message | |
| 2 | overallErrorCategory | 1..1 | INFO, WARN, ERROR | ||
| 2 | status | 1..1 | OK, FAILURE |
Beispiele
SOAP
Update status
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:aut="http://authoring.ws.terminologie.fhdo.de/"> <soapenv:Header/> <soapenv:Body> <aut:UpdateValueSetStatus> <parameter> <valueSet> <status>1</status> <id>1</id> <valueSetVersions> <versionId>4</versionId> <status>1</status> </valueSetVersions> </valueSet> <loginToken>237b6ee6-a448-4b91-8210-a896bf50258a</loginToken> </parameter> </aut:UpdateValueSetStatus> </soapenv:Body> </soapenv:Envelope>
