Terminologieserver - Authoring - RemoveTerminologyOrConcept

Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
(automatisch erstellt vom Webservice-Schnittstellen-Tool)
 
(automatisch erstellt vom Webservice-Schnittstellen-Tool)
 
(Eine dazwischenliegende Version von einem Benutzer wird nicht angezeigt)
Zeile 2: Zeile 2:
  
 
=Beschreibung=
 
=Beschreibung=
−
ELGA specific<br>
+
Removes a terminology, value set or a single concept.<br>
 
=Request/Response=
 
=Request/Response=
 
==Request==
 
==Request==
Zeile 14: Zeile 14:
 
     <th>Beschreibung</th>
 
     <th>Beschreibung</th>
 
   </tr>
 
   </tr>
 +
<tr id="row_object">
 +
  <td id="cardinality_cell">1</td>
 +
  <td id="param_level1">deleteInfo</td>
 +
  <td>DeleteInfo</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Specifies the object which should be deleted.</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">type</td>
 +
  <td></td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>{ CODE_SYSTEM, CODE_SYSTEM_VERSION, VALUE_SET, VALUE_SET_VERSION, CODE_SYSTEM_ENTITY_VERSION}</td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">codeSystem</td>
 +
  <td>code_system</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>Name of codesystem. Each codesystem requires at least one version.</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">id</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Internal ID = Primary Key of Code System</td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">codeSystemVersion</td>
 +
  <td>code_system_version</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>Version of a Code System</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">4</td>
 +
  <td id="param_level4">versionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">codeSystemEntityVersion</td>
 +
  <td>code_system_entity_version</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>code_system_entity_version is the superclass of every Concept and Association.  </td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">versionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>The ID of this entry.</td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">valueSet</td>
 +
  <td>value_set</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>A subset of terms.Every valueset has at least one valueset-version.</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">id</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>ID of the valueset.</td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">valueSetVersion</td>
 +
  <td>value_set_version</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>Represents  the version of an valueset.</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">4</td>
 +
  <td id="param_level4">versionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Version ID of the value set</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">1</td>
 +
  <td id="param_level1">loginToken</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Login-Token that ensures the user is logged in.</td>
 +
</tr>
 
</table>
 
</table>
 
<br>
 
<br>
Zeile 26: Zeile 118:
 
     <th>Beschreibung</th>
 
     <th>Beschreibung</th>
 
   </tr>
 
   </tr>
 +
<tr id="row_object">
 +
  <td id="cardinality_cell">1</td>
 +
  <td id="param_level1">returnInfos</td>
 +
  <td>ReturnType</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Return information</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">count</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>number of results</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">message</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>an additional message</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">overallErrorCategory</td>
 +
  <td></td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>INFO, WARN, ERROR</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">status</td>
 +
  <td></td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>OK, FAILURE</td>
 +
</tr>
 
</table>
 
</table>
 +
=Beispiele=
 +
==SOAP==
 +
===Delete a complete codesystem with all versions===
 +
<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: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>
 +
</source>
 +
===Delete a value set with all versions===
 +
<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: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>
 +
</source>
 
<br><br>
 
<br><br>
  
 
[[Terminologieserver - Webservice Dokumentation|zurück zur Webservice-Übersicht]]
 
[[Terminologieserver - Webservice Dokumentation|zurück zur Webservice-Übersicht]]

Aktuelle Version vom 30. September 2014, 12:31 Uhr

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>



zurück zur Webservice-Übersicht

Von „http://www.wiki.mi.fh-dortmund.de/cts2/index.php?title=Terminologieserver_-_Authoring_-_RemoveTerminologyOrConcept“
Meine Werkzeuge
Namensräume
Varianten
Aktionen
Navigation
Werkzeuge