WS-Beschreibung - Terminologieserver Authoring UpdateValueSetStatus
Aus Termserver-CTS2
Inhaltsverzeichnis |
Functionality
Edits the status of a value set or value set version.
Prerequisites
Requires Login.
Request/Response
Request
Parameter | Typ | Länge | Kardinalität | Beschreibung |
---|---|---|---|---|
LoginType | LoginType | 1..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. | |
id | Long | 1..1 | ID of the valueset. | |
status | Integer | 0..1 | Status of the current entry. Can be found in a domain. The status is changed, if he is listed. | |
value_set_version | value_set_version | 0..1 | Represents the version of an valueset. | |
status | Integer | 1..1 | The status of the current entry. Can be found in a domain. | |
versionId | Long | 1..1 | Version ID of the value set |
Response
Parameter | Typ | Länge | Kardinalität | Beschreibung |
---|---|---|---|---|
ReturnType | ReturnType | 1..1 | Return information | |
count | Integer | 1..1 | number of results | |
message | String | 1..1 | an additional message | |
overallErrorCategory | 1..1 | INFO, WARN, ERROR | ||
status | 1..1 | OK, FAILURE |
Annotations
Noteworthiness
Hints
Examples
SOAP messages
<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> <login> <sessionID>xxx</sessionID> </login> </parameter> </aut:UpdateValueSetStatus> </soapenv:Body> </soapenv:Envelope>