Terminologieserver - Authoring - UpdateConceptStatus
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= | ||
| + | Update the status of a concept (code system entity version). <br> | ||
=Request/Response= | =Request/Response= | ||
==Request== | ==Request== | ||
| Zeile 33: | Zeile 35: | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
<td>code_system_entity_version is the superclass of every Concept and Association. </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">statusDeactivated</td> | ||
| + | <td>Integer</td> | ||
| + | <td></td> <td id="cardinality_cell">0..1</td> | ||
| + | <td>Defines the state. Default value is 0 (=visible). Look for available values in the according domain.</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 38: | Zeile 47: | ||
<td id="param_level3">statusVisibility</td> | <td id="param_level3">statusVisibility</td> | ||
<td>Integer</td> | <td>Integer</td> | ||
| − | <td></td> <td id="cardinality_cell"> | + | <td></td> <td id="cardinality_cell">0..1</td> |
<td>Status of the current entry. Can be taken from a domain.</td> | <td>Status of the current entry. Can be taken from a domain.</td> | ||
| + | </tr> | ||
| + | <tr> | ||
| + | <td id="cardinality_cell">3</td> | ||
| + | <td id="param_level3">statusWorkflow</td> | ||
| + | <td>Integer</td> | ||
| + | <td></td> <td id="cardinality_cell">0..1</td> | ||
| + | <td>A workflow status, can be unique for each codesystem.</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 62: | Zeile 78: | ||
<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 90: | Zeile 106: | ||
</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:UpdateConceptStatus> | ||
| + | <parameter> | ||
| + | <codeSystemEntity> | ||
| + | <codeSystemEntityVersions> | ||
| + | <versionId>4</versionId> | ||
| + | <statusVisibility>1</statusVisibility> | ||
| + | <statusWorkflow>3</statusWorkflow> | ||
| + | </codeSystemEntityVersions> | ||
| + | </codeSystemEntity> | ||
| + | <loginToken>237b6ee6-a448-4b91-8210-a896bf50258a</loginToken> | ||
| + | </parameter> | ||
| + | </aut:UpdateConceptStatus> | ||
| + | </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
Update the status of a concept (code system entity 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 | codeSystemEntity | code_system_entity | 1..1 | Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version. | |
| 2 | codeSystemEntityVersion | code_system_entity_version | 1..1 | code_system_entity_version is the superclass of every Concept and Association. | |
| 3 | statusDeactivated | Integer | 0..1 | Defines the state. Default value is 0 (=visible). Look for available values in the according domain. | |
| 3 | statusVisibility | Integer | 0..1 | Status of the current entry. Can be taken from a domain. | |
| 3 | statusWorkflow | Integer | 0..1 | A workflow status, can be unique for each codesystem. | |
| 3 | versionId | Long | 1..1 | The ID of this entry. |
Response
| Level | Parameter | Typ | Länge | Kardinalität | Beschreibung |
|---|---|---|---|---|---|
| 1 | returnInfos | ReturnType | 1..1 | Return information | |
| 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:UpdateConceptStatus> <parameter> <codeSystemEntity> <codeSystemEntityVersions> <versionId>4</versionId> <statusVisibility>1</statusVisibility> <statusWorkflow>3</statusWorkflow> </codeSystemEntityVersions> </codeSystemEntity> <loginToken>237b6ee6-a448-4b91-8210-a896bf50258a</loginToken> </parameter> </aut:UpdateConceptStatus> </soapenv:Body> </soapenv:Envelope>
