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)
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 id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">codeSystemType</td>
 +
  <td>String</td>
 +
  <td>30</td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Type of Code System (Taxonomy, Ontology). Possible values are available in domain table with id 6</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">currentVersionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Version of the Code System</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">description</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Narrative description of Code System</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">descriptionEng</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>English description of code system</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="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">insertTimestamp</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Timestamp, when the Code System was inserted</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">name</td>
 +
  <td>String</td>
 +
  <td>100</td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Name of the Code System. The precise name should be specified in the Code System Version.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">website</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>url to the code system if available</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 id="gray">
 +
  <td id="cardinality_cell">4</td>
 +
  <td id="param_level4">codeSystemId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td></td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">4</td>
 +
  <td id="param_level4">description</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Description of the Code System</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">4</td>
 +
  <td id="param_level4">expirationDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Point of time the Code System looses its validity.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">4</td>
 +
  <td id="param_level4">insertTimestamp</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Point of time when the Code System Version was inserted.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">4</td>
 +
  <td id="param_level4">lastChangeDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Date the code system was last changed.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">4</td>
 +
  <td id="param_level4">licenceHolder</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Owner of the licence.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">4</td>
 +
  <td id="param_level4">name</td>
 +
  <td>String</td>
 +
  <td>100</td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Complete Name of the Code System.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">4</td>
 +
  <td id="param_level4">oid</td>
 +
  <td>String</td>
 +
  <td>100</td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Official OID</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">4</td>
 +
  <td id="param_level4">preferredLanguageCd</td>
 +
  <td>String</td>
 +
  <td>30</td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Preferred language for this code system. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...)</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">4</td>
 +
  <td id="param_level4">previousVersionID</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Refers to the prior version, if there are more than one.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">4</td>
 +
  <td id="param_level4">releaseDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Point of time, when this version starts to be valid.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">4</td>
 +
  <td id="param_level4">source</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Source of the Code System Version</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">4</td>
 +
  <td id="param_level4">status</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Status of the current entry. Can be taken from a domain.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">4</td>
 +
  <td id="param_level4">statusDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Point of time of the last change of the status</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">4</td>
 +
  <td id="param_level4">underLicence</td>
 +
  <td>Boolean</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>true, if Code System is under license (Code System will be invisible for all users without proper license)</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">4</td>
 +
  <td id="param_level4">validityRange</td>
 +
  <td>String</td>
 +
  <td>30</td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Validity range, Values from domain list "codesystem_validityrange".
 +
Standard: 1 (required), 2 (recomended), 3 (limited), 4 (optional)</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 id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">codeSystemEntityId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Foreign key to code system entities ID</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">effectiveDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Last change date of the entity version.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">insertTimestamp</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Point in time when entry was inserted.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">isLeaf</td>
 +
  <td>Boolean</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Indicates if an element is leaf or not. Value will be set by a trigger and is therefore read only. </td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">majorRevision</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Major revision of this entry (composition of major and minor version e.g. 1.3).</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">minorRevision</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Minor revision of this entry (composition of major and minor version e.g. 1.3)</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">previousVersionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Refers to the prior version, if there are more than one version.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">statusDeactivated</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Defines the state. Default value is 0 (=visible). Look for available values in the according domain.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">statusDeactivatedDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Date when statusDeactivated changed</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">statusVisibility</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Status of the current entry. Can be taken from a domain.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">statusVisibilityDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Point of time of the last change of the status.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">statusWorkflow</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>A workflow status, can be unique for each codesystem.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">statusWorkflowDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Date when statusWorkflow changed</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 id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">currentVersionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Points to the current version of the valueset.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">description</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Description of the valueset.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">descriptionEng</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td></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="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">name</td>
 +
  <td>String</td>
 +
  <td>50</td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Name of the valueset.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">status</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Status of the current entry. Can be found in a domain.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">statusDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Alteration time of the status.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">website</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td></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 id="gray">
 +
  <td id="cardinality_cell">4</td>
 +
  <td id="param_level4">insertTimestamp</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Timestamp of the insertion of the valueset version.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">4</td>
 +
  <td id="param_level4">lastChangeDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td></td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">4</td>
 +
  <td id="param_level4">name</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td></td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">4</td>
 +
  <td id="param_level4">oid</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td></td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">4</td>
 +
  <td id="param_level4">preferredLanguageCd</td>
 +
  <td>String</td>
 +
  <td>30</td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Preferred language of value set version. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...)</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">4</td>
 +
  <td id="param_level4">previousVersionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Points to the previous version.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">4</td>
 +
  <td id="param_level4">releaseDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Start date for the validity of the valueset version.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">4</td>
 +
  <td id="param_level4">status</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>The status of the current entry. Can be found in a domain.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">4</td>
 +
  <td id="param_level4">statusDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Alteration time of the status.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">4</td>
 +
  <td id="param_level4">validityRange</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Validity range (German: Gültigkeitsbereich)</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">4</td>
 +
  <td id="param_level4">valueSetId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Foreign key to the ID of the 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 516:
 
     <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]]

Version vom 30. September 2014, 12:20 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 codeSystemType String 30 - Type of Code System (Taxonomy, Ontology). Possible values are available in domain table with id 6
3 currentVersionId Long - Version of the Code System
3 description String 65535 - Narrative description of Code System
3 descriptionEng String 65535 - English description of code system
3 id Long 1..1 Internal ID = Primary Key of Code System
3 insertTimestamp java.util.Date - Timestamp, when the Code System was inserted
3 name String 100 - Name of the Code System. The precise name should be specified in the Code System Version.
3 website String 65535 - url to the code system if available
3 codeSystemVersion code_system_version 0..1 Version of a Code System
4 codeSystemId Long -
4 description String 65535 - Description of the Code System
4 expirationDate java.util.Date - Point of time the Code System looses its validity.
4 insertTimestamp java.util.Date - Point of time when the Code System Version was inserted.
4 lastChangeDate java.util.Date - Date the code system was last changed.
4 licenceHolder String 65535 - Owner of the licence.
4 name String 100 - Complete Name of the Code System.
4 oid String 100 - Official OID
4 preferredLanguageCd String 30 - Preferred language for this code system. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...)
4 previousVersionID Long - Refers to the prior version, if there are more than one.
4 releaseDate java.util.Date - Point of time, when this version starts to be valid.
4 source String 65535 - Source of the Code System Version
4 status Integer - Status of the current entry. Can be taken from a domain.
4 statusDate java.util.Date - Point of time of the last change of the status
4 underLicence Boolean - true, if Code System is under license (Code System will be invisible for all users without proper license)
4 validityRange String 30 - Validity range, Values from domain list "codesystem_validityrange". Standard: 1 (required), 2 (recomended), 3 (limited), 4 (optional)
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 codeSystemEntityId Long - Foreign key to code system entities ID
3 effectiveDate java.util.Date - Last change date of the entity version.
3 insertTimestamp java.util.Date - Point in time when entry was inserted.
3 isLeaf Boolean - Indicates if an element is leaf or not. Value will be set by a trigger and is therefore read only.
3 majorRevision Integer - Major revision of this entry (composition of major and minor version e.g. 1.3).
3 minorRevision Integer - Minor revision of this entry (composition of major and minor version e.g. 1.3)
3 previousVersionId Long - Refers to the prior version, if there are more than one version.
3 statusDeactivated Integer - Defines the state. Default value is 0 (=visible). Look for available values in the according domain.
3 statusDeactivatedDate java.util.Date - Date when statusDeactivated changed
3 statusVisibility Integer - Status of the current entry. Can be taken from a domain.
3 statusVisibilityDate java.util.Date - Point of time of the last change of the status.
3 statusWorkflow Integer - A workflow status, can be unique for each codesystem.
3 statusWorkflowDate java.util.Date - Date when statusWorkflow changed
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 currentVersionId Long - Points to the current version of the valueset.
3 description String 65535 - Description of the valueset.
3 descriptionEng String 65535 -
3 id Long 1..1 ID of the valueset.
3 name String 50 - Name of the valueset.
3 status Integer - Status of the current entry. Can be found in a domain.
3 statusDate java.util.Date - Alteration time of the status.
3 website String 65535 -
3 valueSetVersion value_set_version 0..1 Represents the version of an valueset.
4 insertTimestamp java.util.Date - Timestamp of the insertion of the valueset version.
4 lastChangeDate java.util.Date -
4 name String -
4 oid String -
4 preferredLanguageCd String 30 - Preferred language of value set version. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...)
4 previousVersionId Long - Points to the previous version.
4 releaseDate java.util.Date - Start date for the validity of the valueset version.
4 status Integer - The status of the current entry. Can be found in a domain.
4 statusDate java.util.Date - Alteration time of the status.
4 validityRange Long - Validity range (German: Gültigkeitsbereich)
4 valueSetId Long - Foreign key to the ID of the 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