Terminologieserver - Authoring - RemoveTerminologyOrConcept
Aus Termserver-CTS2
zurück zur Webservice-Übersicht
Inhaltsverzeichnis |
Beschreibung
Removes a terminology, value set or a single concept.
Request/Response
Request
| Level | Parameter | Typ | Länge | Kardinalität | Beschreibung |
|---|---|---|---|---|---|
| 1 | deleteInfo | DeleteInfo | 1..1 | Specifies the object which should be deleted. | |
| 2 | type | 1..1 | { CODE_SYSTEM, CODE_SYSTEM_VERSION, VALUE_SET, VALUE_SET_VERSION, CODE_SYSTEM_ENTITY_VERSION} | ||
| 2 | codeSystem | code_system | 0..1 | Name of codesystem. Each codesystem requires at least one version. | |
| 3 | id | Long | 1..1 | Internal ID = Primary Key of Code System | |
| 3 | codeSystemVersion | code_system_version | 0..1 | Version of a Code System | |
| 4 | versionId | Long | 1..1 | ||
| 2 | codeSystemEntityVersion | code_system_entity_version | 0..1 | code_system_entity_version is the superclass of every Concept and Association. | |
| 3 | versionId | Long | 1..1 | The ID of this entry. | |
| 2 | valueSet | value_set | 0..1 | A subset of terms.Every valueset has at least one valueset-version. | |
| 3 | id | Long | 1..1 | ID of the valueset. | |
| 3 | valueSetVersion | value_set_version | 0..1 | Represents the version of an valueset. | |
| 4 | versionId | Long | 1..1 | Version ID of the value set | |
| 1 | loginToken | String | 1..1 | Login-Token that ensures the user is logged in. |
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
Delete a complete codesystem with all versions
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:aut="http://authoring.ws.terminologie.fhdo.de/"> <soapenv:Header/> <soapenv:Body> <aut:RemoveTerminologyOrConcept> <parameter> <deleteInfo> <codeSystem> <id>139</id> </codeSystem> <type>CODE_SYSTEM</type> </deleteInfo> <loginToken>97a9b711-91f7-4c0b-adab-f8d7f7a32e2c</loginToken> </parameter> </aut:RemoveTerminologyOrConcept> </soapenv:Body> </soapenv:Envelope>
Delete a value set with all versions
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:aut="http://authoring.ws.terminologie.fhdo.de/"> <soapenv:Header/> <soapenv:Body> <aut:RemoveTerminologyOrConcept> <parameter> <deleteInfo> <type>VALUE_SET</type> <valueSet> <id>5</id> </valueSet> </deleteInfo> <loginToken>583c602b-780d-4bc6-896d-fdce493e6317</loginToken> </parameter> </aut:RemoveTerminologyOrConcept> </soapenv:Body> </soapenv:Envelope>
